Supply Chain · Procurement Control
Requisition Approval Rules
Which purchase requisitions need a signature, and whose. The same shape a purchase order rule has, because a company should express its delegation of authority once.
/api/scm/pr-approval-rulesPublished as /api/v1/pr-approval-rulesDownload specification (OpenAPI 3.1) Screen: Requisition Approval Rules
Overview
| Package | Supply Chain |
|---|---|
| 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 Supply Chain › Requisition Approval Rules 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 | scm.pr_approval_rules · 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
8 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/pr-approval-rulesList requisition approval rules
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",
"code": "COD-000001",
"name": "Example",
"priority": 10,
"amount_threshold": "1250.00",
"category": "text",
"department": "text",
"req_type": "standard",
"item_type": "text",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"requires_subcontract": true,
"approver_kind": "A named person (their sign-in) — no HRMS needed"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/pr-approval-rules?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/pr-approval-rules/{id}Read one requisition 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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"priority": 10,
"amount_threshold": "1250.00",
"category": "text",
"department": "text",
"req_type": "standard",
"item_type": "text",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"requires_subcontract": true,
"approver_kind": "A named person (their sign-in) — no HRMS needed"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/pr-approval-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/pr-approval-rulesCreate a requisition approval rule
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Rule |
priority | integer | No | Order — Lower runs first. Every matching rule applies; their signatures are collected in this order. |
amount_threshold | numeric | No | Applies at or above (inclusive) — A requisition no rule covers is released without approval: "Amounts covered" shows any gap. |
category | text | No | Only this category |
department | text | No | Only this department |
req_type | text | No | Only this kind of requisition Allowed: standard subcontract service replacement rework |
item_type | text | No | Item type |
warehouse_id | uuid | No | Only this warehouse |
account_id | uuid | No | Only for this customer |
requires_subcontract | boolean | No | Only subcontracting requisitions |
approver_kind | text | No | Who signs — Choose one; only the field for that choice is needed. The conditions above are all optional. "The cost center’s manager": The manager recorded on the cost center (Accounting › Controlling › Cost Centers): its HRMS manager, or else its responsible person. Allowed: A named person (their sign-in) — no HRMS needed An employee (HRMS) Whoever holds a position (HRMS) Anyone holding a role The cost center’s manager The reporting line of whoever raised it (HRMS) |
levels | integer | No | How many levels up |
approver_role | text | No | Role that may sign — The role’s NAME as it appears in Access › Roles — “Plant Manager”, not a slug. A rule naming a role nobody holds routes a requisition to nobody. |
approver_employee_id | uuid | No | Employee |
due_in_hours | integer | No | Due within (hours) |
is_active | boolean | No | Active |
description | text | No | Why this rule exists |
uses_levels | boolean | No | Name the approvers level by level — On: the rule uses its own Approval Levels — named people in order, the absent skipped, delegations followed. Off: the single approver above, repeated for as many levels as it says. |
approver_user_id | uuid | No | Person — Anyone who signs in to this company. They decide it from My approvals, whatever modules they have. |
approver_position_id | uuid | No | Position — Whoever holds this position in HRMS when the document is sent. When somebody else takes the post, new documents go to them with nothing to change here. |
cost_center_id | uuid | No | Only for cost center — Requisitions charged to this cost center, on the requisition or on any line. Leave empty for every cost center. |
Sample body
{
"code": "COD-000001",
"name": "Example",
"priority": 10,
"amount_threshold": "1250.00",
"category": "text",
"department": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"priority": 10,
"amount_threshold": "1250.00",
"category": "text",
"department": "text",
"req_type": "standard",
"item_type": "text",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"requires_subcontract": true,
"approver_kind": "A named person (their sign-in) — no HRMS needed"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/pr-approval-rules" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","priority":10,"amount_threshold":"1250.00","category":"text","department":"text"}'PUT/api/scm/pr-approval-rules/{id}Change a requisition 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.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Rule |
priority | integer | No | Order — Lower runs first. Every matching rule applies; their signatures are collected in this order. |
amount_threshold | numeric | No | Applies at or above (inclusive) — A requisition no rule covers is released without approval: "Amounts covered" shows any gap. |
category | text | No | Only this category |
department | text | No | Only this department |
req_type | text | No | Only this kind of requisition Allowed: standard subcontract service replacement rework |
item_type | text | No | Item type |
warehouse_id | uuid | No | Only this warehouse |
account_id | uuid | No | Only for this customer |
requires_subcontract | boolean | No | Only subcontracting requisitions |
approver_kind | text | No | Who signs — Choose one; only the field for that choice is needed. The conditions above are all optional. "The cost center’s manager": The manager recorded on the cost center (Accounting › Controlling › Cost Centers): its HRMS manager, or else its responsible person. Allowed: A named person (their sign-in) — no HRMS needed An employee (HRMS) Whoever holds a position (HRMS) Anyone holding a role The cost center’s manager The reporting line of whoever raised it (HRMS) |
levels | integer | No | How many levels up |
approver_role | text | No | Role that may sign — The role’s NAME as it appears in Access › Roles — “Plant Manager”, not a slug. A rule naming a role nobody holds routes a requisition to nobody. |
approver_employee_id | uuid | No | Employee |
due_in_hours | integer | No | Due within (hours) |
is_active | boolean | No | Active |
description | text | No | Why this rule exists |
uses_levels | boolean | No | Name the approvers level by level — On: the rule uses its own Approval Levels — named people in order, the absent skipped, delegations followed. Off: the single approver above, repeated for as many levels as it says. |
approver_user_id | uuid | No | Person — Anyone who signs in to this company. They decide it from My approvals, whatever modules they have. |
approver_position_id | uuid | No | Position — Whoever holds this position in HRMS when the document is sent. When somebody else takes the post, new documents go to them with nothing to change here. |
cost_center_id | uuid | No | Only for cost center — Requisitions charged to this cost center, on the requisition or on any line. Leave empty for every cost center. |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"priority": 10,
"amount_threshold": "1250.00",
"category": "text",
"department": "text",
"req_type": "standard",
"item_type": "text",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"requires_subcontract": true,
"approver_kind": "A named person (their sign-in) — no HRMS needed"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/pr-approval-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/scm/pr-approval-rules/{id}Delete a requisition 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/scm/pr-approval-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/pr-approval-rules/ladderLadder
Request body
The keys this action reads (* = required; "one of" lists the only values):
rule*, preview; levels*: [{ approver_kind, name, approver_employee_id, approver_user_id, approver_position_id, approver_role, amount_threshold, due_in_hours, may_skip_if_absent, level_no, who }]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/scm/pr-approval-rules/ladder" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"rule":"value","preview;":"value","name":"value","approver_employee_id":"value","approver_user_id":"value","approver_position_id":"value"}'GET/api/scm/pr-approval-rules/{id}/level-historyLevel history
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/scm/pr-approval-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/level-history" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/pr-approval-rules/{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/scm/pr-approval-rules/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 requisition 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 |
org_unit_id | uuid | read only | Org unit id |
code | text | read, write | Code |
name | text | read, write | Rule |
priority | integer | read, write | Order — Lower runs first. Every matching rule applies; their signatures are collected in this order. |
amount_threshold | numeric | read, write | Applies at or above (inclusive) — A requisition no rule covers is released without approval: "Amounts covered" shows any gap. |
category | text | read, write | Only this category |
department | text | read, write | Only this department |
req_type | text | read, write | Only this kind of requisition Allowed: standard subcontract service replacement rework |
item_type | text | read, write | Item type |
warehouse_id | uuid | read, write | Only this warehouse |
account_id | uuid | read, write | Only for this customer |
requires_subcontract | boolean | read, write | Only subcontracting requisitions |
approver_kind | text | read, write | Who signs — Choose one; only the field for that choice is needed. The conditions above are all optional. "The cost center’s manager": The manager recorded on the cost center (Accounting › Controlling › Cost Centers): its HRMS manager, or else its responsible person. Allowed: A named person (their sign-in) — no HRMS needed An employee (HRMS) Whoever holds a position (HRMS) Anyone holding a role The cost center’s manager The reporting line of whoever raised it (HRMS) |
levels | integer | read, write | How many levels up |
approver_role | text | read, write | Role that may sign — The role’s NAME as it appears in Access › Roles — “Plant Manager”, not a slug. A rule naming a role nobody holds routes a requisition to nobody. |
approver_employee_id | uuid | read, write | Employee |
due_in_hours | integer | read, write | Due within (hours) |
is_active | boolean | read, write | Active |
description | text | read, write | Why this rule exists |
created_at | timestamp with time zone | read only | Created at |
uses_levels | boolean | read, write | Name the approvers level by level — On: the rule uses its own Approval Levels — named people in order, the absent skipped, delegations followed. Off: the single approver above, repeated for as many levels as it says. |
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_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
approver_user_id | uuid | read, write | Person — Anyone who signs in to this company. They decide it from My approvals, whatever modules they have. |
approver_position_id | uuid | read, write | Position — Whoever holds this position in HRMS when the document is sent. When somebody else takes the post, new documents go to them with nothing to change here. |
cost_center_id | uuid | read, write | Only for cost center — Requisitions charged to this cost center, on the requisition or on any line. Leave empty for every cost center. |
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 Supply Chain › Requisition Approval Rules 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.