v1

latestOpenAPI 3.0.0Apache 2.02026-07-142008071.1 MB
CashDrawers

ListCashDrawerShiftEvents

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

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

Path parameters

shift_idstring required

The shift ID.

Query parameters

location_idstring required

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

limitinteger

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

cursorstring

Opaque cursor for fetching the next page of results.

Response

Success

cursorstring

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

Example response

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