List Cash Drawer Shifts - Automate.ax

square.listCashDrawerShifts provides the details for all of the cash drawer shifts for a location in a date range.

Example

automations/square-list-cash-drawer-shifts.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("List Square Cash Drawer Shifts", () => {
  onDashboardRun({ title: "List Square Cash Drawer Shifts" })

  square.listCashDrawerShifts({
    locationId: "location_id",
    sortOrder: "DESC",
    beginTime: "begin_time",
    endTime: "end_time",
    limit: 1,
    cursor: "cursor",
  })
})

Inputs

Every input accepts a compatible signal. It requires CASH_DRAWER_READ.

Field	Type	Required	Default	Description
`locationId`	`string`	Yes	—	The ID of the location to query for a list of cash drawer shifts.
`sortOrder`	`Square.SortOrder \| null`	No	—	The order in which cash drawer shifts are listed in the response, based on their opened_at field. Default value: ASC
`beginTime`	`string \| null`	No	—	The inclusive start time of the query on opened_at, in ISO 8601 format.
`endTime`	`string \| null`	No	—	The exclusive end date of the query on opened_at, in ISO 8601 format.
`limit`	`number \| null`	No	—	Number of cash drawer shift events in a page of results (200 by default, 1000 max).
`cursor`	`string \| null`	No	—	Opaque cursor for fetching the next page of results.

Use the official ListCashDrawerShifts reference for provider field semantics and limits.

Output

Returns the official Square.ListCashDrawerShiftsResponse response as a codec-safe object. Square integer money amounts remain bigint values.