Get Taxes Table
Purpose - Retrieve the taxes table for the authenticated client/account. Useful for showing available tax rates and related identifiers. Endpoint and method - Method: GET - URL: [https://api
Body parameters
module
|
string |
Example: taxes
|
data
|
object |
Example:
|
Purpose
- Retrieve the taxes table for the authenticated client/account. Useful for showing available tax rates and related identifiers.
Endpoint and method
- Method: GET
- URL: [https://api.nizu.io/v2/](https://api.nizu.io/v2/)
- Notes: This endpoint expects a JSON payload even though the method is GET (as currently configured in this request).
Variables used
- {{client_token}}: Bearer or API token used for authentication. Defined in the active environment. Do not expose its value.
Request body
- Content-Type: application/json (raw)
- Schema (guidance based on observed patterns; may be broader in the API):
{
"module": "taxes",
"data": { }
}
- Current example payload in this request:
{
"module": "taxes",
"data": {}
}
Authentication
- Expectation: This request should be sent with a valid client token ({{client_token}}) as part of the request’s auth (commonly Bearer or inherited from the parent). Ensure the token is set in the active environment.
Sample success response (last observed 200)
``` json
{
"success": true,
"data": {
"content": [
{
"id": "1",
"title": "Tax (21%)",
"percentage": "21",
"deleted": "0",
"stripe_tax_id": "txr_1PBynbDgx1UehyAuXP4NmezD"
}
],
"total": 1
}
}
```
Testing notes
- This request currently has no tests. Consider adding assertions to verify:
- Status code is 200.
- success === true.
- data.content is an array and contains items with keys id, title, percentage.
- total is a number >= 0.
- If authentication fails, verify {{client_token}} is present and not expired.
Changelog
- 2025-12-07: Added structured documentation to the request description (purpose, endpoint/method, variables, body schema and example, auth, sample response, testing notes).