Pay Groups
ThePayGroup
object is used to represent a subset of employees that are put together for payroll processing purposes.The PayGroup object
Properties
id
Stringremote_id
Stringpay_group_name
Stringremote_was_deleted
Booleanfield_mappings
Objectremote_data
RemoteData[]{"id": "fd1e0fb5-8f92-4ec9-9f32-179cf732867d","remote_id": "800293","pay_group_name": "contractor","remote_was_deleted": true,Show advanced fields}
/pay-groups
Returns a list of PayGroup
objects.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
created_after
Stringcreated_before
Stringcursor
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
Stringmodified_before
Stringpage_size
Integerremote_id
String{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"id": "fd1e0fb5-8f92-4ec9-9f32-179cf732867d","remote_id": "800293","pay_group_name": "contractor","remote_was_deleted": true,Show advanced fields}]}

Freshteam
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
pay_group_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Keka
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
pay_group_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Paylocity
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
pay_group_name
Stringremote_data
RemoteData[]path
stringdata
object
TriNet
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
pay_group_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
UKG Pro
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
pay_group_name
Stringremote_id
String
UKG Ready
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
pay_group_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Workday
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
pay_group_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
ADP Workforce Now
/pay-groups/{id}
Returns a PayGroup
object with the given id
.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
id
Stringinclude_remote_data
Boolean{"id": "fd1e0fb5-8f92-4ec9-9f32-179cf732867d","remote_id": "800293","pay_group_name": "contractor","remote_was_deleted": true,Show advanced fields}

Freshteam
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
pay_group_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Keka
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
pay_group_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Paylocity
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
pay_group_name
Stringremote_data
RemoteData[]path
stringdata
object
TriNet
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
pay_group_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
UKG Pro
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
pay_group_name
Stringremote_id
String
UKG Ready
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
pay_group_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Workday
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
pay_group_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String