Pay out an amount of cash from register.

For cash drops, use POSCashIN. To get a list of all cash drops and cash payouts, use getCashIns.

Input parameters

Parameter nameDescriptionPossible valueRequired
transactionIDCash drop transaction ID.
Set this parameter to update an existing Transaction.
pointOfSaleIDPoint of sale IDInteger yes
employeeIDEmployee doing the payout. If omitted, Erply assumes payout was done by the user who sent the API call.Integer
sumDecimal yes
currencyCodeCurrency code: EUR, USD. Currency must be defined in Erply. If omitted, or an unknown currency code is provided, API uses your default currency instead.String (3)
commentString (255)
addedTime when this cash payout took place. Correct timestamps are very important for the day end Z Report to be correct. If omitted, InventoryAPI uses current server timestamp.Unix timestamp
*************Additional attributes associated with this item.
Attributes must be supplied as a flat list, each attribute defined by the following set of three parameters. Replace # with set number (1, 2, 3, ...). When updating an existing entry, API will only update the attributes specified in input data and leave all other existing attributes unchanged. To delete an attribute, set its value to 'null' or 'undefined'.
attributeName#Attribute name. Name can only contain the following symbols: A-Z, a-z, 0-9, dash and underscore.String
attributeType#Attribute type, possible types are 'text', 'int' and 'double'. By default 'text'.String
attributeValue#Value of the attribute. Set value to 'null' or 'undefined' to delete an attribute.
'text' attribute can be any string, maximum 255 characters.
'int' must be a signed 32-bit integer.
'double' must be a decimal number.


Field nameTypeDescription
transactionIDIntegerID of the created/updated cash drop transaction.
addedUnixTimeUnix timestamp