POS Cash Drawer Transactions

Overview

Aggregate cash drawer transaction information for a specific location.

Methods

Retrieve Cash Drawer Transactions

Retrieve a specific location cash drawer transactions for a given time frame.

GET /pos/v2/{locationId}/cash-drawer-transactions

Query Parameters

Name Type Description
filter object Set of search parameters. They can be defined as a URI parameters or JSON object
filter.dateTimeFrom string date from in ISO 8601 format, e.g., 2007-03-01T00:00:00Z
filter.dateTimeTo string date to in ISO 8601 format, e.g., 2007-03-01T23:59:59Z

Response 200

Returns a collection of Cash Drawer Transaction objects

{
  "results": [
    {
      "posRef": "string",
      "employeeRef": "string",
      "transactionType": "drawer-cash-in",
      "amount": 0,
      "reason": "string",
      "createdAt": "2025-06-04T12:38:48.599Z",
      "tillRef": "string"
    }
  ],
  "meta": {}
}

Definitions

Cash Drawer Transaction

Name Type Description
posRef* string POS Cash Drawer Transaction reference ID. Unique per location.
employeeRef string POS Employee reference. Available only if it's provided by POS, otherwise null.
transactionType* string ENUM of supported types:
  • drawer-cash-in - The total amount of money in cash that is coming into the drawer that is not part of the sale, e.g. money from Coke machine or valet parking
  • drawer-cash-out - The total amount of money in cash that is taken from the drawer to cover some expenses like paying suppliers or buying some inventory
  • drawer-starting-cash - Cash amount being put into the drawer at the beginning of the shift so that cashier would have cash for change
  • drawer-safe-drop - Amount of money that is taken out of the cash drawer and is put into a safe for security reasons
  • drawer-cash-counted - Entered by the employees counted cash amount in the drawer. Usually is done at the end of the shift as part of the clock-out procedureNOTE: We suggest excluding this value from balance reports. This is not a mandatory procedure for some POS systems and might imbalance the report when accounted for
  • drawer-remove - Till removed from the drawer. The amount is the expected cash amount of all sales transactions which where not voided
  • drawer-no-sale - The drawer was opened without changing the cash amount in the till
  • sale-cash-received - The total cash tendered from a sale
  • sale-cash-change - Change that was given from a sale transaction
  • sale-cash-refund - The cash that was taken out from the drawer to cover the refunded amount
  • sale-void - The cash that was taken out from the drawer to cover voided payment amount or the drawer popped out for non-cash void
  • sale-donation - The donation amount from the sale. It is a change amount in cents that is used for convenience reasons so that customer could donate their pocket change to charity.
  • sale-non-cash-check - The total amount received from checks tender type or different tenders that are considered to be counted as cash like equivalents like personal checks or traveler's checks.The drawer was popped out with any non-cash tender.
  • sale-non-cash-change - The change was paid in cash from the non-cash sale.
  • tip-paid - The total tip amount (including gratuity only if the POS reports it this way) will need to be paid out to employees using cash.
  • tip-reduction - The amount of money that is withheld from credit card transaction tips and stays with an employer
  • gratuity-paid - The gratuity amount will need to be paid out to employees using cash.
  • gratuity-void - Gratuity amount from a ticket when the ticket has been reopened.
amount* number Transaction amount in US cents
reason string Transaction reason, available only if provided by POS.
createdAt* string Date and time in UTC when the cash drawer transaction happened.
tillRef string POS Till reference. Available only if it's provided by POS, otherwise null.

results matching ""

    No results matching ""