Xero · Schema

TaxRate

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Properties

Name Type Description
Name string Name of tax rate
TaxType string The tax type
TaxComponents array See TaxComponents
Status string See Status Codes
ReportTaxType string See ReportTaxTypes
CanApplyToAssets boolean Boolean to describe if tax rate can be used for asset accounts i.e. true,false
CanApplyToEquity boolean Boolean to describe if tax rate can be used for equity accounts i.e true,false
CanApplyToExpenses boolean Boolean to describe if tax rate can be used for expense accounts i.e. true,false
CanApplyToLiabilities boolean Boolean to describe if tax rate can be used for liability accounts i.e. true,false
CanApplyToRevenue boolean Boolean to describe if tax rate can be used for revenue accounts i.e. true,false
DisplayTaxRate number Tax Rate (decimal to 4dp) e.g 12.5000
EffectiveRate number Effective Tax Rate (decimal to 4dp) e.g 12.5000
View JSON Schema on GitHub

JSON Schema

xero-taxrate-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TaxRate",
  "title": "TaxRate",
  "externalDocs": {
    "url": "http://developer.xero.com/documentation/api/tax-rates/"
  },
  "properties": {
    "Name": {
      "description": "Name of tax rate",
      "type": "string"
    },
    "TaxType": {
      "description": "The tax type",
      "type": "string"
    },
    "TaxComponents": {
      "description": "See TaxComponents",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TaxComponent"
      }
    },
    "Status": {
      "description": "See Status Codes",
      "type": "string",
      "enum": [
        "ACTIVE",
        "DELETED",
        "ARCHIVED",
        "PENDING"
      ]
    },
    "ReportTaxType": {
      "description": "See ReportTaxTypes",
      "type": "string",
      "enum": [
        "AVALARA",
        "BASEXCLUDED",
        "CAPITALSALESOUTPUT",
        "CAPITALEXPENSESINPUT",
        "ECOUTPUT",
        "ECOUTPUTSERVICES",
        "ECINPUT",
        "ECACQUISITIONS",
        "EXEMPTEXPENSES",
        "EXEMPTINPUT",
        "EXEMPTOUTPUT",
        "GSTONIMPORTS",
        "INPUT",
        "INPUTTAXED",
        "MOSSSALES",
        "NONE",
        "NONEOUTPUT",
        "OUTPUT",
        "PURCHASESINPUT",
        "SALESOUTPUT",
        "EXEMPTCAPITAL",
        "EXEMPTEXPORT",
        "CAPITALEXINPUT",
        "GSTONCAPIMPORTS",
        "GSTONCAPITALIMPORTS",
        "REVERSECHARGES",
        "PAYMENTS",
        "INVOICE",
        "CASH",
        "ACCRUAL",
        "FLATRATECASH",
        "FLATRATEACCRUAL",
        "ACCRUALS",
        "TXCA",
        "SRCAS",
        "DSOUTPUT",
        "BLINPUT2",
        "EPINPUT",
        "IMINPUT2",
        "MEINPUT",
        "IGDSINPUT2",
        "ESN33OUTPUT",
        "OPINPUT",
        "OSOUTPUT",
        "TXN33INPUT",
        "TXESSINPUT",
        "TXREINPUT",
        "TXPETINPUT",
        "NRINPUT",
        "ES33OUTPUT",
        "ZERORATEDINPUT",
        "ZERORATEDOUTPUT",
        "DRCHARGESUPPLY",
        "DRCHARGE",
        "CAPINPUT",
        "CAPIMPORTS",
        "IMINPUT",
        "INPUT2",
        "CIUINPUT",
        "SRINPUT",
        "OUTPUT2",
        "SROUTPUT",
        "CAPOUTPUT",
        "SROUTPUT2",
        "CIUOUTPUT",
        "ZROUTPUT",
        "ZREXPORT",
        "ACC28PLUS",
        "ACCUPTO28",
        "OTHEROUTPUT",
        "SHOUTPUT",
        "ZRINPUT",
        "BADDEBT",
        "OTHERINPUT",
        "BADDEBTRELIEF",
        "IGDSINPUT3",
        "SROVR",
        "TOURISTREFUND",
        "TXRCN33",
        "TXRCRE",
        "TXRCESS",
        "TXRCTS",
        "CAPEXINPUT",
        "UNDEFINED",
        "CAPEXOUTPUT",
        "ZEROEXPOUTPUT",
        "GOODSIMPORT",
        "NONEINPUT",
        "NOTREPORTED",
        "SROVRRS",
        "SROVRLVG",
        "SRLVG",
        "IM",
        "IMESS",
        "IMN33",
        "IMRE",
        "BADDEBTRECOVERY",
        "USSALESTAX",
        "BLINPUT3"
      ]
    },
    "CanApplyToAssets": {
      "description": "Boolean to describe if tax rate can be used for asset accounts i.e.  true,false",
      "readOnly": true,
      "type": "boolean"
    },
    "CanApplyToEquity": {
      "description": "Boolean to describe if tax rate can be used for equity accounts i.e true,false",
      "readOnly": true,
      "type": "boolean"
    },
    "CanApplyToExpenses": {
      "description": "Boolean to describe if tax rate can be used for expense accounts  i.e. true,false",
      "readOnly": true,
      "type": "boolean"
    },
    "CanApplyToLiabilities": {
      "description": "Boolean to describe if tax rate can be used for liability accounts  i.e. true,false",
      "readOnly": true,
      "type": "boolean"
    },
    "CanApplyToRevenue": {
      "description": "Boolean to describe if tax rate can be used for revenue accounts i.e. true,false",
      "readOnly": true,
      "type": "boolean"
    },
    "DisplayTaxRate": {
      "description": "Tax Rate (decimal to 4dp) e.g 12.5000",
      "readOnly": true,
      "type": "number",
      "format": "double",
      "x-is-money": true
    },
    "EffectiveRate": {
      "description": "Effective Tax Rate (decimal to 4dp) e.g 12.5000",
      "readOnly": true,
      "type": "number",
      "format": "double",
      "x-is-money": true
    }
  },
  "type": "object"
}