Update a taxation item

Updates a specific taxation item by ID.

Request
path Parameters
id
required
string

The unique ID of a taxation item.

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

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.

Request Body schema: application/json
exemptAmount
number <double>

The calculated tax amount excluded due to the exemption.

object

Container for the finance information related to the taxation item.

jurisdiction
string

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

locationCode
string

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

name
string

The name of the taxation item to be updated.

taxAmount
number <double>

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

taxCode
string

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

taxCodeDescription
string

The description of the tax code.

taxDate
string <date>

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

taxRate
number <double>

The tax rate applied to the credit or debit memo.

taxRateDescription
string

The description of the tax rate.

taxRateType
string

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

Enum: "Percentage" "FlatFee"
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
put/v1/taxationitems/{id}
Request samples
application/json
{
  • "exemptAmount": 0,
  • "financeInformation": {
    },
  • "jurisdiction": "CALIFORNIA",
  • "locationCode": "06",
  • "name": "STATE TAX",
  • "taxAmount": 1,
  • "taxCode": "ServiceTaxCode",
  • "taxCodeDescription": "This is tax code description!",
  • "taxDate": "2016-06-05",
  • "taxRate": 0.0625,
  • "taxRateDescription": "This is tax rate description!",
  • "taxRateType": "Percentage"
}
Response samples
application/json
{
  • "createdById": "402881e522cf4f9b0122cf5d82860002",
  • "createdDate": "2017-02-27 18:16:24",
  • "exemptAmount": 0,
  • "id": "402890555a7e9791015a7f12364e0004",
  • "memoItemId": "402890555a7e9791015a7f1235f50003",
  • "sourceTaxItemId": "402890555a7d4022015a7db254e200c1",
  • "jurisdiction": "CALIFORNIA",
  • "locationCode": "06",
  • "name": "STATE TAX",
  • "taxAmount": 1,
  • "taxCode": "ServiceTaxCode",
  • "taxCodeDescription": "This is tax code description!",
  • "taxDate": "2016-06-05",
  • "taxRate": 0.0625,
  • "taxRateDescription": "This is tax rate description!",
  • "taxRateType": "Percentage",
  • "updatedById": "402881e522cf4f9b0122cf5d82860002",
  • "updatedDate": "2017-02-28 17:53:11",
  • "financeInformation": {
    },
  • "success": true
}