TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/platform/approval-rule-catalogPublished as /api/v1/approval-rule-catalog

Download specification (OpenAPI 3.1) Screen: Approval Rule Catalogue

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 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.
Tablecore.approval_rule_catalog · 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-rule-catalogList approval rule catalogue

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",
      "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

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

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.

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

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-rule-catalog/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/approval-rule-catalog/{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-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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
enginetextread onlyEngine
doc_typetextread onlyDoc type
codetextread onlyCode
nametextread onlyRule name — Changes the older rule itself, on the same row its own screen edits.
priorityintegerread onlyPriority — Lower is tried first.
amount_thresholdnumericread onlyFrom amount — The rule applies above this amount.
approvertextread onlyApprover
is_activebooleanread onlyActive
kept_intextread onlyKept in
step_countintegerread onlyStep count
edit_pathtextread onlyEdit path

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 Rule Catalogue 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.