Skip to main content

API: Hierarchy Level Turns Detail Over Time (Legacy)

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 turns results from Inventory > Turns screen, By Hierarchy Level tab. Note: if hierarhcyLevel is set to 0 and itemHierarchyId = 1, this will also match the Turns Over Time chart on the Home > Executive Dashboard screen

Resource: HierachyLevelTurnsDetailOverTime/

Verb: GET

Query String Options:

  • interval (required):
    • 2 = Weekly
    • 4 = Monthly
    • 8 = Quarterly
    • 32 = Yearly
  • itemHierarchyId (required):  which hierarchy is being used, usually "1"
  • hierarchyLevel (required): Hierarchy Node Level. Top company level = 0. This corresponds to the levels you have configured in Forecast Manager's tree view
  • startDate (optional): first date to filter by, e.g. 1/1/2020

Returns: JSON Array of  objects

Example Response JSON:

[
{
"HierarchyNodeId": 1,
"ValueId": 0,
"HierarchyProperty": 0,
"NodeValue": "Contoso",
"PeriodDate": "2023/03/01",
"StartDate": "2023/03/01",
"EndDate": "2023/03/31",
"QuantitySold": 553410.04000,
"Cogs": 18707786.35538,
"OnHandQuantity": 1484485.00000,
"AverageOnHandQuantity": 1421898.4193548387096104,
"TargetOnHandQuantity": 545693.5000000,
"OnHandBalance": 20695428.370000000,
"AverageOnHandBalance": 21291979.3109677419354181,
"TargetOnHandBalance": 7981431.95000000,
"MeasurementPeriodLength": 31,
"CurrentTurns": 10.643369804773910791908371473,
"AverageTurns": 10.345167736315440849042553775,
"TargetTurns": 27.597691590933047401188414244,
"CurrVsTargetTurns": -16.954321786159136609280042771,
"AvgVsTargetTurns": -17.252523854617606552145860469,
"CurrentUnitTurns": 4.3893720196436105189950202128,
"AverageUnitTurns": 4.5825755439950102149786245324,
"TargetUnitTurns": 11.940690007450418891356269739,
"CurrVsTargetUnitTurns": -7.5513179878068083723612495262,
"AvgVsTargetUnitTurns": -7.3581144634554086763776452066
},
{
"HierarchyNodeId": 1,
"ValueId": 0,
"HierarchyProperty": 0,
"NodeValue": "Contoso",
"PeriodDate": "2023/04/01",
"StartDate": "2023/04/01",
"EndDate": "2023/04/30",
"QuantitySold": 579410.04000,
"Cogs": 34590315.01383,
"OnHandQuantity": 1342780.00000,
"AverageOnHandQuantity": 1274330.0999999999999632,
"TargetOnHandQuantity": 573078.5000000,
"OnHandBalance": 20984826.330000000,
"AverageOnHandBalance": 19871917.7453333333333002,
"TargetOnHandBalance": 9001834.59000000,
"MeasurementPeriodLength": 30,
"CurrentTurns": 20.054911394077999024355042161,
"AverageTurns": 21.178068370733669412998257668,
"TargetTurns": 46.751451435886137516774788906,
"CurrVsTargetTurns": -26.696540041808138492419746745,
"AvgVsTargetTurns": -25.573383065152468103776531238,
"CurrentUnitTurns": 5.2499209252446417134601349441,
"AverageUnitTurns": 5.53191737368520134634155982,
"TargetUnitTurns": 12.301087582242223360324981656,
"CurrVsTargetUnitTurns": -7.0511666569975816468648467119,
"AvgVsTargetUnitTurns": -6.769170208557022013983421836
},
...
]

Related articles