Payroll Runs
The
PayrollRun object is used to represent a group of pay statements for a specific pay schedule.Properties
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
run_stateEnumOptional
The state of the payroll run Possible values include:
PAID, DRAFT, APPROVED, FAILED, CLOSED. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.run_typeEnumOptional
The type of the payroll run Possible values include:
REGULAR, OFF_CYCLE, CORRECTION, TERMINATION, SIGN_ON_BONUS. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.start_dateDateTime (ISO 8601)Optional
The day and time the payroll run started.
end_dateDateTime (ISO 8601)Optional
The day and time the payroll run ended.
check_dateDateTime (ISO 8601)Optional
The day and time the payroll run was checked.
remote_was_deletedBooleanRequired
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.
field_mappingsObjectOptional
remote_dataRemoteData[]Optional
GET
/payroll-runs
Betahttps://api.merge.dev/api/hris/v1/payroll-runs
US
EU
APAC
Returns a list of PayrollRun 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.
ended_afterDateTime (ISO 8601)Optional
If provided, will only return payroll runs ended after this datetime.
ended_beforeDateTime (ISO 8601)Optional
If provided, will only return payroll runs ended before this datetime.
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.
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
remote_idStringOptional
The API provider's ID for the given object.
run_typeStringOptional
If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS')
show_enum_originsStringOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more
started_afterDateTime (ISO 8601)Optional
If provided, will only return payroll runs started after this datetime.
started_beforeDateTime (ISO 8601)Optional
If provided, will only return payroll runs started before this datetime.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
ADP Workforce Now
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
check_dateDateTime (ISO 8601)end_dateDateTime (ISO 8601)remote_idStringstart_dateDateTime (ISO 8601)
Gusto
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
check_dateDateTime (ISO 8601)end_dateDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringrun_stateEnumrun_typeEnumstart_dateDateTime (ISO 8601)
OysterHR
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_idStringrun_stateEnum
Paychex
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
check_dateDateTime (ISO 8601)end_dateDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringrun_stateEnumstart_dateDateTime (ISO 8601)
Paylocity
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
check_dateDateTime (ISO 8601)end_dateDateTime (ISO 8601)remote_idStringrun_typeEnumstart_dateDateTime (ISO 8601)
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
end_dateDateTime (ISO 8601)start_dateDateTime (ISO 8601)
TriNet
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
check_dateDateTime (ISO 8601)end_dateDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringrun_typeEnumstart_dateDateTime (ISO 8601)
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
check_dateDateTime (ISO 8601)end_dateDateTime (ISO 8601)remote_idStringrun_stateEnumrun_typeEnumstart_dateDateTime (ISO 8601)
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
check_dateDateTime (ISO 8601)end_dateDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringrun_stateEnumrun_typeEnumstart_dateDateTime (ISO 8601)
Workday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
end_dateDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringrun_stateEnumrun_typeEnumstart_dateDateTime (ISO 8601)GET
/payroll-runs/{id}
Betahttps://api.merge.dev/api/hris/v1/payroll-runs/{id}
US
EU
APAC
Returns a PayrollRun 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.
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
show_enum_originsStringOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
ADP Workforce Now
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
check_dateDateTime (ISO 8601)end_dateDateTime (ISO 8601)remote_idStringstart_dateDateTime (ISO 8601)Gusto
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
check_dateDateTime (ISO 8601)end_dateDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringrun_stateEnumrun_typeEnumstart_dateDateTime (ISO 8601)OysterHR
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_idStringrun_stateEnumPaychex
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
check_dateDateTime (ISO 8601)end_dateDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringrun_stateEnumstart_dateDateTime (ISO 8601)Paylocity
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
check_dateDateTime (ISO 8601)end_dateDateTime (ISO 8601)remote_idStringrun_typeEnumstart_dateDateTime (ISO 8601)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
end_dateDateTime (ISO 8601)start_dateDateTime (ISO 8601)TriNet
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
check_dateDateTime (ISO 8601)end_dateDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringrun_typeEnumstart_dateDateTime (ISO 8601)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
check_dateDateTime (ISO 8601)end_dateDateTime (ISO 8601)remote_idStringrun_stateEnumrun_typeEnumstart_dateDateTime (ISO 8601)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
check_dateDateTime (ISO 8601)end_dateDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringrun_stateEnumrun_typeEnumstart_dateDateTime (ISO 8601)Workday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
end_dateDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringrun_stateEnumrun_typeEnumstart_dateDateTime (ISO 8601)