Retrieve a taxation item

Quickstart API Reference

Request

Retrieves the taxation item with the given ID.

Security

bearerAuth

Path

taxation_item_idstringrequired

ID of the taxation item.

Query

fields[]Array of strings

Allows you to specify which fields are returned in the response.

Accepted values

`custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `amount_credited`, `amount_paid`, `remaining_balance`

Example:fields[]=id,created_time

taxation_item.fields[]Array of stringsdeprecated

Allows you to specify which fields are returned in the response.

Accepted values

Example:taxation_item.fields[]=id,created_time

expand[]Array of strings

Allows you to expand responses by including related object information in a single call. See the Expand responses section of the Quickstart API Tutorials for detailed instructions.

filter[]Array of strings

A case-sensitive filter on the list. See the Filter lists section of the Quickstart API Tutorial for detailed instructions.
Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the "Retrieve a billing document" operation, you can use the filter[] parameter on the related objects such as filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63

page_sizeinteger, [ 1 .. 99 ]

The maximum number of results to return in a single page. If the specified page_size is less than 1 or greater than 99, Zuora will return a 400 error.

zuora-track-idstring

A custom identifier for tracking API requests. If you set a value for this header, Zuora returns the same value in the response header. This header enables you to track your 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 ("), or quote (').

asyncboolean

Making asynchronous requests allows you to scale your applications more efficiently by leveraging Zuora's infrastructure to enqueue and execute requests for you without blocking. These requests also use built-in retry semantics, which makes them much less likely to fail for non-deterministic reasons, even in extreme high-throughput scenarios. Meanwhile, when you send a request to one of these endpoints, you can expect to receive a response in less than 150 milliseconds and these calls are unlikely to trigger rate limit errors. If set to true, Zuora returns a 202 Accepted response, and the response body contains only a request ID.

Default:false

zuora-entity-idsstring

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

idempotency-keystring

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. This idempotency key should be a unique value, and the Zuora server identifies subsequent retries of the same request using this value. For more information, see Idempotent Requests.

accept-encodingstring

Include a accept-encoding: gzip header to compress responses, which can reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes. For more information about this header, see Request and Response Compression.

content-encodingstring

Include a content-encoding: gzip header to compress a request. Upload a gzipped file for the payload if you specify this header. For more information, see Request and Response Compression.

zuora-org-idsstring

Comma separated IDs. If you have Zuora Multi-Org 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.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

cURL

curl -i -X GET \
  'https://rest.test.zuora.com/v2/taxation_items/{taxation_item_id}?fields%5B%5D=id%2Ccreated_time&taxation_item.fields%5B%5D=id%2Ccreated_time&expand%5B%5D=string&filter%5B%5D=string&page_size=1' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'accept-encoding: string' \
  -H 'async: false' \
  -H 'content-encoding: string' \
  -H 'idempotency-key: string' \
  -H 'zuora-entity-ids: string' \
  -H 'zuora-org-ids: string' \
  -H 'zuora-track-id: string'

Responses

Default Response

Headers

ratelimit-limitstring

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

ratelimit-remainingnumber

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

ratelimit-resetnumber

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

zuora-request-idstring

Zuora’s internal identifier for this request.

zuora-track-idstring

A user-supplied identifier for this request. If you supply a zuora-track-id as a request header, Zuora returns the zuora-track-id as a response header.

Bodyapplication/json

idstring

Identifier of the taxation item related to the invoice. Only applicable for credit memos created from invoices.

updated_by_idstringread-only

Unique identifier of the Zuora user who last updated the object

updated_timestring, (date-time)read-only

The date and time when the object was last updated in ISO 8601 UTC format.

created_by_idstringread-only

Unique identifier of the Zuora user who created the object

created_timestring, (date-time)read-only

The date and time when the object was created in ISO 8601 UTC format.

custom_fieldsobject(CustomFields)

Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format.

custom_objectsobjectread-only

The custom objects associated with a Zuora standard object.

jurisdictionstring, <= 32 characters

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

location_codestring, <= 32 characters

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

namestring, <= 128 characters

The name of the taxation item.

amountnumber

The amount of the tax applied to the total price.

tax_codestring

A tax code identifier. If a tax_code of a price is not provided when you create or update a price, Zuora will treat the charged amount as non-taxable. If this code is provide, Zuora considers that this price is taxable and the charged amount will be handled accordingly.

tax_code_namestring

The amount of the tax applied to the total price.

tax_datestring, (date)

The date on which the tax is applied.

Example:"2022-01-01"

tax_ratenumber

The amount of the tax applied to the total price.

tax_rate_namestring

The name of the tax rate, such as sales tax or GST. This name is displayed on billing documents.

amount_exemptnumber

The calculated tax amount excluded due to the exemption.

source_tax_item_idstring

The ID of the taxation item of the invoice, from which the credit or debit memo is created. This field is only applicable when the type of the billing document is credit_memo and debit_memo.

remaining_balancenumberread-only

The remaining balance of the taxation item.

amount_creditednumberread-only

The credit memo amount applied to the taxation item.

amount_paidnumberread-only

The payment amount applied to the taxation item.

amount_refundednumberread-only

The refund amount applied to the taxation item.

amount_appliednumberread-only

The credit memo item amount applied to the taxation item.

sales_tax_payable_accountstring

An active account in your Zuora Chart of Accounts.

on_account_accountstring

An active account in your Zuora Chart of Accounts.

tax_inclusiveboolean

If set to true, it indicates that amounts are inclusive of tax.

tax_rate_typestring

Indicates whether the tax rate is an amount or a percentage.

Enum:"percent""amount"

Response

{
  "id": "8ad08ccf8437067601843a7af4e64rq3",
  "updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
  "updated_time": "2023-01-18T10:21:27-08:00",
  "created_by_id": "2c92c0946a6dffc0016a7faab604299b",
  "created_time": "2023-01-12T11:43:57-08:00",
  "custom_fields": {},
  "jurisdiction": "Forsyth",
  "location_code": "123",
  "name": "County Charge",
  "amount": 0,
  "tax_code": "Maintenance Charges",
  "tax_date": "2022-01-12",
  "tax_rate": 1,
  "tax_rate_name": "Charge",
  "amount_exempt": 0,
  "remaining_balance": 0,
  "amount_credited": 0,
  "amount_paid": 0,
  "tax_inclusive": false
}