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: Returns the current excess detail grid from the Excess & Overstock screen in the Inventory module
Resource: CurrentExcessDetail/
Verb: GET
Query String Arguments
-
includeOverStock (required):
- true
- false
-
includePlannedOverStock (required):
- true
- false
Returns: JSON Array containing records matching current excess details
Example Response JSON:
[{
"AlertKeyId": 1,
"AlertType": 12,
"PrimaryId": 1,
"PrimaryIdProperty": 1,
"MarginPercent": 0.0534979423868312757201646091,
"ExcessDays": 411.32,
"SiteGroupExcessDays": 411.32,
"CurrentDaysOfSupply": 639.83,
"ItemSiteId": 1,
"DateFirstStocked": "2014/06/16",
"ItemId": 16,
"SiteId": 17,
"PrimarySupplierId": 48,
"ItemSiteCategory1Id": 3,
"ItemSiteCategory2Id": 28,
"ItemSiteCategory3Id": 1,
"ItemSiteCategory4Id": 1,
"ItemSiteCategory5Id": 1,
"ItemCode": "0101001",
"SiteCode": "44",
"PrimarySupplierName": "USA Distribution Ltd",
"ItemDescription": "Contoso 512MB MP3 Player E51 Silver",
"ActiveOrderPolicy": 2,
"UsagePattern": 16,
"InventoryPosition": 32,
"AbcClass": "X",
"XyzClass": "Z",
"CurrentCost": 2.30000,
"StandardCost": 2.30000,
"TotalOnHandQuantity": 5.00000,
"StandardPrice": 2.43000,
"OnHandBalance": 11.50000,
"TotalOnOrderQuantity": 0.00000,
"TotalAvailableQuantity": 5.00000,
"TotalAvailableQuantityAtLeadTime": 5.00000,
"CurrentExcessThreshold": 0.00000,
"ExcessQuantity": 5.00000,
"BoMPosition": 0,
"ExcessBalance": 11.500000000,
"TotalForecastedDailyUsage": 0.0,
"TotalDailyUsageAtLeadTime": 0.0,
"SupplierItemCode": "0101001",
"MinimumOrderQuantity": 100,
"OrderMultipleQuantity": 10,
"OnHandCubes": 5.050000,
"ExcessCubes": 5.050000,
"CustomerShipToCount": 19,
"CustomerCount": 19,
"FirstSaleDate": "2021/06/26",
"LastSaleDate": "2024/06/03",
"LastOrderedDate": "2024/01/12",
"LastReceiptDate": "2024/01/09",
"InventoryPositionAtLeadTime": 32,
"ItemSiteCategory1Name": "Audio",
"ItemSiteCategory2Name": "MP4&MP3",
"ItemSiteCategory3Name": "Unassigned",
"ItemSiteCategory4Name": "Unassigned",
"ItemSiteCategory5Name": "Unassigned",
"SiteGroupUsagePattern": 16,
"AlertSummaryId": 0,
"DateUpdated": "0001-01-01T00:00:00+00:00",
"ASt": 0,
"APri": 0,
"AlertTypeName": "CurrentExcess"
},
...
]