v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
CASH

Get all cash events for an employee

Retrieve cash events filtered by employee ID. Cash events can also be consumed by registering a Webhook callback. See https://docs.clover.com/build/webhooks/

get/v3/merchants/{mId}/employees/{empId}/cash_events

Path parameters

mIdstring required

Merchant Id

empIdstring required

Employee Id

Query parameters

filterstring

Filter fields: [employee.id, note, amountChange, employee.name, type, device.id, timestamp]

expandstring

Expandable fields: [employee, device]

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

Response

type'LOAD' | 'TRANSACTION' | 'OPEN' | 'ADJUSTMENT' | 'COUNT' | 'UNLOAD'

The type of event that occurred

amountChangeinteger

The amount that was either added, removed of modified by the event

timestampinteger

Time at which the event was executed

notestring

Any additional information regarding the event