Pay Groups
The
PayGroup object is used to represent a subset of employees that are put together for payroll processing purposes.Properties
idUUIDremote_idStringThe third-party API ID of the matching object.
created_atDateTime (ISO 8601)The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)The datetime that this object was modified by Merge.
pay_group_nameStringThe pay group name.
remote_was_deletedBooleanIndicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
field_mappingsObjectremote_dataRemoteData[]The RemoteData object
The
RemoteData object is used to represent the full data pulled from the third-party API for an object.Properties
pathStringThe third-party API path that is being called.
dataAnyThe data returned from the third-party for this object in its original, unnormalized format.
GET
/pay-groups
https://api.merge.dev/api/hris/v1/pay-groups
US
EU
APAC
Returns a list of PayGroup objects.
Query & path parameters
created_afterDateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
include_deleted_dataBooleanOptional
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
modified_afterDateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeIntegerOptional
Number of results to return per page. The maximum limit is 100.
remote_idStringOptional
The API provider's ID for the given object.
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
ADP RUN
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
remote_dataRemoteData[]pathstringdatastringremote_idString
AllianceHCM
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
pay_group_nameString
Cezanne HR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
pay_group_nameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Dayforce
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
pay_group_nameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Freshteam
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
pay_group_nameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Generic SFTP
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
pay_group_nameStringremote_idString
ISolved
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
pay_group_nameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Keka
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
pay_group_nameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Paylocity
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
pay_group_nameStringremote_dataRemoteData[]pathstringdatastring
SAP SuccessFactors
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
pay_group_nameStringremote_idString
TriNet
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
pay_group_nameStringremote_dataRemoteData[]pathstringdatastringremote_idString
UKG Pro
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
pay_group_nameStringremote_idString
UKG Ready
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
pay_group_nameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Workday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
pay_group_nameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Altera Payroll
BambooHR
Breathe
Gusto
HR Partner
Paychex
Simployer
TriNet HR Platform
GET
/pay-groups/{id}
https://api.merge.dev/api/hris/v1/pay-groups/{id}
US
EU
APAC
Returns a PayGroup object with the given id.
Query & path parameters
idUUIDRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
ADP RUN
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
remote_dataRemoteData[]pathstringdatastringremote_idStringAllianceHCM
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
pay_group_nameStringCezanne HR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
pay_group_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringDayforce
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
pay_group_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringFreshteam
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
pay_group_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringGeneric SFTP
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
pay_group_nameStringremote_idStringISolved
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
pay_group_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringKeka
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
pay_group_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringPaylocity
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
pay_group_nameStringremote_dataRemoteData[]pathstringdatastringSAP SuccessFactors
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
pay_group_nameStringremote_idStringTriNet
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
pay_group_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringUKG Pro
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
pay_group_nameStringremote_idStringUKG Ready
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
pay_group_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringWorkday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
pay_group_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringAltera Payroll
BambooHR
Breathe
Gusto
HR Partner
Paychex
Simployer
TriNet HR Platform