Time Off Balances
The TimeOffBalance object is used to represent current balances for an employee's Time Off plan.
Properties

idUUID
Required

remote_idString
Optional
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.

employeeUUID
Optional
The employee the balance belongs to.

balanceNumber
Optional
The current remaining PTO balance, always measured in terms of hours.

usedNumber
Optional
The amount of PTO used in terms of hours.

policy_typeEnum
Optional
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.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted in the third party platform.

field_mappingsObject
Optional

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.

cursorString
Optional
The pagination cursor value.

employee_idString
Optional
If provided, will only return time off balances for this employee.

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

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_sizeInteger
Optional
Number of results to return per page.

policy_typeString
Optional
If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')

remote_fieldsString
Optional
Deprecated. Use show_enum_origins.

remote_idString
Optional
The API provider's ID for the given object.

show_enum_originsString
Optional
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 fields
Use the /linked-accounts endpoint to pull platform support information
Altera Payroll
Altera Payroll
BambooHR
BambooHR
Charlie
Charlie
Dayforce
Dayforce
Humaans
Humaans
Justworks
Justworks
PayCaptain
PayCaptain
Personio
Personio
Proliant
Proliant
Sage HR
Sage HR
SAP SuccessFactors
SAP SuccessFactors
UKG Pro
UKG Pro
UKG Ready
UKG Ready
Workday
Workday
ADP Workforce Now
ADP Workforce Now
Coming soon
Breathe
Breathe
Coming soon
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

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idUUID
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

remote_fieldsString
Optional
Deprecated. Use show_enum_origins.

show_enum_originsString
Optional
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 fields
Use the /linked-accounts endpoint to pull platform support information
Altera Payroll
Altera Payroll
BambooHR
BambooHR
Charlie
Charlie
Dayforce
Dayforce
Humaans
Humaans
Justworks
Justworks
PayCaptain
PayCaptain
Personio
Personio
Proliant
Proliant
Sage HR
Sage HR
SAP SuccessFactors
SAP SuccessFactors
UKG Pro
UKG Pro
UKG Ready
UKG Ready
Workday
Workday
ADP Workforce Now
ADP Workforce Now
Coming soon
Breathe
Breathe
Coming soon