• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index
You are viewing an old version of the API
BreakType

A defined break template that sets an expectation for possible Break instances on a Shift.

Properties
Name Description
id
string

The UUID for this object.

Max Length 255
location_id
string
Required

The ID of the business location this type of break applies to.

Min Length 1
break_name
string
Required

A human-readable name for this type of break. The name is displayed to employees in Square products.

Min Length 1
expected_duration
string
Required

Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of this break. Precision less than minutes is truncated.

Min Length 1
is_paid
boolean
Required

Whether this break counts towards time worked for compensation purposes.
version
integer (32-bit)

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 a value is not provided, Square's servers execute a "blind" write; potentially overwriting another writer's data.
created_at
string

Read only A read-only timestamp in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00
updated_at
string

Read only A read-only timestamp in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00