🚧

Warning

You must contact Vertex to enable this API before you can use it. Initially, this API is intended for use by new customers.

You can use this API to send Documents and process messages.

If you ingest files in a format other than VRBL, you must use this API.

URL

The API URL for the Vertex e-Invoicing Messaging API is https://{service_uri}/api/v1/messages, where {service_uri} is the service's URL.

The following table lists the available URL:

Components

The API consists of the following requests:

The Vertex e-Invoicing Messaging API: Requests section contains the request topics. Fields are explained in the topics in the Vertex e-Invoicing Messaging API: Field References section.

Using the API

You can use this API to do the following:

Send messages

• Use the Send a Message request to send a Document to the service for processing.

Manage messages

You can use the following requests to retrieve information about messages and to help process them:

• Use the List All Messages request to list messages about previously submitted Documents.
• Use the Retrieve a Message request to retrieve a specified message.
• Use the Confirm Processing of a Message request to confirm a message.
• Use the Retrieve Message Documents request to retrieve the Documents that are associated with a specified message.

In this section