TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/scm/schedule-entriesPublished as /api/v1/schedule-entries

Download specification (OpenAPI 3.1) Screen: Schedule Entries

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 › 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.
Tablescm.schedule_entries · 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/scm/schedule-entriesList schedule entries

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

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

FieldTypeRequiredDescription
schedule_iduuidYesSchedule
resource_iduuidYesResource
entry_nointegerNoEntry no
sequence_nointegerNoSequence
entry_typetextNoType
Allowed: operation setup run maintenance break trip stop loading unloading changeover idle blocked
production_order_iduuidNoProduction order id
production_operation_iduuidNoProduction operation id
planned_order_iduuidNoPlanned order id
load_iduuidNoLoad id
route_iduuidNoRoute id
warehouse_order_iduuidNoWarehouse order id
item_iduuidNoItem id
labeltextYesWhat
reference_notextNoReference
quantitynumericNoQuantity
uom_iduuidNoUom id
planned_starttimestamp with time zoneYesStart
planned_endtimestamp with time zoneYesEnd
actual_starttimestamp with time zoneNoActual start
actual_endtimestamp with time zoneNoActual end
setup_minutesnumericNoSetup minutes
run_minutesnumericNoRun minutes
earliest_starttimestamp with time zoneNoEarliest start
due_attimestamp with time zoneNoDue
depends_on_iduuidNoCannot start before
is_pinnedbooleanNoPinned — do not move it
colortextNoColor
progress_pctnumericNoProgress %
statustextNoStatus
Allowed: planned released in_progress paused completed late blocked cancelled
notestextNoNotes

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

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
schedule_iduuidYesSchedule
resource_iduuidYesResource
entry_nointegerNoEntry no
sequence_nointegerNoSequence
entry_typetextNoType
Allowed: operation setup run maintenance break trip stop loading unloading changeover idle blocked
production_order_iduuidNoProduction order id
production_operation_iduuidNoProduction operation id
planned_order_iduuidNoPlanned order id
load_iduuidNoLoad id
route_iduuidNoRoute id
warehouse_order_iduuidNoWarehouse order id
item_iduuidNoItem id
labeltextYesWhat
reference_notextNoReference
quantitynumericNoQuantity
uom_iduuidNoUom id
planned_starttimestamp with time zoneYesStart
planned_endtimestamp with time zoneYesEnd
actual_starttimestamp with time zoneNoActual start
actual_endtimestamp with time zoneNoActual end
setup_minutesnumericNoSetup minutes
run_minutesnumericNoRun minutes
earliest_starttimestamp with time zoneNoEarliest start
due_attimestamp with time zoneNoDue
depends_on_iduuidNoCannot start before
is_pinnedbooleanNoPinned — do not move it
colortextNoColor
progress_pctnumericNoProgress %
statustextNoStatus
Allowed: planned released in_progress paused completed late blocked cancelled
notestextNoNotes

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

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
schedule_iduuidread, writeSchedule
resource_iduuidread, writeResource
entry_nointegerread, writeEntry no
sequence_nointegerread, writeSequence
entry_typetextread, writeType
Allowed: operation setup run maintenance break trip stop loading unloading changeover idle blocked
production_order_iduuidread, writeProduction order id
production_operation_iduuidread, writeProduction operation id
planned_order_iduuidread, writePlanned order id
load_iduuidread, writeLoad id
route_iduuidread, writeRoute id
warehouse_order_iduuidread, writeWarehouse order id
item_iduuidread, writeItem id
labeltextread, writeWhat
reference_notextread, writeReference
quantitynumericread, writeQuantity
uom_iduuidread, writeUom id
planned_starttimestamp with time zoneread, writeStart
planned_endtimestamp with time zoneread, writeEnd
actual_starttimestamp with time zoneread, writeActual start
actual_endtimestamp with time zoneread, writeActual end
setup_minutesnumericread, writeSetup minutes
run_minutesnumericread, writeRun minutes
earliest_starttimestamp with time zoneread, writeEarliest start
due_attimestamp with time zoneread, writeDue
slack_minutesnumericread onlySlack minutes
is_latebooleanread onlyIs late
is_criticalbooleanread onlyIs critical
depends_on_iduuidread, writeCannot start before
is_pinnedbooleanread, writePinned — do not move it
colortextread, writeColor
progress_pctnumericread, writeProgress %
statustextread, writeStatus
Allowed: planned released in_progress paused completed late blocked cancelled
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
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 › Schedule Entries 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.