Skip to main content

Zuora Tax Rates API Settings

Zuora

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

Zuora Tax Rates API Settings

  1. Last updated
    Aug 26, 2024
  2. Save as PDF

Describes managing tax rates, including retrieval, creation, updating, and deletion through the Settings API.

Retrieve a list of tax rates

To retrieve a list of tax rates,  see the following request and a sample of 200 response:

HTTP request:

GET https://rest.apisandbox.zuora.com/settings/tax-rate-periods/{ID}/tax-rates?size=100&page=1

Request body:

Key Value
Curl GET https://rest.apisandbox.zuora.com/settings/tax-rate-periods/{ID}/tax-rates?size=100&page=1
Authorization Auth Type - Bearer Token  <oauth_token>
Headers
  • Authorization - Bearer <oauth_token>
  • Content-Type - application/json

Response body:

view sourceprint?
001{
002    "taxRates": [
003        {
004            "id": "8ad081dd90a5e74f0190ba75246f06b5",
005            "taxRatePeriodId": "8ad081dd90a5e74f0190ba7523d106b4",
006            "country": "United States",
007            "state": "Alabama",
008            "county": null,
009            "city": null,
010            "postalCode": null,
011            "taxRegion": null,
012            "taxRate1": 0.08,
013            "taxRateType1": "Percentage",
014            "taxName1": "Sales Tax",
015            "taxJursdiction1": "State",
016            "taxLocationCode1": "",
017            "taxRateDescription1": "Alabama",
018            "taxRate2": 0.0,
019            "taxRateType2": null,
020            "taxName2": null,
021            "taxJursdiction2": null,
022            "taxLocationCode2": null,
023            "taxRateDescription2": null,
024            "taxRate3": 0.0,
025            "taxRateType3": null,
026            "taxName3": null,
027            "taxJursdiction3": null,
028            "taxLocationCode3": null,
029            "taxRateDescription3": null
030        },
031        {
032            "id": "8ad081dd90a5e74f0190ba75247506b6",
033            "taxRatePeriodId": "8ad081dd90a5e74f0190ba7523d106b4",
034            "country": "United States",
035            "state": "Alaska",
036            "county": null,
037            "city": null,
038            "postalCode": null,
039            "taxRegion": null,
040            "taxRate1": 0.0,
041            "taxRateType1": "Percentage",
042            "taxName1": "Sales Tax",
043            "taxJursdiction1": "State",
044            "taxLocationCode1": "",
045            "taxRateDescription1": "Alaska",
046            "taxRate2": 0.0,
047            "taxRateType2": null,
048            "taxName2": null,
049            "taxJursdiction2": null,
050            "taxLocationCode2": null,
051            "taxRateDescription2": null,
052            "taxRate3": 0.0,
053            "taxRateType3": null,
054            "taxName3": null,
055            "taxJursdiction3": null,
056            "taxLocationCode3": null,
057            "taxRateDescription3": null
058        },
059        {
060            "id": "8ad081dd90a5e74f0190ba75247b06b7",
061            "taxRatePeriodId": "8ad081dd90a5e74f0190ba7523d106b4",
062            "country": "United States",
063            "state": "Arizona",
064            "county": null,
065            "city": null,
066            "postalCode": null,
067            "taxRegion": null,
068            "taxRate1": 0.056,
069            "taxRateType1": "Percentage",
070            "taxName1": "Sales Tax",
071            "taxJursdiction1": "State",
072            "taxLocationCode1": "",
073            "taxRateDescription1": "Arizona",
074            "taxRate2": 0.0,
075            "taxRateType2": null,
076            "taxName2": null,
077            "taxJursdiction2": null,
078            "taxLocationCode2": null,
079            "taxRateDescription2": null,
080            "taxRate3": 0.0,
081            "taxRateType3": null,
082            "taxName3": null,
083            "taxJursdiction3": null,
084            "taxLocationCode3": null,
085            "taxRateDescription3": null
086        },
087        {
088            "id": "8ad081dd90a5e74f0190ba75248006b8",
089            "taxRatePeriodId": "8ad081dd90a5e74f0190ba7523d106b4",
090            "country": "United States",
091            "state": "Arkansas",
092            "county": null,
093            "city": null,
094            "postalCode": null,
095            "taxRegion": null,
096            "taxRate1": 0.06,
097            "taxRateType1": "Percentage",
098            "taxName1": "Sales Tax",
099            "taxJursdiction1": "State",
100            "taxLocationCode1": "",
101            "taxRateDescription1": "Arkansas",
102            "taxRate2": 0.0,
103            "taxRateType2": null,
104            "taxName2": null,
105            "taxJursdiction2": null,
106            "taxLocationCode2": null,
107            "taxRateDescription2": null,
108            "taxRate3": 0.0,
109            "taxRateType3": null,
110            "taxName3": null,
111            "taxJursdiction3": null,
112            "taxLocationCode3": null,
113            "taxRateDescription3": null
114        },
115        
116        {
117            "id": "8ad081dd90a5e74f0190ba75250b06d2",
118            "taxRatePeriodId": "8ad081dd90a5e74f0190ba7523d106b4",
119            "country": "United States",
120            "state": "New Jersey",
121            "county": null,
122            "city": null,
123            "postalCode": null,
124            "taxRegion": null,
125            "taxRate1": 0.07,
126            "taxRateType1": "Percentage",
127            "taxName1": "Sales Tax",
128            "taxJursdiction1": "State",
129            "taxLocationCode1": "",
130            "taxRateDescription1": "New Jersey",
131            "taxRate2": 0.0,
132            "taxRateType2": null,
133            "taxName2": null,
134            "taxJursdiction2": null,
135            "taxLocationCode2": null,
136            "taxRateDescription2": null,
137            "taxRate3": 0.0,
138            "taxRateType3": null,
139            "taxName3": null,
140            "taxJursdiction3": null,
141            "taxLocationCode3": null,
142            "taxRateDescription3": null
143        },
144        
145        {
146            "id": "8ad081dd90a5e74f0190ba7525c806ec",
147            "taxRatePeriodId": "8ad081dd90a5e74f0190ba7523d106b4",
148            "country": "Italy",
149            "state": null,
150            "county": null,
151            "city": null,
152            "postalCode": null,
153            "taxRegion": null,
154            "taxRate1": 0.2,
155            "taxRateType1": "Percentage",
156            "taxName1": "VAT",
157            "taxJursdiction1": "",
158            "taxLocationCode1": "",
159            "taxRateDescription1": "VAT",
160            "taxRate2": 0.0,
161            "taxRateType2": null,
162            "taxName2": null,
163            "taxJursdiction2": null,
164            "taxLocationCode2": null,
165            "taxRateDescription2": null,
166            "taxRate3": 0.0,
167            "taxRateType3": null,
168            "taxName3": null,
169            "taxJursdiction3": null,
170            "taxLocationCode3": null,
171            "taxRateDescription3": null
172        },
173        {
174            "id": "8ad081dd90a5e74f0190ba75266c0707",
175            "taxRatePeriodId": "8ad081dd90a5e74f0190ba7523d106b4",
176            "country": "Canada",
177            "state": "Yukon",
178            "county": null,
179            "city": null,
180            "postalCode": null,
181            "taxRegion": null,
182            "taxRate1": 0.05,
183            "taxRateType1": "Percentage",
184            "taxName1": "CDNTax",
185            "taxJursdiction1": "",
186            "taxLocationCode1": "",
187            "taxRateDescription1": "GST",
188            "taxRate2": 0.0,
189            "taxRateType2": null,
190            "taxName2": null,
191            "taxJursdiction2": null,
192            "taxLocationCode2": null,
193            "taxRateDescription2": null,
194            "taxRate3": 0.0,
195            "taxRateType3": null,
196            "taxName3": null,
197            "taxJursdiction3": null,
198            "taxLocationCode3": null,
199            "taxRateDescription3": null
200        }
201    ],
202    "success": true
203}

