PayrollRun
object is used to represent a group of pay statements for a specific pay schedule.id
Stringremote_id
Stringrun_state
EnumPAID
, DRAFT
, APPROVED
, FAILED
, CLOSED
. In cases where there is no clear mapping, the original value passed through will be returned.run_type
EnumREGULAR
, 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
Stringend_date
Stringcheck_date
Stringremote_was_deleted
Booleancreated_at
Stringmodified_at
Stringfield_mappings
Objectremote_data
RemoteData[]{"id": "37336947-b3d4-4a4c-a310-ab6ab510e079","remote_id": "19202938","run_state": "PAID","run_type": "REGULAR","start_date": "2020-11-08T00:00:00Z","end_date": "2020-11-15T00:00:00Z","check_date": "2020-11-15T00:00:00Z","remote_was_deleted": true,"created_at": "2021-09-15T00:00:00Z","modified_at": "2021-10-16T00:00:00Z",Show advanced fields}
https://api.merge.dev/api/hris/v1/payroll-runs
Returns a list of PayrollRun
objects.
Authorization
StringX-Account-Token
Stringcreated_after
Stringcreated_before
Stringcursor
Stringended_after
Stringended_before
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
Stringmodified_before
Stringpage_size
Integerremote_fields
Stringremote_id
Stringrun_type
Stringshow_enum_origins
Stringstarted_after
Stringstarted_before
String{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"id": "37336947-b3d4-4a4c-a310-ab6ab510e079","remote_id": "19202938","run_state": "PAID","run_type": "REGULAR","start_date": "2020-11-08T00:00:00Z","end_date": "2020-11-15T00:00:00Z","check_date": "2020-11-15T00:00:00Z","remote_was_deleted": true,"created_at": "2021-09-15T00:00:00Z","modified_at": "2021-10-16T00:00:00Z",Show advanced fields}]}

Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
end_date
Stringremote_data
RemoteData[]path
stringdata
stringrun_state
Enumstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringend_date
Stringremote_id
Stringrun_state
Enumrun_type
Enumstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrun_state
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringrun_state
Enumstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringend_date
Stringremote_id
Stringrun_type
Enumstart_date
String
Field support for Rippling depends on when your customer's API key was generated
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringrun_state
Enumrun_type
Enumstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
end_date
Stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
stringrun_type
Enumstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringend_date
Stringremote_id
Stringrun_state
Enumrun_type
Enumstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringrun_state
Enumrun_type
Enumstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
end_date
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringrun_state
Enumrun_type
Enumstart_date
Stringhttps://api.merge.dev/api/hris/v1/payroll-runs/{id}
Returns a PayrollRun
object with the given id
.
Authorization
StringX-Account-Token
Stringid
Stringinclude_remote_data
Booleanremote_fields
Stringshow_enum_origins
String{"id": "37336947-b3d4-4a4c-a310-ab6ab510e079","remote_id": "19202938","run_state": "PAID","run_type": "REGULAR","start_date": "2020-11-08T00:00:00Z","end_date": "2020-11-15T00:00:00Z","check_date": "2020-11-15T00:00:00Z","remote_was_deleted": true,"created_at": "2021-09-15T00:00:00Z","modified_at": "2021-10-16T00:00:00Z",Show advanced fields}

Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
end_date
Stringremote_data
RemoteData[]path
stringdata
stringrun_state
Enumstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringend_date
Stringremote_id
Stringrun_state
Enumrun_type
Enumstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrun_state
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringrun_state
Enumstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringend_date
Stringremote_id
Stringrun_type
Enumstart_date
String
Field support for Rippling depends on when your customer's API key was generated
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringrun_state
Enumrun_type
Enumstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
end_date
Stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
stringrun_type
Enumstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringend_date
Stringremote_id
Stringrun_state
Enumrun_type
Enumstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringrun_state
Enumrun_type
Enumstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
end_date
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringrun_state
Enumrun_type
Enumstart_date
String