HTTP status codes

The service's API uses standard HTTP Status codes, including:

Code	Description
200	Successful request.
400 invalid request	It can also signify a business error. You can review the error's details for further information.
401 unauthorized	The request is not allowed.
500 internal server error	Generally, the operation should be retried later, and if the error persists, support should be contacted.

Error information in API responses

Whenever possible, the API returns an application/json response with error information, such as below:

{
    "documentId": null,
    "status": "SchemaIsNonCompliantError",
    "rejectMessage": "Validation Error: The element 'PartyTaxScheme' in namespace 'urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2' has incomplete content. List of possible elements expected: 'CompanyID, TaxLevelCode, ExemptionReasonCode, ExemptionReason' in namespace 'urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2' as well as 'RegistrationAddress, TaxScheme' in namespace 'urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2'."
}

This data structure contains the error type (category) and a message with additional details.

Error status

The status field shows one of the statuses as listed both below and in the Document Workflow Status topic:

Status	Description
`Pending`	The initial state of the document while it is being pre-processed. While in this status, the document is not yet visible in the e-Invoicing dashboard. This is a transient state. Documents move from this status to either In Progress when they are successfully validated or Processing Issue in the case of an error.
`In Progress`	After initial validation, a document is visible in the e-Invoicing dashboard, and delivery is in progress through the network to the tax authority and the final recipient. This is a transient state. Documents move from this status to either Completed or Error.
`Completed`	The business process of the document is complete and all deliveries are final.
`Processing Issue`	The document shows this status when an error occurs in the early stages of ingestion, for example, the input document is not correctly formatted.
`Error`	The document shows this status once it has made it through early validation but has a business error, for example, it was rejected by the tax authority. This category of error can generally be resolved by the user by correcting the issue indicated.

Error messages

Error messages are based on the Rules. These are displayed on the Vertex e-Invoicing UI.

In this section

Topic	Description
VRBL: Messages	The VRBL core messages are the ones that are common to all countries.
PEPPOL: Messages	Read the core PEPPOL messages.
EN 16931: Messages	View the messages for EN 16931.
Belgium PEP: Messages	View the messages for Belgium.
Denmark PEP: Messages	View the messages for Denmark PEP.
Denmark OL: Rules	View the messages for Denmark OL.
Estonia PEP: Messages	View the messages used by Estonia
Finland PEP: Messages	View the messages for Finland.
France PEP: Messages	View the messages for France.
Germany PEP: Messages	View the messages for Germany PEP.
Germany XR: Messages	View the messages for Germany XR .
Greece PEP: Messages	View the messages for Greece.
India IRP: Messages	View the messages for India IRP.
Italy FPA: Messages	View the messages for Italy.
Japan PEP: Messages	View the messages for Japan.
Lithuania PEP: Messages	View the messages for Lithuania.
Malaysia MYS: Messages	View the messages for Malaysia.
Netherlands PEP: Messages	View the messages for the Netherlands.
Norway PEP: Messages	View the messages for Norway.
Portugal PTC: Messages	View the messages for Portugal.
Romania PEF: Messages	View the messages for Romania.
Saudi Arabia ZTA: Messages	View the messages for Saudi Arabia.
Serbia SRF: Messages	View the messages for Serbia.
Slovakia ISE: Messages	View the messages for Slovakia.
Slovenia PEP: Messages	View the messages for Slovenia.
Spain PEP: Messages	View the messages for Spain PEP.
Spain FTE: Messages	View the messages for Spain FTE.
Sweden PEP: Messages	View the messages for Sweden.
Taiwan TWF: Messages	View the messages for Taiwan.
UK PEP: Messages	View the messages for the UK.