---
title: "Get all cash events"
method: GET
path: "/v3/merchants/{mId}/cash_events"
tags: ["CASH"]
---

# Get all cash events

`GET /v3/merchants/{mId}/cash_events`

Retrieve all cash events for this merchant. Cash events can also be consumed by registering a Webhook callback. See https://docs.clover.com/build/webhooks/

## Path parameters

- `mId` string, required

## Query parameters

- `filter` string
- `expand` string

## Headers

- `User-Agent` string, required

## Response `200`

- object
  - `type` 'LOAD' | 'TRANSACTION' | 'OPEN' | 'ADJUSTMENT' | 'COUNT' | 'UNLOAD' — The type of event that occurred
  - `amountChange` integer — The amount that was either added, removed of modified by the event
  - `timestamp` integer — Time at which the event was executed
  - `note` string — Any additional information regarding the event
  - `employee` object — The employee who performed the event
    - `id` string — Unique identifier
    - `name` string, required — Full name of the employee
    - `nickname` string — Nickname of the employee (shows up on receipts)
    - `customId` string — Custom ID of the employee
    - `email` string — Email of the employee (optional)
    - `inviteSent` boolean — Returns true if this employee was sent an invite to activate their account
    - `claimedTime` integer — Timestamp of when this employee claimed their account
    - `deletedTime` integer — Timestamp of when this employee was deleted
    - `pin` string — Employee PIN (hashed)
    - `unhashedPin` string — Employee PIN
    - `role` 'OWNER' | 'ADMIN' | 'MANAGER' | 'EMPLOYEE' — Employee System Role
    - `roles` object[]
      - `id` string — Unique identifier.
    - `isOwner` boolean — Returns true if this employee is the owner account for this merchant
    - `shifts` object[] — This employee's shifts
      - `id` string — Unique identifier.
    - `payments` object[] — This employee's payments
      - `id` string — Unique identifier.
    - `orders` object[] — This employee's orders
      - `id` string — Unique identifier.
    - `employeeCards` object[] — This employee's employee cards
      - `id` string — Unique identifier.
    - `merchant` object — The merchant employing this employee.
      - `id` string — Unique identifier.
  - `device` object — The device that initiated the event
    - `id` string — Unique identifier
    - `name` string — Name of the device (if entered)
    - `model` string
    - `merchant` object
      - `id` string — Unique identifier.
    - `orderPrefix` string — A prefix that will be applied to order numbers. This is useful if the merchant and/or customer needs to track which device an order came from.
    - `terminalId` string — The merchant device's terminal Id. FD-IPG sets the merchant_device terminal Id for LATAM devices
    - `terminalPrefix` integer
    - `serial` string — The device's serial number.
    - `buildNumber` integer
    - `secureId` string
    - `buildType` 'ENG' | 'USER' | 'USERDEBUG'
    - `cpuId` string
    - `imei` string — The IMEI of the device
    - `imsi` string — The IMSI of the SIM in the device (if present)
    - `simIccid` string — The ICCID of the SIM in the device (if present)
    - `deviceCertificate` string
    - `pedCertificate` string
    - `deviceTypeName` string
    - `productName` string
    - `pinDisabled` boolean — Whether this device has PIN prompt disabled.
    - `offlinePayments` boolean
    - `offlinePaymentsAll` boolean
    - `offlinePaymentsLimit` integer
    - `offlinePaymentsPromptThreshold` integer
    - `offlinePaymentsTotalPaymentsLimit` integer
    - `offlinePaymentsLimitDefault` integer
    - `offlinePaymentsPromptThresholdDefault` integer
    - `offlinePaymentsTotalPaymentsLimitDefault` integer
    - `offlinePaymentsMaxLimit` integer
    - `offlinePaymentsMaxTotalPaymentsLimit` integer
    - `showOfflinePayments` boolean
    - `maxOfflineDays` integer
    - `allowStoreAndForward` boolean
    - `secureReports` object[]
      - `id` string — Unique identifier.
    - `bundleIndicator` string
    - `deviceType` object
      - `id` string — Unique identifier.
  - `merchant` object — The event occurred for this merchant.
    - `id` string — Unique identifier.

---

[API](https://skmtc.net/clover/apis/platform-api.md) · [All operations](https://skmtc.net/clover/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/clover/platform-api/revisions/08da265101a3/schema)