日本語のコンテンツは機械翻訳されており、補助的な参照を目的としています。機械翻訳の精度は保証できません。英語版が正となります。また、現時点では検索機能は日本語での検索をサポートしていません。翻訳に関するフィードバックについては、docs@zuora.comに送信してください。

Zuora Tax Code API Settings

Last updated

Aug 26, 2024
Save as PDF

Describes managing tax codes within the Zuora Tax Engine, including operations to create, retrieve, update, and delete tax codes.

Get Specific Tax Code ID

The ID of a specific zuora tax code is required as a path parameter to get the tax codes. See the following request and a sample of 200 response to get the ID of any tax code:

All the examples provided in this section use the Zuora Sandbox endpoint URL. You must substitute it with your own endpoint base URL.

HTTP request:

GET https://rest.apisandbox.zuora.com/settings/tax-codes/ztax/{id}

Request body:

Key	Value
Curl	GET https://rest.apisandbox.zuora.com/se...odes/ztax/{id}
Authorization	Auth Type - Bearer Token <oauth_token>
Headers	Authorization - Bearer <oauth_token> Content-Type - application/json

Response body:

01{
02   "id": "47d2609fda26e8f15d7954299457f92e",
03   "taxEngineId": "47d2609f2dd03671de006c57df2e46cc",
04   "active": true,
05   "name": "Avalara Sales Tax",
06   "description": "",
07   "taxCompanyId": "47d2609f15d506b1bd7084de4499292c",
08   "externalTaxCode": "ZDEVSE-0001",
09   "success": true
10}

Create Tax Codes

Ensure that you retrieve the engine ID of the Tax Rate Period Engine from the Get Specific Tax Code ID section before proceeding with the following steps. To create a new Tax Code, see the following request and a sample of 200 response:

HTTP request:

POST https://rest.apisandbox.zuora.com/settings/tax-codes/ztax

Request body:

Key Value

Curl POST https://rest.apisandbox.zuora.com/settings/tax-codes/ztax

Authorization Auth Type - Bearer Token <oauth_token>

Headers

Authorization - Bearer <oauth_token>
Content-Type - application/json

Body

--data {

"name": "string | null",

"active": true,

"description": "string | null",

"taxEngineId": "string"

}

Example:

1{
2 "name": "Example Tax Code",
3 "active": true,
4 "description": "This is a description for the tax code.",
5 "taxEngineId": "47d2609fbd479ec78fe32045b894f187"
6}

Response body:

1{
2   "id": "8ad095ba917efcb101918d8acaec367f",
3   "taxEngineId": "47d2609fbd479ec78fe32045b894f187",
4   "active": false,
5   "name": "Example Tax Code",
6   "description": "This is a description for the tax code.",
7   "success": true
8}

Update Tax Codes

To update the Zuora Tax Code, see the following request and a sample of 200 response:

HTTP request:

PUT https://rest.apisandbox.zuora.com/settings/tax-codes/ztax/{id}

Request body:

Key Value

Curl PUT https://rest.apisandbox.zuora.com/settings/tax-codes/ztax/{id}

Authorization Auth Type - Bearer Token <oauth_token>

Headers

Authorization - Bearer <oauth_token>
Content-Type - application/json

Body

--data {

"name": "string",

"active": true,

"description": "string | null",

"taxEngineId": "string"

}

Example:

1{
2 "name": "Update Tax Code",
3 "active": true,
4 "description": "A description for the new tax code.",
5 "taxEngineId": "47d2609fbd479ec78fe32045b894f187"
6}

Response body:

1{
2   "id": "47d2609fda26e8f15d7954299457f92e",
3   "taxEngineId": "47d2609fbd479ec78fe32045b894f187",
4   "active": false,
5   "name": "Update Tax Code",
6   "description": "A description for the new tax code.",
7   "success": true
8}

Delete Tax Codes

To delete a tax code, see the following request and a sample of 200 response:

HTTP request:

DELETE https://rest.apisandbox.zuora.com/settings/tax-codes/ztax/{id}

Request body:

Key	Value
Curl	DELETE `https://rest.apisandbox.zuora.com/settings/tax-codes/ztax/{id}`
Authorization	Auth Type - Bearer Token <oauth_token>
Headers	Authorization - Bearer <oauth_token> Content-Type - application/json

Response body:

1{
2   "success": true
3}