all counts for an audit for each location, including expected quantities
|
Type |
Description |
| Name |
string
|
audit name; readonly in this model
|
| Summaries |
IEnumerable<Inventory.Models.AuditCountSummary>
|
summary of counts and expected for skus within this audit
|
| ItemTraits |
Generic.Models.ItemTraits
|
unique identifying characteristics of an item in a location
|
| ItemIdentifier |
Generic.Models.ItemIdentifier
|
|
| Sku |
string
|
|
| Id |
int
|
|
| Qualifier |
string
|
|
| LotNumber |
string
|
|
| SerialNumber |
string
|
|
| Cost |
decimal?
|
|
| ExpirationDate |
DateTime?
|
|
| PalletIdentifier |
Generic.Models.PalletIdentifier
|
|
| NameKey |
Generic.Models.PalletNameKey
|
|
| FacilityIdentifier |
Generic.Models.FacilityIdentifier
|
|
| Name |
string
|
|
| Id |
int
|
|
| Name |
string
|
|
| Id |
int
|
|
| TotalCounted |
decimal
|
for given sku, the total counted in the audit
|
| TotalOnHand |
decimal
|
for given sku, the total system on hand for given locations in the audit
|
| TotalAvailable |
decimal
|
for given sku, the total system available for given locations in the audit
|
| TotalFacilityOnHand |
decimal
|
for given sku, the total system on hand in the whole facility
|
| TotalFacilityAvailable |
decimal
|
for given sku, the total system available in the whole facility
|
| OnHandInventoryLocations |
IEnumerable<Inventory.Models.OnHandInventoryLocation>
|
locations and quantities of the TotalFacilityOnHand
|
| LocationIdentifier |
Generic.Models.LocationIdentifier
|
|
| NameKey |
Generic.Models.LocationNameKey
|
|
| FacilityIdentifier |
Generic.Models.FacilityIdentifier
|
|
| Name |
string
|
|
| Id |
int
|
|
| Name |
string
|
|
| Id |
int
|
|
| OnHand |
decimal
|
|
| Available |
decimal
|
|
| ResourceList |
IList<Inventory.Models.AuditCount>
|
|
| CountId |
int
|
internal id for this count; use in AuditCountIdentifier when moving and adjusting
|
| PalletInfo |
Inventory.Models.PalletInfo
|
in GETs: the movable unit; in POSTs or PUTs: identifies existing movable unit or properties of new movable unit
|
| PalletId |
int?
|
for identifying: if known specify only this; other fields are ignored
|
| Label |
string
|
for identifying: if known but PalletId unknown, specify label, other fields ignored;
for creating: new unique label or leave blank for system to generate unique label number
|
| SplitOverCapacityOnCreate |
bool?
|
if true will use PalletInfo as template to create multiples and splits associated receive items accordingly
|
| QtyOverrideOnSplit |
decimal?
|
when creating and SplitOverCapacityOnCreate is true, overrides the Item.Options.Pallets.Qty otherwise used to create multiples
|
| PalletTypeIdentifier |
Generic.Models.PalletTypeIdentifier
|
required when creating new movable unit
|
| Name |
string
|
|
| Id |
int
|
|
| Metric |
Generic.Models.Dimension
|
optional when creating; if only Metric specified, Imperial is calculated
|
| Length |
decimal?
|
|
| Width |
decimal?
|
|
| Height |
decimal?
|
|
| Weight |
decimal?
|
|
| Imperial |
Generic.Models.Dimension
|
optional when creating; if only Imperial specified, Metric is calculated
|
| Length |
decimal?
|
|
| Width |
decimal?
|
|
| Height |
decimal?
|
|
| Weight |
decimal?
|
|
| CustomerIdentifier |
Generic.Models.CustomerIdentifier
|
|
| ExternalId |
string
|
|
| Name |
string
|
|
| Id |
int
|
|
| LocationIdentifier |
Generic.Models.LocationIdentifier
|
|
| NameKey |
Generic.Models.LocationNameKey
|
|
| FacilityIdentifier |
Generic.Models.FacilityIdentifier
|
|
| Name |
string
|
|
| Id |
int
|
|
| Name |
string
|
|
| Id |
int
|
|
| ItemTraits |
Generic.Models.ItemTraits
|
either what was counted or what is contained within a location
|
|
Generic.Models.ItemTraits |
unique identifying characteristics of an item in a location
|
| ItemIdentifier |
Generic.Models.ItemIdentifier
|
|
| Sku |
string
|
|
| Id |
int
|
|
| Qualifier |
string
|
|
| LotNumber |
string
|
|
| SerialNumber |
string
|
|
| Cost |
decimal?
|
|
| ExpirationDate |
DateTime?
|
|
| PalletIdentifier |
Generic.Models.PalletIdentifier
|
|
| NameKey |
Generic.Models.PalletNameKey
|
|
| FacilityIdentifier |
Generic.Models.FacilityIdentifier
|
|
| Name |
string
|
|
| Id |
int
|
|
| Name |
string
|
|
| Id |
int
|
|
| Counted |
decimal
|
how many was counted; zero if not counted but system thinks inventory is in given location
|
| OnHand |
decimal
|
how many the system thinks is on hand in given location
|
| Available |
decimal
|
how many the system thinks is available in given location
|
| SystemQty |
decimal?
|
how many are expected
|
| AllocatedQty |
decimal?
|
how many the system has onhand at the time of counting
|
| OtherInventoryOnHand |
IEnumerable<Inventory.Models.NotCounted>
|
if Audit's CollectTrackbys true when counted or item doesn't allow trackbys: null; otherwise not null, listing on-hand quantities with any non-empty trackby in given location
|
| LotNumber |
string
|
|
| SerialNumber |
string
|
|
| ExpirationDate |
DateTime?
|
|
| OnHand |
decimal
|
|
| Available |
decimal
|
|
| LocationEmpty |
bool
|
Indicates if the location marked empty
|
| HasTrackByDataRecorded |
bool
|
Indicates if there are track bys recorded in the system inventory data
|
| Links |
IList<WebApi.Hal.Link>
|
|
|
-
/rels/inventory/auditcounts
|
Links to all audit counts on get |
|
-
/rels/inventory/auditlocationcounts
|
DELETE to remove all counts for this location |
|
-
/rels/inventory/auditswap
|
swap inventory quantity to this location from other specified locations |
|
-
/rels/inventory/audit
|
|
| Links |
IList<WebApi.Hal.Link>
|
|
|
-
/rels/inventory/audit
|
|
|
-
/rels/inventory/auditadjust
|
|
|
-
edit |
DELETE to remove all counts from all locations of this audit |
Sample accept: application/hal+json
{
"name": "str",
"summaries": [
{
"itemTraits": {
"itemIdentifier": {
"sku": "str",
"id": 2
},
"qualifier": "str",
"lotNumber": "str",
"serialNumber": "str",
"cost": 1.0,
"expirationDate": "2016-12-25T23:00:00",
"palletIdentifier": {
"nameKey": {
"facilityIdentifier": {
"name": "str",
"id": 2
},
"name": "str"
},
"id": 1
}
},
"totalCounted": 1.0,
"totalOnHand": 2.0,
"totalAvailable": 3.0,
"totalFacilityOnHand": 4.0,
"totalFacilityAvailable": 5.0,
"onHandInventoryLocations": [
{
"locationIdentifier": {
"nameKey": {
"facilityIdentifier": {
"name": "str",
"id": 2
},
"name": "str"
},
"id": 1
},
"onHand": 1.0,
"available": 2.0
}
]
}
],
"_embedded": {
"http://api.3plCentral.com/rels/inventory/auditcount": [
{
"countId": 1,
"palletInfo": {
"palletId": 1,
"label": "str",
"splitOverCapacityOnCreate": true,
"qtyOverrideOnSplit": 1.0,
"palletTypeIdentifier": {
"name": "str",
"id": 2
},
"metric": {
"length": 1.0,
"width": 1.0,
"height": 1.0,
"weight": 1.0
},
"imperial": {
"length": 1.0,
"width": 1.0,
"height": 1.0,
"weight": 1.0
}
},
"customerIdentifier": {
"externalId": "str",
"name": "str",
"id": 3
},
"locationIdentifier": {
"nameKey": {
"facilityIdentifier": {
"name": "str",
"id": 2
},
"name": "str"
},
"id": 1
},
"itemTraits": {
"itemIdentifier": {
"sku": "str",
"id": 2
},
"qualifier": "str",
"lotNumber": "str",
"serialNumber": "str",
"cost": 1.0,
"expirationDate": "2016-12-25T23:00:00",
"palletIdentifier": {
"nameKey": {
"facilityIdentifier": {
"name": "str",
"id": 2
},
"name": "str"
},
"id": 1
}
},
"counted": 2.0,
"onHand": 3.0,
"available": 4.0,
"systemQty": 1.0,
"allocatedQty": 1.0,
"otherInventoryOnHand": [
{
"lotNumber": "str",
"serialNumber": "str",
"expirationDate": "2016-12-25T23:00:00",
"onHand": 3.0,
"available": 4.0
}
],
"locationEmpty": true,
"hasTrackByDataRecorded": true
}
]
}
}