Get PEPPOL UBL formatted document

get

https://example.com/peppol-api/ubl-documents/{documentId}

The GET /ubl-documents/{documentId} endpoint is used to retrieve a specific UBL document by its identifier. The endpoint expects the documentId parameter to be provided in the path of the request URL.

Upon successful retrieval of the UBL document, the response will contain the UBL document in the response body. The format of the document will be in compliance with the PEPPOL standard.

NOTE: It's important to note that UBL documents are only available for 30 days. After this period, they will be permanently deleted and will no longer be available for retrieval. Therefore, it's important to archive the UBL documents as required by relevant laws and regulations.

Path Params

documentId

uuid

required

The documentId path parameter is the unique identifier of the UBL document.

Headers

X-Customer

string

The X-Customer header is used in API requests to indicate the identity of the customer sending a PEPPOL invoice. When the customer can't be derived from the authentication credentials used to authorize the request the X-Customer header must be used to specify which customer is making the request. This allows the API to process the request appropriately based on the identity of the customer. The usage of the X-Customer header is only allowed for internal consumers of the API. External consumers are not authorized to use this header.

string

required

The Accept header must be set to application/sh.peppol.api.v001+json. This specific format allows the API to identify the version of the request payload being sent and process it accordingly.

If the Accept header is not set to the expected format, the API will return an ERROR-UNSUPPORTED-ACCEPT-HEADER error to indicate that the request payload format is not supported.

Responses

200The PEPPOL UBL document was successfully downloaded.

401Unauthorized, The request has not been applied because it lacks valid authentication credentials for the target resource. Action: Add Authorization information to the http-request.

403Forbidden, If authentication credentials were provided in the request, the server considers them insufficient to grant access.

404Not Found, the specified identifier of the resource was not found.

406The service was unable to process your request due to an unsupported accept header. Please ensure that your accept header is set correctly and try again.

415The service was unable to process your request due to an unsupported content type header. Please ensure that your content type header is set correctly and try again.

500Internal Server Error, The service was unable to process the request. Action: Please contact our support for this issue including all details(Request-body, error message, ..).

503Maintenance mode, the server is currently unable to handle the request due to a temporary maintenance of the API. Action: Please try again at a later moment.