Get Additional Document Data

Use this request to retrieve additional raw data related to the document.

To retrieve additional raw data, use the GET method and the following URL:

https://e-invoicing-service.vertexcloud.com/customers/v2/documents/{documentId}/{format}

Details

DetailDescription
MethodGET
Endpoint/v2/documents/{documentId}/{format}
API Reference TopicGet Additional Data from the Invoice

Invoice Data

Every Document handled by Vertex e-Invoicing is accessible through this request. The VRBL payload contains the canonical representation of the Document and is the recommended format for programmatically extracting information from the invoice because it is a consistent format across all jurisdictions supported by Vertex e-Invoicing.

The following formats are supported:

FormatDescription
VRBLThe full representation of the invoice in the canonical form described by the VRBL User Guide
Invoice PDFA human-readable version of selected information in the invoice
Legal DocumentThe legal representation of the invoice
• For Inbound invoices, this is the exact document received.
• For Outbound invoices, this is the invoice as transmitted to the network.
ArchiveA ZIP file containing all artifacts related to the invoice. For a completed invoice, this always includes the VRBL, PDF, and legal document, and may include additional files like confirmations, acknowledgments, signature files, or timestamps depending on the jurisdiction.
AttachmentsA ZIP file containing any attached files embedded in the VRBL document.

Request Parameters

The following parameters can be specified in requests:

Path ParameterTypeDescription
documentIdGUIDThe unique identifier of the document within Vertex e-Invoicing.
formatStringOne of the following formats:
• VRBL
• PDF
• LegalDocument
• Archive
• Attachments

Response Output

The body of the response will be the raw content of the invoice for the specified format. For example, if
the format is VRBL, the response has Content-Type=application/xml and the body contains
the VRBL representation of the invoice.