Inventory_GetLotBalanceByPeriod (Get)
- Last UpdatedNov 13, 2025
- 2 minute read
| Get | Inventory_GetLotBalanceByPeriod |
Resource Path:/api/v1/inventory/GetLotBalanceByPeriod
| Name | Description | Data Type |
|---|---|---|
| samplePeriod | Required. The period of time to use in a query. This can be any filterable period definition or datetime. | string |
| period | Required. The application supported period like Hour, Day, Month, and so on. The value "Now" is not allowed. | string |
| location | Required. The hierarchy location where the data is to be retrieved. | string |
| deleted | A boolean-result flag. When this value is set to True, the deleted fields are included in the results. | boolean |
The response body is of type Array[LotBalance].
Request
GET 'https://localhost:9003/api/v1/inventory/GetLotBalanceByPeriod?location=Rocky%20Mining.Emerald.Crushing.Primary%20Crusher&SamplePeriod=3E3D%20%222022-04-01T003A003A00.0000000Z%22%20And%203C3D%20%222022-04-02T003A003A00.0000000Z%22&Period=Day&Deleted=False'Response
[
{
"SamplePeriod": "2022-04-01T18:30:00Z",
"Location": "Rocky Mining.Emerald.Crushing.Primary Crusher",
"LocationIdentifier": null,
"MaterialClass": "Material Class.WIP",
"MaterialClassIdentifier": null,
"Material": "Material Model.WIP.ROM",
"MaterialIdentifier": null,
"LotGroup": "LG1",
"Lot": "LOT1-1",
"Balance": 500.00000000000000,
"Units": "Tons",
"Fields": {
"Id": 705,
"CreatedDateTime": "2019-04-16T11:07:06.5666667Z",
"IsDebtLot": false,
"SampleIdentifier": null,
"MovementEventIdentifier": null,
"FE": 0.50000000000000,
"Owners": "Owner1",
"FE Tons": 2.5000000000000000000000000000,
"Density": 1.00000000000000,
"Supplier": "SUP1",
"Volume": 500.00000000000000000000000000,
"GeoType": "GT1"
}
},
{
"SamplePeriod": "2022-04-01T18:30:00Z",
"Location": "Rocky Mining.Emerald.Crushing.Primary Crusher",
"LocationIdentifier": null,
"MaterialClass": "Material Class.WIP",
"MaterialClassIdentifier": null,
"Material": "Material Model.WIP.ROM",
"MaterialIdentifier": null,
"LotGroup": "SOAPLG1-3",
"Lot": "SOAPLOT1-3",
"Balance": 43470.00000000000000,
"Units": "Tons",
"Fields": {
"Id": 300610,
"CreatedDateTime": "2022-04-01T03:25:13.32Z",
"IsDebtLot": false,
"SampleIdentifier": null,
"MovementEventIdentifier": null,
"FE": 0.85000000000000,
"Owners": "Owner2",
"FE Tons": 369.49500000000000000000000000,
"Density": 1.25000000000000,
"Supplier": "SUP2",
"Volume": 54337.500000000000000000000000,
"GeoType": "GT2"
}
}
]Specify the filters as key value pairs. You can use the name or invariant display name for filtering. For example, if you need to add filter on custom field Au Tonnes greater than 0.005, then add a parameter with name Au Tonnes and value as > 0.005.