Skip to navigation
Introduction

Common error responses

Understand the error codes and responses returned by the Invoice API.

We always respond to request failures with an HTTP status code and appropriate error details in the response body. This allows your application to programmatically resolve errors and provide inline error messaging within your application when appropriate.

Error response format

{
  "code": 400,
  "status": "error",
  "messages": [
    "Bad Request: The field `Field name` is invalid."
  ]
}

Common error responses

400 Bad Request

{
  "code": 400,
  "status": "error",
  "messages": [
    "Bad Request: The filter field is invalid."
  ]
}
{
  "code": 400,
  "status": "error",
  "messages": [
    "Bad Request: Invalid Search Query."
  ]
}

401 Unauthorized

{
  "code": 401,
  "status": "error",
  "messages": [
    "Access is unauthorized: An error occurred during authentication or authorization process."
  ]
}

403 Forbidden

{
  "code": 403,
  "status": "error",
  "messages": [
    "Bad Request: API is disabled for the consumer."
  ]
}

500 Server Error

{
  "code": 500,
  "status": "error",
  "messages": [
    "Server Error: Operation failed."
  ]
}

504 Gateway Timeout

{
  "code": 504,
  "status": "error",
  "messages": [
    "Internal Server Error."
  ]
}