Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 1.75 KB

break-type.md

File metadata and controls

38 lines (29 loc) · 1.75 KB

Break Type

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

Structure

Break Type

Fields

Name Type Tags Description
id String Optional The UUID for this object.
Constraints: Maximum Length: 255
location_id String Required The ID of the business location this type of break applies to.
Constraints: Minimum Length: 1
break_name String Required A human-readable name for this type of break. The name is displayed to
employees in Square products.
Constraints: Minimum 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.

Example for break expected duration of 15 minutes: T15M
Constraints: Minimum Length: 1
is_paid TrueClass | FalseClass Required Whether this break counts towards time worked for compensation
purposes.
version Integer Optional 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 Optional A read-only timestamp in RFC 3339 format.
updated_at String Optional A read-only timestamp in RFC 3339 format.

Example (as JSON)

{
  "id": "id4",
  "location_id": "location_id8",
  "break_name": "break_name4",
  "expected_duration": "expected_duration0",
  "is_paid": false,
  "version": 236,
  "created_at": "created_at8",
  "updated_at": "updated_at0"
}