Sign in
hris/employerbenefits

Retrieve Employer Benefit

Retrieve an Employer Benefit from any connected Hris software

get/hris/employerbenefits/{id}

Path parameters

idstring required

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

benefit_plan_typestring nullable

The type of the benefit plan

namestring nullable

The name of the employer benefit

descriptionstring nullable

The description of the employer benefit

deduction_codestring nullable

The deduction code for the employer benefit

field_mappingsobject nullable

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

idstring nullable

The UUID of the employer benefit record

remote_idstring nullable

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

remote_dataobject nullable

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

remote_created_atstring date-time nullable

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

created_atstring date-time nullable

The created date of the employer benefit record

modified_atstring date-time nullable

The last modified date of the employer benefit record

remote_was_deletedboolean nullable

Indicates if the employer benefit was deleted in the remote system

Example response

{
  "benefit_plan_type": "Health Insurance",
  "name": "Company Health Plan",
  "description": "Comprehensive health insurance coverage for employees",
  "deduction_code": "HEALTH-001",
  "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