Introduction

Our API enables seamless integration between your system and VATify, allowing you to automate the submission and retrieval of VAT-related data. With our API, you can manage VAT compliance effortlessly by sending and receiving documents in a standardized format.

Key Features:-

Automated Data Exchange: Submit and retrieve VAT information automatically.

Flexible Document Configuration: Depending on the API call, specific parameters may be required. Refer to the DocumentConfig object for a detailed list of parameters that may become mandatory.

To get started, explore the available methods and ensure your requests follow the required parameters for successful integration.

Prerequesites

• Review the Request Access topic on this site to gain access to our API.
• Review the Environments topic on this site to learn more about the available environments.
• Review the API Authentication section on this site to understand how to access the services of our API.
• Review the [Send document] topic on this site to submit documents to VATify.

API Overview

An overview of the API can be found in the [Integration API] topic.

Process flows

• Outbound: Document sent from your system to Tax Authorities or other recipient.
• Inbound: DO WE SUPPORT THIS FLOW?

Outbound Process

The following diagram shows an example of an outbound process flow, by sending a Document over VATify to Tax Authorities.

📘

Note

As an example, your implementation can differ from this outbound process flow.

TODO: OUTBOUND PROCESS FLOW

Outbound process flow example

The steps are:

1. Invoice is sent as VRBL Document. A Send Document 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.

Inbound Process

The following diagram shows an example of an inbound process flow, by sending a Document over VATify to Tax Authorities.

Lorem ipsum dolor sit amet

Integration

To integrate the service, complete the following steps:

1. Request access to our API. See Request Access
2. Select the appropriate environment. See Environments
3. Perform the API Authentication to obtain your access tocken. See API Authentication
4. Use the [Send Document] service to a Document. In [Example files] you can find some examples.
5. Test the full process.

---

For additional assistance or technical support, contact the Marosa team directly.