Using the Vertex e-Invoicing APIs
Read about which API you should use.
You can use the Vertex e-Invoicing APIs to load invoices into the service and check on the processing status.
Vertex e-Invoicing includes 2 APIs:
- The ENV.CUSTOMER.API (referred to as the Vertex e-Invoicing API) is used for customers with existing installations. See Vertex e-Invoicing API: Reference Guide.
- The Vertex Messaging API (referred to as the Vertex e-Invoicing Messaging API) is intended for use for new customers. If you are ingesting non-VRBL files, you must use this API. See Vertex e-Invoicing Messaging API: Reference Guide.
The following table outlines the features supported by each API:
| API | Supports |
|---|---|
| Vertex e-Invoicing API | |
| Vertex e-Invoicing Messaging API |
Both APIs support the countries listed in the Supported Countries topic.
Getting started
Before you can send API requests, you need to retrieve your access token as detailed in the API Authentication and Access topic.
Vertex e-Invoicing API users can use the Send Document request to send Documents.
Vertex e-Invoicing Messaging API users can use the Send a Message request to do the same.
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.
- Vertex e-Invoicing API users can review the Send Document topic on this site for the requirements to upload files.
- Vertex e-Invoicing Messaging API users can review the Send a Message 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.
In this guide
This guide contains the following sections:
| Topic | Description |
|---|---|
| Using the Vertex e-Invoicing APIs | The overview for this section. |
| Error Handling | Information about error and status messages. |
| Vertex e-Invoicing API: Overview | Read about the e-Invoicing API. |
| Vertex Messaging API: Overview | Read about the Vertex Messaging API. |
| Vertex e-Invoicing Webhook | This section explains how you can use the Webhook. |
Updated 19 days ago
