List cash drawer shift events

GET

/v2/cash-drawers/shifts/{shift_id}/events

Provides a paginated list of events for a single cash drawer shift.

Permissions:CASH_DRAWER_READ

Guide

List Cash Drawer Shift Events

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

shift_id

string

Required

The shift ID.

Link to section

Query parameters

Link to section

location_id

string

Required

The ID of the location to list cash drawer shifts for.

Link to section

limit

integer(32-bit)

Number of resources to be returned in a page of results (200 by default, 1000 max).

Link to section

cursor

string

Opaque cursor for fetching the next page of results.

Link to section

Response fields

Link to section

cursor

string

Opaque cursor for fetching the next page. Cursor is not present in the last page of results.

Link to section

errors

Any errors that occurred during the request.

Link to section

cash_drawer_shift_events

All of the events (payments, refunds, etc.) for a cash drawer during the shift.

Link to section

Examples

GET /v2/cash-drawers/shifts/{shift_id}/events

curl https://connect.squareup.com/v2/cash-drawers/shifts/shift_id0/events \
  -H 'Square-Version: 2024-04-17' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Response JSON

{
  "cash_drawer_shift_events": [
    {
      "id": "9F07DB01-D85A-4B77-88C3-D5C64CEB5155",
      "event_type": "CASH_TENDER_PAYMENT",
      "event_money": {
        "amount": 100,
        "currency": "USD"
      },
      "created_at": "2019-11-22T00:43:02.000Z",
      "description": "",
      "team_member_id": ""
    },
    {
      "id": "B2854CEA-A781-49B3-8F31-C64558231F48",
      "event_type": "CASH_TENDER_PAYMENT",
      "event_money": {
        "amount": 250,
        "currency": "USD"
      },
      "created_at": "2019-11-22T00:43:12.000Z",
      "description": "",
      "team_member_id": ""
    },
    {
      "id": "B5FB7F72-95CD-44A3-974D-26C41064D042",
      "event_type": "CASH_TENDER_CANCELLED_PAYMENT",
      "event_money": {
        "amount": 250,
        "currency": "USD"
      },
      "created_at": "2019-11-22T00:43:23.000Z",
      "description": "",
      "team_member_id": ""
    },
    {
      "id": "0B425480-8504-40B4-A867-37B23543931B",
      "event_type": "CASH_TENDER_REFUND",
      "event_money": {
        "amount": 100,
        "currency": "USD"
      },
      "created_at": "2019-11-22T00:43:46.000Z",
      "description": "",
      "team_member_id": ""
    },
    {
      "id": "8C66E60E-FDCF-4EEF-A98D-3B14B7ED5CBE",
      "event_type": "PAID_IN",
      "event_money": {
        "amount": 10000,
        "currency": "USD"
      },
      "created_at": "2019-11-22T00:44:18.000Z",
      "description": "Transfer from another drawer",
      "team_member_id": ""
    },
    {
      "id": "D5ACA7FE-C64D-4ADA-8BC8-82118A2DAE4F",
      "event_type": "PAID_OUT",
      "event_money": {
        "amount": 10000,
        "currency": "USD"
      },
      "created_at": "2019-11-22T00:44:29.000Z",
      "description": "Transfer out to another drawer",
      "team_member_id": ""
    }
  ]
}