Avalara · Schema

NexusModel

NexusModel schema from Avalara API

Taxes

Properties

Name Type Description
id integer
companyId integer
country string Two-character ISO 3166 country code
region string State or province code
jurisTypeId string
jurisdictionTypeId string
jurisCode string
jurisName string
effectiveDate string
endDate string
nexusTypeId string
hasLocalNexus boolean
View JSON Schema on GitHub

JSON Schema

avatax-rest-nexus-model-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/avalara/refs/heads/main/json-schema/avatax-rest-nexus-model-schema.json",
  "title": "NexusModel",
  "description": "NexusModel schema from Avalara API",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer"
    },
    "companyId": {
      "type": "integer"
    },
    "country": {
      "type": "string",
      "description": "Two-character ISO 3166 country code"
    },
    "region": {
      "type": "string",
      "description": "State or province code"
    },
    "jurisTypeId": {
      "type": "string",
      "enum": [
        "STA",
        "CTY",
        "CIT",
        "STJ",
        "CNT"
      ]
    },
    "jurisdictionTypeId": {
      "type": "string"
    },
    "jurisCode": {
      "type": "string"
    },
    "jurisName": {
      "type": "string"
    },
    "effectiveDate": {
      "type": "string",
      "format": "date"
    },
    "endDate": {
      "type": "string",
      "format": "date"
    },
    "nexusTypeId": {
      "type": "string",
      "enum": [
        "None",
        "SalesOrSellersUseTax",
        "SalesTax",
        "SSTVolunteer",
        "SSTNonVolunteer"
      ]
    },
    "hasLocalNexus": {
      "type": "boolean"
    }
  }
}