TimeOffBalance
object is used to represent current balances for an employee's Time Off plan.id
UUIDremote_id
Stringcreated_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)employee
UUIDbalance
Numberused
Numberpolicy_type
EnumVACATION
, SICK
, PERSONAL
, JURY_DUTY
, VOLUNTEER
, BEREAVEMENT
. In cases where there is no clear mapping, the original value passed through will be returned.remote_was_deleted
Booleanfield_mappings
Objectremote_data
RemoteData[]https://api.merge.dev/api/hris/v1/time-off-balances
Returns a list of TimeOffBalance
objects.
created_after
DateTime (ISO 8601)created_before
DateTime (ISO 8601)cursor
Stringemployee_id
Stringexpand
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
DateTime (ISO 8601)modified_before
DateTime (ISO 8601)page_size
Integerpolicy_type
Stringremote_fields
Stringremote_id
Stringshow_enum_origins
String![ADP Workforce Now](https://merge-api-production.s3.amazonaws.com/media/ADP_Square_Logo_GXCPXY1.jpg)
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringused
Number![Altera Payroll](https://merge-api-production.s3.amazonaws.com/media/Altera_Square_Logo.png)
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringused
Number![BambooHR](https://merge-api-production.s3.amazonaws.com/media/BambooHR_Square_Logo.jpg)
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringused
Number![Charlie](https://merge-api-production.s3.amazonaws.com/media/CharlieHR_Square_Logo.png)
Supported Response Fields
balance
Numberemployee
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringused
Number![Dayforce](https://merge-api-production.s3.amazonaws.com/media/PlatformDayforce.png)
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
string![Hibob](https://merge-api-production.s3.amazonaws.com/media/PlatformHibob.png)
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringused
Number![Humaans](https://merge-api-production.s3.amazonaws.com/media/Humaans_Square_Logo.jpg)
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringremote_id
Stringused
Number![Justworks](https://merge-api-production.s3.amazonaws.com/media/Justworks_Square_Logo.jpg)
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumused
Number![PayCaptain](https://merge-api-production.s3.amazonaws.com/media/Paycaptain_square.png)
Supported Response Fields
balance
Numberemployee
UUIDused
Number![Personio](https://merge-api-production.s3.amazonaws.com/media/Personio_Square_Logo.jpg)
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringremote_id
String![Planday](https://merge-api-production.s3.amazonaws.com/media/PlatformPlanday.png)
Supported Response Fields
employee
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
String![Proliant](https://merge-api-production.s3.amazonaws.com/media/Proliant_Square_Logo.jpg)
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringremote_id
Stringused
Number![Sage HR](https://merge-api-production.s3.amazonaws.com/media/Sage_Square_Logo_FAQpKpP.jpg)
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringused
Number![SAP SuccessFactors](https://merge-api-production.s3.amazonaws.com/media/SuccessFactors_Square_Logo_BcXogF0.jpg)
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringremote_id
String![UKG Pro](https://merge-api-production.s3.amazonaws.com/media/UKG_Square_Logo_fl9LQnt.png)
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringused
Number![UKG Ready](https://merge-api-production.s3.amazonaws.com/media/UKG_Square_Logo_fl9LQnt_jYRGZr5.png)
Supported Response Fields
balance
Numberemployee
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringused
Number![Workday](https://merge-api-production.s3.amazonaws.com/media/Workday_Square_Logo.jpg)
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
string![Breathe](https://merge-api-production.s3.amazonaws.com/media/__sized__/Breathe_Square_Logo_FY9Zgjm-thumbnail-144x144-70.jpg)
https://api.merge.dev/api/hris/v1/time-off-balances/{id}
Returns a TimeOffBalance
object with the given id
.
expand
Stringid
UUIDinclude_remote_data
Booleanremote_fields
Stringshow_enum_origins
String![ADP Workforce Now](https://merge-api-production.s3.amazonaws.com/media/ADP_Square_Logo_GXCPXY1.jpg)
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringused
Number![Altera Payroll](https://merge-api-production.s3.amazonaws.com/media/Altera_Square_Logo.png)
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringused
Number![BambooHR](https://merge-api-production.s3.amazonaws.com/media/BambooHR_Square_Logo.jpg)
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringused
Number![Charlie](https://merge-api-production.s3.amazonaws.com/media/CharlieHR_Square_Logo.png)
Supported Response Fields
balance
Numberemployee
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringused
Number![Dayforce](https://merge-api-production.s3.amazonaws.com/media/PlatformDayforce.png)
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
string![Hibob](https://merge-api-production.s3.amazonaws.com/media/PlatformHibob.png)
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringused
Number![Humaans](https://merge-api-production.s3.amazonaws.com/media/Humaans_Square_Logo.jpg)
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringremote_id
Stringused
Number![Justworks](https://merge-api-production.s3.amazonaws.com/media/Justworks_Square_Logo.jpg)
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumused
Number![PayCaptain](https://merge-api-production.s3.amazonaws.com/media/Paycaptain_square.png)
Supported Response Fields
balance
Numberemployee
UUIDused
Number![Personio](https://merge-api-production.s3.amazonaws.com/media/Personio_Square_Logo.jpg)
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringremote_id
String![Planday](https://merge-api-production.s3.amazonaws.com/media/PlatformPlanday.png)
Supported Response Fields
employee
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
String![Proliant](https://merge-api-production.s3.amazonaws.com/media/Proliant_Square_Logo.jpg)
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringremote_id
Stringused
Number![Sage HR](https://merge-api-production.s3.amazonaws.com/media/Sage_Square_Logo_FAQpKpP.jpg)
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringused
Number![SAP SuccessFactors](https://merge-api-production.s3.amazonaws.com/media/SuccessFactors_Square_Logo_BcXogF0.jpg)
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringremote_id
String![UKG Pro](https://merge-api-production.s3.amazonaws.com/media/UKG_Square_Logo_fl9LQnt.png)
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringused
Number![UKG Ready](https://merge-api-production.s3.amazonaws.com/media/UKG_Square_Logo_fl9LQnt_jYRGZr5.png)
Supported Response Fields
balance
Numberemployee
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringused
Number![Workday](https://merge-api-production.s3.amazonaws.com/media/Workday_Square_Logo.jpg)
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
string![Breathe](https://merge-api-production.s3.amazonaws.com/media/__sized__/Breathe_Square_Logo_FY9Zgjm-thumbnail-144x144-70.jpg)