Time Off Balances

The TimeOffBalance object is used to represent a Time Off Balance for an employee.

The TimeOffBalance object

Properties

idString

Required

remote_idString

Optional

The third-party API ID of the matching object.

employeeString

Optional

balanceNumber

Optional

The current remaining PTO balance in terms of hours. This does not represent the starting PTO balance. If the API provider only provides PTO balance in terms of days, we estimate 8 hours per day.

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, or - in cases where there is no clear mapping - the original value passed through.

remote_was_deletedBoolean

Required

Indicates whether or not this object has been deleted on the third-party.

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
}

GET

/time-off-balances

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 deleted in the third-party service.

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, will only return objects modified after this datetime.

modified_beforeString

Optional

If provided, will only return objects modified before this datetime.

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_idString

Optional

The API provider's ID for the given object.

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
    }
  ]
}

CharlieHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

balanceNumber

remote_idString

usedNumber

employeeString

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

balanceNumber

remote_idString

usedNumber

policy_typeEnum

employeeString

Altera Payroll

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

balanceNumber

usedNumber

policy_typeEnum

employeeString

Proliant

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

balanceNumber

remote_idString

usedNumber

policy_typeEnum

employeeString

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

balanceNumber

usedNumber

policy_typeEnum

employeeString

Hint: Use the /linked-accounts endpoint to pull platform support information.

GET

/time-off-balances/{id}

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.

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
}

CharlieHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

balanceNumber

remote_idString

usedNumber

employeeString

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

balanceNumber

remote_idString

usedNumber

policy_typeEnum

employeeString

Altera Payroll

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

balanceNumber

usedNumber

policy_typeEnum

employeeString

Proliant

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

balanceNumber

remote_idString

usedNumber

policy_typeEnum

employeeString

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

balanceNumber

usedNumber

policy_typeEnum

employeeString

Hint: Use the /linked-accounts endpoint to pull platform support information.

Time Off

Next Up

Account Details

Time Off Balances

The TimeOffBalance object

Properties

/time-off-balances

Header Parameters

Query & Path Parameters

CharlieHR

Workday

Sage HR

BambooHR

UKG Ready

Justworks

Personio

Humaans.io

Altera Payroll

Proliant

UKG Pro

/time-off-balances/{id}

Header Parameters

Query & Path Parameters

CharlieHR

Workday

Sage HR

BambooHR

UKG Ready

Justworks

Personio

Humaans.io

Altera Payroll

Proliant

UKG Pro

Previous

Next Up

Get Started

API Reference