Create Tax Rates

To create a new Tax rate, see the following request and a sample of 200 response:

HTTP request:

POST https://rest.apisandbox.zuora.com/settings/tax-rate-periods/{taxRatePeriodID}/tax-rates

Request body:

Key Value
Curl POST https://rest.apisandbox.zuora.com/settings/tax-rate-periods/{taxRatePeriodID}/tax-rates
Authorization Auth Type - Bearer Token  <oauth_token>
Headers
  • Authorization - Bearer <oauth_token>
  • Content-Type - application/json
Body

{

   "taxRates": [

       {

           "country": "string",

           "state": "string",

           "taxRate1": number,

           "taxRateType1": "Percentage",

           "taxName1": "string",

           "taxJurisdiction1": "string",

           "taxLocationCode1": "string",

           "taxRateDescription1": "string"

       }

   ]

}

Example:

view sourceprint?
01{
02   "taxRates": [
03       {
04           "country": "United States",
05           "state": "California",
06           "taxRate1": 0.08,
07           "taxRateType1": "Percentage",
08           "taxName1": "taxName1",
09           "taxJursdiction1": "state",
10           "taxLocationCode1": "000-1",
11           "taxRateDescription1": "taxRateDescription1"
12       }
13   ]
14}

Response body:

view sourceprint?
01{
02   "taxRates": [
03       {
04           "id": "8ad08487917ed51f01918ddbf7352ff5",
05           "taxRatePeriodId": "8ad081dd917ed47501918dcd15c954c0",
06           "country": "United States",
07           "state": "California",
08           "county": null,
09           "city": null,
10           "postalCode": null,
11           "taxRegion": null,
12           "taxRate1": 0.08,
13           "taxRateType1": "Percentage",
14           "taxName1": "taxName1",
15           "taxJursdiction1": "state",
16           "taxLocationCode1": "000-1",
17           "taxRateDescription1": "taxRateDescription1",
18           "taxRate2": 0.0,
19           "taxRateType2": null,
20           "taxName2": null,
21           "taxJursdiction2": null,
22           "taxLocationCode2": null,
23           "taxRateDescription2": null,
24           "taxRate3": 0.0,
25           "taxRateType3": null,
26           "taxName3": null,
27           "taxJursdiction3": null,
28           "taxLocationCode3": null,
29           "taxRateDescription3": null
30       }
31   ],
32   "success": true
33}

Update Tax Rates

Tax rates cannot be updated. To make changes, you must delete the existing tax rate and create a new one.

Delete Tax Rates

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

 This API deletes all tax rates for a period.

HTTP request:

DELETE https://rest.apisandbox.zuora.com/settings/tax-rate-periods/{ID}/tax-rates

Request body:

Key Value
Curl DELETE https://rest.apisandbox.zuora.com/settings/tax-rate-periods/{ID}/tax-rates
Authorization Auth Type - Bearer Token  <oauth_token>
Headers
  • Authorization - Bearer <oauth_token>
  • Content-Type - application/json

Response body: 

view sourceprint?
1{
2   "success": true
3}