TRANXACT.AI Help

Platform · Process & Structure

Approval Document Types

What can be sent for approval. The built-in types are run by their own modules' rules (listed under Approval Rule Catalogue) or by self-service; add a type of your own by naming the table it lives in. No code needed.

Type REST6 operationsBase path /api/platform/approval-doc-typesPublished as /api/v1/approval-doc-types

Download specification (OpenAPI 3.1) Screen: Approval Document Types

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 Document Types 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_doc_types · 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-doc-typesList approval document types

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",
      "label": "text",
      "engine": "text",
      "table_name": "Example",
      "id_column": "text",
      "number_column": "text",
      "amount_column": "text",
      "currency_column": "USD",
      "party_column": "text",
      "org_unit_column": "text",
      "grant_module": "text",
      "grant_resource": "text",
      "status_column": "draft"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "label": "text",
  "engine": "text",
  "table_name": "Example",
  "id_column": "text",
  "number_column": "text",
  "amount_column": "text",
  "currency_column": "USD",
  "party_column": "text",
  "org_unit_column": "text",
  "grant_module": "text",
  "grant_resource": "text",
  "status_column": "draft"
}

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

Sample request

curl "https://demo.tranxact.ai/api/platform/approval-doc-types/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/approval-doc-typesCreate a approval document type

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
doc_typetextYesType key — Lower case, such as expense_claim or contract.
labeltextYesName
table_nametextNoTable — schema.table, such as crm.contracts. It must carry org_id.
id_columntextNoId column
number_columntextNoNumber column — The column people know the document by.
amount_columntextNoAmount column — Routes can be limited by amount when this is named.
currency_columntextNoCurrency column
party_columntextNoDescription column
org_unit_columntextNoOrg unit column — Routes can be limited to an org unit, and org-unit-manager steps need it.
grant_moduletextNoScreen module — The module of the screen the documents are kept on, such as crm.
grant_resourcetextNoScreen resource — The screen key, such as contracts. Only people who may change that screen can send one for approval.
status_columntextNoStatus column
on_approved_statustextNoStatus when approved
on_rejected_statustextNoStatus when rejected
when_no_ruletextNoWhen no route applies
Allowed: Refuse to send it (safe) Approve it automatically
allow_self_approvalbooleanNoRequester may approve their own
is_activebooleanNoActive
descriptiontextNoDescription

Sample body

{
  "doc_type": "text",
  "label": "text",
  "table_name": "Example",
  "id_column": "text",
  "number_column": "text",
  "amount_column": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "doc_type": "text",
  "label": "text",
  "engine": "text",
  "table_name": "Example",
  "id_column": "text",
  "number_column": "text",
  "amount_column": "text",
  "currency_column": "USD",
  "party_column": "text",
  "org_unit_column": "text",
  "grant_module": "text",
  "grant_resource": "text",
  "status_column": "draft"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/approval-doc-types" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"doc_type":"text","label":"text","table_name":"Example","id_column":"text","number_column":"text","amount_column":"text"}'
PUT/api/platform/approval-doc-types/{id}Change a approval document type

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_typetextYesType key — Lower case, such as expense_claim or contract.
labeltextYesName
table_nametextNoTable — schema.table, such as crm.contracts. It must carry org_id.
id_columntextNoId column
number_columntextNoNumber column — The column people know the document by.
amount_columntextNoAmount column — Routes can be limited by amount when this is named.
currency_columntextNoCurrency column
party_columntextNoDescription column
org_unit_columntextNoOrg unit column — Routes can be limited to an org unit, and org-unit-manager steps need it.
grant_moduletextNoScreen module — The module of the screen the documents are kept on, such as crm.
grant_resourcetextNoScreen resource — The screen key, such as contracts. Only people who may change that screen can send one for approval.
status_columntextNoStatus column
on_approved_statustextNoStatus when approved
on_rejected_statustextNoStatus when rejected
when_no_ruletextNoWhen no route applies
Allowed: Refuse to send it (safe) Approve it automatically
allow_self_approvalbooleanNoRequester may approve their own
is_activebooleanNoActive
descriptiontextNoDescription

Sample body

{
  "doc_type": "text",
  "label": "text"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "doc_type": "text",
  "label": "text",
  "engine": "text",
  "table_name": "Example",
  "id_column": "text",
  "number_column": "text",
  "amount_column": "text",
  "currency_column": "USD",
  "party_column": "text",
  "org_unit_column": "text",
  "grant_module": "text",
  "grant_resource": "text",
  "status_column": "draft"
}

Sample request

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

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-doc-types/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/approval-doc-types/{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-doc-types/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 document type, 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, writeType key — Lower case, such as expense_claim or contract.
labeltextread, writeName
enginetextread onlyEngine
table_nametextread, writeTable — schema.table, such as crm.contracts. It must carry org_id.
id_columntextread, writeId column
number_columntextread, writeNumber column — The column people know the document by.
amount_columntextread, writeAmount column — Routes can be limited by amount when this is named.
currency_columntextread, writeCurrency column
party_columntextread, writeDescription column
org_unit_columntextread, writeOrg unit column — Routes can be limited to an org unit, and org-unit-manager steps need it.
grant_moduletextread, writeScreen module — The module of the screen the documents are kept on, such as crm.
grant_resourcetextread, writeScreen resource — The screen key, such as contracts. Only people who may change that screen can send one for approval.
status_columntextread, writeStatus column
on_approved_statustextread, writeStatus when approved
on_rejected_statustextread, writeStatus when rejected
when_no_ruletextread, writeWhen no route applies
Allowed: Refuse to send it (safe) Approve it automatically
allow_self_approvalbooleanread, writeRequester may approve their own
is_builtinbooleanread onlyIs builtin
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 › Approval Document Types 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.