TRANXACT.AI Help

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.

Type REST12 operationsBase path /api/scm/schedulesPublished as /api/v1/schedules

Download specification (OpenAPI 3.1) Screen: Capacity Schedules

Overview

PackageSupply Chain
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 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.
Tablescm.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

12 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/scm/schedulesList capacity 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",
      "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

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

FieldTypeRequiredDescription
nametextYesName
schedule_typetextNoType
supply_plan_iduuidNoSupply plan
warehouse_iduuidNoWarehouse
location_iduuidNoLocation
horizon_fromtimestamp with time zoneYesBoard from
horizon_totimestamp with time zoneYesBoard to
bucket_minutesintegerNoBucket (minutes)
methodtextNoBuilt by
Allowed: manual forward backward finite_forward finite_backward optimizer imported
sequencing_ruletextNoSequenced by — Naming it out loud is the point: a board nobody can explain is a board nobody follows.
notestextNoNotes

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

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
nametextYesName
schedule_typetextNoType
supply_plan_iduuidNoSupply plan
warehouse_iduuidNoWarehouse
location_iduuidNoLocation
horizon_fromtimestamp with time zoneYesBoard from
horizon_totimestamp with time zoneYesBoard to
bucket_minutesintegerNoBucket (minutes)
methodtextNoBuilt by
Allowed: manual forward backward finite_forward finite_backward optimizer imported
sequencing_ruletextNoSequenced by — Naming it out loud is the point: a board nobody can explain is a board nobody follows.
notestextNoNotes

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

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

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):

source, respectDependencies

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/sequence" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"source":"value","respectDependencies":"value"}'
POST/api/scm/schedules/{id}/moveMove

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):

entryId*, plannedStart, resourceId, pin, cascade

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/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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
schedule_notextread onlySchedule no
nametextread, writeName
schedule_typetextread, writeType
supply_plan_iduuidread, writeSupply plan
warehouse_iduuidread, writeWarehouse
location_iduuidread, writeLocation
horizon_fromtimestamp with time zoneread, writeBoard from
horizon_totimestamp with time zoneread, writeBoard to
bucket_minutesintegerread, writeBucket (minutes)
resource_ids_uuidread onlyResource ids
methodtextread, writeBuilt by
Allowed: manual forward backward finite_forward finite_backward optimizer imported
sequencing_ruletextread, writeSequenced by — Naming it out loud is the point: a board nobody can explain is a board nobody follows.
entry_countintegerread onlyEntry count
late_countintegerread onlyLate count
total_setup_minutesnumericread onlyTotal setup minutes
total_run_minutesnumericread onlyTotal run minutes
makespan_minutesnumericread onlyMakespan minutes
utilization_pctnumericread onlyUtilization pct
published_attimestamp with time zoneread onlyPublished at
published_byuuidread onlyPublished by
statustextread onlyStatus
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
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
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

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 Supply Chain › Capacity 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.