Tax rates
Tax rates in the BlueSuite REST API
Maintain named tax rates for the workspace. Use the returned tax-rate ID when associating a rate with a quote, job, invoice, or service plan. Percentage values are expressed as numbers; for example, 8.5 represents 8.5 percent.
Creating or editing a tax-rate record does not by itself rewrite every existing document's pricing.
GET /api/v1/tax-rates
GET /api/v1/tax-ratesRequired scopes: tax-rates:read.
Query parameters
| Field | Type / accepted values | Required | Details |
|---|---|---|---|
page | integer | No | Page number, starting at 1. Default: 1. |
per_page | integer | No | Records per page, from 1 to 100. Default: 25. minimum: 1. maximum: 100. |
search | string | No | Search text. maxLength: 100. |
sort_by | string | No | Sort column. See the supported columns below when listed. |
sort_direction | "asc", "desc" | No | Sort direction. Default: "desc". |
Response
200 with { "success": true, "data": [...], "pagination": { "page": 1, "per_page": 25, "total_pages": 1 } }.
See response conventions and errors.
POST /api/v1/tax-rates
POST /api/v1/tax-ratesRequired scopes: tax-rates:write.
JSON body
| Field | Type / accepted values | Required | Details |
|---|---|---|---|
name | string | Yes | |
description | string | No | |
rate | number | Yes |
Unknown body fields are rejected. Conditional requirements are explained above.
Response
201 with { "success": true, "data": ... }. The data contains the result of the operation.
See response conventions and errors.
GET /api/v1/tax-rates/:id
GET /api/v1/tax-rates/:idRequired scopes: tax-rates:read.
Path parameters: id. Use positive integer record IDs from this workspace.
Response
200 with { "success": true, "data": ... }. The data contains the result of the operation.
See response conventions and errors.
PUT /api/v1/tax-rates/:id
PUT /api/v1/tax-rates/:idRequired scopes: tax-rates:write.
Path parameters: id. Use positive integer record IDs from this workspace.
JSON body
| Field | Type / accepted values | Required | Details |
|---|---|---|---|
name | string | No | |
description | string | No | |
rate | number | No |
Unknown body fields are rejected. Conditional requirements are explained above.
Response
200 with { "success": true, "data": ... }. The data contains the result of the operation.
See response conventions and errors.
DELETE /api/v1/tax-rates/:id
DELETE /api/v1/tax-rates/:idRequired scopes: tax-rates:write.
Path parameters: id. Use positive integer record IDs from this workspace.
No request body.
Response
200 with { "success": true, "data": ... }. The data contains the result of the operation.