Vertex e-Invoicing API: Overview
Read about how to use the Vertex e-Invoicing API.
This API is used by existing customers.
URIs
The URI for the Vertex e-Invoicing API is https:{service_uri}/customers/v2/ where {service_uri} is the URL of the environment that you want to access, like Production or Test.
The following table lists the available URIs:
| URI | Description |
|---|---|
https://e-invoicing-service.vertexcloud.com/ | Production environment |
? | Test environment |
Component Overview
The API consists of the following components:
| Requests (Endpoint) | Description |
|---|---|
Send Document (documents) | Load a file into the service. |
Get Document Status (documents/{documentId}) | Check the status of a document. |
Get Documents from the Integration Queue (documents/integration-queue) | Retrieve documents in the invoice queue. |
Get Additional Document Data (documents/{documentId}/{format}) | Retrieve additional data related to an invoice. |
Mark Documents as Integrated (documents/integrated-flag) | Mark documents as integrated into your system. |
Using this API
The following sections detail how you can use this API:
Sending Documents
You use the Send Document request to send Documents to the service.
Retrieving a Document's status
You use the Get Document Status request to retrieve the status of your document. This will return a message that updates you on the current status. These are listed in the Document Workflow Status topic.
Idempotency key
To prevent submitting duplicate copies of the invoice, supply an idempotency key in your requests, as described in the Idempotency Key topic.
In this section
| Topic | Description |
|---|---|
| Send Document | The request you use to send Documents to the service. |
| Idempotency Key | To prevent submitting duplicate copies of the invoice, supply a key parameter. |
| Get Document Status | The request you use to retrieve the status of the processing. |
| Document Workflow Status | The messages sent back by the Get Document Status request. |
| Get Documents from the Invoice Queue | Use this request to retrieve documents to be integrated into your processing system. |
| Get Additional Document Data | Use this request to retrieve additional raw data related to the invoice. |
| Mark Documents as Integrated | Use this request to mark documents as integrated. |
Updated 19 days ago