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. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.remote_was_deleted
Booleanfield_mappings
Objectremote_data
RemoteData[]RemoteData
object is used to represent the full data pulled from the third-party API for an object.path
Stringdata
Anyhttps://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
Booleaninclude_shell_data
Booleanmodified_after
DateTime (ISO 8601)modified_before
DateTime (ISO 8601)page_size
Integerpolicy_type
Stringremote_fields
Stringremote_id
Stringshow_enum_origins
String
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringused
Number
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringused
Number
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringused
Number
Supported Response Fields
balance
Numberemployee
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringused
Number
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
string
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringused
Number
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringremote_id
Stringused
Number
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumused
Number
Supported Response Fields
balance
Numberemployee
UUIDused
Number
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
employee
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringremote_id
Stringused
Number
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringused
Number
Supported Response Fields
balance
Numberemployee
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringused
Number
Supported Response Fields
balance
Numberemployee
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringused
Number
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
string

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
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringused
Number
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringused
Number
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringused
Number
Supported Response Fields
balance
Numberemployee
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringused
Number
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
string
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringused
Number
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringremote_id
Stringused
Number
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumused
Number
Supported Response Fields
balance
Numberemployee
UUIDused
Number
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
employee
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringremote_id
Stringused
Number
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringused
Number
Supported Response Fields
balance
Numberemployee
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
stringused
Number
Supported Response Fields
balance
Numberemployee
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringused
Number
Supported Response Fields
balance
Numberemployee
UUIDpolicy_type
Enumremote_data
RemoteData[]path
stringdata
string
