TRANXACT.AI Help

Platform · Process & Structure

Status Transitions

A move from one status to another with a name: who may make it, the fields that must be filled first, a condition the record must meet, and whether a note is needed. A move named like a built-in verb (confirm, close) also lets that built-in action start from this status. Moves are made through the move route and ASK.

Type REST6 operationsBase path /api/platform/status-transitionsPublished as /api/v1/status-transitions

Download specification (OpenAPI 3.1) Screen: Status Transitions

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 › Status Transitions 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.status_transitions · 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/status-transitionsList status transitions

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",
      "from_code": "FRO-000001",
      "to_code": "TO-000001",
      "verb": "text",
      "label": "text",
      "allowed_roles": [],
      "required_fields": [],
      "guard_expr": "text",
      "require_note": true,
      "is_active": true,
      "description": "text",
      "created_at": "2026-10-30T09:00:00Z",
      "created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "from_code": "FRO-000001",
  "to_code": "TO-000001",
  "verb": "text",
  "label": "text",
  "allowed_roles": [],
  "required_fields": [],
  "guard_expr": "text",
  "require_note": true,
  "is_active": true,
  "description": "text",
  "created_at": "2026-10-30T09:00:00Z",
  "created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

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

Sample request

curl "https://demo.tranxact.ai/api/platform/status-transitions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/status-transitionsCreate a status transition

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
doc_typetextYesDocument
from_codetextNoFrom status — Empty means from any status.
to_codetextYesTo status
verbtextYesVerb — The action name, such as hold or release.
labeltextYesLabel
allowed_roles_textNoRoles that may — Comma separated role codes. Empty means anybody who may change the screen.
required_fields_textNoFields that must be filled — Comma separated column names that must hold a value before the move.
guard_exprtextNoCondition — Optional, in the expression language over the record, such as total < 50000.
require_notebooleanNoAsk for a note
is_activebooleanNoActive
descriptiontextNoDescription

Sample body

{
  "doc_type": "text",
  "to_code": "TO-000001",
  "verb": "text",
  "label": "text",
  "from_code": "FRO-000001",
  "allowed_roles": [],
  "required_fields": [],
  "guard_expr": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "doc_type": "text",
  "from_code": "FRO-000001",
  "to_code": "TO-000001",
  "verb": "text",
  "label": "text",
  "allowed_roles": [],
  "required_fields": [],
  "guard_expr": "text",
  "require_note": true,
  "is_active": true,
  "description": "text",
  "created_at": "2026-10-30T09:00:00Z",
  "created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/status-transitions" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"doc_type":"text","to_code":"TO-000001","verb":"text","label":"text","from_code":"FRO-000001","allowed_roles":[],"required_fields":[],"guard_expr":"text"}'
PUT/api/platform/status-transitions/{id}Change a status transition

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
doc_typetextYesDocument
from_codetextNoFrom status — Empty means from any status.
to_codetextYesTo status
verbtextYesVerb — The action name, such as hold or release.
labeltextYesLabel
allowed_roles_textNoRoles that may — Comma separated role codes. Empty means anybody who may change the screen.
required_fields_textNoFields that must be filled — Comma separated column names that must hold a value before the move.
guard_exprtextNoCondition — Optional, in the expression language over the record, such as total < 50000.
require_notebooleanNoAsk for a note
is_activebooleanNoActive
descriptiontextNoDescription

Sample body

{
  "doc_type": "text",
  "to_code": "TO-000001"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "doc_type": "text",
  "from_code": "FRO-000001",
  "to_code": "TO-000001",
  "verb": "text",
  "label": "text",
  "allowed_roles": [],
  "required_fields": [],
  "guard_expr": "text",
  "require_note": true,
  "is_active": true,
  "description": "text",
  "created_at": "2026-10-30T09:00:00Z",
  "created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/platform/status-transitions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"doc_type":"text","to_code":"TO-000001"}'
DELETE/api/platform/status-transitions/{id}Delete a status transition

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/status-transitions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/status-transitions/{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/status-transitions/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 status transition, 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, writeDocument
from_codetextread, writeFrom status — Empty means from any status.
to_codetextread, writeTo status
verbtextread, writeVerb — The action name, such as hold or release.
labeltextread, writeLabel
allowed_roles_textread, writeRoles that may — Comma separated role codes. Empty means anybody who may change the screen.
required_fields_textread, writeFields that must be filled — Comma separated column names that must hold a value before the move.
guard_exprtextread, writeCondition — Optional, in the expression language over the record, such as total < 50000.
require_notebooleanread, writeAsk for a note
is_activebooleanread, writeActive
descriptiontextread, writeDescription
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 › Status Transitions 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.