HTTP Status Codes

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

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:

Error Messages

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

In This Section