Get Forecast

GET /api/forecast/{id}

Required privilege: Forecast / View

Returns a single forecast with all of its line items.

---

Path Parameters

Parameter	Type	Required	Description
id	integer	Yes	Internal forecast identifier

---

Response

{
  "data": {
    "rows": {
      "id": 77,
      "Forecast List Number": "FC-2024-Q1",
      "Forecast List Date": "2024-01-01",
      "Forecast List Document Status": "Active",
      "details": [
        {
          "id": 501,
          "Item Id": 55,
          "Item Number": "ITEM-A",
          "Item Description": "Widget Assembly - Type A",
          "Warehouse Id": 3,
          "Warehouse Number": "WH-01",
          "Forecast Details Quantity": 500,
          "Forecast Details Date": "2024-01-15",
          "Forecast Details Document Status": "Active",
          "Forecast Details Unique Id": null
        }
      ]
    }
  }
}

Detail Line Fields

Field	Type	Description
id	integer	Internal forecast line ID
Item Number	string	Item reference
Warehouse Number	string	Target warehouse
Forecast Details Quantity	number	Forecasted quantity
Forecast Details Date	string | null	Forecast period date
Forecast Details Document Status	string	Line status

---

Errors

Status	Code	Description
400	ForecastList.NotFound	No forecast with this ID
403	User.NotPrivileged	Insufficient privilege