Specifies whether the call fails if the request body contains unknown fields.
By default, Zuora ignores unknown fields in the request body.
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.
If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a
The value is in the
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.
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 (
The Chart of Accounts
The calculated tax amount excluded due to the exemption. Character limit: 16 Values: a decimal value
The ID of the specific invoice item that the taxation information applies to. Character limit: 32 Values: a valid invoice item ID
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
The identifier for the location based on the value of the
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
The amount of the tax applied to the charge. Character limit: 16 Values: a decimal value
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
The description for the tax code. Character limit: 255 Values: a string of 255 characters or fewer
The date that the tax is applied to the charge, in
The tax rate applied to the charge. Character limit: 16 Values: a valid decimal value
The description of the tax rate. Character limit: 255 Values: a string of 255 characters or fewer
The type of the tax rate applied to the charge.
Character limit: 10 Values:
Custom fields of the Taxation Item object. The name of each custom field has the form
- "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"
- "Success": true,
- "Id": "2c93808457d787030157e0306f413a96"