TRANXACT.AI Help

Supply Chain · Procurement Control

Approval Levels

The people a rule asks to sign, one level at a time, in order. A level whose approver has left or is on leave is skipped and the next one fills it; a level that must be filled by somebody holds the document instead. Works the same way for a purchase order and for a requisition, because it is one policy.

Type REST6 operationsBase path /api/scm/approval-levelsPublished as /api/v1/approval-levels

Download specification (OpenAPI 3.1) Screen: Approval Levels

Overview

PackageSupply Chain
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Supply Chain › Approval Levels 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.
Tablescm.approval_levels · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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/scm/approval-levelsList approval levels

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "po_rule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "pr_rule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "level_no": 10,
      "name": "Example",
      "approver_kind": "A named person (their sign-in) — no HRMS needed",
      "approver_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "approver_role": "text",
      "may_skip_if_absent": true,
      "amount_threshold": "1250.00",
      "due_in_hours": 10,
      "notes": "text",
      "is_active": true,
      "created_at": "2026-10-30T09:00:00Z"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/scm/approval-levels?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/approval-levels/{id}Read one approval level

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "po_rule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "pr_rule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "level_no": 10,
  "name": "Example",
  "approver_kind": "A named person (their sign-in) — no HRMS needed",
  "approver_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "approver_role": "text",
  "may_skip_if_absent": true,
  "amount_threshold": "1250.00",
  "due_in_hours": 10,
  "notes": "text",
  "is_active": true,
  "created_at": "2026-10-30T09:00:00Z"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/scm/approval-levels/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/approval-levelsCreate a approval level

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
po_rule_iduuidNoPurchase order rule
pr_rule_iduuidNoRequisition rule — A level belongs to one rule — a requisition rule, a purchase order rule or a hiring rule. Choose only one of the three.
level_nointegerYesLevel — Signatures are collected in this order. Level 2 cannot decide before level 1 has.
nametextNoWhat this level is called — e.g. "Manager 1". It is what the approver sees on the document.
approver_kindtextNoWho signs — Choose one; only the field for that choice is needed. "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)
approver_employee_iduuidNoEmployee
approver_roletextNoAnyone holding this role — A sign-in role from Administration › Roles, by its name or code — not a position in HRMS. If nobody holds it the level is skipped where it may be, and otherwise the document is refused with the reason.
may_skip_if_absentbooleanNoMay be skipped when the approver is away — On: the next level fills it. Off: the document waits until somebody is in the post — which is usually right for a final authority.
amount_thresholdnumericNoOnly at or above (inclusive) — Lets one rule say "a manager over 5,000, an executive over 50,000". "Over 1,000" is from 1,000.01.
due_in_hoursintegerNoDue within (hours)
notestextNoNotes
is_activebooleanNoActive
hr_rule_iduuidNoHiring rule — For a hiring request (HRMS > Hiring Approval Rules). Its "Only at or above" and "Only up to" are the annual cost of the vacancy. A hiring rule with no level that applies cannot send a request for approval.
approver_user_iduuidNoPerson — Anyone who signs in to this company. They decide it from My approvals, whatever modules they have.
approver_position_iduuidNoPosition — 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.

Sample body

{
  "level_no": 10,
  "po_rule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "pr_rule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "name": "Example",
  "approver_kind": "A named person (their sign-in) — no HRMS needed"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "po_rule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "pr_rule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "level_no": 10,
  "name": "Example",
  "approver_kind": "A named person (their sign-in) — no HRMS needed",
  "approver_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "approver_role": "text",
  "may_skip_if_absent": true,
  "amount_threshold": "1250.00",
  "due_in_hours": 10,
  "notes": "text",
  "is_active": true,
  "created_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/approval-levels" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"level_no":10,"po_rule_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","pr_rule_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","name":"Example","approver_kind":"A named person (their sign-in) — no HRMS needed"}'
