Skip to main content

API: Underforecasted

Updated

NOTE: This is an article for the legacy API. To access updated information on this endpoint, please reference the HTML guide attached to the bottom of the REST API Access document

 

Description: Gets results from the grid in the Underforecasted screen

Resource: UnderforecastedPeriodDetail/

Verb: GET

Query String Options:

  • nodeLevel (required): Hierarchy Node Level. Top company level = 0. This corresponds to the levels you have configured in Forecast Manager's tree view
  • itemHierarchyId (required): which hierarchy is being used, usually "1"
  • demandForecastSeriesId (required): which forecast series to view, usually "1"

Returns: JSON Array of  objects

Example Response JSON:

[{
"AlertKeyId": 1202305014125,
"AlertType": 8,
"PrimaryId": 4125,
"PrimaryIdProperty": 3,
"ForecastErrorPercent": -0.9423076923076923076923076923,
"StatisticalErrorPercent": -0.516391978021978021978021978,
"UnderforecastRevenueVariance": 887.51250,
"LevelName": "Customer Group",
"NodeLevel": 5,
"HierarchyProperty": 2048,
"ShipperId": 5,
"SiteId": 2,
"ItemId": 92,
"BuyerId": 4,
"PrimarySupplierId": 61,
"CustomerShipToCategory1Id": 5,
"CustomerId": 0,
"CustomerShipToId": 0,
"ItemSiteCategory1Id": 9,
"ItemSiteCategory2Id": 7,
"ItemSiteCategory3Id": 1,
"ItemSiteCategory4Id": 1,
"ItemSiteCategory5Id": 1,
"ItemSiteId": 150,
"DemandForecastSeriesName": "Operational Forecast",
"NodeValue": "Tier 2 Customers",
"HierarchyNodeId": 4125,
"DemandForecastSeriesId": 1,
"PeriodDate": "2023/05/01",
"Interval": 4,
"ForecastQuantity": 5.25000,
"StatisticalForecastQuantity": 44.00833,
"ForecastAverageQuantity": 17.78164,
"StatisticalAverageQuantity": 38.59641,
"ForecastRevenue": 54.33750,
"StatisticalForecastRevenue": 455.48621,
"AverageForecastErrorPercent": 0.88861,
"AverageStatisticalErrorPercent": 0.64994,
"AverageForecastErrorUnits": 44.87500,
"AverageStatisticalErrorUnits": 23.18144,
"PeriodTotalQuantitySold": 91.00000,
"PeriodTotalRevenue": 941.85000,
"PercentThroughPeriod": 1.00000,
"PercentOfDemandExpected": 1.00000,
"ProjectedPeriodTotalQuantitySold": 91.00000,
"ProjectedPeriodTotalRevenue": 941.85000,
"ForecastErrorUnits": -85.75000,
"ForecastErrorDollars": -887.51250,
"StatisticalErrorUnits": -46.99167,
"StatisticalErrorDollars": -486.36378,
"UsagePattern": 1,
"IsAutoForecasted": true,
"ProjectedInventoryPosition": 32,
"ShipperName": "Shipper ABB",
"ItemCode": "0201031",
"ItemDescription": "Adventure Works 52\" LCD HDTV X590 Black",
"SiteCode": "95",
"CustomerShipToCategory1Value": "Tier 2 Customers",
"ItemSiteCategory1Name": "TV and Video",
"ItemSiteCategory2Name": "Televisions",
"ItemSiteCategory3Name": "Unassigned",
"ItemSiteCategory4Name": "Unassigned",
"ItemSiteCategory5Name": "Unassigned",
"AbcClass": "N",
"XyzClass": "N",
"BuyerName": "Michael Schumacher",
"PrimarySupplierName": "Contoso Hub Warehouse",
"ActiveOrderPolicy": 2,
"AlertSummaryId": 3481,
"AMsg": "Demand in period 5/1/2023 of 91 is above max expected range.",
"DateCreated": "2023/06/01",
"DateUpdated": "2023-06-01T00:00:00-05:00",
"ASt": 1,
"APri": 2,
"Rank": 60,
"AlertTypeName": "UnderForecast"
},
...
]

Related articles