getStocktakings

Retrieve physical stocktakings.

A physical stocktaking is an operation where inventory is manually re-counted; if actual count differs from the inventory quantity in Erply, the quantity in Erply is adjusted.

When physical stocktaking is completed, the stocktaking act must be confirmed. Any surplus items can then be taken into inventory with an Inventory Registration, and missing items subtracted with an Inventory Write-Off.

To retrieve all item counts in one specific stocktaking, see getStocktakingReadings. To start a new stocktaking (create a new stocktaking act), see saveStocktaking. To update quantities on an act, see saveStocktakingReadings and incrementStocktakingReading. To delete an act, see deleteStocktaking.

Input parameters

Parameter name Description Possible value Required
stocktakingID Integer
status Possible values: "CONFIRMED", "IN_PROGRESS". String
changedSince Retrieve physical stocktakings that have been added or modified since the specified timestamp. Integer (Unix timestamp)
recordsOnPage Number of records API should return. By default 20, at most 100. Integer
pageNo API returns at most recordsOnPage items at a time. To retrieve the next recordsOnPage items, send a new request with pageNo incremented by one. By default, API returns "page 1". Integer

Response

Field name Type Description
stocktakingID Integer
warehouses String
prodgroupID Integer Product group filter that was applied to the stocktaking.
productCategoryID Integer Product category filter that was applied to the stocktaking.
brandID Integer Brand filter that was applied to the stocktaking.
supplierID Integer Supplier filter that was applied to the stocktaking.
locationInWarehouse String Location in warehouse filter that was applied to the stocktaking.
onlyItemsWithoutWarehouseLocation Integer (0 or 1) Whether the filter "only items without warehouse location" was applied to the stocktaking.
excludeReservations Integer (0 or 1) Whether the stocktaking was created to count all products in stock, or only the non-reserved items in stock (excluding lay-by items).
status String Possible values: "CONFIRMED", "IN_PROGRESS".
numberOfRows Integer Number of rows in the stocktaking.
inventoryRegistrationID Integer ID of the Inventory Registration linked to the stocktaking.
inventoryWriteOffID Integer ID of the Inventory Write-Off linked to the stocktaking.
added Unix timestamp Timestamp when the stocktaking was created.
addedByUserName String (16) An identifier referring to the user who created this stocktaking. This is NOT actually the user's name; it's just a string, at most 16 characters long. However, typically it matches the first 16 characters of the user's name.
addedByEmployeeID Integer Employee ID who created the stocktaking.
confirmedTimestamp Unix timestamp Timestamp when the stocktaking was confirmed.
confirmedByUserName String (16) An identifier referring to the user who confirmed this stocktaking. This is NOT actually the user's name; it's just a string, at most 16 characters long. However, typically it matches the first 16 characters of the user's name.
confirmedByEmployeeID Integer Employee ID who confirmed the stocktaking.
lastModified Unix timestamp Last modification time.