taxcoderesponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/quickbooks/json-schema/quickbooks-taxcoderesponse-schema.json",
  "title": "taxcoderesponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/quickbooks-taxcode-api-openapi.yml#/components/schemas/taxcoderesponse",
  "type": "object",
  "properties": {
    "SyncToken": {
      "type": "string",
      "description": "Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online.",
      "x-intuit-required": "Required for update"
    },
    "TaxGroup": {
      "type": "boolean",
      "description": "true—-this object represents a group of one or more tax rates.\nfalse—-this object represents pseudo-tax codes TAX and NON.",
      "x-intuit-required": "Optional",
      "x-intuit-default": "true"
    },
    "PurchaseTaxRateList": {
      "allOf": [
        {
          "$ref": "#/$defs/taxratelist"
        }
      ],
      "description": "List of references to tax rates that apply for purchase transactions when this tax code represents a group of tax rates. Required when TaxGroup is set to true",
      "x-intuit-required": "Conditionally required"
    },
    "TaxCodeConfigType": {
      "type": "string",
      "description": "Flag to identify whether the TaxCode is system defined by Automated Sales Tax engine or user generated. Valid values include \nUSER_DEFINED, \nSYSTEM_GENERATEDSYSTEM_GENERATED."
    },
    "Taxable": {
      "type": "boolean",
      "description": "False or null means meaning non-taxable. True means taxable. Always true, except for the pseudo taxcode NON.",
      "x-intuit-required": "Optional"
    },
    "Name": {
      "type": "string",
      "description": "User recognizable name for the tax sales code.",
      "x-intuit-required": "Required",
      "x-intuit-filterable": true,
      "x-intuit-sortable": true
    },
    "Active": {
      "type": "boolean",
      "description": "False if inactive. Inactive sales tax codes may be hidden from display and may not be used on financial transactions.",
      "x-intuit-required": "Optional",
      "x-intuit-default": "true",
      "x-intuit-filterable": true
    },
    "Description": {
      "type": "string",
      "description": "User entered description for the sales tax code.",
      "x-intuit-required": "Optional",
      "x-intuit-filterable": true,
      "x-intuit-sortable": true
    },
    "Hidden": {
      "type": "boolean",
      "description": "Read-only. Denotes whether active tax codes are displayed on transactions.\ntrue—-This tax code is hidden on transactions.\nfalse—-This tax code is displayed on transactions.",
      "x-intuit-required": "Optional"
    },
    "MetaData": {
      "allOf": [
        {
          "$ref": "#/$defs/modificationmetadata"
        }
      ],
      "description": "Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.",
      "x-intuit-required": "Optional"
    },
    "Id": {
      "type": "string",
      "description": "Unique identifier for this object.",
      "x-intuit-required": "Required for update",
      "x-intuit-filterable": true
    },
    "SalesTaxRateList": {
      "allOf": [
        {
          "$ref": "#/$defs/taxratelist"
        }
      ],
      "description": "List of references to tax rates that apply for sales transactions when this tax code represents a group of tax rates. Required when TaxGroup is set to true",
      "x-intuit-required": "Conditionally required"
    }
  },
  "required": [
    "Name"
  ],
  "$defs": {
    "modificationmetadata": {
      "type": "object",
      "title": "modificationmetadata",
      "properties": {
        "CreateTime": {
          "type": "string",
          "format": "date-time",
          "description": "Time the entity was created in the source domain.",
          "x-intuit-filterable": true,
          "x-intuit-sortable": true
        },
        "LastUpdatedTime": {
          "type": "string",
          "format": "date-time",
          "description": "Time the entity was last updated in the source domain.",
          "x-intuit-filterable": true,
          "x-intuit-sortable": true
        }
      }
    },
    "taxratelist": {
      "type": "object",
      "title": "taxratelist",
      "properties": {
        "TaxRateDetail": {
          "type": "array",
          "items": {},
          "description": "TaxRateDetail that specifies qualified detail of TaxRate.",
          "x-intuit-required": "Optional"
        }
      }
    }
  }
}