Anrok · Schema

JurisSummary

Summary of the tax amount due and tax ID validation for a jurisdiction.

Sales TaxVATTax ComplianceSaaSFintechTax AutomationNexusE-Invoicing

Properties

Name Type Description
id string The ID of the jurisdiction.
name string The name of the jurisdiction.
preTaxAmount string The pre-tax amount in the smallest denomination of the currency (e.g. cents or pennies).
taxAmountDue object
taxIdValidation object
View JSON Schema on GitHub

JSON Schema

juris-summary.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/anrok/main/json-schema/juris-summary.json",
  "title": "JurisSummary",
  "description": "Summary of the tax amount due and tax ID validation for a jurisdiction.",
  "type": "object",
  "properties": {
    "id": {
      "description": "The ID of the jurisdiction.",
      "type": "string",
      "example": "us-TX"
    },
    "name": {
      "description": "The name of the jurisdiction.",
      "type": "string",
      "example": "Texas"
    },
    "preTaxAmount": {
      "description": "The pre-tax amount in the smallest denomination of the currency (e.g. cents or pennies).",
      "type": "string",
      "format": "Decimal",
      "example": "100.00"
    },
    "taxAmountDue": {
      "$ref": "#/components/schemas/TaxAmountDue"
    },
    "taxIdValidation": {
      "type": "object",
      "properties": {
        "processedTaxIds": {
          "description": "The tax IDs that were processed.",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "taxId": {
                "description": "The tax ID.",
                "type": "string",
                "example": "1234567890"
              },
              "isValid": {
                "description": "Whether the tax ID is valid.",
                "type": "boolean"
              }
            }
          }
        }
      }
    }
  }
}