The TimeOffBalance object

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

idstringOptionalRead-onlyformat: "uuid"

remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only

The datetime that this object was created by Merge.

modified_atdatetimeOptionalRead-only

The datetime that this object was modified by Merge.

employeestring or nullOptionalformat: "uuid"

The employee the balance belongs to.

balancedouble or nullOptional

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 nullOptional

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 nullOptional

The policy type of this time off balance. * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT

remote_was_deletedbooleanOptionalRead-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 nullOptionalRead-only

remote_datalist of objects or nullOptionalRead-only

1	{
2	"id": "string",
3	"remote_id": "string",
4	"created_at": "2023-01-01T00:00:00Z",
5	"modified_at": "2023-01-01T00:00:00Z",
6	"employee": "string",
7	"balance": 1,
8	"used": 1,
9	"policy_type": "VACATION",
10	"remote_was_deleted": true,
11	"field_mappings": {
12	"organization_defined_targets": {
13	"string": {}
14	},
15	"linked_account_defined_targets": {
16	"string": {}
17	}
18	},
19	"remote_data": [
20	{
21	"path": "string",
22	"data": {}
23	}
24	]
25	}