TRANXACT.AI Help

Platform · Process & Structure

Approval Requests

Every document sent through this company's own routes, and where it stands. Approvers decide in My approvals.

Type REST6 operationsBase path /api/platform/approval-requestsPublished as /api/v1/approval-requests

Download specification (OpenAPI 3.1) Screen: Approval Requests

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 Requests 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_request_board · 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-requestsList approval requests

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",
      "doc_type": "text",
      "doc_label": "text",
      "doc_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "doc_no": "DOC-000001",
      "summary": "text",
      "amount": "1250.00",
      "currency": "USD",
      "route_name": "Example",
      "status": "draft",
      "requested_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "requested_by_name": "Example",
      "requested_at": "2026-10-30T09:00:00Z",
      "decided_at": "2026-10-30T09:00:00Z"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "doc_type": "text",
  "doc_label": "text",
  "doc_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "doc_no": "DOC-000001",
  "summary": "text",
  "amount": "1250.00",
  "currency": "USD",
  "route_name": "Example",
  "status": "draft",
  "requested_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requested_by_name": "Example",
  "requested_at": "2026-10-30T09:00:00Z",
  "decided_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/platform/approval-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/approval-requestsCreate a approval request

Request body

The record as JSON. Fields marked Yes are required.

No body.

Sample body

{}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "doc_type": "text",
  "doc_label": "text",
  "doc_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "doc_no": "DOC-000001",
  "summary": "text",
  "amount": "1250.00",
  "currency": "USD",
  "route_name": "Example",
  "status": "draft",
  "requested_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requested_by_name": "Example",
  "requested_at": "2026-10-30T09:00:00Z",
  "decided_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/approval-requests" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
PUT/api/platform/approval-requests/{id}Change a approval request

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",
  "doc_type": "text",
  "doc_label": "text",
  "doc_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "doc_no": "DOC-000001",
  "summary": "text",
  "amount": "1250.00",
  "currency": "USD",
  "route_name": "Example",
  "status": "draft",
  "requested_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requested_by_name": "Example",
  "requested_at": "2026-10-30T09:00:00Z",
  "decided_at": "2026-10-30T09:00:00Z"
}

Sample request

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

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-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/approval-requests/{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-requests/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 request, 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
doc_typetextread onlyDoc type
doc_labeltextread onlyDoc label
doc_iduuidread onlyDoc id
doc_notextread onlyDoc no
summarytextread onlySummary
amountnumericread onlyAmount
currencytextread onlyCurrency
route_nametextread onlyRoute name
statustextread onlyStatus
requested_byuuidread onlyRequested by
requested_by_nametextread onlyRequested by name
requested_attimestamp with time zoneread onlyRequested at
decided_attimestamp with time zoneread onlyDecided at
outcome_notetextread onlyOutcome note
chaintextread onlyChain

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 Requests 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.