Part Number: TI-API
What do the Financial Document API error codes mean?
This thread has been locked.
Part Number: TI-API
What do the Financial Document API error codes mean?
| Scenario | Error Details | Remediation Steps |
| Input cannot be blank. | {
"Messages": [
{
"Code": "TI-FIR-40016",
"Type": "ERROR",
"Message": "Input cannot be blank."
}
]
} |
Customer should pass a valid input |
| CustomerGlobalIdentifier is required. | {
"Messages": [
{
"Code": "TI-FIR-40010",
"Type": "ERROR",
"Message": "CustomerGlobalIdentifier is required."
}
]
} |
CustomerGlobalIdentifier is required. Contact TI API Support (api-portal.ti.com/support). |
| The sold-to number is blank or invalid. | {
"Messages": [
{
"Code": "TI-FIR-40020",
"Type": "ERROR",
"Message": "The sold-to number is blank or invalid. Confirm and re-enter."
}
]
} |
Customer should pass a valid CustomerSoldToIdentifier in the request. This field cannot be blank. |
| Sold-to number exceeds the max length of 17 | {
"Messages": [
{
"Code": "TI-FIR-40030",
"Type": "ERROR",
"Message": "Provide one of the following - the document number, your reference number,the delivery number or the purchase order number."
}
]
} |
Customer should pass a valid CustomerSoldToIdentifier in the request. The value cannot exceed 17 characters in length |
| One of four fields is required. | {
"Messages": [
{
"Code": "TI-FIR-40032",
"Type": "ERROR",
"Message": "Provide one of the following - the document number, your reference number,the delivery number or the purchase order number."
}
]
} |
Customer should only pass one valid SupplierFinancialDocumentIdentifier or CustomerReferenceIdentifier or SupplierDeliveryIdentifier or CustomerPurchaseOrderIdentifier in the request |
| Only one of four fields can be populated. | {
"Messages": [
{
"Code": "TI-FIR-40034",
"Type": "ERROR",
"Message": "Only one of the following can be provided -the document number, your reference number,the delivery number or the purchase order number."
}
]
} |
Customer should only pass one valid SupplierFinancialDocumentIdentifier or CustomerReferenceIdentifier or SupplierDeliveryIdentifier or CustomerPurchaseOrderIdentifier in the request |
| SupplierFinancialDocumentIdentifier cannot exceed 10 characters in length. | {
"Messages": [
{
"Code": "TI-FIR-40040",
"Type": "ERROR",
"Message": "The document number can not exceed 10 characters.Verify and re-enter."
}
]
} |
Customer should pass a valid SupplierFinancialDocumentIdentifier in the request. The value cannot exceed 10 characters in length |
| CustomerReferenceIdentifier cannot exceed 16 characters in length. | {
"Messages": [
{
"Code": "TI-FIR-40044",
"Type": "ERROR",
"Message": "Your reference number can not exceed 16 characters.Verify and re-enter."
}
]
} |
Customer should not exceed 16 characters in length. |
| SupplierDeliveryIdentifier cannot exceed 10 characters in length. | {
"Messages": [
{
"Code": "TI-FIR-40050",
"Type": "ERROR",
"Message": "The delivery number can not exceed 10 characters.Verify and re-enter."
}
]
} |
Customer should pass a valid SupplierDeliveryIdentifier in the request. The value cannot exceed 10 characters in length |
| CustomerPurchaseOrderIdentifier cannot exceed 35 characters in length. | {
"Messages": [
{
"Code": "TI-FIR-40060",
"Type": "ERROR",
"Message": "The purchase order number can not exceed 35 characters.Verify and re-enter."
}
]
} |
Customer should pass a valid CustomerPurchaseOrderIdentifier in the request. The value cannot exceed 35 characters in length. |
| SupplierDocumentStatus cannot exceed 10 characters in length. | {
"Messages": [
{
"Code": "TI-FIR-40070",
"Type": "ERROR",
"Message": "The document status can not exceed 10 characters.Verify and re-enter."
}
]
} |
Customer should pass a valid SupplierDocumentStatus in the request. The value cannot exceed 10 characters in length. |
| SupplierDocumentCreatedFromDate is not a valid date (YYYY-MM-DD). | {
"Messages": [
{
"Code": "TI-FIR-40080",
"Type": "ERROR",
"Message": "The document creation date format is YYYY-MM-DD.Correct and re-submit."
}
]
} |
Customer should pass a valid SupplierDocumentCreatedFromDate in the request. The valid date format is YYYY-MM-DD |
| SupplierDocumentCreatedToDate is not a valid date (YYYY-MM-DD). | {
"Messages": [
{
"Code": "TI-FIR-40090",
"Type": "ERROR",
"Message": "The document creation date format is YYYY-MM-DD.Correct and re-submit."
}
]
} |
Customer should pass a valid SupplierDocumentCreatedToDate in the request. The valid date format is YYYY-MM-DD |
| RequestPDF can either be blank or X. | {
"Messages": [
{
"Code": "TI-FIR-40100",
"Type": "ERROR",
"Message": "Pass an 'X' in the SupplierDocumentPDF field if a PDF is desired.Otherwise the field should be blank."
}
]
} |
Customer should pass a valid RequestPDF in the request. Customer should pass X in the field if they want to receive a PDF otherwise the field should be left blank. |
|
System error occurred. Connection refused (Connection refused) |
{
"Messages": [
{
"Code": "TI-FIR-50000",
"Type": "ERROR",
"Message": "Contact API Support with at least the following details: error code, error message and API endpoint."
}
]
} |
Customer should contact API support with all the details such as the error message, the error code, the API endpoint etc. |
| Outage Information | {
"Messages": [
{
"Code": "TI-FIR-51000",
"Type": "ERROR",
"Message": "This API is currently unavailable between $OutageStart and $OutageEnd $timeZoneStr. Re-submit your request after the maintenance window."
}
]
} |
Customer will be informed of Outage information. |
**Attention** This is a public forum