<- Object

Object

All versions ->

BreakType

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

Link to section

Properties

Link to section

id

string

UUID for this object.

Max Length
255
Link to section

location_id

string

Required

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

Min Length
1
Link to section

break_name

string

Required

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

Min Length
1
Link to section

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 below minutes is truncated.

Min Length
1
Link to section

is_paid

boolean

Required

Whether this break counts towards time worked for compensation purposes.

Link to section

version

integer(32-bit)

Used for resolving concurrency issues; request will fail if version provided does not match server version at time of request. If a value is not provided, Square's servers execute a "blind" write; potentially overwriting another writer's data.

Link to section

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

Link to section

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