Sign in
Taxation Items

CRUD: Create a taxation item

Creates a Taxation Item object.

post/v1/object/taxation-item

Query parameters

rejectUnknownFieldsboolean

Specifies whether the call fails if the request body contains unknown fields. With rejectUnknownFields set to true, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is:

{
    "message": "Error - unrecognised fields"
}

By default, Zuora ignores unknown fields in the request body.

Headers

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.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

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-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-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-Versionstring

The minor API version.

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

Request body

AccountingCodestring

The Chart of Accounts

ExemptAmountnumber double

The calculated tax amount excluded due to the exemption. Character limit: 16 Values: a decimal value

InvoiceItemIdstring required

The ID of the specific invoice item that the taxation information applies to. Character limit: 32 Values: a valid invoice item ID

Jurisdictionstring required

The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. Character limit: 32 Values: a string of 32 characterrs or fewer

LocationCodestring

The identifier for the location based on the value of the TaxCode field. Character limit: 32 Values: automatically generated

Namestring required

The name of the tax rate, such as sales tax or GST. This name is displayed on invoices. Character limit: 128 Values: a string of 128 characters or fewer

TaxAmountnumber double required

The amount of the tax applied to the charge. Character limit: 16 Values: a decimal value

TaxCodestring

The tax code identifies which tax rules and tax rates to apply to a specific charge. Character limit: 32 Values: a string of 32 characters or fewer

TaxCodeDescriptionstring

The description for the tax code. Character limit: 255 Values: a string of 255 characters or fewer

TaxDatestring date required

The date that the tax is applied to the charge, in yyyy-mm-dd format. Character limit: 29

TaxRatenumber double required

The tax rate applied to the charge. Character limit: 16 Values: a valid decimal value

TaxRateDescriptionstring

The description of the tax rate. Character limit: 255 Values: a string of 255 characters or fewer

TaxRateTypestring required

The type of the tax rate applied to the charge. Character limit: 10 Values: Percentage, FlatFee

Example request

{
  "InvoiceItemId": "8ad086fa92d66ffe0192dc7e5dd65161",
  "Jurisdiction": "CALIFORNIA",
  "Name": "CA TAX",
  "TaxAmount": 3,
  "TaxDate": "2024-11-04",
  "TaxRate": 3,
  "TaxRateType": "FlatFee"
}

Response

OK

Idstring
Successboolean

Changes