PUT /v1/taxationitems/{id}
Updates a specific taxation item by ID.
Servers
- https://rest.test.zuora.com
- https://rest.sandbox.na.zuora.com
- https://rest.apisandbox.zuora.com
- https://rest.na.zuora.com
- https://rest.zuora.com
- https://rest.test.eu.zuora.com
- https://rest.sandbox.eu.zuora.com
- https://rest.eu.zuora.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
id |
String | Yes |
The unique ID of a taxation item. |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Content-Encoding |
String | No |
Include the |
Zuora-Track-Id |
String | No |
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 ( |
Authorization |
String | No |
The value is in the |
Zuora-Entity-Ids |
String | No |
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 | No |
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. |
Accept-Encoding |
String | No |
Include the If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
exemptAmount |
Number | No |
The calculated tax amount excluded due to the exemption. |
jurisdiction |
String | No |
The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. |
name |
String | No |
The name of the taxation item to be updated. |
taxRateType |
String | No |
The type of the tax rate applied to the credit or debit memo. Possible values:
|
taxAmount |
Number | No |
The amount of the tax applied to the credit or debit memo. |
locationCode |
String | No |
The identifier for the location based on the value of the |
taxCode |
String | No |
The tax code identifies which tax rules and tax rates to apply to a specific credit or debit memo. |
taxDate |
String | No |
The date when the tax is applied to the credit or debit memo. |
taxRate |
Number | No |
The tax rate applied to the credit or debit memo. |
taxCodeDescription |
String | No |
The description of the tax code. |
taxRateDescription |
String | No |
The description of the tax rate. |
financeInformation |
Object | No |
Container for the finance information related to the taxation item. |
financeInformation.salesTaxPayableAccountingCode |
String | No |
The accounting code for the sales taxes payable. |
financeInformation.onAccountAccountingCode |
String | No |
The accounting code that maps to an on account in your accounting system. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.