TRANXACT.AI Help

Supply Chain · Demand Planning

Demand Plans

A named, dated statement of what is expected. Versioned rather than overwritten: last month plan is what this month accuracy is measured against, and editing one in place destroys the only evidence anybody has.

Type REST16 operationsBase path /api/scm/demand-plansPublished as /api/v1/demand-plans

Download specification (OpenAPI 3.1) Screen: Demand Plans

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 › Demand Plans 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.demand_plans · 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

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

GET/api/scm/demand-plansList demand plans

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",
      "plan_no": "PLA-000001",
      "name": "Example",
      "version": 10,
      "supersedes_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "plan_type": "statistical",
      "bucket": "text",
      "horizon_from": "2026-10-30",
      "horizon_to": "2026-10-30",
      "history_from": "2026-10-30",
      "history_to": "2026-10-30",
      "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/scm/demand-plans?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/demand-plans/{id}Read one demand plan

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",
  "plan_no": "PLA-000001",
  "name": "Example",
  "version": 10,
  "supersedes_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "plan_type": "statistical",
  "bucket": "text",
  "horizon_from": "2026-10-30",
  "horizon_to": "2026-10-30",
  "history_from": "2026-10-30",
  "history_to": "2026-10-30",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/scm/demand-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/demand-plansCreate a demand plan

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
nametextYesName
versionintegerNoVersion
supersedes_iduuidNoSupersedes
plan_typetextNoType
Allowed: statistical consensus budget sales marketing collaborative scenario baseline
buckettextNoGrain — A weekly plan and a monthly plan are different documents, and adding them together is the classic way to double-count.
horizon_fromdateYesPlan from
horizon_todateYesPlan to
history_fromdateNoHistory from
history_todateNoHistory to
warehouse_iduuidNoWarehouse
location_iduuidNoLocation
item_categorytextNoCategory
account_iduuidNoCustomer
forecast_model_iduuidNoForecast model
currencytextNoCurrency
owner_user_iduuidNoOwner
notestextNoNotes

Sample body

{
  "name": "Example",
  "horizon_from": "2026-10-30",
  "horizon_to": "2026-10-30",
  "version": 10,
  "supersedes_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "plan_type": "statistical",
  "bucket": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "plan_no": "PLA-000001",
  "name": "Example",
  "version": 10,
  "supersedes_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "plan_type": "statistical",
  "bucket": "text",
  "horizon_from": "2026-10-30",
  "horizon_to": "2026-10-30",
  "history_from": "2026-10-30",
  "history_to": "2026-10-30",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/demand-plans" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example","horizon_from":"2026-10-30","horizon_to":"2026-10-30","version":10,"supersedes_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","plan_type":"statistical","bucket":"text"}'
PUT/api/scm/demand-plans/{id}Change a demand plan

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
versionintegerNoVersion
supersedes_iduuidNoSupersedes
plan_typetextNoType
Allowed: statistical consensus budget sales marketing collaborative scenario baseline
buckettextNoGrain — A weekly plan and a monthly plan are different documents, and adding them together is the classic way to double-count.
horizon_fromdateYesPlan from
horizon_todateYesPlan to
history_fromdateNoHistory from
history_todateNoHistory to
warehouse_iduuidNoWarehouse
location_iduuidNoLocation
item_categorytextNoCategory
account_iduuidNoCustomer
forecast_model_iduuidNoForecast model
currencytextNoCurrency
owner_user_iduuidNoOwner
notestextNoNotes

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",
  "plan_no": "PLA-000001",
  "name": "Example",
  "version": 10,
  "supersedes_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "plan_type": "statistical",
  "bucket": "text",
  "horizon_from": "2026-10-30",
  "horizon_to": "2026-10-30",
  "history_from": "2026-10-30",
  "history_to": "2026-10-30",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/demand-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example","horizon_from":"2026-10-30"}'
DELETE/api/scm/demand-plans/{id}Delete a demand plan

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

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

itemIds, overwriteOverrides

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/demand-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/calculate" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"itemIds":"value","overwriteOverrides":"value"}'
POST/api/scm/demand-plans/{id}/scoreScore

Path parameters

NameTypeDescription
idstring (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/scm/demand-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/score" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/demand-plans/{id}/submitSubmit

Path parameters

NameTypeDescription
idstring (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/scm/demand-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/submit" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/demand-plans/{id}/returnReturn

Path parameters

NameTypeDescription
idstring (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/scm/demand-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/return" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/demand-plans/{id}/approveApprove

Path parameters

NameTypeDescription
idstring (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/scm/demand-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/demand-plans/{id}/publishPublish

Path parameters

NameTypeDescription
idstring (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/scm/demand-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/publish" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/demand-plans/{parentId}/linesLines

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/demand-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/demand-plans/{parentId}/linesLines

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/demand-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/scm/demand-plans/{parentId}/lines/{lineId}Lines

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/demand-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/scm/demand-plans/{parentId}/lines/{lineId}Lines

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/demand-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a demand plan, 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
plan_notextread onlyPlan no
nametextread, writeName
versionintegerread, writeVersion
supersedes_iduuidread, writeSupersedes
plan_typetextread, writeType
Allowed: statistical consensus budget sales marketing collaborative scenario baseline
buckettextread, writeGrain — A weekly plan and a monthly plan are different documents, and adding them together is the classic way to double-count.
horizon_fromdateread, writePlan from
horizon_todateread, writePlan to
history_fromdateread, writeHistory from
history_todateread, writeHistory to
warehouse_iduuidread, writeWarehouse
location_iduuidread, writeLocation
item_categorytextread, writeCategory
account_iduuidread, writeCustomer
forecast_model_iduuidread, writeForecast model
currencytextread, writeCurrency
item_countintegerread onlyItem count
line_countintegerread onlyLine count
total_quantitynumericread onlyTotal quantity
total_valuenumericread onlyTotal value
mapenumericread onlyMape
bias_pctnumericread onlyBias pct
owner_user_iduuidread, writeOwner
approved_byuuidread onlyApproved by
approved_attimestamp with time zoneread onlyApproved at
run_attimestamp with time zoneread onlyRun at
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
submitted_byuuidread onlySubmitted by
submitted_attimestamp with time zoneread onlySubmitted at
published_byuuidread onlyPublished by
published_attimestamp with time zoneread onlyPublished at

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 › Demand Plans 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.