API interfaces in Scope
Scope provides a range of API interfaces that enable access to shipment data and business partner information from the system.
Currently the following APIs are available:
- Order API
- Partner API
- Accounts Payable API
- Tax Authority API
Order API
The Order API provides endpoints for retrieving order and shipment data. It is primarily designed for statistical analysis, reporting, and integration with external systems that require essential shipment information.
The API is strictly read-only and does not permit data modifications. As it delivers only basic data rather than comprehensive shipment details, it is generally not intended for operational processes.
The following information is provided as part of the order and shipment data.
- General order and shipment data
- Air freight specific data
- Ocean freight specific data such as container data
- DGR information
- Finance data
- CO₂ Calculation
- Transport order data
- Customs order data
- Milestones from tracking templates
- Reference numbers
- Jobcosting
Partner API
The Partner API provides read-only access to master data of partners. The available data includes:
- General partner information
- Contacts
- Registration IDs
- Certain details of the debtor profile
- Certain details of the creditor profile
Accounts Payable API
Incoming invoices can be imported as drafts via the API for continued processing in Scope and may also be created, retrieved, finalized, or canceled.
Tax Authority API
The Tax Authority API enables integration between Scope and e-invoicing providers or local tax authority portals.
In countries where outgoing invoices require approval from tax authorities before issuance, the acceptance or rejection result can be transmitted to Scope via the API.
For a comprehensive and technical documentation for all APIs please refer to: Scope-rest-webservices