Getting Started with Vertex e-Invoicing
Learn how to use Vertex e-Invoicing to upload invoices for submission to tax authorities and transmission to buyers.
Introduction
Vertex e-Invoicing helps you to simplify VAT compliance globally, providing a single, scalable solution for managing real-time reporting and the creation, exchange, and clearance of e-invoices. By connecting with source financial systems, e-Invoicing streamlines electronic invoicing processes, helping to increase efficiency and reduce compliance risk.
The Vertex e-Invoicing REST API enables you to upload e-invoices and other Documents for processing according to the country mandate, including, submission to Tax Authorities and, in some countries, delivery to other parties like Buyers.
Documents is the collective term for the e-invoices and credit notes that you send to the service. For an overview of this and other terms, see the Glossary.
Vertex Universal Standard (VRBL)
Vertex Universal Standard (VRBL) is the name of the format that you must use to submit Documents. See the VRBL Overview.
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.
Restrictions
- You send Documents and the status only is returned when you poll using the Get Document Status request. The service is not bi-directional.
- Some countries require specific elements and values. These are documented in the section for that country. For an example, see Malaysia: Overview.
- B2C is not supported.
- Some countries support B2B and B2G. Some only support B2G. See Supported Countries for details.
Component Overview
The following graphic shows the components:
Vertex e-Invoicing consists of the following components:
- REST API: This is used to integrate the service with your applications. See Using the Vertex e-Invoicing API.
- Vertex e-Invoicing: The component that creates the invoice and submits it to the Tax Authority.
- Documents: Documents is the collective term for the e-invoices, credit notes, and other types that are sent to the Tax Authority electronically. See Modeling Documents.
The following bodies can be recipients:
- Tax Authority: The Tax Authority is the legal body responsible for collecting the e-invoices. They are the only recipient for most countries.
- Other Recipients: In some countries, other parties with compatible systems, such as Buyers can receive Documents, so you can send to these in specific circumstances.
API Overview
An overview of the API is provided in the Using the Vertex e-Invoicing API 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:
- Invoice is sent as VRBL Document. A Send File request is sent to Vertex e-Invoicing.
- Vertex e-Invoicing sends a success message and GUID to the user.
- 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.
- Vertex e-Invoicing retrieves the status and returns it in the response to the request.
- The user receives the status.
- 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.
- 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.
- The user checks the status again as they did in step 3, using another Get Document Status request.
- The user receives the status from Vertex e-Invoicing in the response to the Get Document Status request.
Integration
To integrate the service, complete the following steps:
- Retrieve your access token. See API Authentication and Access.
- Integrate the requests into your environment. See Using the Vertex e-Invoicing API.
- Use the Send Document request to send some sample files. You can get samples from the Example Files topic.
- Test your integration.
In this Section
Topic | Description |
---|---|
API Authentication and Access | You use an access token to authenticate requests. Before you do, you must ensure that you have the correct user credentials to retrieve the token. |
Supported Countries | Read about the supported countries and regions. |
Glossary | Read about terms that are used frequently in this documentation. |
Copyright Notice | Read this copyright notice. |
Updated 22 days ago