POS Tax
Methods
Retrieve Taxes
Retrieve a specific location POS taxes.
GET /pos/v2/{locationId}/taxes
Response 200
Returns taxes in requested location
{
"results": [
{
"posRef": "string",
"name": "string",
"isActive": true,
"isHidden": true,
"rate": {
"type": "amount",
"percent": 0,
"amount": 0
}
}
],
"meta": {}
}
Definitions
POS Tax
POS Tax (e.g., State Tax)
| Name | Type | Description |
|---|---|---|
| posRef* | string | POS Tax reference ID. Unique per location |
| name* | string | Tax name |
| isActive | boolean | Indicates whether this Tax is active in POS or not |
| isHidden | boolean | Is this tax included in the item price? |
| rate* | object | Tax rate details |
Menu Tax Rate
Tax rate details
| Name | Type | Description |
|---|---|---|
| type* | string | POS available tax types:
|
| percent | integer | Non-null in case type is percent. Tax rate (Integer, division by 10000 to get a percent. In case there is rate of 1000000 there will be 100 percent) |
| amount | integer | Non-null in case type is amount. The amount in US cents |