business/documents method

Last modified: 2. August 2024

This method allows OpenTrans 2.1 documents to be retrieved for existing orders and quotes. The corresponding transaction IDs can be obtained using the respective business/deals or business/quotes API methods.

OpenTrans 2.1 ORDER download

The following URL is an example of retrieving an OpenTrans 2.1 ORDER document for an ITscope order that has already been created or sent, using the transaction ID ‘acb-sxf-sswa-1241541′:

https://api.itscope.com/2.0/business/documents/acb-sxf-sswa-1241541/ORDER.xml

OpenTrans 2.1 ORDERRESPONSE download

The following URL is an example of retrieving an OpenTrans 2.1 ORDERRESPONSE document for an ITscope order that has already been sent, using the transaction ID ‘acb-sxf-bbaaa-35461541′:

https://api.itscope.com/2.0/business/documents/acb-sxf-bbaaa-35461541/ORDERRESPONSE.xml

OpenTrans 2.1 DISPATCHNOTIFICATION download

The following URL is an example of retrieving an OpenTrans 2.1 DISPATCHNOTIFICATION document for an ITscope order that has already been sent, using the transaction ID ‘bdh-aur-bbey-887523435′:

https://api.itscope.com/2.0/business/documents/bdh -aur-bbey-887523435 /DISPATCHNOTIFICATION.xml

OpenTrans 2.1 INVOICE download

The following URL is an example of retrieving an OpenTrans 2.1 INVOICE document for an ITscope order that has already been sent, using the transaction ID ‘buik-oikje-uiohd-98792874′:

https://api.itscope.com/2.0/business/documents/ buik-oikje-uiohd-98792874 /INVOICE.xml

ZUGFerd Download

The following URL is an example of retrieving an ZUGFerd Invoide pdf document for an ITscope order that has already been sent, using the transaction ID ‘buik-oikje-uiohd-98792874′: The ZUGFerd Format will be only available from specific suppliers.

Bsp: https://api.itscope.com/2.0/business/documents/buik-oikje-uiohd-98792874/INVOICE.pdf

OpenTrans 2.1 QUOTATION download

The following URL is an example of retrieving an OpenTrans 2.1 QUOTATION document for an ITscope order that has already been created or sent, using the transaction ID ‘123-agfa-1254-579a653bd’:

https://api.itscope.com/2.0/business/documents/123-agfa-1254-579a653bd/QUOTATION.xml

Semantic validation of OpenTrans 2.1 order and order response documents against the OpenTrans XSD schema

This can be used to validate all order and response documents in OpenTrans 2.1 format during development or before sending via our API. Here only a semantic validation takes place against the OpenTrans 2.1 XSD schema.

This concerns the following documents

In case of an incorrect document, the lines and column numbers that led to an invalid result are listed in the error outputs.

Example.: https://api.itscope.com/2.0/business/documents/validateschema

Semantic and content validation of the OpenTrans 2.1 ORDER order document before sending an order to a supplier

This method can only be used to validate the OpenTrans 2.1 ORDER document, i.e. the order via API.

This method requires a correct order document that is addressed to a supplier listed in ITscope. On the one hand, a semantic validation takes place against the OpenTrans 2.1 XSD schema, but also an additional content check of the document in relation to certain settings of the supplier from whom the order is to be placed. (e.g. article numbers, prices, addresses, and also whether the necessary services for the supplier are all set up correctly in ITscope.

We only recommend using this method if you want to make sure that the order will go through without errors before sending a real LIVE order to a supplier.

In the event of an incorrect document, the rows and column numbers that led to an invalid result are listed in the error outputs

Example: https://api.itscope.com/2.0/business/documents/validate

Was this article helpful?
Dislike 0
Views: 380