TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/platform/batch-schedulesPublished as /api/v1/batch-schedules

Download specification (OpenAPI 3.1) Screen: Job Schedules

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 › 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.
Tablebatch.job_schedules · 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/batch-schedulesList job schedules

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",
      "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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
job_iduuidYesJob
nametextNoName
cadencetextNoCadence
Allowed: once every_15_min hourly daily weekly monthly quarterly annually on_demand
run_attime without time zoneNoAt — Time of day, in the zone below.
day_of_weekintegerNoDay of week — 0 is Sunday.
day_of_monthintegerNoDay of month — 31 in a 30-day month is that month’s last day, not the 1st of the next.
dry_runbooleanNoRehearse only
is_activebooleanNoActive
descriptiontextNoWhat it is for
starts_attimestamp with time zoneNoWhen (a one-off)
time_zonetextNoTime 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

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
job_iduuidYesJob
nametextNoName
cadencetextNoCadence
Allowed: once every_15_min hourly daily weekly monthly quarterly annually on_demand
run_attime without time zoneNoAt — Time of day, in the zone below.
day_of_weekintegerNoDay of week — 0 is Sunday.
day_of_monthintegerNoDay of month — 31 in a 30-day month is that month’s last day, not the 1st of the next.
dry_runbooleanNoRehearse only
is_activebooleanNoActive
descriptiontextNoWhat it is for
starts_attimestamp with time zoneNoWhen (a one-off)
time_zonetextNoTime 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

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/batch-schedules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/batch-schedules/{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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
job_iduuidread, writeJob
nametextread, writeName
cadencetextread, writeCadence
Allowed: once every_15_min hourly daily weekly monthly quarterly annually on_demand
run_attime without time zoneread, writeAt — Time of day, in the zone below.
day_of_weekintegerread, writeDay of week — 0 is Sunday.
day_of_monthintegerread, writeDay of month — 31 in a 30-day month is that month’s last day, not the 1st of the next.
parametersjsonbread onlyParameters
dry_runbooleanread, writeRehearse only
is_activebooleanread, writeActive
last_run_attimestamp with time zoneread onlyLast run at
next_duetimestamp with time zoneread onlyNext due
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
descriptiontextread, writeWhat it is for
starts_attimestamp with time zoneread, writeWhen (a one-off)
run_oncebooleanread onlyRun once
run_asuuidread onlyRun as
created_byuuidread onlyCreated by
origintextread onlyOrigin
origin_refjsonbread onlyOrigin ref
claimed_attimestamp with time zoneread onlyClaimed at
claimed_bytextread onlyClaimed by
last_run_iduuidread onlyLast run id
last_statustextread onlyLast status
last_errortextread onlyLast error
run_countintegerread onlyRun count
time_zonetextread, writeTime 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_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 › Job Schedules 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.