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

idString
Required

remote_idString
Optional
The third-party API ID of the matching object.

employeeString
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 by third party webhooks.

created_atString
Required

modified_atString
Required
This is the datetime that this object was last updated by Merge

field_mappingsObject
Optional

remote_dataRemoteData[]
Optional

The TimeOffBalance object
JSON
{
"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,
"created_at": "2021-09-15T00:00:00Z",
"modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
}

GET
/time-off-balances

https://api.merge.dev/api/hris/v1/time-off-balances

US
EU

Returns a list of TimeOffBalance objects.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.
Query & Path Parameters

created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
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_afterString
Optional
If provided, only objects synced by Merge after this date time will be returned.

modified_beforeString
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
Which fields should be returned in non-normalized form.

Response
JSON
{
"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,
"created_at": "2021-09-15T00:00:00Z",
"modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
}
]
}
Field support by platform
Altera Payroll
Altera Payroll

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


balanceNumber

employeeString

policy_typeEnum

remote_dataRemoteData[]
pathstring
datastring

usedNumber
BambooHR
BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


balanceNumber

employeeString

policy_typeEnum

remote_dataRemoteData[]
pathstring
datastring

usedNumber
Ceridian Dayforce
Ceridian Dayforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


balanceNumber

employeeString

policy_typeEnum

remote_dataRemoteData[]
pathstring
datastring
Charlie
Charlie

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


balanceNumber

employeeString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

usedNumber
Humaans
Humaans

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


balanceNumber

employeeString

policy_typeEnum

remote_dataRemoteData[]
pathstring
datastring

remote_idString

usedNumber
Justworks
Justworks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


balanceNumber

employeeString

policy_typeEnum

usedNumber
PayCaptain
PayCaptain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


balanceNumber

employeeString

usedNumber
Personio
Personio

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


balanceNumber

employeeString

policy_typeEnum

remote_idString
Proliant
Proliant

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


balanceNumber

employeeString

policy_typeEnum

remote_dataRemoteData[]
pathstring
datastring

remote_idString

usedNumber
Sage HR
Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


balanceNumber

employeeString

policy_typeEnum

remote_dataRemoteData[]
pathstring
datastring

usedNumber
UKG Pro
UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


balanceNumber

employeeString

policy_typeEnum

remote_dataRemoteData[]
pathstring
datastring

usedNumber
UKG Ready
UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


balanceNumber

employeeString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

usedNumber
Workday
Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


balanceNumber

employeeString

policy_typeEnum

remote_dataRemoteData[]
pathstring
datastring
ADP Workforce Now
ADP Workforce Now
Coming soon
Breathe
Breathe
Coming soon
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET
/time-off-balances/{id}

https://api.merge.dev/api/hris/v1/time-off-balances/{id}

US
EU

Returns a TimeOffBalance object with the given id.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.
Query & Path Parameters

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

idString
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
Which fields should be returned in non-normalized form.

Response
JSON
{
"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,
"created_at": "2021-09-15T00:00:00Z",
"modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
}
Field support by platform
Altera Payroll
Altera Payroll

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


balanceNumber

employeeString

policy_typeEnum

remote_dataRemoteData[]
pathstring
datastring

usedNumber
BambooHR
BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


balanceNumber

employeeString

policy_typeEnum

remote_dataRemoteData[]
pathstring
datastring

usedNumber
Ceridian Dayforce
Ceridian Dayforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


balanceNumber

employeeString

policy_typeEnum

remote_dataRemoteData[]
pathstring
datastring
Charlie
Charlie

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


balanceNumber

employeeString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

usedNumber
Humaans
Humaans

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


balanceNumber

employeeString

policy_typeEnum

remote_dataRemoteData[]
pathstring
datastring

remote_idString

usedNumber
Justworks
Justworks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


balanceNumber

employeeString

policy_typeEnum

usedNumber
PayCaptain
PayCaptain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


balanceNumber

employeeString

usedNumber
Personio
Personio

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


balanceNumber

employeeString

policy_typeEnum

remote_idString
Proliant
Proliant

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


balanceNumber

employeeString

policy_typeEnum

remote_dataRemoteData[]
pathstring
datastring

remote_idString

usedNumber
Sage HR
Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


balanceNumber

employeeString

policy_typeEnum

remote_dataRemoteData[]
pathstring
datastring

usedNumber
UKG Pro
UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


balanceNumber

employeeString

policy_typeEnum

remote_dataRemoteData[]
pathstring
datastring

usedNumber
UKG Ready
UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


balanceNumber

employeeString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

usedNumber
Workday
Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


balanceNumber

employeeString

policy_typeEnum

remote_dataRemoteData[]
pathstring
datastring
ADP Workforce Now
ADP Workforce Now
Coming soon
Breathe
Breathe
Coming soon
Hint: Use the /linked-accounts endpoint to pull platform support information.