Avalara · JSON Structure

Avatax Rest Error Result Structure

ErrorResult schema from Avalara API

Type: object Properties: 1
Taxes

ErrorResult is a JSON Structure definition published by Avalara, describing 1 property. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

error

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/avalara/refs/heads/main/json-structure/avatax-rest-error-result-structure.json",
  "description": "ErrorResult schema from Avalara API",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "Machine-readable error code"
        },
        "message": {
          "type": "string",
          "description": "Human-readable error message"
        },
        "target": {
          "type": "string",
          "description": "The component that generated the error"
        },
        "details": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string"
              },
              "number": {
                "type": "int32"
              },
              "message": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "faultCode": {
                "type": "string"
              },
              "helpLink": {
                "type": "string"
              },
              "severity": {
                "type": "string",
                "enum": [
                  "Error",
                  "Warning",
                  "Exception"
                ]
              }
            }
          }
        }
      }
    }
  },
  "name": "ErrorResult"
}