Time Off Balances
TheTimeOffBalance
object is used to represent current balances for an employee's Time Off plan.The TimeOffBalance object
Properties
id
Stringremote_id
Stringemployee
Stringbalance
Numberused
Numberpolicy_type
EnumVACATION
, SICK
, PERSONAL
, JURY_DUTY
, VOLUNTEER
, BEREAVEMENT
, or - in cases where there is no clear mapping - the original value passed through.remote_was_deleted
Booleanfield_mappings
Objectremote_data
RemoteData[]{"id": "91b2b905-e866-40c8-8be2-efe53827a0aa","remote_id": "19202938","employee": "d2f972d0-2526-434b-9409-4c3b468e08f0","balance": "60.0","used": "45.0","policy_type": "VACATION","remote_was_deleted": true,Show advanced fields}
/time-off-balances
Returns a list of TimeOffBalance
objects.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
created_after
Stringcreated_before
Stringcursor
Stringemployee_id
Stringexpand
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
Stringmodified_before
Stringpage_size
Integerpolicy_type
Stringremote_fields
Stringremote_id
Stringshow_enum_origins
String{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"id": "91b2b905-e866-40c8-8be2-efe53827a0aa","remote_id": "19202938","employee": "d2f972d0-2526-434b-9409-4c3b468e08f0","balance": "60.0","used": "45.0","policy_type": "VACATION","remote_was_deleted": true,Show advanced fields}]}

Altera Payroll
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
balance
Numberemployee
Stringpolicy_type
Enumremote_data
RemoteData[]path
stringdata
objectused
Number
BambooHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
balance
Numberemployee
Stringpolicy_type
Enumremote_data
RemoteData[]path
stringdata
objectused
Number
Ceridian Dayforce
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
balance
Numberemployee
Stringpolicy_type
Enumremote_data
RemoteData[]path
stringdata
object
Charlie
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
balance
Numberemployee
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringused
Number
Humaans
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
balance
Numberemployee
Stringpolicy_type
Enumremote_data
RemoteData[]path
stringdata
objectremote_id
Stringused
Number
Justworks
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
balance
Numberemployee
Stringpolicy_type
Enumused
Number
PayCaptain
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
balance
Numberemployee
Stringused
Number
Personio
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
balance
Numberemployee
Stringpolicy_type
Enumremote_id
String
Proliant
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
balance
Numberemployee
Stringpolicy_type
Enumremote_data
RemoteData[]path
stringdata
objectremote_id
Stringused
Number
Sage HR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
balance
Numberemployee
Stringpolicy_type
Enumremote_data
RemoteData[]path
stringdata
objectused
Number
UKG Pro
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
balance
Numberemployee
Stringpolicy_type
Enumremote_data
RemoteData[]path
stringdata
objectused
Number
UKG Ready
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
balance
Numberemployee
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringused
Number
Workday
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
balance
Numberemployee
Stringpolicy_type
Enumremote_data
RemoteData[]path
stringdata
object
ADP Workforce Now

Breathe
/time-off-balances/{id}
Returns a TimeOffBalance
object with the given id
.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
expand
Stringid
Stringinclude_remote_data
Booleanremote_fields
Stringshow_enum_origins
String{"id": "91b2b905-e866-40c8-8be2-efe53827a0aa","remote_id": "19202938","employee": "d2f972d0-2526-434b-9409-4c3b468e08f0","balance": "60.0","used": "45.0","policy_type": "VACATION","remote_was_deleted": true,Show advanced fields}

Altera Payroll
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
balance
Numberemployee
Stringpolicy_type
Enumremote_data
RemoteData[]path
stringdata
objectused
Number
BambooHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
balance
Numberemployee
Stringpolicy_type
Enumremote_data
RemoteData[]path
stringdata
objectused
Number
Ceridian Dayforce
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
balance
Numberemployee
Stringpolicy_type
Enumremote_data
RemoteData[]path
stringdata
object
Charlie
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
balance
Numberemployee
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringused
Number
Humaans
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
balance
Numberemployee
Stringpolicy_type
Enumremote_data
RemoteData[]path
stringdata
objectremote_id
Stringused
Number
Justworks
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
balance
Numberemployee
Stringpolicy_type
Enumused
Number
PayCaptain
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
balance
Numberemployee
Stringused
Number
Personio
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
balance
Numberemployee
Stringpolicy_type
Enumremote_id
String
Proliant
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
balance
Numberemployee
Stringpolicy_type
Enumremote_data
RemoteData[]path
stringdata
objectremote_id
Stringused
Number
Sage HR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
balance
Numberemployee
Stringpolicy_type
Enumremote_data
RemoteData[]path
stringdata
objectused
Number
UKG Pro
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
balance
Numberemployee
Stringpolicy_type
Enumremote_data
RemoteData[]path
stringdata
objectused
Number
UKG Ready
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
balance
Numberemployee
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringused
Number
Workday
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
balance
Numberemployee
Stringpolicy_type
Enumremote_data
RemoteData[]path
stringdata
object
ADP Workforce Now
