Sign in
hris/benefits

Retrieve Benefit

Retrieve a Benefit from any connected Hris software

get/hris/benefits/{id}

Path parameters

idstring required

id of the benefit 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

provider_namestring nullable

The name of the benefit provider

employee_idstring nullable

The UUID of the associated employee

employee_contributionnumber nullable

The employee contribution amount

company_contributionnumber nullable

The company contribution amount

start_datestring date-time nullable

The start date of the benefit

end_datestring date-time nullable

The end date of the benefit

employer_benefit_idstring nullable

The UUID of the associated employer benefit

field_mappingsobject nullable

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

idstring nullable

The UUID of the benefit record

remote_idstring nullable

The remote ID of the benefit in the context of the 3rd Party

remote_dataobject nullable

The remote data of the benefit in the context of the 3rd Party

remote_created_atstring date-time nullable

The date when the benefit was created in the 3rd party system

created_atstring date-time nullable

The created date of the benefit record

modified_atstring date-time nullable

The last modified date of the benefit record

remote_was_deletedboolean nullable

Indicates if the benefit was deleted in the remote system

Example response

{
  "provider_name": "Health Insurance Provider",
  "employee_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "employee_contribution": 100,
  "company_contribution": 200,
  "start_date": "2024-01-01T00:00:00Z",
  "end_date": "2024-12-31T23:59:59Z",
  "employer_benefit_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "field_mappings": {
    "custom_field_1": "value1",
    "custom_field_2": "value2"
  },
  "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "remote_id": "benefit_1234",
  "remote_data": {
    "raw_data": {
      "additional_field": "some value"
    }
  },
  "remote_created_at": "2024-10-01T12:00:00Z",
  "created_at": "2024-10-01T12:00:00Z",
  "modified_at": "2024-10-01T12:00:00Z"
}

Changes