TRANXACT.AI Help

Supply Chain · Demand Planning

Demand Forecast Lines

One item, one place, one period. Five quantities, because the statistical number, what sales think, what marketing think, what was agreed and what happened are five different facts.

Type REST6 operationsBase path /api/scm/demand-forecastsPublished as /api/v1/demand-forecasts

Download specification (OpenAPI 3.1) Screen: Demand Forecast Lines

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 Forecast Lines 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_forecasts · 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/demand-forecastsList demand forecast lines

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",
      "plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "period_start": "2026-10-30",
      "period_end": "2026-10-30",
      "period_code": "PER-000001",
      "uom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "history_quantity": "12.0000",
      "statistical_quantity": "12.0000",
      "sales_quantity": "12.0000",
      "marketing_quantity": "12.0000"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_start": "2026-10-30",
  "period_end": "2026-10-30",
  "period_code": "PER-000001",
  "uom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "history_quantity": "12.0000",
  "statistical_quantity": "12.0000",
  "sales_quantity": "12.0000",
  "marketing_quantity": "12.0000"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
plan_iduuidYesPlan
item_iduuidYesItem
warehouse_iduuidNoWarehouse
location_iduuidNoLocation id
account_iduuidNoCustomer
period_startdateYesPeriod from
period_enddateYesPeriod to
period_codetextNoPeriod code
uom_iduuidNoUnit
sales_quantitynumericNoSales says
marketing_quantitynumericNoMarketing says
consensus_quantitynumericNoAgreed
final_quantitynumericNoFinal
unit_pricenumericNoUnit price
currencytextNoCurrency
override_reasontextNoWhy it was overridden — An override with no reason is an override nobody can review.
is_promotionalbooleanNoPromotional
promotion_reftextNoPromotion reference
is_new_productbooleanNoNew product
is_lockedbooleanNoLocked against recalculation

Sample body

{
  "plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_start": "2026-10-30",
  "period_end": "2026-10-30",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_code": "PER-000001"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_start": "2026-10-30",
  "period_end": "2026-10-30",
  "period_code": "PER-000001",
  "uom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "history_quantity": "12.0000",
  "statistical_quantity": "12.0000",
  "sales_quantity": "12.0000",
  "marketing_quantity": "12.0000"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/demand-forecasts" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"plan_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","period_start":"2026-10-30","period_end":"2026-10-30","warehouse_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","location_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","period_code":"PER-000001"}'
PUT/api/scm/demand-forecasts/{id}Change a forecast line

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
plan_iduuidYesPlan
item_iduuidYesItem
warehouse_iduuidNoWarehouse
location_iduuidNoLocation id
account_iduuidNoCustomer
period_startdateYesPeriod from
period_enddateYesPeriod to
period_codetextNoPeriod code
uom_iduuidNoUnit
sales_quantitynumericNoSales says
marketing_quantitynumericNoMarketing says
consensus_quantitynumericNoAgreed
final_quantitynumericNoFinal
unit_pricenumericNoUnit price
currencytextNoCurrency
override_reasontextNoWhy it was overridden — An override with no reason is an override nobody can review.
is_promotionalbooleanNoPromotional
promotion_reftextNoPromotion reference
is_new_productbooleanNoNew product
is_lockedbooleanNoLocked against recalculation

Sample body

{
  "plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_start": "2026-10-30",
  "period_end": "2026-10-30",
  "period_code": "PER-000001",
  "uom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "history_quantity": "12.0000",
  "statistical_quantity": "12.0000",
  "sales_quantity": "12.0000",
  "marketing_quantity": "12.0000"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/demand-forecasts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"plan_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
DELETE/api/scm/demand-forecasts/{id}Delete a forecast line

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-forecasts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/demand-forecasts/{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-forecasts/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 forecast line, 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
plan_iduuidread, writePlan
item_iduuidread, writeItem
warehouse_iduuidread, writeWarehouse
location_iduuidread, writeLocation id
account_iduuidread, writeCustomer
period_startdateread, writePeriod from
period_enddateread, writePeriod to
period_codetextread, writePeriod code
uom_iduuidread, writeUnit
history_quantitynumericread onlyHistory quantity
statistical_quantitynumericread onlyStatistical quantity
sales_quantitynumericread, writeSales says
marketing_quantitynumericread, writeMarketing says
consensus_quantitynumericread, writeAgreed
final_quantitynumericread, writeFinal
actual_quantitynumericread onlyActual quantity
lower_boundnumericread onlyLower bound
upper_boundnumericread onlyUpper bound
confidence_pctnumericread onlyConfidence pct
unit_pricenumericread, writeUnit price
value_amountnumericread onlyValue amount
currencytextread, writeCurrency
override_reasontextread, writeWhy it was overridden — An override with no reason is an override nobody can review.
overridden_byuuidread onlyOverridden by
overridden_attimestamp with time zoneread onlyOverridden at
is_promotionalbooleanread, writePromotional
promotion_reftextread, writePromotion reference
is_new_productbooleanread, writeNew product
is_lockedbooleanread, writeLocked against recalculation
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 › Demand Forecast Lines 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.