Platform · Process & Structure
Approval Rule Catalogue
Every approval rule in the company in one list: the routes written here and the rules the purchasing, sales, hiring and journal screens keep. The older ones still run exactly as before and are edited where they are kept.
/api/platform/approval-rule-catalogPublished as /api/v1/approval-rule-catalogDownload specification (OpenAPI 3.1) Screen: Approval Rule Catalogue
Overview
| Package | Platform |
|---|---|
| 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 Platform › Approval Rule Catalogue 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 | core.approval_rule_catalog · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; 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/platform/approval-rule-catalogList approval rule catalogue
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",
"engine": "text",
"doc_type": "text",
"code": "COD-000001",
"name": "Example",
"priority": 10,
"amount_threshold": "1250.00",
"approver": "text",
"is_active": true,
"kept_in": "text",
"step_count": 10,
"edit_path": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/platform/approval-rule-catalog?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/approval-rule-catalog/{id}Read one approval rule
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",
"engine": "text",
"doc_type": "text",
"code": "COD-000001",
"name": "Example",
"priority": 10,
"amount_threshold": "1250.00",
"approver": "text",
"is_active": true,
"kept_in": "text",
"step_count": 10,
"edit_path": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/platform/approval-rule-catalog/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/approval-rule-catalogCreate a approval rule
Request body
The record as JSON. Fields marked Yes are required.
No body.
Sample body
{}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"engine": "text",
"doc_type": "text",
"code": "COD-000001",
"name": "Example",
"priority": 10,
"amount_threshold": "1250.00",
"approver": "text",
"is_active": true,
"kept_in": "text",
"step_count": 10,
"edit_path": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/approval-rule-catalog" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{}'PUT/api/platform/approval-rule-catalog/{id}Change a approval rule
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
No body.
Sample body
{}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"engine": "text",
"doc_type": "text",
"code": "COD-000001",
"name": "Example",
"priority": 10,
"amount_threshold": "1250.00",
"approver": "text",
"is_active": true,
"kept_in": "text",
"step_count": 10,
"edit_path": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/platform/approval-rule-catalog/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{}'DELETE/api/platform/approval-rule-catalog/{id}Delete a approval rule
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/platform/approval-rule-catalog/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/approval-rule-catalog/{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/platform/approval-rule-catalog/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a approval rule, 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 |
engine | text | read only | Engine |
doc_type | text | read only | Doc type |
code | text | read only | Code |
name | text | read only | Rule name — Changes the older rule itself, on the same row its own screen edits. |
priority | integer | read only | Priority — Lower is tried first. |
amount_threshold | numeric | read only | From amount — The rule applies above this amount. |
approver | text | read only | Approver |
is_active | boolean | read only | Active |
kept_in | text | read only | Kept in |
step_count | integer | read only | Step count |
edit_path | text | read only | Edit path |
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 Platform › Approval Rule Catalogue 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.