getInventoryRegistrations

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.

Input parameters

Parameter name Description Possible value Required
inventoryRegistrationID  Get one specific Inventory Registration.  Integer    
warehouseID  Retrieve inventory registrations of a specific location (warehouse, store). See getWarehouses Integer    
dateFrom    Date (yyyy-mm-dd)    
dateTo    Date (yyyy-mm-dd)    
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    
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 retrive 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
inventoryRegistrationID  Integer  ID of inventory registration  
inventoryRegistrationNo  Integer  Inventory registration number  
creatorID  Integer    
warehouseID  Integer    
inventoryID  Integer    
supplierID  Integer    
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.  
currencyRate  Decimal  eg. 1.25543
Exchange rate of the inventory registration currency against system's default currency.  
date  Date  eg. 2010-01-29  
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:

Field nameTypeDescription
productIDIntegerID of the product.
priceDecimalUnit cost at which product was taken into inventory. However, if you need to track inventory value, it is recommended to use the "cost" field instead; see below.
amountDecimal

Quantity taken into stock.

This value can also be negative; in that case, the quantity was subtracted from stock (written off). When doing inventory adjustments, it might be convenient to put both positive and negative adjustments on the same document.

costDecimal

Unit cost. This value is retrieved from inventory records and it reflects the unit cost at which the item was taken into inventory. For negative quantities, unit cost depends on which inventory batches the subtracted quantity was drawn from.

To retrieve this field, you need to set input parameter "getCost" = 1.

packageIDInteger

Package ID, if the item has been taken into inventory in packages.

To retrieve the packages of a particular product, see getProducts, block "productPackages".

This field, and the following ones, are not returned if your account does not have the "Packages on Inventory Registrations" extra module activated.

amountOfPackagesDecimalAmount of packages
amountInPackageDecimalAmount of products contained in one package
packageTypeStringReadable package type name
packageTypeIDIntegerType ID of the package.