Object Index
/ Definition
You are viewing an old version of the API
BreakType
Object Index / Definition
A defined break template that sets an expectation for possible Break
instances on a Shift
Properties
| Name | Description |
|---|---|
id
|
UUID for this object. |
break_name
Required
|
A human-readable name for this type of break. Will be displayed to employees in Square products. |
expected_duration
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. |
is_paid
Required
|
Whether this break counts towards time worked for compensation purposes. |
location_id
Required
|
The ID of the business location this type of break applies to. |
created_at
|
A read-only timestamp in RFC 3339 format. |
updated_at
|
A read-only timestamp in RFC 3339 format. |
version
|
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. |