POST
/
tax-rates
/
{id}
/
archive
Archive a tax rate
curl --request POST \
  --url https://eu.sequencehq.com/api/tax-rates/{id}/archive \
  --header 'Authorization: <authorization>'
{
  "id": "d58bf2e3-7a5d-4900-8457-2521c6880f7d",
  "versionId": "82ef6f1a-afc2-4a8d-b868-6d9c72bf395f",
  "sequenceAccountId": "dce9ae85-d8d0-42b4-bcad-f221a64363c6",
  "version": 0,
  "isPublished": false,
  "name": "UK Sales Tax",
  "invoiceName": "Value Added Tax",
  "invoiceShortName": "VAT",
  "description": "Value Added Tax applied to sales in the UK",
  "amount": "0.2",
  "country": "GB",
  "region": "London",
  "taxCategoryId": "ce109c64-dcc0-487a-ac8c-e3237c60cdb6",
  "subRates": [],
  "isArchived": true
}

Headers

​
Authorization
string
required

Your 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
required

TaxRate ID

Response

OK

​
id
string
required

Tax Rate ID

Example:

"d58bf2e3-7a5d-4900-8457-2521c6880f7d"

​
versionId
string
required

Tax Rate Version ID

Example:

"82ef6f1a-afc2-4a8d-b868-6d9c72bf395f"

​
sequenceAccountId
string
required

Sequence Account ID

Example:

"dce9ae85-d8d0-42b4-bcad-f221a64363c6"

​
version
integer
required

Tax Rate version

Example:

0

​
isPublished
boolean
required

Tax Rate status

Example:

false

​
name
string
required

The full name of the tax rate, e.g. "Sales tax"

Example:

"UK Sales Tax"

​
invoiceName
string
required

The long name used on the invoice, e.g. "Value Added Tax"

Example:

"Value Added Tax"

​
invoiceShortName
string
required

The short name used on the invoice, e.g. "VAT"

Example:

"VAT"

​
amount
string
required

The 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.

Example:

"0.2"

​
country
enum<string>
required

The 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
Example:

"GB"

​
isArchived
boolean
required

Archived

Example:

true

​
description
string

The description of the tax rate

Example:

"Value Added Tax applied to sales in the UK"

​
region
string

The region that this tax rate applies to

Example:

"London"

​
taxCategoryId
string

The Tax Category Version ID that this Tax Rate is part of

Example:

"ce109c64-dcc0-487a-ac8c-e3237c60cdb6"

​
subRates
any[]

The sub rates of this tax rate

Example:
[]