CRUD: Create a taxation item

Request
query Parameters
rejectUnknownFields
boolean
Default: false

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.

header Parameters
Idempotency-Key
string <= 255 characters

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-Encoding
string

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-Encoding
string

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.

Authorization
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Entity-Ids
string

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 do not need to set this header.

Zuora-Org-Ids
string

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.

Zuora-Track-Id
string <= 64 characters

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 (').

Request Body schema: application/json
required
InvoiceItemId
required
string

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

Jurisdiction
required
string

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

Name
required
string

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

TaxAmount
required
number <double>

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

TaxRate
required
number <double>

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

TaxDate
required
string <date>

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

TaxRateType
required
string

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

AccountingCode
string

The Chart of Accounts

ExemptAmount
number <double>

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

LocationCode
string

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

TaxCode
string

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

TaxCodeDescription
string

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

TaxRateDescription
string

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

property name*
additional property
any

Custom fields of the Taxation Item object. The name of each custom field has the form customField__c. Custom field names are case sensitive. See Manage Custom Fields for more information.

Responses
200
400
401
post/v1/object/taxation-item
Request samples
application/json
{
  • "AccountingCode": "Usage Revenue",
  • "ExemptAmount": 50,
  • "InvoiceItemId": "2c93808457d787030157e0306cd43a88",
  • "Jurisdiction": "test",
  • "LocationCode": "code - 001",
  • "Name": "test",
  • "TaxAmount": 3,
  • "TaxCode": "taxcode",
  • "TaxCodeDescription": "description",
  • "TaxDate": "2016-10-20",
  • "TaxMode": "TaxExclusive",
  • "TaxRate": 3,
  • "TaxRateDescription": "test",
  • "TaxRateType": "FlatFee"
}
Response samples
application/json
{
  • "Id": "2c93808457d787030157e0306f413a96",
  • "Success": true
}