iotoms Docs

Get a tax

GET
/api/v1/catalog/attributes/taxes/{id}

Returns one tax rate definition by its ID: its name, its rates as percentages (taxRate1 and an optional second rate taxRate2) and status.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*integer

ID of the record.

Formatint64

Response Body

OK

*/*
  1. response
id*integer

Numeric tax ID; use it as taxId on items.

Formatint64
name*string

Tax name, unique across the catalog (up to 100 characters).

taxRate1*number

First tax rate as a percentage (e.g. 5.00 means 5%), up to two decimals.

taxRate2?|

Optional second tax rate as a percentage, applied alongside the first; 0 when not used.

modifiedTime*string

When the tax was last changed (ISO 8601 timestamp).

Formatdate-time
status*string

Tax status, e.g. active.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/catalog/attributes/taxes/0'
Example Response
{  "id": 0,  "name": "string",  "taxRate1": 0,  "taxRate2": 0,  "modifiedTime": "2019-08-24T14:15:22Z",  "status": "string"}