Platform · Automation
Document Intake
Folders and mailboxes whose documents become DRAFTS: a supplier invoice, a sales order. Nothing is ever posted; the file is attached to the draft it made.
/api/platform/intake-sourcesPublished as /api/v1/intake-sourcesDownload specification (OpenAPI 3.1) Screen: Document Intake
Overview
| Package | Platform |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Platform › Document Intake 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. |
| Table | platform.intake_sources · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
8 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/platform/intake-sourcesList document intake
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"kind": "A folder on a connected drive",
"drive_source_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"folder_path": "text",
"mailbox_address": "text",
"target_kind": "text",
"poll_minutes": 10,
"next_poll_at": "2026-10-30T09:00:00Z",
"claimed_by": "text",
"claimed_at": "2026-10-30T09:00:00Z",
"last_polled_at": "2026-10-30T09:00:00Z"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/platform/intake-sources?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/intake-sources/{id}Read one intake source
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"kind": "A folder on a connected drive",
"drive_source_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"folder_path": "text",
"mailbox_address": "text",
"target_kind": "text",
"poll_minutes": 10,
"next_poll_at": "2026-10-30T09:00:00Z",
"claimed_by": "text",
"claimed_at": "2026-10-30T09:00:00Z",
"last_polled_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/intake-sources/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/intake-sourcesCreate a intake source
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code — e.g. AP-INBOX |
name | text | Yes | Name |
kind | text | No | Kind Allowed: A folder on a connected drive A mailbox (messages handed in by the mail gateway) |
drive_source_id | uuid | No | Drive |
folder_path | text | No | Folder — The folder watched, as the drive names it. |
mailbox_address | text | No | Mailbox address |
target_kind | text | Yes | Makes |
poll_minutes | integer | No | Check every (minutes) |
is_active | boolean | No | Active |
Sample body
{
"code": "COD-000001",
"name": "Example",
"target_kind": "text",
"kind": "A folder on a connected drive",
"drive_source_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"folder_path": "text",
"mailbox_address": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"kind": "A folder on a connected drive",
"drive_source_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"folder_path": "text",
"mailbox_address": "text",
"target_kind": "text",
"poll_minutes": 10,
"next_poll_at": "2026-10-30T09:00:00Z",
"claimed_by": "text",
"claimed_at": "2026-10-30T09:00:00Z",
"last_polled_at": "2026-10-30T09:00:00Z"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/intake-sources" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","target_kind":"text","kind":"A folder on a connected drive","drive_source_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","folder_path":"text","mailbox_address":"text"}'PUT/api/platform/intake-sources/{id}Change a intake source
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code — e.g. AP-INBOX |
name | text | Yes | Name |
kind | text | No | Kind Allowed: A folder on a connected drive A mailbox (messages handed in by the mail gateway) |
drive_source_id | uuid | No | Drive |
folder_path | text | No | Folder — The folder watched, as the drive names it. |
mailbox_address | text | No | Mailbox address |
target_kind | text | Yes | Makes |
poll_minutes | integer | No | Check every (minutes) |
is_active | boolean | No | Active |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"kind": "A folder on a connected drive",
"drive_source_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"folder_path": "text",
"mailbox_address": "text",
"target_kind": "text",
"poll_minutes": 10,
"next_poll_at": "2026-10-30T09:00:00Z",
"claimed_by": "text",
"claimed_at": "2026-10-30T09:00:00Z",
"last_polled_at": "2026-10-30T09:00:00Z"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/platform/intake-sources/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/platform/intake-sources/{id}Delete a intake source
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/intake-sources/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/intake-sources/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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, withLinesResponse
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/intake-sources/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'POST/api/platform/intake-sources/{id}/pollPoll
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
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/intake-sources/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/poll" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/intake-sources/{id}/receiveReceive
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
attachments, file, messageIdResponse
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/intake-sources/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/receive" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"attachments":"value","file":"value","messageId":"value"}'Data model
Every field of a intake source, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
code | text | read, write | Code — e.g. AP-INBOX |
name | text | read, write | Name |
kind | text | read, write | Kind Allowed: A folder on a connected drive A mailbox (messages handed in by the mail gateway) |
drive_source_id | uuid | read, write | Drive |
folder_path | text | read, write | Folder — The folder watched, as the drive names it. |
mailbox_address | text | read, write | Mailbox address |
target_kind | text | read, write | Makes |
poll_minutes | integer | read, write | Check every (minutes) |
next_poll_at | timestamp with time zone | read only | Next poll at |
claimed_by | text | read only | Claimed by |
claimed_at | timestamp with time zone | read only | Claimed at |
last_polled_at | timestamp with time zone | read only | Last polled at |
last_error | text | read only | Last error |
items_count | integer | read only | Items count |
is_active | boolean | read, write | Active |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Platform › Document Intake for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused 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.