CRM · Records
Jurisdiction total
Read and maintain jurisdiction total records (acct.tax_wizard_jurisdictions).
/api/crm/tax-jurisdiction-totalsPublished as /api/v1/tax-jurisdiction-totalsOverview
| Package | CRM |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold CRM › Jurisdiction total on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | acct.tax_wizard_jurisdictions · kept per company (and organisational unit where it has one) |
| Record | Read only; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/crm/tax-jurisdiction-totalsList jurisdiction total
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"jurisdiction_code": "JUR-000001",
"jurisdiction_name": "Example",
"level": "text",
"parent_code": "PAR-000001",
"authority_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"authority_name": "Example",
"registration_no": "REG-000001",
"tax_head": "text",
"rate_pct": "1250.00",
"gross_sales": "1250.00"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/crm/tax-jurisdiction-totals?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/tax-jurisdiction-totals/{id}Read one jurisdiction total
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"jurisdiction_code": "JUR-000001",
"jurisdiction_name": "Example",
"level": "text",
"parent_code": "PAR-000001",
"authority_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"authority_name": "Example",
"registration_no": "REG-000001",
"tax_head": "text",
"rate_pct": "1250.00",
"gross_sales": "1250.00"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/crm/tax-jurisdiction-totals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/tax-jurisdiction-totalsPost jurisdiction total
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/tax-jurisdiction-totals" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/tax-jurisdiction-totals/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/tax-jurisdiction-totals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'PUT/api/crm/tax-jurisdiction-totals/{id}Put jurisdiction total
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/tax-jurisdiction-totals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/crm/tax-jurisdiction-totals/{id}Delete jurisdiction total
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/crm/tax-jurisdiction-totals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a jurisdiction total, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
run_id | uuid | read only | Run id |
jurisdiction_id | uuid | read only | Jurisdiction id |
jurisdiction_code | text | read only | Jurisdiction code |
jurisdiction_name | text | read only | Jurisdiction name |
level | text | read only | Level |
parent_code | text | read only | Parent code |
authority_id | uuid | read only | Authority id |
authority_name | text | read only | Authority name |
registration_no | text | read only | Registration no |
tax_head | text | read only | Tax head |
rate_pct | numeric | read only | Rate pct |
gross_sales | numeric | read only | Gross sales |
exempt_sales | numeric | read only | Exempt sales |
taxable_base | numeric | read only | Taxable base |
tax_collected | numeric | read only | Tax collected |
tax_due | numeric | read only | Tax due |
input_credit | numeric | read only | Input credit |
net_payable | numeric | read only | Net payable |
transaction_count | integer | read only | Transaction count |
variance | numeric | read only | Variance |
is_registered | boolean | read only | Is registered |
notes | text | read only | Notes |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold CRM › Jurisdiction total for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.