API-Schnittstellen in Scope
Scope stellt verschiedene API-Schnittstellen zur Verfügung, über die unter anderem Sendungsdaten und Geschäftspartnerinformationen aus dem System abgerufen werden können.
Aktuell stehen folgende APIs zur Verfügung:
- Order API
- Quotation API
- Partner API
- Salesperson API
- Charge Type API
- Accounts Payable API
- Tax Authority API
Order API
Die Order API bietet Endpunkte zum Abruf von Auftrags- und Sendungsdaten. Sie ist primär für statistische Auswertungen, Reporting-Zwecke sowie zur Anbindung externer Systeme vorgesehen, die grundlegende Informationen zu Sendungen benötigen.
Die API ist ausschließlich lesend ausgelegt und unterstützt keine Datenänderungen. Da sie lediglich Basisdaten und keine vollständigen Sendungsinformationen liefert, ist sie für operative Prozesse in der Regel nicht geeignet.
Folgende Daten werden als Teil der Auftrags- und Sendungsdaten zurückgegeben.
- Allgemeine Auftrags- und Sendungsdaten
- Luftfracht spezifische Daten
- Seefracht spezifische Daten wie z. B. Container-Daten
- DGR-Informationen
- Finanzdaten
- CO₂-Berechnungen
- Transportauftragsdaten
- Zollauftragsdaten
- Meilensteine aus Tracking-Vorlagen
- Referenznummern
- Kosten & Erlöse
Qutation API
Die Quotation API bietet Endpunkte zum Erstellen, Verwalten und Abrufen von Offerten.
Zur Verfügung stehen aktuell folgenden Möglichkeiten:
- Erstellen von Angeboten mit allen allgemeinen Offertendetails wie,
- Interessent, Versender, Empfänger
- Annahmeort und PLZ, Lieferort und PLZ
- Ladehafen/Abgangsort und Löschafen/Ankunfsort
- Incoterm und Ort sowie Auftragsumfang und Sendungsumfang
- Container und Packstückdetails inkl. Kolli, Art, Abmessungen, Gewicht, Warenbezeichnung, HTS Code, Stapelfaktor, SHCs etc.
- Angebotsoptionen mit Informationen zu Spediteuren und Preisen werden über einen separaten Endpunkt verwaltet
- Anzeigen von Angeboten
Die Quotaion API befindet sich in aktiver Entwicklung und es werden laufend noch weitere Funktionen hinzugefügt.
Partner API
Die Partner API ermöglicht den lesenden Zugriff auf Geschäftspartner-Stammdaten. Zur Verfügung gestellt werden unter anderem:
- Allgemeine Geschäftspartnerdaten
- Kontakte
- Registriernummern
- Ausgewählte Felder des Debitorenprofils
- Ausgewählte Felder des Kreditorenprofils
Salesperson API
Die Salesperson API ermöglicht den lesenden Zugriff auf die wichtigsten Verkäufer-Stammdaten.
Charge Type API
Die Salesperson API ermöglicht den lesenden Zugriff auf die wichtigsten Verkäufer-Stammdaten.
Accounts Payable API
Tax Authority API
Die Tax Authority API ermöglicht die Anbindung von Scope an E-Invoicing-Anbieter oder Portale lokaler Steuerbehörden.
In Ländern, in denen Ausgangsbelege vor der Rechnungsstellung durch die Behörden genehmigt werden müssen, kann das Ergebnis – Annahme oder Ablehnung – per API an Scope übermittelt werden.
Eine detailliertere und technische Dokumentation zu allen APIs finden Sie hier: Scope-rest-webservices