Retrieve Message Documents

Use this request to retrieve the Documents that are associated with a message.

The original invoice and a confirmation of the receipt is returned in a ZIP file. The exact contents can vary by country or format.

The ZIP file is returned only after the processing is complete. For example, this might mean internal processing for inbound messages and the official acknowledgment from the Tax Authority for outbound messages.

To retrieve the Documents, use a GET operation and the following URL:

https://{service_uri}/api/v1/messages/{messageId}/documents

where:

  • {service_uri} is the service's URI.
  • {messageId} is the message ID you want to retrieve. This is explained in the Path parameter section of this topic.

For example:

curl --request GET \
     --url https://e-invoicing-message.vertexcloud.com/api/v1/messages/ewdasdasa/documents \
     --header 'accept: application/zip'

Details

TypeValue
Endpoint/api/v1/messages
MethodGET
API Reference TopicRetrieve message documents

Path parameter

FieldDetailsDescription
messageIdUUIDID of the message

Example

Request

curl --request GET \
     --url https://e-invoicing-message.vertexcloud.com/api/v1/messages/ewdasdasa/documents \
     --header 'accept: application/zip'

Response

The response returns a ZIP file that contains the message Documents.