PUT/api/scm/approval-levels/{id}Change a approval level

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
po_rule_iduuidNoPurchase order rule
pr_rule_iduuidNoRequisition rule — A level belongs to one rule — a requisition rule, a purchase order rule or a hiring rule. Choose only one of the three.
level_nointegerYesLevel — Signatures are collected in this order. Level 2 cannot decide before level 1 has.
nametextNoWhat this level is called — e.g. "Manager 1". It is what the approver sees on the document.
approver_kindtextNoWho signs — Choose one; only the field for that choice is needed. "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)
approver_employee_iduuidNoEmployee
approver_roletextNoAnyone holding this role — A sign-in role from Administration › Roles, by its name or code — not a position in HRMS. If nobody holds it the level is skipped where it may be, and otherwise the document is refused with the reason.
may_skip_if_absentbooleanNoMay be skipped when the approver is away — On: the next level fills it. Off: the document waits until somebody is in the post — which is usually right for a final authority.
amount_thresholdnumericNoOnly at or above (inclusive) — Lets one rule say "a manager over 5,000, an executive over 50,000". "Over 1,000" is from 1,000.01.
due_in_hoursintegerNoDue within (hours)
notestextNoNotes
is_activebooleanNoActive
hr_rule_iduuidNoHiring rule — For a hiring request (HRMS > Hiring Approval Rules). Its "Only at or above" and "Only up to" are the annual cost of the vacancy. A hiring rule with no level that applies cannot send a request for approval.
approver_user_iduuidNoPerson — Anyone who signs in to this company. They decide it from My approvals, whatever modules they have.
approver_position_iduuidNoPosition — 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.

Sample body

{
  "level_no": 10,
  "po_rule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "po_rule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "pr_rule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "level_no": 10,
  "name": "Example",
  "approver_kind": "A named person (their sign-in) — no HRMS needed",
  "approver_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "approver_role": "text",
  "may_skip_if_absent": true,
  "amount_threshold": "1250.00",
  "due_in_hours": 10,
  "notes": "text",
  "is_active": true,
  "created_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/approval-levels/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"level_no":10,"po_rule_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
DELETE/api/scm/approval-levels/{id}Delete a approval level

Path parameters

NameTypeDescription
idstring (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/approval-levels/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/approval-levels/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (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, withLines

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/approval-levels/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 level, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
po_rule_iduuidread, writePurchase order rule
pr_rule_iduuidread, writeRequisition rule — A level belongs to one rule — a requisition rule, a purchase order rule or a hiring rule. Choose only one of the three.
level_nointegerread, writeLevel — Signatures are collected in this order. Level 2 cannot decide before level 1 has.
nametextread, writeWhat this level is called — e.g. "Manager 1". It is what the approver sees on the document.
approver_kindtextread, writeWho signs — Choose one; only the field for that choice is needed. "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)
approver_employee_iduuidread, writeEmployee
approver_roletextread, writeAnyone holding this role — A sign-in role from Administration › Roles, by its name or code — not a position in HRMS. If nobody holds it the level is skipped where it may be, and otherwise the document is refused with the reason.
may_skip_if_absentbooleanread, writeMay be skipped when the approver is away — On: the next level fills it. Off: the document waits until somebody is in the post — which is usually right for a final authority.
amount_thresholdnumericread, writeOnly at or above (inclusive) — Lets one rule say "a manager over 5,000, an executive over 50,000". "Over 1,000" is from 1,000.01.
due_in_hoursintegerread, writeDue within (hours)
notestextread, writeNotes
is_activebooleanread, writeActive
created_attimestamp with time zoneread onlyCreated at
hr_rule_iduuidread, writeHiring rule — For a hiring request (HRMS > Hiring Approval Rules). Its "Only at or above" and "Only up to" are the annual cost of the vacancy. A hiring rule with no level that applies cannot send a request for approval.
org_unit_iduuidread onlyOrg unit id
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
approver_user_iduuidread, writePerson — Anyone who signs in to this company. They decide it from My approvals, whatever modules they have.
approver_position_iduuidread, writePosition — 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.

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Supply Chain › Approval Levels for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.