Sign in
hris/employments

Retrieve Employment

Retrieve an Employment from any connected Hris software

get/hris/employments/{id}

Path parameters

idstring required

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

job_titlestring nullable

The job title of the employment

pay_ratenumber nullable

The pay rate of the employment

pay_periodstring nullable

The pay period of the employment

pay_frequencystring nullable

The pay frequency of the employment

pay_currencystring nullable

The currency of the pay

flsa_statusstring nullable

The FLSA status of the employment

effective_datestring date-time nullable

The effective date of the employment

employment_typestring nullable

The type of employment

pay_group_idstring nullable

The UUID of the associated pay group

employee_idstring nullable

The UUID of the associated employee

field_mappingsobject nullable

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

idstring nullable

The UUID of the employment record

remote_idstring nullable

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

remote_dataobject nullable

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

remote_created_atstring date-time nullable

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

created_atstring date-time nullable

The created date of the employment record

modified_atstring date-time nullable

The last modified date of the employment record

remote_was_deletedboolean nullable

Indicates if the employment was deleted in the remote system

Example response

{
  "job_title": "Software Engineer",
  "pay_rate": 100000,
  "pay_period": "MONTHLY",
  "pay_frequency": "WEEKLY",
  "pay_currency": "USD",
  "flsa_status": "EXEMPT",
  "effective_date": "2023-01-01",
  "employment_type": "FULL_TIME",
  "pay_group_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "employee_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "field_mappings": {
    "custom_field_1": "value1",
    "custom_field_2": "value2"
  },
  "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "remote_id": "employment_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