This thread has been locked.

If you have a related question, please click the "Ask a related question" button in the top right corner. The newly created question will be automatically linked to this question.

[FAQ] TI-API: v2 Backlog financial document (invoice) API error codes and meanings (part 1 of 2)

Part Number: TI-API

What do the v2 financial document (invoice) API error codes mean?

  • Scenario Error details Remediation steps
    Missing Input
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-FIR-API-0016",
    			"type": "ERROR",
    			"reason": "Missing Input",
    			"message": "Input cannot be null or empty. Enter a valid input."
    		}
    	]
    }
    Input is missing and cannot be null or empty. Enter a valid input. If further assistance is needed, contact TI API Support at api-portal.ti.com/support
    Missing CustomerGlobalIdentifier
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-FIR-API-0010",
    			"type": "ERROR",
    			"reason": "Missing CustomerGlobalIdentifier",
    			"message": " CustomerGlobalIdentifier is required. Contact TI API Support https://api-portal.ti.com/support for assistance."
    		}
    	]
    }
    CustomerGlobalIdentifier is required and cannot be null or empty. Contact TI API Support api-portal.ti.com/support for assistance.
    Missing or invalid soldToAccountNumber
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-FIR-API-0020",
    			"type": "ERROR",
    			"reason": "ERROR",
    			"message": " soldToAccountNumber cannot be null or empty or is not valid. Enter a valid soldToAccountNumber and resubmit request."
    		}
    	]
    }
    soldToAccountNumber is not valid or missing and cannot be null or empty. Enter a valid soldToAccountNumber and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    Invalid soldToAccountNumber
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-FIR-API-0021",
    			"type": "ERROR",
    			"reason": "ERROR",
    			"message": " soldToAccountNumber cannot exceed 17 characters in length. Enter a valid soldToAccountNumber up to 17 characters and resubmit request."
    		}
    	]
    }
    soldToAccountNumber exceeds the maximum length of 17 characters. Enter a valid soldToAccountNumber that does not exceed 17 characters and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    One of the Identifiers required
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-FIR-API-0030",
    			"type": "ERROR",
    			"reason": "One Identifier required",
    			"message": "One of the following identifiers orderNumber or financialDocumentNumber or deliveryNumber or customerPurchaseOrderNumber is required.  Enter one of the valid Identifiers and resubmit request. "
    		}
    	]
    }
    Only one field is required. Enter one of the following valid fields: orderNumber or financialDocumentNumber deliveryNumber or customerPurchaseOrderNumber and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    Populate only one Identifier
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-FIR-API-0031",
    			"type": "ERROR",
    			"reason": "Populate only one Identifier",
    			"message": "Only one of the following identifiers orderNumber or financialDocumentNumber or deliveryNumber or customerPurchaseOrderNumber can be provided. Enter one of the valid Identifiers and resubmit request. "
    		}
    	]
    }
    Only one field can be populated. Enter one of the following valid fields: orderNumber or financialDocumentNumber or deliveryNumber or customerPurchaseOrderNumber and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    Invalid financialDocumentNumber
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-FIR-API-0040",
    			"type": "ERROR",
    			"reason": "Invalid  financialDocumentNumber",
    			"message": " financialDocumentNumber cannot exceed 10 characters in length. Enter a valid financialDocumentNumber up to 10 characters and resubmit request."
    		}
    	]
    }
    financialDocumentNumber cannot exceed the maximum length of 10 characters. Enter a valid financialDocumentNumber that does not exceed 10 characters and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    Invalid orderNumber
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-FIR-API-0041",
    			"type": "ERROR",
    			"reason": "ERROR",
    			"message": " orderNumber cannot exceed 10 characters in length. Enter a valid orderNumber up to 10 characters and resubmit request."
    		}
    	]
    }
    orderNumber cannot exceed the maximum length of 10 characters. Enter a valid orderNumber that does not exceed 10 characters and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    Invalid deliveryNumber
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-FIR-API-0042",
    			"type": "ERROR",
    			"reason": "Invalid deliveryNumber",
    			"message": " deliveryNumber cannot exceed 10 characters in length. Enter a valid deliveryNumber up to 10 characters and resubmit request.."
    		}
    	]
    }
    deliveryNumber cannot exceeds the maximum length of 10 characters. Enter a valid deliveryNumber that does not exceed 10 characters and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    Invalid customerPurchaseOrderNumber
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-FIR-API-0043",
    			"type": "ERROR",
    			"reason": "Invalid customerPurchaseOrderNumber",
    			"message": " customerPurchaseOrderNumber cannot exceed 35 characters in length. Enter a valid customerPurchaseOrderNumber up to 35 characters and resubmit request."
    		}
    	]
    }
    customerPurchaseOrderNumber exceeds the maximum length of 35 characters. Enter a valid customerPurchaseOrderNumber that does not exceed 35 characters and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    Invalid status
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-FIR-API-0044",
    			"type": "ERROR",
    			"reason": "Invalid status",
    			"message": " status cannot exceed 10 characters in length. Enter a valid status up to 10 characters and resubmit request."
    		}
    	]
    }
    status exceeds the maximum length of 10 characters. Enter a valid status that does not exceed 10 characters and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    Invalid startDate
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-FIR-API-0045",
    			"type": "ERROR",
    			"reason": "Invalid startDate",
    			"message": " startDate does not have a valid date format.  Verify and correct the startDate format to YYYY-MM-DD and resubmit request."
    		}
    	]
    }
    Invalid date format for startDate. Enter the valid startDate format to YYY-MM-DD and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    Invalid endDate
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-FIR-API-0046",
    			"type": "ERROR",
    			"reason": "Invalid endDate",
    			"message": " endDate does not have a valid date format. Verify and correct the endDate format to YYYY-MM-DD and resubmit request."
    		}
    	]
    }
    Invalid date format for endDate. Enter the valid endDate format to YYY-MM-DD and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    requestInvoicePDF must have value
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-FIR-API-0047",
    			"type": "ERROR",
    			"reason": "requestInvoicePDF must have valid value",
    			"message": "Pass "true" as the value if a PDF is desired. Otherwise the field should be blank.. Otherwise the field should be blank or false."
    		}
    	]
    }
    requestInvoicePDF value must be true or false if the PDF is needed. Enter X to receive a PDF; otherwise the field will default to false. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    Not a valid number financialDocumentNumber
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-FIR-API-0048",
    			"type": "ERROR",
    			"reason": "financialDocumentNumber is not a Invalid Number",
    			"message": " financialDocumentNumber does not have a valid numeric format. Verify and correct the financialDocumentNumber format to contain numeric digits and resubmit request."
    		}
    	]
    }
    financialDocumentNumber is not a valid numeric number. Enter a valid financialDocumentNumber that contain numeric digits and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    Not a valid number orderNumber
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-FIR-API-0049",
    			"type": "ERROR",
    			"reason": "orderNumber is not a Invalid Number",
    			"message": " orderNumber does not have a valid numeric format. Verify and correct the orderNumber format to contain numeric digits and resubmit request."
    		}
    	]
    }
    orderNumber is not a valid numeric number. Enter a valid orderNumber that contain numeric digits and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    Not a valid number deliveryNumber
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-FIR-API-0050",
    			"type": "ERROR",
    			"reason": "deliveryNumber is not a Invalid Number",
    			"message": " deliveryNumber does not have a valid numeric format. Verify and correct the deliveryNumber format to contain numeric digits and resubmit request."
    		}
    	]
    }
    deliveryNumber is not a valid numeric number. Enter a valid deliveryNumber that contain numeric digits and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    TI API system error occurred Connection refused (Connection refused)
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-FIR-API-0500",
    			"type": "ERROR",
    			"reason": "TI API system error occurred  Connection refused",
    			"message": " Contact TI API Support https://api-portal.ti.com/support with the following details: error code, error message and API endpoint."
    		}
    	]
    }
    System error has occurred or connection refused. Contact TI API Support api-portal.ti.com/support with all details such as the error message, the error code, the API endpoint, and any other errors encountered.
    TI API unavailable for scheduled system maintenance
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-FIR-API-0510",
    			"type": "ERROR",
    			"reason": "TI API unavailable for scheduled maintenance",
    			"message": "This TI API is currently unavailable between $OutageStart and $OutageEnd $timeZoneStr for scheduled system maintenance. Resubmit request after maintenance has ended."
    		}
    	]
    }
    The TI API system is currently unavailable due to scheduled system maintenance. Re-submit your request after the maintenance has ended. If after the schedule maintenance has ended and issues are still encountered, contact TI API Support api-portal.ti.com/support

    {}

    View v2 Backlog financial document (invoice) API error codes and meanings (part 2 of 2)

**Attention** This is a public forum