TaxationItem
From API Documentation
This object is for customers that have purchased Z-Taxation. Z-Taxation allows you to apply taxation and manage your customer's tax exemption status.
Supported Calls
This object is used in the query and create calls.
Fields
In addition to the following fields, zObject contributes additional fields. For information on the field types, see Field Types.
| Name | Required? | Type | Allowed Operations: ● Yes ○ No | Allowable Values | Description |
|---|---|---|---|---|---|
| AccountingCode | No. System generated and applied if there is a taxation (with Z-Taxation), else can be specified when working with 3rd party tax systems. | string | ● Create
● Query | Valid accounting codes created in Z-Billing administration, 32 characters maximum. | Specifies the accounting for the taxation line item. Used for integration with accounting systems. |
| CreatedById | System generated, always exists | zns:ID | ○ Create
● Query | 32 characters maximum. This field is not editable. | Available as of version 20.0 of the API. The Zuora system automatically generates this ID of the user who created the object. |
| CreatedDate | System generated, always exists | dateTime | ○ Create
● Query | This field is not editable. | Available as of version 20.0 of the API. The Zuora system automatically generates this, and denotes when the objects was first created. |
| ExemptAmount | No | double (v1.0-18.0) / decimal (v19.0+) | ● Create
● Query | Valid double value generated by Z-Taxation. | This is summary if taxes that would be applied if the customer was not tax exempt. Having this value allows you to report the summary amount that was not taxed because the customer was tax exempt. |
| InvoiceId | Yes | zns:ID | ● Create
● Query | A valid ID of an Invoice object. | This relates the the taxation information to a given Invoice. |
| InvoiceItemId | Yes | zns:ID | ● Create
● Query | A valid ID of an InvoiceItem object. | This relates the the taxation information to a given InvoiceItem. |
| Jurisdiction | Yes if using Z-Taxation, no if using 3rd party tax systems. | string | ● Create
● Query | This field is the jurisdiction value populated for each tax rate, 32 characters maximum. | The jurisdiction value that typically represents the tax jurisdiction such as state, county, city, etc. |
| LocationCode | Yes if using Z-Taxation, no if using 3rd party tax systems. | string | ● Create
● Query | This field is the location code populated for each tax rate, 32 characters maximum. | This location code typically identifies a code that will aid in reporting or correlation to external tax tables. This field is often a numeric value created by the tax jurisdiction. |
| Name | Yes | string | ● Create
● Query | This field is the tax name populated for each tax rate, 128 characters maximum. | The name of the Tax Rate such as Sales Tax or GST, etc. This name appears on the invoice. |
| TaxAmount | No (system generated) if using Z-Taxation, required if importing taxation from a 3rd party tax system. | double (v1.0-18.0) / decimal (v19.0+) | ● Create
● Query | The amount of the tax. | |
| TaxCode | No | string | ● Create
● Query | 32 characters maximum | The tax code for this tax. |
| TaxCodeDescription | No | string | ● Create
● Query | 255 characters maximum | Description for the tax code. |
| TaxDate | No | datetime | ● Create
● Query | Valid datetime. | The date when tax was applied. |
| TaxRate | Yes | double (v1.0-18.0) / decimal (v19.0+) | ● Create
● Query | This field is the tax rate populated for each tax rate. | The tax rate can be any numeric value. Often it represents a percentage such as .07 for 7%. |
| TaxRateDescription | No | string | ● Create
● Query | This field is the tax rate description populated for each tax rate, 255 characters maximum. | The description of the tax rate is user defined and is used to help with reporting. |
| TaxRateType | Yes | string | ● Create
● Query | Percentage, FlatFee | The tax rate type is typically percentage, but may be defined as flat fee depending on the tax rules |
| UpdatedById | System generated, always exists | ZNS:Id | ○ Create
● Query | 32 characters maximum. This field is not editable. | Available as of version 20.0 of the API. The Zuora system automatically generates this Id of the user who last updated the object. |
| UpdatedDate | System generated, always exists | dateTime | ○ Create
● Query | This field is not editable. | Available as of version 20.0 of the API. The Zuora system automatically generates this, and denotes when the objects was last updated. |
