Tax Rates
Archive a tax rate
Tax Rates
Archive a tax rate
Archive a tax rate
POST
/
tax-rates
/
{id}
/
archive
Headers
Authorization
string
requiredYour API credentials. Eg. Basic {credentials}.
Sequence-Version
enum<string>
Use this header to select an API version
Available options:
2024-07-30 Path Parameters
id
string
requiredTaxRate ID
Response
200 - application/json
id
string
requiredTax Rate ID
versionId
string
requiredTax Rate Version ID
sequenceAccountId
string
requiredSequence Account ID
version
integer
requiredTax Rate version
isPublished
boolean
requiredTax Rate status
name
string
requiredThe full name of the tax rate, e.g. "Sales tax"
invoiceName
string
requiredThe long name used on the invoice, e.g. "Value Added Tax"
invoiceShortName
string
requiredThe short name used on the invoice, e.g. "VAT"
amount
string
requiredThe tax rate. Must be between 0 and 100. If this tax rate has any sub-rates, then all sub-rates must add up to this amount.
country
enum<string>
requiredThe country that this tax rate applies to
Available options:
AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW isArchived
boolean
requiredArchived
description
string
The description of the tax rate
region
string
The region that this tax rate applies to
taxCategoryId
string
The Tax Category Version ID that this Tax Rate is part of
subRates
any[]
The sub rates of this tax rate