Supply Chain · Reachable by link
Schedule Entries
One bar on the Gantt. What makes it a schedule rather than a calendar is the dependency: operation 20 cannot start before operation 10 has finished.
/api/scm/schedule-entriesPublished as /api/v1/schedule-entriesDownload specification (OpenAPI 3.1) Screen: Schedule Entries
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 › Schedule Entries 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.schedule_entries · 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/scm/schedule-entriesList schedule entries
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",
"schedule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"resource_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"entry_no": 10,
"sequence_no": 10,
"entry_type": "operation",
"production_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"production_operation_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"planned_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"route_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"label": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/schedule-entries?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/schedule-entries/{id}Read one schedule entry
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",
"schedule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"resource_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"entry_no": 10,
"sequence_no": 10,
"entry_type": "operation",
"production_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"production_operation_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"planned_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"route_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"label": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/schedule-entries/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/schedule-entriesCreate a schedule entry
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
schedule_id | uuid | Yes | Schedule |
resource_id | uuid | Yes | Resource |
entry_no | integer | No | Entry no |
sequence_no | integer | No | Sequence |
entry_type | text | No | Type Allowed: operation setup run maintenance break trip stop loading unloading changeover idle blocked |
production_order_id | uuid | No | Production order id |
production_operation_id | uuid | No | Production operation id |
planned_order_id | uuid | No | Planned order id |
load_id | uuid | No | Load id |
route_id | uuid | No | Route id |
warehouse_order_id | uuid | No | Warehouse order id |
item_id | uuid | No | Item id |
label | text | Yes | What |
reference_no | text | No | Reference |
quantity | numeric | No | Quantity |
uom_id | uuid | No | Uom id |
planned_start | timestamp with time zone | Yes | Start |
planned_end | timestamp with time zone | Yes | End |
actual_start | timestamp with time zone | No | Actual start |
actual_end | timestamp with time zone | No | Actual end |
setup_minutes | numeric | No | Setup minutes |
run_minutes | numeric | No | Run minutes |
earliest_start | timestamp with time zone | No | Earliest start |
due_at | timestamp with time zone | No | Due |
depends_on_id | uuid | No | Cannot start before |
is_pinned | boolean | No | Pinned — do not move it |
color | text | No | Color |
progress_pct | numeric | No | Progress % |
status | text | No | Status Allowed: planned released in_progress paused completed late blocked cancelled |
notes | text | No | Notes |
Sample body
{
"schedule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"resource_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"label": "text",
"planned_start": "2026-10-30T09:00:00Z",
"planned_end": "2026-10-30T09:00:00Z",
"entry_no": 10,
"sequence_no": 10,
"entry_type": "operation"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"schedule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"resource_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"entry_no": 10,
"sequence_no": 10,
"entry_type": "operation",
"production_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"production_operation_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"planned_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"route_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"label": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/schedule-entries" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"schedule_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","resource_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","label":"text","planned_start":"2026-10-30T09:00:00Z","planned_end":"2026-10-30T09:00:00Z","entry_no":10,"sequence_no":10,"entry_type":"operation"}'PUT/api/scm/schedule-entries/{id}Change a schedule entry
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 |
|---|---|---|---|
schedule_id | uuid | Yes | Schedule |
resource_id | uuid | Yes | Resource |
entry_no | integer | No | Entry no |
sequence_no | integer | No | Sequence |
entry_type | text | No | Type Allowed: operation setup run maintenance break trip stop loading unloading changeover idle blocked |
production_order_id | uuid | No | Production order id |
production_operation_id | uuid | No | Production operation id |
planned_order_id | uuid | No | Planned order id |
load_id | uuid | No | Load id |
route_id | uuid | No | Route id |
warehouse_order_id | uuid | No | Warehouse order id |
item_id | uuid | No | Item id |
label | text | Yes | What |
reference_no | text | No | Reference |
quantity | numeric | No | Quantity |
uom_id | uuid | No | Uom id |
planned_start | timestamp with time zone | Yes | Start |
planned_end | timestamp with time zone | Yes | End |
actual_start | timestamp with time zone | No | Actual start |
actual_end | timestamp with time zone | No | Actual end |
setup_minutes | numeric | No | Setup minutes |
run_minutes | numeric | No | Run minutes |
earliest_start | timestamp with time zone | No | Earliest start |
due_at | timestamp with time zone | No | Due |
depends_on_id | uuid | No | Cannot start before |
is_pinned | boolean | No | Pinned — do not move it |
color | text | No | Color |
progress_pct | numeric | No | Progress % |
status | text | No | Status Allowed: planned released in_progress paused completed late blocked cancelled |
notes | text | No | Notes |
Sample body
{
"schedule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"resource_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"schedule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"resource_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"entry_no": 10,
"sequence_no": 10,
"entry_type": "operation",
"production_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"production_operation_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"planned_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"route_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"label": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/schedule-entries/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"schedule_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","resource_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/scm/schedule-entries/{id}Delete a schedule entry
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/schedule-entries/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/schedule-entries/{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/schedule-entries/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 schedule entry, 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 |
schedule_id | uuid | read, write | Schedule |
resource_id | uuid | read, write | Resource |
entry_no | integer | read, write | Entry no |
sequence_no | integer | read, write | Sequence |
entry_type | text | read, write | Type Allowed: operation setup run maintenance break trip stop loading unloading changeover idle blocked |
production_order_id | uuid | read, write | Production order id |
production_operation_id | uuid | read, write | Production operation id |
planned_order_id | uuid | read, write | Planned order id |
load_id | uuid | read, write | Load id |
route_id | uuid | read, write | Route id |
warehouse_order_id | uuid | read, write | Warehouse order id |
item_id | uuid | read, write | Item id |
label | text | read, write | What |
reference_no | text | read, write | Reference |
quantity | numeric | read, write | Quantity |
uom_id | uuid | read, write | Uom id |
planned_start | timestamp with time zone | read, write | Start |
planned_end | timestamp with time zone | read, write | End |
actual_start | timestamp with time zone | read, write | Actual start |
actual_end | timestamp with time zone | read, write | Actual end |
setup_minutes | numeric | read, write | Setup minutes |
run_minutes | numeric | read, write | Run minutes |
earliest_start | timestamp with time zone | read, write | Earliest start |
due_at | timestamp with time zone | read, write | Due |
slack_minutes | numeric | read only | Slack minutes |
is_late | boolean | read only | Is late |
is_critical | boolean | read only | Is critical |
depends_on_id | uuid | read, write | Cannot start before |
is_pinned | boolean | read, write | Pinned — do not move it |
color | text | read, write | Color |
progress_pct | numeric | read, write | Progress % |
status | text | read, write | Status Allowed: planned released in_progress paused completed late blocked cancelled |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
org_unit_id | uuid | read only | Org unit id |
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 › Schedule Entries 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.