Error Codes
Response Codes
To denote a successful execution or an error occurrence, the standard HTTP code is used. Along with the HTTP code, the response body will include an error entity with a custom error code assigned to the specific issue described in the message.
HTTP Codes for Errors
Response Body Format
The error response will include one of the following entities in the response body.
Format 1
{
"status":"XXX",
"errors":[
{
"subcode":"XXXX-XXXX",
"message":"..."
}
],
"message":"...",
"success":false
} For errors with this format, the success field will always be “false,” and the status field will have the same code value as the HTTP status code in the response. The base message, the outer message field, will include a description for the given endpoint path where the error was thrown, and the inner message field will include the specific description of the error cause. The subcode field will be a combination of the product code name, SMAR for receivables or SMAP for payables, with a code number associated directly to the cause of the error.
Format 2
{
"timestamp":"XXXXXXXXXXXXX",
"status":"XXX",
"error":"...",
"message":"...""path":"..."
} For errors with this format, the status field will have the same code value as the HTTP status code in the response, and the error field will be the standard name assigned to that HTTP status code. Additionally, and the message field will include the description of the error and the path field will be the path of the resource that threw the error.