BreakTypes
Create, update, delete, and query the available break types in Square. Note: Square enforces a maximum of 3 break types per location.
Table Specific Information
Select
The add-in uses the Square API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the add-in.
- Id supports the following operator: =.
- LocationId supports the following operator: =.
Retrieve all break types:
SELECT * FROM BreakTypes
Retrieve a specific break type:
SELECT * FROM BreakTypes WHERE Id = 'REGS1EQR1TPZ5'
Retrieve break types for a specific location:
SELECT * FROM BreakTypes WHERE LocationId = '92BYHNBR6W77E'
Insert
To create a break type, you must specify the LocationId, BreakName, ExpectedDuration, and IsPaid columns.
INSERT INTO BreakTypes (LocationId, BreakName, ExpectedDuration, IsPaid) VALUES ('92BYHNBR6W77E', 'Tea Break', 'PT5M', true)
Update
Modify the details of an existing break type by providing the Id of the break type:
UPDATE BreakTypes SET BreakName = 'Updated Break', ExpectedDuration = 'PT10M', IsPaid = false WHERE Id = 'REGS1EQR1TPZ5'
Delete
Delete a break type by providing the Id of the break type:
DELETE FROM BreakTypes WHERE Id = 'REGS1EQR1TPZ5'
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
The UUID for this object. |
| LocationId | String | False |
The ID of the business location this break type belongs to. |
| BreakName | String | False |
A custom name for this type of break. |
| ExpectedDuration | String | False |
Format: ISO 8601 duration. The expected length of this break. Represented as a duration string (e.g., PT30M for 30 minutes). |
| IsPaid | Boolean | False |
Whether this break type counts as paid time. |
| Version | Integer | False |
Used for resolving concurrency issues. The request fails if the version provided does not match the server version at the time of the request. If not provided, Square executes a blind write; potentially overwriting data from another write. |
| CreatedAt | Datetime | True |
A read-only timestamp in RFC 3339 format; presented in UTC. |
| UpdatedAt | Datetime | True |
A read-only timestamp in RFC 3339 format; presented in UTC. |
Pseudocolumns
Pseudo column fields are used in the WHERE clause of SELECT statements (unless stated otherwise) and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| IdempotencyKey | String |
A unique string that identifies the request. Supported only for INSERT operations. Maximum length is 45 characters. |