getCashIns

Retrieve POS cash drops and cash payouts.

A cash drop can be recorded with API call POSCashIN and a payout with POSCashOUT. These operations are printed on the register's day-end Z Report.

By convention, a cash drop with an amount of 0 is an indicator of "No Sale", ie. just opening the drawer.

Input parameters

Parameter name Description Possible value Required
warehouseID  Warehouse ID.  Integer    
pointOfSaleID  Point of sale ID.  Integer    
employeeID  Employee ID.  Integer    
dateTimeFrom  Beginning of the date interval for which you want to retrieve POS cash drops and cash payouts (deprecated alternative name: startDateTime).  ISO date and time string ("yyyy-mm-dd hh:mm:ss")    
dateTimeUntil  End of the date interval for which you want to retrieve POS cash drops and cash payouts (deprecated alternative name: endDateTime).  ISO date and time string ("yyyy-mm-dd hh:mm:ss")    
searchAttributeName  Search from attribute name. searchAttributeName and searchAttributeValue have to be specified both.  String    
searchAttributeValue  Search from attribute value.  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 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
transactionID  Integer  ID of the cash drop or cash payout transaction.

In ERPLY, cash drops and payouts are stored in the same table, so there cannot be a cash drop and cash payout with the same ID.  
sum  Decimal    
currencyCode  String  Currency code: EUR, USD.  
currencyRate  Decimal    
warehouseID  Integer  Warehouse ID.  
warehouseName  String  Warehouse name.  
pointOfSaleID  Integer  Point of sale ID.  
pointOfSaleName  Integer  Point of sale name.  
employeeID  Integer  Employee ID.  
employeeName  String  Employee name.  
dateTime  ISO date and time string ("yyyy-mm-dd hh:mm:ss")    
comment  String (255)    
added  Unix timestamp  Creation time.  
lastModified  Unix timestamp  Last modification time.  
attributes  Array  Additional attributes. Each item looks like this:

Field nameTypeDescription
attributeNameStringAttribute name
attributeTypeStringAttribute type
attributeValueStringAttribute value