Time Off Balances
The
TimeOffBalance object is used to represent current balances for an employee's Time Off plan.Properties
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
employeeUUIDOptional
The employee the balance belongs to.
balanceNumberOptional
The current remaining PTO balance, measured in hours. For integrations that return this value in days, Merge multiplies by 8 to calculate hours.
usedNumberOptional
The amount of PTO used in terms of hours. For integrations that return this value in days, Merge multiplies by 8 to calculate hours.
policy_typeEnumOptional
The policy type of this time off balance. Possible values include:
VACATION, 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_deletedBooleanRequired
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
field_mappingsObjectOptional
remote_dataRemoteData[]Optional
GET
/time-off-balances
https://api.merge.dev/api/hris/v1/time-off-balances
US
EU
APAC
Returns a list of TimeOffBalance objects.
Query & Path Parameters
created_afterDateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
employee_idStringOptional
If provided, will only return time off balances for this employee.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBooleanOptional
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
modified_afterDateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeIntegerOptional
Number of results to return per page.
policy_typeStringOptional
If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
remote_idStringOptional
The API provider's ID for the given object.
show_enum_originsStringOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
ADP Workforce Now
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDpolicy_typeEnumremote_dataRemoteData[]pathstringdatastringusedNumber
Altera Payroll
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDpolicy_typeEnumremote_dataRemoteData[]pathstringdatastringusedNumber
BambooHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDpolicy_typeEnumremote_dataRemoteData[]pathstringdatastringusedNumber
Charlie
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringusedNumber
Dayforce
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDpolicy_typeEnumremote_dataRemoteData[]pathstringdatastring
Hibob
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDpolicy_typeEnumremote_dataRemoteData[]pathstringdatastringusedNumber
Humaans
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDpolicy_typeEnumremote_dataRemoteData[]pathstringdatastringremote_idStringusedNumber
Justworks
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDpolicy_typeEnumusedNumber
PayCaptain
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDusedNumber
Personio
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDpolicy_typeEnumremote_dataRemoteData[]pathstringdatastringremote_idString
Planday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
employeeUUIDremote_dataRemoteData[]pathstringdatastringremote_idString
Proliant
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDpolicy_typeEnumremote_dataRemoteData[]pathstringdatastringremote_idStringusedNumber
Sage HR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDpolicy_typeEnumremote_dataRemoteData[]pathstringdatastringusedNumber
Sage People
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDremote_dataRemoteData[]pathstringdatastringremote_idString
SAP SuccessFactors
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDpolicy_typeEnumremote_dataRemoteData[]pathstringdatastringremote_idString
UKG Pro
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDpolicy_typeEnumremote_dataRemoteData[]pathstringdatastringusedNumber
UKG Ready
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringusedNumber
Workday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDpolicy_typeEnumremote_dataRemoteData[]pathstringdatastring
Breathe
GET
/time-off-balances/{id}
https://api.merge.dev/api/hris/v1/time-off-balances/{id}
US
EU
APAC
Returns a TimeOffBalance object with the given id.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUIDRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
show_enum_originsStringOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
ADP Workforce Now
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDpolicy_typeEnumremote_dataRemoteData[]pathstringdatastringusedNumberAltera Payroll
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDpolicy_typeEnumremote_dataRemoteData[]pathstringdatastringusedNumberBambooHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDpolicy_typeEnumremote_dataRemoteData[]pathstringdatastringusedNumberCharlie
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringusedNumberDayforce
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDpolicy_typeEnumremote_dataRemoteData[]pathstringdatastringHibob
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDpolicy_typeEnumremote_dataRemoteData[]pathstringdatastringusedNumberHumaans
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDpolicy_typeEnumremote_dataRemoteData[]pathstringdatastringremote_idStringusedNumberJustworks
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDpolicy_typeEnumusedNumberPayCaptain
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDusedNumberPersonio
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDpolicy_typeEnumremote_dataRemoteData[]pathstringdatastringremote_idStringPlanday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
employeeUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringProliant
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDpolicy_typeEnumremote_dataRemoteData[]pathstringdatastringremote_idStringusedNumberSage HR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDpolicy_typeEnumremote_dataRemoteData[]pathstringdatastringusedNumberSage People
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringSAP SuccessFactors
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDpolicy_typeEnumremote_dataRemoteData[]pathstringdatastringremote_idStringUKG Pro
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDpolicy_typeEnumremote_dataRemoteData[]pathstringdatastringusedNumberUKG Ready
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringusedNumberWorkday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
balanceNumberemployeeUUIDpolicy_typeEnumremote_dataRemoteData[]pathstringdatastringBreathe