Break Object - Square API Reference

Name	Description
`id string`	UUID for this object
`start_at string` Required	RFC 3339; follows same timezone info as `Shift`. Precision up to the minute is respected; seconds are truncated. Min Length 1
`end_at string`	RFC 3339; follows same timezone info as `Shift`. Precision up to the minute is respected; seconds are truncated.
`break_type_id string` Required	The `BreakType` this `Break` was templated on. Min Length 1
`name string` Required	A human-readable name. 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 the break. Min Length 1
`is_paid boolean` Required	Whether this break counts towards time worked for compensation purposes.

UUID for this object

Required

RFC 3339; follows same timezone info as Shift. Precision up to the minute is respected; seconds are truncated.

Min Length 1

RFC 3339; follows same timezone info as Shift. Precision up to the minute is respected; seconds are truncated.


          
  
  
            break_type_id
          


        

        
    string

Required

The BreakType this Break was templated on.

Min Length 1

Required

A human-readable name.

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 the break.

Min Length 1

Required

Whether this break counts towards time worked for compensation purposes.

Object Index

You are viewing an old version of the API

All Versions

Break