TRANXACT.AI Help

Platform · Process & Structure

Approval Steps

Who decides, in what order. Steps with the same level number are parallel (all must approve). Name a fallback for when the approver has left, is the requester, or the role is empty.

Type REST6 operationsBase path /api/platform/approval-route-stepsPublished as /api/v1/approval-route-steps

Download specification (OpenAPI 3.1) Screen: Approval Steps

Overview

PackagePlatform
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 Platform › Approval Steps 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.
Tablecore.approval_route_steps · 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/platform/approval-route-stepsList approval steps

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",
      "route_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "level_no": 10,
      "name": "Example",
      "approver_kind": "A named person",
      "approver_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "approver_role": "text",
      "manager_levels": 10,
      "fallback_kind": "A named person",
      "fallback_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "fallback_role": "text",
      "amount_threshold": "1250.00",
      "due_in_hours": 10,
      "is_active": true
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "route_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "level_no": 10,
  "name": "Example",
  "approver_kind": "A named person",
  "approver_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "approver_role": "text",
  "manager_levels": 10,
  "fallback_kind": "A named person",
  "fallback_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "fallback_role": "text",
  "amount_threshold": "1250.00",
  "due_in_hours": 10,
  "is_active": true
}

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

Sample request

curl "https://demo.tranxact.ai/api/platform/approval-route-steps/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/approval-route-stepsCreate a approval step

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
route_iduuidYesRoute
level_nointegerYesLevel
nametextNoStep name
approver_kindtextYesApprover
Allowed: A named person Anybody holding a role The requester's manager (N levels up) The manager of the document's org unit
approver_user_iduuidNoNamed person
approver_roletextNoRole code
manager_levelsintegerNoManagers up — 1 is the direct manager, 2 their manager.
fallback_kindtextNoFallback
Allowed: A named person Anybody holding a role
fallback_user_iduuidNoFallback person
fallback_roletextNoFallback role code
amount_thresholdnumericNoOnly above amount — The step applies only to documents above this amount; 0 is always.
due_in_hoursintegerNoDue in (hours)
is_activebooleanNoActive

Sample body

{
  "route_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "level_no": 10,
  "approver_kind": "A named person",
  "name": "Example",
  "approver_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "approver_role": "text",
  "manager_levels": 10
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "route_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "level_no": 10,
  "name": "Example",
  "approver_kind": "A named person",
  "approver_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "approver_role": "text",
  "manager_levels": 10,
  "fallback_kind": "A named person",
  "fallback_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "fallback_role": "text",
  "amount_threshold": "1250.00",
  "due_in_hours": 10,
  "is_active": true
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/approval-route-steps" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"route_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","level_no":10,"approver_kind":"A named person","name":"Example","approver_user_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","approver_role":"text","manager_levels":10}'
PUT/api/platform/approval-route-steps/{id}Change a approval step

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
route_iduuidYesRoute
level_nointegerYesLevel
nametextNoStep name
approver_kindtextYesApprover
Allowed: A named person Anybody holding a role The requester's manager (N levels up) The manager of the document's org unit
approver_user_iduuidNoNamed person
approver_roletextNoRole code
manager_levelsintegerNoManagers up — 1 is the direct manager, 2 their manager.
fallback_kindtextNoFallback
Allowed: A named person Anybody holding a role
fallback_user_iduuidNoFallback person
fallback_roletextNoFallback role code
amount_thresholdnumericNoOnly above amount — The step applies only to documents above this amount; 0 is always.
due_in_hoursintegerNoDue in (hours)
is_activebooleanNoActive

Sample body

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "route_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "level_no": 10,
  "name": "Example",
  "approver_kind": "A named person",
  "approver_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "approver_role": "text",
  "manager_levels": 10,
  "fallback_kind": "A named person",
  "fallback_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "fallback_role": "text",
  "amount_threshold": "1250.00",
  "due_in_hours": 10,
  "is_active": true
}

Sample request

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

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/platform/approval-route-steps/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/approval-route-steps/{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/platform/approval-route-steps/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 step, 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
route_iduuidread, writeRoute
level_nointegerread, writeLevel
nametextread, writeStep name
approver_kindtextread, writeApprover
Allowed: A named person Anybody holding a role The requester's manager (N levels up) The manager of the document's org unit
approver_user_iduuidread, writeNamed person
approver_roletextread, writeRole code
manager_levelsintegerread, writeManagers up — 1 is the direct manager, 2 their manager.
fallback_kindtextread, writeFallback
Allowed: A named person Anybody holding a role
fallback_user_iduuidread, writeFallback person
fallback_roletextread, writeFallback role code
amount_thresholdnumericread, writeOnly above amount — The step applies only to documents above this amount; 0 is always.
due_in_hoursintegerread, writeDue in (hours)
is_activebooleanread, writeActive
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
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

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 Platform › Approval Steps 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.