List Break Types - Automate.ax

square.listBreakTypes returns a paginated list of BreakType instances for a business.

Example

automations/square-list-break-types.automation.ts

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

export default automation("List Square Break Types", () => {
  onDashboardRun({ title: "List Square Break Types" })

  square.listBreakTypes({
    locationId: "location_id",
    limit: 1,
    cursor: "cursor",
  })
})

Inputs

Every input accepts a compatible signal. It requires TIMECARDS_SETTINGS_READ.

Field	Type	Required	Default	Description
`locationId`	`string \| null`	No	—	Filter the returned `BreakType` results to only those that are associated with the specified location.
`limit`	`number \| null`	No	—	The maximum number of `BreakType` results to return per page. The number can range between 1 and 200. The default is 200.
`cursor`	`string \| null`	No	—	A pointer to the next page of `BreakType` results to fetch.

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

Output

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