Error Handling

This topic explains how to handle errors and other messages.

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 will return 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 error type (category) and message with additional details.

Error Status

The status field shows one of the status listed below and in the Document Status Fields topic:

Field	Display Name	Description
`None`	Awaiting Processing	Your invoice is ready and waiting to be processed
`Initialized`	Preparation Complete	Your invoice is initialized for the next steps
`Validating`	Invoice Validation	Your invoice is being reviewed to ensure it meets the criteria.
`MimeChecking`	File Type Verification	The invoice file types are being verified to confirm that they are valid and supported.
`UploadedToQuarantineBucket`	Quarantined for Safety	Your invoice was uploaded to a quarantine bucket and is awaiting further safety checks.
`VirusScanningSourceXml`	Source XML Virus Scan	The XML is being scanned for viruses.
`ExtractingAttachments`	Retrieving Attachments	We are extracting the attachments from your invoice for processing
`VirusScanningAttachments`	Attachments Virus Scan	All attachments are being scanned for viruses
`VssComplete`	Virus Scan Complete	The virus scan completed successfully
`Verifying`	Invoice Verification	The invoice is being verified
`Deduplicating`	Duplicate Check in Progress	We are comparing your invoice for duplicates in the system
`Loading`	Invoice Loading	Your invoice is being loaded for processing.
`LoadComplete`	Invoice Loaded	Your invoice was loaded and is ready for the next step
`VirusScannedSourceXml`	XML Virus Scan Complete	The invoice XML file successfully passed the virus scan
`VirusScannedAttachments`	Attachments Virus Scan Complete	All attachments passed the virus scan
`ExtractedAttachments`	Attachments retrieved	The attachments for the invoice were extracted.
`Validated`	Invoice Validated	The invoice was validated for accuracy and completeness
`MimeChecked`	File Types Verified	The invoice file types were verified as valid and supported
`Verified`	Verification Success	Your invoice details were verified
`Dedupled`	Duplicate Check Complete	No duplicates found
`MovingFiles`	File Transfer in Progress	Your invoice files are being transferred
`MovedFiles`	File Transfer Complete	Your invoice files were transferred successfully
`SendingToPartner`	Preparing to Send	Your invoice is being prepared for transmission to the partner
`SentToPartner`	Transmission Initiated	Your invoice is on its way to the partner
`ApplyingSchemaRules`	Executing schema rules	Your invoice is being evaluated against schema rules
`SchemaRulesCheckPassed`	File is compliant with schema rules	Your invoice is compliant with applied schema rules
`CheckingTransmissionStatus`	Checking Transmission Status	The partner is processing your invoice. Confirmation will be provided once the invoice is accepted
`Transmitted`	Transmission completed	The files have been transmitted to the Tax Authority.
`Completed`	Processing Complete	Invoice pdf has been retrieved successfully
`EnqueuingBackgroundProcess`	Invoice Queued	Your invoice is scheduled for background processing
`BackgroundEntryProcess`	Processing Initiated	Your invoice is being processed now
`ValidationError`	Validation Issues Detected	Review your invoice for errors and resubmit it
`DuplicationError`	Duplicate Invoice Found	There is a duplicate of your invoice in our system
`VssCheckError`	Virus Detected	Your invoice contains a virus. Please ensure that your files are clean
`AttachmentIsNotAllowedError`	Unsupported Attachment Type	There are one or more attachments of an unsupported file type
`SchemaIsNotCompliantError`	Schema Non-Compliance	Your invoice format does not match our required schema
`XmlIsInvalidError`	XML Is Invalid Error	Your invoice XML file has a formatting issue
`AttachmentMaxSizeExceeded`	Attachment Max Size Exceeded	Your attachment exceeds the maximum allowed size
`VssRetrieveResultsCheckError`	Virus Scan Retrieve Results Check Error	There was an error while retrieving the results of the virus scan.
`SentToPartnerError`	Transmission to Partner error	An error occurred while transmitting the invoice to the partner
`Rejected`	Invoice Rejected	Your invoice was rejected due to specific issues
`UnknownError`	Unexpected Error Occurred	An unspecified error occurred. Try again or contact support
`FileMaxSizeExceededError`	FileMaxSizeExceededError	Your invoice exceeds the maximum allowed size
`SchemaRulesCheckFailedError`	File is non-compliant with schema rules	Your invoice is non-compliant with applied schema rules
`FileTransferringFromSFTP`	SFTP Transmission Initiated	Your invoice is being transferred from your SFTP host
`FileTransferedFromSFTP`	SFTP Transmission Completed	Your invoice was transferred from your SFTP host.
`InvoiceIgnoredForDelivery`	Invoice Ignored For Delivery	This invoice was not delivered because the SFTP configuration was disabled or the Final Invoices feature was not activated at the time it was processed.
`InvoiceDelivered`	Invoice Delivered Successfully	This invoice was delivered successfully.
`InvoiceUndeliverable`	Invoice Undeliverable	This invoice was marked as Undeliverable after multiple attempts to deliver failed.
`FileTransferringToSFTP`	SFTP Transfer Initiated	Your invoice is being transferred to your SFTP host.
`FileTransferredToSFTP`	SFTP Transfer Completed	Your invoice was transferred to your SFTP host.

Error Messages

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

Updated about 2 months ago