TaxationItem

Last updated
Save as PDF

The TaxationItem object is used to add a tax amount to an invoice item. In the typical use-case, the tax amount that you specify in the object is calculated by Z-Tax or a third-party tax engine such as Avalara or Connect tax engine.

Changes that you make with this object affect the product charges in your product catalog, but not the charges in existing subscriptions. To change taxes in existing subscriptions, you need to amend the subscription - remove the existing charge and replace it with the modified charge.

Z-Tax and third-party tax engines such as Avalara or Connect tax engine can create TaxationItem objects. Before you use the TaxationItem object, you have to configure Z-Tax, Avalara, or Connect tax engine, as the object's fields rely on the values you create during the configuration process.

Supported calls

You can use this object with the following calls:

Typically, third-party applications use the create() call, and API users use the query() call to show tax information outside of the Zuora web-based UI or invoice PDF.

Field Descriptions

All field names are case sensitive. Check enumerated values in descriptions to confirm capitalization and spacing. See Field Types for additional information.

Name	Required to Create?	Allowed Operations	Description
AccountingCode	optional	Create Query Update Delete Filter	The accounting code for the taxation item. Accounting codes group transactions that contain similar accounting attributes. Type: string Character limit: 32 Version notes: Z-Tax Values: an active accounting code in your Zuora Chart of Accounts
CreatedById	optional	Query Filter	The ID of the user who created the taxation item. Type: zns:ID Character limit: 32 Version notes: Z-Tax; WSDL 20.0+ Values: automatically generated
CreatedDate	optional	Query Filter	The date when the payment was created in the Zuora system. Type: dateTime Character limit: 29 Version notes: Z-Tax; WSDL 20.0+ Values: automatically generated
ExemptAmount	optional	Create Query Update Filter	The calculated tax amount excluded due to the exemption. Type: decimal (currency) Character limit: 16 Version notes: Z-Tax; type is double for WSDL18.0 and older Values: a decimal value
Id	optional	Query Filter	The ID of this object. Upon creation, the ID of this object is `TaxationItemId`. Type: zns:ID Character limit: 32 Version notes: Z-Tax Values: automatically generated
InvoiceId	optional	Create Query Filter	The ID of the invoice that the taxation item applies to. Type: zns:ID Character limit: 32 Version notes: Z-Tax Values: automatically generated
InvoiceItemId	required	Create Query Filter	The ID of the specific invoice item that the taxation information applies to. Type: zns:ID Character limit: 32 Version notes: Z-Tax Values: a valid invoice item ID
Jurisdiction	required	Create Query Update Filter	The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. Type: string Character limit: 32 Version notes: Z-Tax Values: a string of 32 characterrs or fewer
LocationCode	optional	Create Query Update Filter	The identifier for the location based on the value of the `TaxCode` field. Type: string Character limit: 32 Version notes: Z-Tax Values: automatically generated
Name	required	Create Query Update Filter	The name of the tax rate, such as sales tax or GST. This name is displayed on invoices. Type: string Character limit: 128 Version notes: Z-Tax Values: a string of 128 characters or fewer
TaxAmount	required	Create Query Update Delete Filter	The amount of the tax applied to the charge. Type: decimal (currency) Character limit: 16 Version notes: Z-Tax; type is double for WSDL18.0 and older Values: a decimal value
TaxCode	optional	Create Query Update Delete Filter	The tax code identifies which tax rules and tax rates to apply to a specific charge. Type: string Character limit: 32 Version notes: Z-Tax Values: a string of 32 characters or fewer
TaxCodeDescription	optional	Create Query Update Delete Filter	The description for the tax code. Type: string Character limit: 255 Version notes: Z-Tax Values: a string of 255 characters or fewer
TaxDate	required	Create Query Update Delete Filter	The date that the tax is applied to the charge. Type: date: Supported as of WSDL version 69+ dateTime: Supported through WSDL version 68 Character limit: 29 Version notes: Z-Tax Values: a valid date and time value
TaxRate	required	Create Query Update Filter	The tax rate applied to the charge. Type: decimal Character limit: 16 Version notes: Z-Tax; type is double for WSDL18.0 and older Values: a valid decimal value
TaxRateDescription	optional	Create Query Update Filter	The description of the tax rate. Type: string Character limit: 255 Version notes: Z-Tax Values: a string of 255 characters or fewer
TaxRateType	required	Create Query Update Filter	The type of the tax rate applied to the charge. Type: string (enum) Character limit: 10 Version notes: Z-Tax Values: `Percentage`, `FlatFee`
UpdatedById	optional	Query Filter	The ID of the user who last updated the taxation item. Type: zns:ID Character limit: Version notes: Z-Tax; WSDL 20.0+ Values: automatically generated
UpdatedDate	optional	Query Filter	The date when the taxation item was last updated. Type: dateTime Character limit: Version notes: Z-Tax; WSDL 20.0+ Values: automatically generated

Additional Field Detail

Id

The ID of this object. Every object has a unique identifier that Zuora automatically assigns upon creation. You use this ID later when you work with the object. For example, if you send an amend() call to modify an existing subscription, then you need to include the specific Subscriptionobject's ID with the call.

The ID for the TaxationItem object is TaxationItemId.