Create Break Type - Automate.ax

square.createBreakType creates a new BreakType.

Example

automations/square-create-break-type.automation.ts

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

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

  square.createBreakType({
    idempotencyKey: "PAD3NG5KSN2GL",
    breakType: {
      locationId: "CGJN03P1D08GF",
      breakName: "Lunch Break",
      expectedDuration: "PT30M",
      isPaid: true,
    },
  })
})

Inputs

Every input accepts a compatible signal. It requires TIMECARDS_SETTINGS_WRITE.

Field	Type	Required	Default	Description
`idempotencyKey`	`string`	No	—	A unique string value to ensure the idempotency of the operation.
`breakType`	`Square.BreakType`	Yes	—	The `BreakType` to be created.

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

Output

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