Sign in
Taxation Items

Retrieve a taxation item

Retrieves the information about a specific taxation item by ID.

get/v1/taxation-items/{id}

Path parameters

idstring required

The unique ID of a taxation item.

Headers

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Response

OK

createdByIdstring

The ID of the Zuora user who created the taxation item.

createdDatestring

The date and time when the taxation item was created in the Zuora system, in yyyy-mm-dd hh:mm:ss format.

exemptAmountnumber double

The calculated tax amount excluded due to the exemption.

idstring

The ID of the taxation item.

jurisdictionstring nullable

The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.

locationCodestring nullable

The identifier for the location based on the value of the taxCode field.

memoItemIdstring nullable

The ID of the credit or debit memo associated with the taxation item.

namestring

The name of the taxation item.

sourceTaxItemIdstring nullable

The ID of the taxation item of the invoice, which the credit or debit memo is created from.

successboolean

Returns true if the request was processed successfully.

taxAmountnumber double

The amount of the tax applied to the credit or debit memo.

taxCodestring nullable

The tax code identifies which tax rules and tax rates to apply to a specific credit or debit memo.

taxCodeDescriptionstring nullable

The description of the tax code.

taxDatestring date

The date when the tax is applied to the credit or debit memo.

taxRatenumber double

The tax rate applied to the credit or debit memo.

taxRateDescriptionstring nullable

The description of the tax rate.

taxRateType'Percentage' | 'FlatFee'

The type of the tax rate applied to the credit or debit memo.

updatedByIdstring

The ID of the Zuora user who last updated the taxation item.

updatedDatestring

The date and time when the taxation item was last updated, in yyyy-mm-dd hh:mm:ss format.

Changes