Retrieve Inventory Registrations.
Inventory Registration is a document that takes products into inventory; it has a list of items and quantities. It is similar to a Purchase Invoice, but has fewer fields and is best suited for registering your initial stock quantities when you start using Erply — or for making inventory quantity adjustments.
Non-stock products and bundles cannot be on Inventory Registrations (these items do not have inventory).
Products can be removed from stock with Inventory Write-offs (see getInventoryWriteOffs) and moved between locations with Inventory Transfers (see getInventoryTransfers).
To create an Inventory Registration, see saveInventoryRegistration.
|Parameter name||Description||Possible value||Required|
|inventoryRegistrationID||Get one specific Inventory Registration.||Integer|
|inventoryRegistrationIDs||Multiple Inventory Registration IDs, separated by commas, such as: 1,2,3,4,5.||String|
|warehouseID||Retrieve inventory registrations of a specific location (warehouse, store). See getWarehouses.||Integer|
|cause||Search for an Inventory Registration by the text field "Source of received inventory". Only exact matches are returned (field full contents must match).||String|
|getCost||If set to 1, API also returns the cost.||Integer|
|searchAttributeName||Name of attribute to search from. Both "searchAttributeName" and "searchAttributeValue" have to be specified. Error 1030 will be returned if value is an array.||String|
|searchAttributeValue||Attribute value to search for. Error 1030 will be returned if value is an array.||String|
|changedSince||Retrieve only items that have been added or modified since the specified timestamp. Use it to keep a local database in sync with Erply.||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|
|inventoryRegistrationID||Integer||ID of inventory registration|
|inventoryRegistrationNo||Integer||Inventory registration number|
|reasonID||Integer||Reason Code ID. This field is returned only if the "Reason codes for Inventory registrations" module has been enabled on your account. Contact customer support to enable it.|
|currencyCode||String||Currency code: EUR, USD.|
Exchange rate of the inventory registration currency against system's default currency.
|inventoryTransactionDate||Date||Inventory transaction date.
This is the date on which the document was confirmed and when the items on this document were added into inventory, or removed from inventory. While "document date" can be edited by users at any time, "inventory transaction date" is always set by Erply and cannot be changed.
Inventory Reports and COGS reports are based on the inventory transaction date.
|cause||String||Source of received inventory|
|confirmed||Integer||0 or 1|
|added||Unix timestamp||Creation time.|
|lastModified||Unix timestamp||Last modification time.|
|rows||Array||Each row contains the following fields:
|attributes||Array||Additional attributes. Each item looks like this: