Time Off Balance

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

The TimeOffBalance object

Properties


idString
Optional

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

employeeString
Optional
The employee the balance belongs to.

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

remote_dataRemoteData[]
Optional

The TimeOffBalance object

{
  "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_data": [
    {
      "path": "/leave",
      "data": [
        "Varies by platform"
      ]
    }
  ]
}

GET

/time-off-balance

Returns a list of TimeOffBalance objects.


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_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

{
  "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_data": [
        {
          "path": "/leave",
          "data": [
            "Varies by platform"
          ]
        }
      ]
    }
  ]
}
Field support by platform

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

employeeString

balanceNumber

usedNumber

remote_idString

Humaans.io

Humaans.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

employeeString

balanceNumber

usedNumber

remote_idString

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

employeeString

balanceNumber

usedNumber

Personio

Personio

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

employeeString

balanceNumber

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

employeeString

balanceNumber

policy_typeEnum

BambooHR

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

employeeString

balanceNumber

usedNumber

policy_typeEnum

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

employeeString

balanceNumber

usedNumber

policy_typeEnum
GET

/time-off-balance/{id}

Returns an 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.

idString
Required

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

Response

{
  "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_data": [
    {
      "path": "/leave",
      "data": [
        "Varies by platform"
      ]
    }
  ]
}
Field support by platform

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

employeeString

balanceNumber

usedNumber

remote_idString

Humaans.io

Humaans.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

employeeString

balanceNumber

usedNumber

remote_idString

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

employeeString

balanceNumber

usedNumber

Personio

Personio

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

employeeString

balanceNumber

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

employeeString

balanceNumber

policy_typeEnum

BambooHR

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

employeeString

balanceNumber

usedNumber

policy_typeEnum

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

employeeString

balanceNumber

usedNumber

policy_typeEnum