Inventory_GetLotGroupBalance (Get)
- Last UpdatedNov 13, 2025
- 1 minute read
| Get | Inventory_GetLotGroupBalance |
Resource Path:/api/v1/inventory/GetLotGroupBalance
| Name | Description | Data Type |
|---|---|---|
| location | Required. The hierarchy location where the data is to be retrieved. | string |
| samplePeriod | The period of time to use in the query. This can be any filterable period definition or datetime. | datetime |
| fields | The custom fields that must be specified as comma separated fields in a query. These are returned in the result if specified. | string |
The response body is of type Array[LotGroupBalance].
Request | Current balance
GET 'https://localhost:9003/api/v1/inventory/GetLotGroupBalance?location=SiteFolder.Area2.WorkCenter4&Fields=Au%20Tonnes,%20Ag%20Tonnes'Response
[
{
"SamplePeriod": "2019-12-30T21:35:50Z",
"Location": "SiteFolder.Area2.WorkCenter4",
"LocationIdentifier": "WC4",
"MaterialClass": "Material Class.MaterialClass1",
"MaterialClassIdentifier": null,
"LotGroup": "LG1",
"Balance": 205,
"Units": null,
"Fields": {
"Au Tonnes": 0.4797,
"Ag Tonnes": 0.25625
}
}
]Request | Overtime
GET 'https://localhost:9003/api/v1/inventory/GetLotGroupBalance?location=SiteFolder.Area2.WorkCenter4&Fields=Au%20Tonnes,%20Ag%20Tonnes&SamplePeriod=3E=20%222019-12-01T14:00:00.0000000Z%22%20And%203C=20%222019-12-31T14:00:00.0000000Z%22'Response
[
{
"CreatedDateTime": "2020-01-09T21:37:39.1766667Z",
"SamplePeriod": "2019-12-23T03:52:31.0566667Z",
"Location": "SiteFolder.Area2.WorkCenter4",
"LocationIdentifier": "WC4",
"MaterialClass": "Material Class.MaterialClass1",
"MaterialClassIdentifier": null,
"LotGroup": "LG1",
"Balance": 100,
"Units": null,
"Fields": {
"Au Tonnes": 0.000326,
"Ag Tonnes": 0.00119
}
},
{
"CreatedDateTime": "2020-01-09T21:36:21.7131151Z",
"SamplePeriod": "2019-12-30T21:35:50Z",
"Location": "SiteFolder.Area2.WorkCenter4",
"LocationIdentifier": "WC4",
"MaterialClass": "Material Class.MaterialClass1",
"MaterialClassIdentifier": null,
"LotGroup": "LG1",
"Balance": 205,
"Units": null,
"Fields": {
"Au Tonnes": 0.4797,
"Ag Tonnes": 0.25625
}
}
]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.