Platform · Process & Structure
Approval Document Types
What can be sent for approval. The built-in types are run by their own modules' rules (listed under Approval Rule Catalogue) or by self-service; add a type of your own by naming the table it lives in. No code needed.
/api/platform/approval-doc-typesPublished as /api/v1/approval-doc-typesDownload specification (OpenAPI 3.1) Screen: Approval Document Types
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 Document Types 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_doc_types · 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-doc-typesList approval document types
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",
"doc_type": "text",
"label": "text",
"engine": "text",
"table_name": "Example",
"id_column": "text",
"number_column": "text",
"amount_column": "text",
"currency_column": "USD",
"party_column": "text",
"org_unit_column": "text",
"grant_module": "text",
"grant_resource": "text",
"status_column": "draft"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/platform/approval-doc-types?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/approval-doc-types/{id}Read one approval document type
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",
"doc_type": "text",
"label": "text",
"engine": "text",
"table_name": "Example",
"id_column": "text",
"number_column": "text",
"amount_column": "text",
"currency_column": "USD",
"party_column": "text",
"org_unit_column": "text",
"grant_module": "text",
"grant_resource": "text",
"status_column": "draft"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/platform/approval-doc-types/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/approval-doc-typesCreate a approval document type
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
doc_type | text | Yes | Type key — Lower case, such as expense_claim or contract. |
label | text | Yes | Name |
table_name | text | No | Table — schema.table, such as crm.contracts. It must carry org_id. |
id_column | text | No | Id column |
number_column | text | No | Number column — The column people know the document by. |
amount_column | text | No | Amount column — Routes can be limited by amount when this is named. |
currency_column | text | No | Currency column |
party_column | text | No | Description column |
org_unit_column | text | No | Org unit column — Routes can be limited to an org unit, and org-unit-manager steps need it. |
grant_module | text | No | Screen module — The module of the screen the documents are kept on, such as crm. |
grant_resource | text | No | Screen resource — The screen key, such as contracts. Only people who may change that screen can send one for approval. |
status_column | text | No | Status column |
on_approved_status | text | No | Status when approved |
on_rejected_status | text | No | Status when rejected |
when_no_rule | text | No | When no route applies Allowed: Refuse to send it (safe) Approve it automatically |
allow_self_approval | boolean | No | Requester may approve their own |
is_active | boolean | No | Active |
description | text | No | Description |
Sample body
{
"doc_type": "text",
"label": "text",
"table_name": "Example",
"id_column": "text",
"number_column": "text",
"amount_column": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"doc_type": "text",
"label": "text",
"engine": "text",
"table_name": "Example",
"id_column": "text",
"number_column": "text",
"amount_column": "text",
"currency_column": "USD",
"party_column": "text",
"org_unit_column": "text",
"grant_module": "text",
"grant_resource": "text",
"status_column": "draft"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/approval-doc-types" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"doc_type":"text","label":"text","table_name":"Example","id_column":"text","number_column":"text","amount_column":"text"}'PUT/api/platform/approval-doc-types/{id}Change a approval document type
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.
| Field | Type | Required | Description |
|---|---|---|---|
doc_type | text | Yes | Type key — Lower case, such as expense_claim or contract. |
label | text | Yes | Name |
table_name | text | No | Table — schema.table, such as crm.contracts. It must carry org_id. |
id_column | text | No | Id column |
number_column | text | No | Number column — The column people know the document by. |
amount_column | text | No | Amount column — Routes can be limited by amount when this is named. |
currency_column | text | No | Currency column |
party_column | text | No | Description column |
org_unit_column | text | No | Org unit column — Routes can be limited to an org unit, and org-unit-manager steps need it. |
grant_module | text | No | Screen module — The module of the screen the documents are kept on, such as crm. |
grant_resource | text | No | Screen resource — The screen key, such as contracts. Only people who may change that screen can send one for approval. |
status_column | text | No | Status column |
on_approved_status | text | No | Status when approved |
on_rejected_status | text | No | Status when rejected |
when_no_rule | text | No | When no route applies Allowed: Refuse to send it (safe) Approve it automatically |
allow_self_approval | boolean | No | Requester may approve their own |
is_active | boolean | No | Active |
description | text | No | Description |
Sample body
{
"doc_type": "text",
"label": "text"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"doc_type": "text",
"label": "text",
"engine": "text",
"table_name": "Example",
"id_column": "text",
"number_column": "text",
"amount_column": "text",
"currency_column": "USD",
"party_column": "text",
"org_unit_column": "text",
"grant_module": "text",
"grant_resource": "text",
"status_column": "draft"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/platform/approval-doc-types/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"doc_type":"text","label":"text"}'DELETE/api/platform/approval-doc-types/{id}Delete a approval document type
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-doc-types/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/approval-doc-types/{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-doc-types/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 document type, 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 |
doc_type | text | read, write | Type key — Lower case, such as expense_claim or contract. |
label | text | read, write | Name |
engine | text | read only | Engine |
table_name | text | read, write | Table — schema.table, such as crm.contracts. It must carry org_id. |
id_column | text | read, write | Id column |
number_column | text | read, write | Number column — The column people know the document by. |
amount_column | text | read, write | Amount column — Routes can be limited by amount when this is named. |
currency_column | text | read, write | Currency column |
party_column | text | read, write | Description column |
org_unit_column | text | read, write | Org unit column — Routes can be limited to an org unit, and org-unit-manager steps need it. |
grant_module | text | read, write | Screen module — The module of the screen the documents are kept on, such as crm. |
grant_resource | text | read, write | Screen resource — The screen key, such as contracts. Only people who may change that screen can send one for approval. |
status_column | text | read, write | Status column |
on_approved_status | text | read, write | Status when approved |
on_rejected_status | text | read, write | Status when rejected |
when_no_rule | text | read, write | When no route applies Allowed: Refuse to send it (safe) Approve it automatically |
allow_self_approval | boolean | read, write | Requester may approve their own |
is_builtin | boolean | read only | Is builtin |
is_active | boolean | read, write | Active |
description | text | read, write | Description |
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 |
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 |
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 Document Types 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.