Supply Chain · Capacity & Scheduling
Capacity Schedules
One board: this set of resources, over this window. A factory schedule, a work center schedule and a vehicle schedule are the same document with a different resource kind on it.
/api/scm/schedulesPublished as /api/v1/schedulesDownload specification (OpenAPI 3.1) Screen: Capacity Schedules
Overview
| Package | Supply Chain |
|---|---|
| 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 Supply Chain › Capacity 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 | scm.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
12 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/schedulesList capacity 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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"schedule_no": "SCH-000001",
"name": "Example",
"schedule_type": "text",
"supply_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"horizon_from": "2026-10-30T09:00:00Z",
"horizon_to": "2026-10-30T09:00:00Z",
"bucket_minutes": 10,
"resource_ids": [],
"method": "manual",
"sequencing_rule": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/schedules?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/schedules/{id}Read one 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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"schedule_no": "SCH-000001",
"name": "Example",
"schedule_type": "text",
"supply_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"horizon_from": "2026-10-30T09:00:00Z",
"horizon_to": "2026-10-30T09:00:00Z",
"bucket_minutes": 10,
"resource_ids": [],
"method": "manual",
"sequencing_rule": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/schedules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/schedulesCreate a schedules
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
name | text | Yes | Name |
schedule_type | text | No | Type |
supply_plan_id | uuid | No | Supply plan |
warehouse_id | uuid | No | Warehouse |
location_id | uuid | No | Location |
horizon_from | timestamp with time zone | Yes | Board from |
horizon_to | timestamp with time zone | Yes | Board to |
bucket_minutes | integer | No | Bucket (minutes) |
method | text | No | Built by Allowed: manual forward backward finite_forward finite_backward optimizer imported |
sequencing_rule | text | No | Sequenced by — Naming it out loud is the point: a board nobody can explain is a board nobody follows. |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"horizon_from": "2026-10-30T09:00:00Z",
"horizon_to": "2026-10-30T09:00:00Z",
"schedule_type": "text",
"supply_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"schedule_no": "SCH-000001",
"name": "Example",
"schedule_type": "text",
"supply_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"horizon_from": "2026-10-30T09:00:00Z",
"horizon_to": "2026-10-30T09:00:00Z",
"bucket_minutes": 10,
"resource_ids": [],
"method": "manual",
"sequencing_rule": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/schedules" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","horizon_from":"2026-10-30T09:00:00Z","horizon_to":"2026-10-30T09:00:00Z","schedule_type":"text","supply_plan_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","warehouse_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","location_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/scm/schedules/{id}Change a 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 |
|---|---|---|---|
name | text | Yes | Name |
schedule_type | text | No | Type |
supply_plan_id | uuid | No | Supply plan |
warehouse_id | uuid | No | Warehouse |
location_id | uuid | No | Location |
horizon_from | timestamp with time zone | Yes | Board from |
horizon_to | timestamp with time zone | Yes | Board to |
bucket_minutes | integer | No | Bucket (minutes) |
method | text | No | Built by Allowed: manual forward backward finite_forward finite_backward optimizer imported |
sequencing_rule | text | No | Sequenced by — Naming it out loud is the point: a board nobody can explain is a board nobody follows. |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"horizon_from": "2026-10-30T09:00:00Z"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"schedule_no": "SCH-000001",
"name": "Example",
"schedule_type": "text",
"supply_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"horizon_from": "2026-10-30T09:00:00Z",
"horizon_to": "2026-10-30T09:00:00Z",
"bucket_minutes": 10,
"resource_ids": [],
"method": "manual",
"sequencing_rule": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/schedules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","horizon_from":"2026-10-30T09:00:00Z"}'DELETE/api/scm/schedules/{id}Delete a 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/scm/schedules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/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/scm/schedules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'POST/api/scm/schedules/{id}/sequenceSequence
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):
source, respectDependenciesResponse
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/scm/schedules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/sequence" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"source":"value","respectDependencies":"value"}'POST/api/scm/schedules/{id}/moveMove
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):
entryId*, plannedStart, resourceId, pin, cascadeResponse
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/scm/schedules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/move" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"entryId":"value","plannedStart":"value","resourceId":"value","pin":"value","cascade":"value"}'GET/api/scm/schedules/{parentId}/entriesEntries
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/scm/schedules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/entries" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/schedules/{parentId}/entriesEntries
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, 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/scm/schedules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/entries" \
-H "Authorization: Bearer $TOKEN"PUT/api/scm/schedules/{parentId}/entries/{lineId}Entries
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, 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 PUT "https://demo.tranxact.ai/api/scm/schedules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/entries/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/scm/schedules/{parentId}/entries/{lineId}Entries
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, 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 DELETE "https://demo.tranxact.ai/api/scm/schedules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/entries/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a 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 |
org_unit_id | uuid | read only | Org unit id |
schedule_no | text | read only | Schedule no |
name | text | read, write | Name |
schedule_type | text | read, write | Type |
supply_plan_id | uuid | read, write | Supply plan |
warehouse_id | uuid | read, write | Warehouse |
location_id | uuid | read, write | Location |
horizon_from | timestamp with time zone | read, write | Board from |
horizon_to | timestamp with time zone | read, write | Board to |
bucket_minutes | integer | read, write | Bucket (minutes) |
resource_ids | _uuid | read only | Resource ids |
method | text | read, write | Built by Allowed: manual forward backward finite_forward finite_backward optimizer imported |
sequencing_rule | text | read, write | Sequenced by — Naming it out loud is the point: a board nobody can explain is a board nobody follows. |
entry_count | integer | read only | Entry count |
late_count | integer | read only | Late count |
total_setup_minutes | numeric | read only | Total setup minutes |
total_run_minutes | numeric | read only | Total run minutes |
makespan_minutes | numeric | read only | Makespan minutes |
utilization_pct | numeric | read only | Utilization pct |
published_at | timestamp with time zone | read only | Published at |
published_by | uuid | read only | Published by |
status | text | read only | Status |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
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 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
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 Supply Chain › Capacity 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.