Payroll Runs
ThePayrollRun
object is used to represent a group of pay statements for a specific pay schedule.The PayrollRun object
Properties
id
Stringremote_id
Stringrun_state
EnumPAID
, DRAFT
, APPROVED
, FAILED
, CLOSED
, or - in cases where there is no clear mapping - the original value passed through.run_type
EnumREGULAR
, OFF_CYCLE
, CORRECTION
, TERMINATION
, SIGN_ON_BONUS
, or - in cases where there is no clear mapping - the original value passed through.start_date
Stringend_date
Stringcheck_date
Stringremote_data
RemoteData[]remote_was_deleted
Booleanfield_mappings
Object{"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_data": [{"path": "/payroll","data": ["Varies by platform"]}],"remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}
/payroll-runs
Returns a list of PayrollRun
objects.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
created_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_data": [{"path": "/payroll","data": ["Varies by platform"]}],"remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}]}

ADP Workforce Now
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringremote_id
String
Factorial
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
end_date
Stringremote_data
RemoteData[]path
stringdata
objectrun_state
Enumstart_date
String
Gusto
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrun_state
Enumrun_type
Enumstart_date
String
Paychex
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrun_state
Enumstart_date
String
Paylocity
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
objectstart_date
String
Rippling
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrun_state
Enumrun_type
Enumstart_date
String
SAP SuccessFactors
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
end_date
Stringstart_date
String
TriNet
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
objectrun_type
Enumstart_date
String
UKG Pro
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
objectrun_state
Enumrun_type
Enumstart_date
String
UKG Ready
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrun_state
Enumrun_type
Enumstart_date
String
Workday
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
end_date
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrun_state
Enumrun_type
Enumstart_date
String/payroll-runs/{id}
Returns a PayrollRun
object with the given id
.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
id
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_data": [{"path": "/payroll","data": ["Varies by platform"]}],"remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}

ADP Workforce Now
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringremote_id
String
Factorial
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
end_date
Stringremote_data
RemoteData[]path
stringdata
objectrun_state
Enumstart_date
String
Gusto
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrun_state
Enumrun_type
Enumstart_date
String
Paychex
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrun_state
Enumstart_date
String
Paylocity
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
objectstart_date
String
Rippling
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrun_state
Enumrun_type
Enumstart_date
String
SAP SuccessFactors
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
end_date
Stringstart_date
String
TriNet
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
objectrun_type
Enumstart_date
String
UKG Pro
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
objectrun_state
Enumrun_type
Enumstart_date
String
UKG Ready
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
check_date
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrun_state
Enumrun_type
Enumstart_date
String
Workday
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
end_date
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringrun_state
Enumrun_type
Enumstart_date
String