You can use the Vertex e-Invoicing API's requests to load invoices into the service and check on the processing status.

Getting Started

Before you can send API requests, you need to retrieve your access token as detailed in the API Authentication and Access topic.

You use the Send Document request to send Documents in the VRBL format.

Prerequisites

📘

Note

Vertex Community is a resource for Knowledge Articles, Training, Customer Forum, and Customer Support. Accessing Vertex Community requires login credentials. You can request login credentials on the Community, but you will need your company's account number. If you do not know your account number, contact your company's administrator or [email protected].

• Review the How e-Invoicing Works topic on Vertex Community.
• Review the Accessing e-Invoicing topic on Vertex Community.
• Review the API credential creation for e-Invoicing topic on Vertex Community.
• Review the Document Files topic on this site for the requirements to upload files.
• Review the API Authentication and Access topic on this site to understand how to access the service's API.

API Overview

The API consists of the following components

The API Reference Guide lists the requests and fields in the API.

Using the API

The following sections detail how you can use the 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 Status Fields topic.

Adding Correlation ID

You can add a Correlation ID any request and this ID can be used later to help identify the request later. You use the x-correlation-id to do this. See Correlation IDs.

Key Parameters

To prevent submitting duplicate copies of the invoice, supply a key parameter in your requests, as described in the Key Parameters topic.

Process Flow

The following diagram shows an example process flow. In this example, the e-invoices are sent using VRBL. Your implementation might differ due to your requirements:

The steps are:

1. Invoice is sent as VRBL Document. A Send File request is sent to Vertex e-Invoicing.
2. Vertex e-Invoicing sends a success message and GUID to the user.
3. The user wants to retrieve the status. They send a Get Document Status request, specifying the same GUID as was returned in the previous step.
4. Vertex e-Invoicing retrieves the status and returns it in the response to the request.
5. The user receives the status.
6. When the Document is ready (validated and transformed as per specific country mandate), the service sends it to the Tax Authority or other recipient per the configuration.
7. The Tax Authority accepts the Document and sends a reply to the service. Finalized XML, PDF, and signature files (if applicable) are available in the service's Dashboard after this step is complete.
8. The user checks the status again as they did in step 3, using another Get Document Status request.
9. The user receives the status from Vertex e-Invoicing in the response to the Get Document Status request.

In this Section

This section contains the following topics: