List Site Tax Rates
Retrieve the tax rates configured for a site. Use this list when preparing invoice line items or displaying the configured default. The API key user needs invoice viewing permission for the site.
GET /sites/{site_id}/taxrates
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
site_id |
string | Yes | QReserve site ID. |
Example
curl -H 'Authorization: YOUR_API_KEY' 'https://api.qreserve.com/sites/SITE_ID/taxrates'
Response
data is a list of tax rates and numitems is the number returned.
| Field | Type | Description |
|---|---|---|
invoice_tax_rate_id |
string | QReserve tax rate ID. |
name |
string | Display name. |
code |
string | Tax code. |
rate |
integer | Percent multiplied by 10,000. Divide by 10,000 to get the percentage. |
is_default |
boolean | Whether this is the default tax rate for the site. |
tax_note |
string | Configured tax note. |
{
"status": "success",
"data": [
{
"invoice_tax_rate_id": "TAX_RATE_ID",
"name": "HST",
"code": "HST",
"rate": 130000,
"is_default": true,
"tax_note": ""
}
],
"numitems": 1
}
In this example, 130000 represents 13%. An unknown site returns a not-found response.
See the Invoices API overview for shared IDs and permissions.