Xero · Schema

APIException

The object returned for a bad request

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Properties

Name Type Description
ErrorNumber number The error number
Type string The type of error
Message string The message describing the error
View JSON Schema on GitHub

JSON Schema

xero-apiexception-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/APIException",
  "title": "APIException",
  "description": "The object returned for a bad request",
  "type": "object",
  "properties": {
    "ErrorNumber": {
      "description": "The error number",
      "type": "number",
      "format": "integer",
      "example": 16
    },
    "Type": {
      "description": "The type of error",
      "type": "string",
      "example": "QueryParseException"
    },
    "Message": {
      "description": "The message describing the error",
      "type": "string",
      "example": "No property or field 'hi' exists in type 'Employee' (at index 0)"
    }
  }
}