Platform · Batch
Job Schedules
When each job runs without anybody starting it. Every one of these fires in the background as the person who created it, so it may take as long as it takes — which is the point for a large file read off a drive, or a folder somebody drops one into every morning. "State" says whether it is waiting, running, overdue or paused; overdue for long means the API is not running the scheduler.
/api/platform/batch-schedulesPublished as /api/v1/batch-schedulesOverview
| 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 › Job Schedules 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 | batch.job_schedules · 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
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/platform/batch-schedulesList job schedules
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",
"job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"name": "Example",
"cadence": "once",
"run_at": "text",
"day_of_week": 10,
"day_of_month": 10,
"parameters": {},
"dry_run": true,
"is_active": true,
"last_run_at": "2026-10-30T09:00:00Z",
"next_due": "2026-10-30T09:00:00Z",
"created_at": "2026-10-30T09:00:00Z",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/platform/batch-schedules?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/batch-schedules/{id}Read one batch schedules
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",
"job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"name": "Example",
"cadence": "once",
"run_at": "text",
"day_of_week": 10,
"day_of_month": 10,
"parameters": {},
"dry_run": true,
"is_active": true,
"last_run_at": "2026-10-30T09:00:00Z",
"next_due": "2026-10-30T09:00:00Z",
"created_at": "2026-10-30T09:00:00Z",
"org_unit_id": "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/batch-schedules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/batch-schedulesCreate a batch schedules
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
job_id | uuid | Yes | Job |
name | text | No | Name |
cadence | text | No | Cadence Allowed: once every_15_min hourly daily weekly monthly quarterly annually on_demand |
run_at | time without time zone | No | At — Time of day, in the zone below. |
day_of_week | integer | No | Day of week — 0 is Sunday. |
day_of_month | integer | No | Day of month — 31 in a 30-day month is that month’s last day, not the 1st of the next. |
dry_run | boolean | No | Rehearse only |
is_active | boolean | No | Active |
description | text | No | What it is for |
starts_at | timestamp with time zone | No | When (a one-off) |
time_zone | text | No | Time zone — Empty means UTC — and 02:00 UTC in Riyadh is 05:00. Allowed: UTC Africa/Abidjan Africa/Accra Africa/Addis_Ababa Africa/Algiers Africa/Asmera Africa/Bamako Africa/Bangui Africa/Banjul Africa/Bissau Africa/Blantyre Africa/Brazzaville |
Sample body
{
"job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"name": "Example",
"cadence": "once",
"run_at": "text",
"day_of_week": 10
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"name": "Example",
"cadence": "once",
"run_at": "text",
"day_of_week": 10,
"day_of_month": 10,
"parameters": {},
"dry_run": true,
"is_active": true,
"last_run_at": "2026-10-30T09:00:00Z",
"next_due": "2026-10-30T09:00:00Z",
"created_at": "2026-10-30T09:00:00Z",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/batch-schedules" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"job_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","name":"Example","cadence":"once","run_at":"text","day_of_week":10}'PUT/api/platform/batch-schedules/{id}Change a batch schedules
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 |
|---|---|---|---|
job_id | uuid | Yes | Job |
name | text | No | Name |
cadence | text | No | Cadence Allowed: once every_15_min hourly daily weekly monthly quarterly annually on_demand |
run_at | time without time zone | No | At — Time of day, in the zone below. |
day_of_week | integer | No | Day of week — 0 is Sunday. |
day_of_month | integer | No | Day of month — 31 in a 30-day month is that month’s last day, not the 1st of the next. |
dry_run | boolean | No | Rehearse only |
is_active | boolean | No | Active |
description | text | No | What it is for |
starts_at | timestamp with time zone | No | When (a one-off) |
time_zone | text | No | Time zone — Empty means UTC — and 02:00 UTC in Riyadh is 05:00. Allowed: UTC Africa/Abidjan Africa/Accra Africa/Addis_Ababa Africa/Algiers Africa/Asmera Africa/Bamako Africa/Bangui Africa/Banjul Africa/Bissau Africa/Blantyre Africa/Brazzaville |
Sample body
{
"job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"name": "Example",
"cadence": "once",
"run_at": "text",
"day_of_week": 10,
"day_of_month": 10,
"parameters": {},
"dry_run": true,
"is_active": true,
"last_run_at": "2026-10-30T09:00:00Z",
"next_due": "2026-10-30T09:00:00Z",
"created_at": "2026-10-30T09:00:00Z",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/platform/batch-schedules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"job_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","name":"Example"}'DELETE/api/platform/batch-schedules/{id}Delete a batch schedules
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/batch-schedules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/batch-schedules/{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/batch-schedules/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 batch schedules, 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 |
job_id | uuid | read, write | Job |
name | text | read, write | Name |
cadence | text | read, write | Cadence Allowed: once every_15_min hourly daily weekly monthly quarterly annually on_demand |
run_at | time without time zone | read, write | At — Time of day, in the zone below. |
day_of_week | integer | read, write | Day of week — 0 is Sunday. |
day_of_month | integer | read, write | Day of month — 31 in a 30-day month is that month’s last day, not the 1st of the next. |
parameters | jsonb | read only | Parameters |
dry_run | boolean | read, write | Rehearse only |
is_active | boolean | read, write | Active |
last_run_at | timestamp with time zone | read only | Last run at |
next_due | timestamp with time zone | read only | Next due |
created_at | timestamp with time zone | read only | Created at |
org_unit_id | uuid | read only | Org unit id |
description | text | read, write | What it is for |
starts_at | timestamp with time zone | read, write | When (a one-off) |
run_once | boolean | read only | Run once |
run_as | uuid | read only | Run as |
created_by | uuid | read only | Created by |
origin | text | read only | Origin |
origin_ref | jsonb | read only | Origin ref |
claimed_at | timestamp with time zone | read only | Claimed at |
claimed_by | text | read only | Claimed by |
last_run_id | uuid | read only | Last run id |
last_status | text | read only | Last status |
last_error | text | read only | Last error |
run_count | integer | read only | Run count |
time_zone | text | read, write | Time zone — Empty means UTC — and 02:00 UTC in Riyadh is 05:00. Allowed: UTC Africa/Abidjan Africa/Accra Africa/Addis_Ababa Africa/Algiers Africa/Asmera Africa/Bamako Africa/Bangui Africa/Banjul Africa/Bissau Africa/Blantyre Africa/Brazzaville |
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 › Job Schedules 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.