Manufacturing · Master Scheduling
Master Production Schedules
What the plant commits to finish, period by period. The consumption rule is the whole point: a company that adds forecast to orders builds everything twice.
/api/mfg/master-schedulesPublished as /api/v1/master-schedulesDownload specification (OpenAPI 3.1) Screen: Master Production Schedules
Overview
| Package | Manufacturing |
|---|---|
| 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 Manufacturing › Master Production 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 | mfg.master_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
13 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/mfg/master-schedulesList master production 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",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"product_family": "text",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"demand_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bucket": "week",
"horizon_from": "2026-10-30",
"horizon_to": "2026-10-30",
"demand_time_fence_days": 10,
"planning_time_fence_days": 10,
"consumption_rule": "consume_forward"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/mfg/master-schedules?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/mfg/master-schedules/{id}Read one master schedule
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",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"product_family": "text",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"demand_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bucket": "week",
"horizon_from": "2026-10-30",
"horizon_to": "2026-10-30",
"demand_time_fence_days": 10,
"planning_time_fence_days": 10,
"consumption_rule": "consume_forward"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/mfg/master-schedules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/master-schedulesCreate a master schedule
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
name | text | Yes | Name |
item_id | uuid | No | Item |
product_family | text | No | Product family — For a plant-level schedule covering a family rather than one item. |
warehouse_id | uuid | No | Warehouse |
demand_plan_id | uuid | No | Demand plan — Where the forecast comes from, so a change to it is traceable into the schedule rather than retyped. |
bucket | text | No | Bucket Allowed: week day month |
horizon_from | date | Yes | Horizon from |
horizon_to | date | Yes | Horizon to |
demand_time_fence_days | integer | No | Demand time fence (days) — Inside it the forecast is ignored and only real orders count. |
planning_time_fence_days | integer | No | Planning time fence (days) — Inside it the system may not move supply on its own. Without it, every re-run reschedules the job on the machine. |
consumption_rule | text | No | Consumption rule Allowed: consume_forward consume_backward consume_both greater_of sum |
consumption_days_forward | integer | No | Consume forward (days) |
consumption_days_backward | integer | No | Consume backward (days) |
safety_stock | numeric | No | Safety stock |
target_dos | numeric | No | Target days of supply |
planner_id | uuid | No | Planner |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"horizon_from": "2026-10-30",
"horizon_to": "2026-10-30",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"product_family": "text",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"demand_plan_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",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"product_family": "text",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"demand_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bucket": "week",
"horizon_from": "2026-10-30",
"horizon_to": "2026-10-30",
"demand_time_fence_days": 10,
"planning_time_fence_days": 10,
"consumption_rule": "consume_forward"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/mfg/master-schedules" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","horizon_from":"2026-10-30","horizon_to":"2026-10-30","item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","product_family":"text","warehouse_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","demand_plan_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/mfg/master-schedules/{id}Change a master schedule
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 |
item_id | uuid | No | Item |
product_family | text | No | Product family — For a plant-level schedule covering a family rather than one item. |
warehouse_id | uuid | No | Warehouse |
demand_plan_id | uuid | No | Demand plan — Where the forecast comes from, so a change to it is traceable into the schedule rather than retyped. |
bucket | text | No | Bucket Allowed: week day month |
horizon_from | date | Yes | Horizon from |
horizon_to | date | Yes | Horizon to |
demand_time_fence_days | integer | No | Demand time fence (days) — Inside it the forecast is ignored and only real orders count. |
planning_time_fence_days | integer | No | Planning time fence (days) — Inside it the system may not move supply on its own. Without it, every re-run reschedules the job on the machine. |
consumption_rule | text | No | Consumption rule Allowed: consume_forward consume_backward consume_both greater_of sum |
consumption_days_forward | integer | No | Consume forward (days) |
consumption_days_backward | integer | No | Consume backward (days) |
safety_stock | numeric | No | Safety stock |
target_dos | numeric | No | Target days of supply |
planner_id | uuid | No | Planner |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"horizon_from": "2026-10-30"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"schedule_no": "SCH-000001",
"name": "Example",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"product_family": "text",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"demand_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bucket": "week",
"horizon_from": "2026-10-30",
"horizon_to": "2026-10-30",
"demand_time_fence_days": 10,
"planning_time_fence_days": 10,
"consumption_rule": "consume_forward"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/mfg/master-schedules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","horizon_from":"2026-10-30"}'DELETE/api/mfg/master-schedules/{id}Delete a master schedule
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/mfg/master-schedules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/mfg/master-schedules/{parentId}/periodsPeriods
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/mfg/master-schedules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/periods" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/master-schedules/{parentId}/periodsPeriods
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/mfg/master-schedules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/periods" \
-H "Authorization: Bearer $TOKEN"PUT/api/mfg/master-schedules/{parentId}/periods/{lineId}Periods
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/mfg/master-schedules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/periods/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/mfg/master-schedules/{parentId}/periods/{lineId}Periods
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/mfg/master-schedules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/periods/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/master-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/mfg/master-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/mfg/master-schedules/{id}/buildBuild
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/mfg/master-schedules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/build" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/master-schedules/{id}/rough-cutRough cut
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/mfg/master-schedules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/rough-cut" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/master-schedules/{id}/firmFirm
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):
overrideReasonResponse
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/mfg/master-schedules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/firm" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrideReason":"value"}'Data model
Every field of a master schedule, 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 |
item_id | uuid | read, write | Item |
product_family | text | read, write | Product family — For a plant-level schedule covering a family rather than one item. |
warehouse_id | uuid | read, write | Warehouse |
demand_plan_id | uuid | read, write | Demand plan — Where the forecast comes from, so a change to it is traceable into the schedule rather than retyped. |
bucket | text | read, write | Bucket Allowed: week day month |
horizon_from | date | read, write | Horizon from |
horizon_to | date | read, write | Horizon to |
demand_time_fence_days | integer | read, write | Demand time fence (days) — Inside it the forecast is ignored and only real orders count. |
planning_time_fence_days | integer | read, write | Planning time fence (days) — Inside it the system may not move supply on its own. Without it, every re-run reschedules the job on the machine. |
consumption_rule | text | read, write | Consumption rule Allowed: consume_forward consume_backward consume_both greater_of sum |
consumption_days_forward | integer | read, write | Consume forward (days) |
consumption_days_backward | integer | read, write | Consume backward (days) |
safety_stock | numeric | read, write | Safety stock |
target_dos | numeric | read, write | Target days of supply |
planner_id | uuid | read, write | Planner |
status | text | read only | Status |
approved_by | uuid | read only | Approved by |
approved_at | timestamp with time zone | read only | Approved at |
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 Manufacturing › Master Production 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.