Payroll Runs
The PayrollRun object is used to represent a group of pay statements for a specific pay schedule.
Properties

idUUID
Required

remote_idString
Optional
The third-party API ID of the matching object.

created_atDateTime (ISO 8601)
Required

modified_atDateTime (ISO 8601)
Required
This is the datetime that this object was last updated by Merge

run_stateEnum
Optional
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.

run_typeEnum
Optional
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.

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_deletedBoolean
Required
Indicates whether or not this object has been deleted in the third party platform.

field_mappingsObject
Optional

remote_dataRemoteData[]
Optional


GET
/payroll-runs
Beta

https://api.merge.dev/api/hris/v1/payroll-runs

US
EU

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.

cursorString
Optional
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_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

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_sizeInteger
Optional
Number of results to return per page.

remote_fieldsString
Optional
Deprecated. Use show_enum_origins.

remote_idString
Optional
The API provider's ID for the given object.

run_typeString
Optional
If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS')

show_enum_originsString
Optional
A comma separated list of enum field names you'd like returned as original values, rather than normalized to Merge's standard 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 fields
Use the /linked-accounts endpoint to pull platform support information
ADP Workforce Now
ADP Workforce Now
Gusto
Gusto
OysterHR
OysterHR
Paychex
Paychex
Paylocity
Paylocity
SAP SuccessFactors
SAP SuccessFactors
TriNet
TriNet
UKG Pro
UKG Pro
UKG Ready
UKG Ready
Workday
Workday
GET
/payroll-runs/{id}
Beta

https://api.merge.dev/api/hris/v1/payroll-runs/{id}

US
EU

Returns a PayrollRun object with the given id.


Query & Path Parameters

idUUID
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

remote_fieldsString
Optional
Deprecated. Use show_enum_origins.

show_enum_originsString
Optional
A comma separated list of enum field names you'd like returned as original values, rather than normalized to Merge's standard enum values. Learn more

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ADP Workforce Now
ADP Workforce Now
Gusto
Gusto
OysterHR
OysterHR
Paychex
Paychex
Paylocity
Paylocity
SAP SuccessFactors
SAP SuccessFactors
TriNet
TriNet
UKG Pro
UKG Pro
UKG Ready
UKG Ready
Workday
Workday