Payroll Runs
The
PayrollRun
object is used to represent a group of pay statements for a specific pay schedule.Properties
id
UUIDRequired
remote_id
StringOptional
The third-party API ID of the matching object.
created_at
DateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_at
DateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
run_state
EnumOptional
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_type
EnumOptional
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_date
DateTime (ISO 8601)Optional
The day and time the payroll run started.
end_date
DateTime (ISO 8601)Optional
The day and time the payroll run ended.
check_date
DateTime (ISO 8601)Optional
The day and time the payroll run was checked.
remote_was_deleted
BooleanRequired
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_mappings
ObjectOptional
remote_data
RemoteData[]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_after
DateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_before
DateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursor
StringOptional
The pagination cursor value.
ended_after
DateTime (ISO 8601)Optional
If provided, will only return payroll runs ended after this datetime.
ended_before
DateTime (ISO 8601)Optional
If provided, will only return payroll runs ended before this datetime.
include_deleted_data
BooleanOptional
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_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_data
BooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
modified_after
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_before
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_size
IntegerOptional
Number of results to return per page.
remote_fields
StringOptional
Deprecated. Use show_enum_origins.
remote_id
StringOptional
The API provider's ID for the given object.
run_type
StringOptional
If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS')
show_enum_origins
StringOptional
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_after
DateTime (ISO 8601)Optional
If provided, will only return payroll runs started after this datetime.
started_before
DateTime (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_date
DateTime (ISO 8601)end_date
DateTime (ISO 8601)remote_id
Stringstart_date
DateTime (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_date
DateTime (ISO 8601)end_date
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrun_state
Enumrun_type
Enumstart_date
DateTime (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_data
RemoteData[]path
stringdata
stringremote_id
Stringrun_state
EnumPaychex
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
check_date
DateTime (ISO 8601)end_date
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrun_state
Enumstart_date
DateTime (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_date
DateTime (ISO 8601)end_date
DateTime (ISO 8601)remote_id
Stringrun_type
Enumstart_date
DateTime (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_date
DateTime (ISO 8601)start_date
DateTime (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_date
DateTime (ISO 8601)end_date
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringrun_type
Enumstart_date
DateTime (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_date
DateTime (ISO 8601)end_date
DateTime (ISO 8601)remote_id
Stringrun_state
Enumrun_type
Enumstart_date
DateTime (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_date
DateTime (ISO 8601)end_date
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrun_state
Enumrun_type
Enumstart_date
DateTime (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_date
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrun_state
Enumrun_type
Enumstart_date
DateTime (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
id
UUIDRequired
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
remote_fields
StringOptional
Deprecated. Use show_enum_origins.
show_enum_origins
StringOptional
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_date
DateTime (ISO 8601)end_date
DateTime (ISO 8601)remote_id
Stringstart_date
DateTime (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_date
DateTime (ISO 8601)end_date
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrun_state
Enumrun_type
Enumstart_date
DateTime (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_data
RemoteData[]path
stringdata
stringremote_id
Stringrun_state
EnumPaychex
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
check_date
DateTime (ISO 8601)end_date
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrun_state
Enumstart_date
DateTime (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_date
DateTime (ISO 8601)end_date
DateTime (ISO 8601)remote_id
Stringrun_type
Enumstart_date
DateTime (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_date
DateTime (ISO 8601)start_date
DateTime (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_date
DateTime (ISO 8601)end_date
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringrun_type
Enumstart_date
DateTime (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_date
DateTime (ISO 8601)end_date
DateTime (ISO 8601)remote_id
Stringrun_state
Enumrun_type
Enumstart_date
DateTime (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_date
DateTime (ISO 8601)end_date
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrun_state
Enumrun_type
Enumstart_date
DateTime (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_date
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrun_state
Enumrun_type
Enumstart_date
DateTime (ISO 8601)