Skip to content

Create Forecast

POST /api/forecast

Required privilege: Forecast / Edit Content-Type: application/json CSRF header required: X-XSRF-TOKEN


Request Body

{
  "Forecast List Number": "FC-2024-Q2",
  "Forecast List Document Status": "Active",
  "Forecast List Date": "2024-04-01",
  "Forecast Id": null,
  "details": [
    {
      "id": null,
      "Item Number": "ITEM-A",
      "Warehouse Number": "WH-01",
      "Forecast Details Quantity": 600,
      "Forecast Details Date": "2024-04-15",
      "Forecast Details Document Status": "Active",
      "Forecast Details Unique Id": null
    }
  ]
}

Header Fields

Field Type Required Description
Forecast List Number string Yes Unique forecast identifier
Forecast List Document Status string Yes Status
Forecast List Date string | null No ISO 8601 date
Forecast Id integer | null No null for new forecasts

Detail Line Fields

Field Type Required Description
id integer | null No null for new lines
Item Number string Yes Item reference - must exist in Item Master
Warehouse Number string Yes Warehouse - must exist in Warehouse Master
Forecast Details Quantity number Yes Forecasted quantity
Forecast Details Date string | null No Forecast period date
Forecast Details Document Status string Yes Line status
Forecast Details Unique Id string | null No External identifier

Response

{
  "message": "Forecast created successfully.",
  "notification_type": "Success"
}