Sign in
hris/paygroups

Retrieve Pay Group

Retrieve a Pay Group from any connected Hris software

get/hris/paygroups/{id}

Path parameters

idstring required

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

pay_group_namestring nullable

The name of the pay group

field_mappingsobject nullable

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

idstring nullable

The UUID of the pay group record

remote_idstring nullable

The remote ID of the pay group in the context of the 3rd Party

remote_dataobject nullable

The remote data of the pay group in the context of the 3rd Party

remote_created_atstring date-time nullable

The date when the pay group was created in the 3rd party system

created_atstring date-time nullable

The created date of the pay group record

modified_atstring date-time nullable

The last modified date of the pay group record

remote_was_deletedboolean nullable

Indicates if the pay group was deleted in the remote system

Example response

{
  "pay_group_name": "Monthly Salaried",
  "field_mappings": {
    "custom_field_1": "value1",
    "custom_field_2": "value2"
  },
  "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "remote_id": "paygroup_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