Search

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 nameDescriptionPossible valueRequired
warehouseIDWarehouse ID.Integer
pointOfSaleIDPoint of sale ID.Integer
employeeIDEmployee ID.Integer
dateTimeFromBeginning 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")
dateTimeUntilEnd 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")
searchAttributeNameSearch from attribute name. searchAttributeName and searchAttributeValue have to be specified both.String
searchAttributeValueSearch from attribute value.String
changedSinceRetrieve 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)
recordsOnPageNumber of records API should return. By default 20, at most 100.Integer
pageNoAPI 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 nameTypeDescription
transactionIDIntegerID 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.
sumDecimal
currencyCodeStringCurrency code: EUR, USD.
currencyRateDecimal
warehouseIDIntegerWarehouse ID.
warehouseNameStringWarehouse name.
pointOfSaleIDIntegerPoint of sale ID.
pointOfSaleNameIntegerPoint of sale name.
employeeIDIntegerEmployee ID.
employeeNameStringEmployee name.
dateTimeISO date and time string ("yyyy-mm-dd hh:mm:ss")
commentString (255)
addedUnix timestampCreation time.
lastModifiedUnix timestampLast modification time.
attributesArrayAdditional attributes. Each item looks like this:

Field nameTypeDescription
attributeNameStringAttribute name
attributeTypeStringAttribute type
attributeValueStringAttribute value