Sign in
hris/timeoffbalances

Retrieve Time off Balances

Retrieve Time off Balances from any connected Hris software

get/hris/timeoffbalances/{id}

Path parameters

idstring required

id of the timeoffbalance you want to retrieve.

Query parameters

remote_databoolean

Set to true to include data from the original Hris software.

Headers

x-connection-tokenstring required

The connection token

Response

balancenumber nullable

The current balance of time off

employee_idstring nullable

The UUID of the associated employee

usednumber nullable

The amount of time off used

policy_typestring nullable

The type of time off policy

field_mappingsobject nullable

The custom field mappings of the object between the remote 3rd party & Panora

idstring nullable

The UUID of the time off balance record

remote_idstring nullable

The remote ID of the time off balance in the context of the 3rd Party

remote_dataobject nullable

The remote data of the time off balance in the context of the 3rd Party

remote_created_atstring nullable

The date when the time off balance was created in the 3rd party system

created_atstring nullable

The created date of the time off balance record

modified_atstring nullable

The last modified date of the time off balance record

remote_was_deletedboolean nullable

Indicates if the time off balance was deleted in the remote system

Example response

{
  "balance": 80,
  "employee_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "used": 40,
  "policy_type": "VACATION",
  "field_mappings": {
    "custom_field_1": "value1",
    "custom_field_2": "value2"
  },
  "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "remote_id": "timeoff_balance_1234",
  "remote_data": {
    "raw_data": {
      "additional_field": "some value"
    }
  },
  "remote_created_at": "2024-06-15T12:00:00Z",
  "created_at": "2024-06-15T12:00:00Z",
  "modified_at": "2024-06-15T12:00:00Z"
}

Changes