Common ModelsTime off balances

/time-off-balances/{id}

Returns a TimeOffBalance object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

expandenumOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
Allowed values:
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).

remote_fieldsenumOptional

Deprecated. Use show_enum_origins.

Allowed values:
show_enum_originsenumOptional
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](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
Allowed values:

Response

idstring or nullRead-onlyformat: "uuid"
remote_idstring or null

The third-party API ID of the matching object.

created_atdatetime or nullRead-only
The datetime that this object was created by Merge.
modified_atdatetime or nullRead-only
The datetime that this object was modified by Merge.
employeestring or nullformat: "uuid"
The employee the balance belongs to.
balancedouble or null
The current remaining PTO balance, measured in hours. For integrations that return this value in days, Merge multiplies by 8 to calculate hours.
useddouble or null
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_typeenum or null
The policy type of this time off balance. * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT
remote_was_deletedboolean or nullRead-only
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](https://docs.merge.dev/integrations/hris/supported-features/).
field_mappingsobject or nullRead-only
remote_datalist of objects or nullRead-only
<MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+WYW2/iOBSA/wryIwLSlrLdIq1WXMqtQ8hymZ1qVEUnziEYnDjYTrmM5r+vAqELM51ZQbOzTPeNOPbn5PM5zjGfCAWNnpArUiYTyRTJEV+4yEmZDJmPvfG4ChwCiiRHIGQm+Jj0tJ+uSI6oKAyF1Og2GHJXtSSOSZkYPkoP81HAxgxdI+5usECjJ0EzESjjeVh+vBlHcoSzYIZuhVIRBfp7oG3HPGx7fnEZ31aa5EgISumJFJE36eM8QvVdZvw8HH0MNPC8CxqMvfF5uQW81BY/uYscNbp10FBHjTR+xWSuidahKhvGBHlY2MxbcPHJwMAAqRnlqIxS8fbq5raUTyib2X+3Pf7bZXY6d4Rzk7U9ym2Ist0hXZrD9sKcetdm7Xpprkclcz1bm9PZRdb2INsddku94UOxV69c9l7oYA9++XD7vlqvdswsXd8VzenDwhzSy+6Qzpx1u9hp0kWn9cfSXD9cdeujojm8K3Wa4rJX66turS+6lUKB5Mj+SpLyx0/7DUmAVOpWxsSlzjQxOBzR9sHDPTPbxYCQ5cPI4YwWVLEAPqxFAAtVoMI3fHQZGJW6ZcdEu4mBPZhHILEQBt5OPxPBs3tSJndmq2LW7uqHgVB5AsbB4UjKWkb4VfSS8kfiPIc7+iEXK4x/hoIzurL1KoyvJPpCox0v1OGVHYKekByJFLrkMb41j5hE1wIJPmqU8QyPn3PfMvankLOxkBQzplikp+0Za5ti8SbdcY0SMhaspOA8JXEbZmLLfic88aaUVcF3hGj105G1ox3omoZvR1dtApIzTMdWAvtC1w+Lrn8UlDQx90RZdVhttpt0bFkc9FhIf0c93zQM2DyKtWGg49JCHuutIfhMZdLKyZ23DdVW57LrvyYLGyKSm8Ep6NmyzsfLS5aO1NPEACWjmUFjaKUjydsSbTXWYaLK9jvF5UV79B8rO3lzajFHOOlm2AZ5piF0oqTIBwhUOpoS2E9RG7w2uixY1SDUwFI69ViwolveD9+pTnp9lEoETKT08gltFzkN8R6aN8OzzbRXBw+HwIVVuptTAv1XpJ1WVB5rRQrOINApaUlo/4vdaAAeplZPxjB778xSdBbXN92zTcavq/FXOLRQhDyl88zG4xa4c0mXgza9n57lEfBYXRUrM4goRaUaQLWQKRURh8z97LWr9IPwGhc/QRYf6XJ038xYMqWP6ei+ed6HndPSM3bUR3BT+mr+bcn2EFq/zq2zTMrTXMX/A6deXyTQMw2qbxt6/PwXr7szh/waAAA=" />