Payroll Runs

The PayrollRun object is used to represent a payroll run. This payroll run is not specific to an employee.

The PayrollRun object

Properties


idString
Required

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

run_stateEnum
Optional
The state of the payroll run Possible values include: PAID, DRAFT, APPROVED, FAILED, CLOSED, or - in cases where there is no clear mapping - the original value passed through.

run_typeEnum
Optional
The type of the payroll run Possible values include: REGULAR, OFF_CYCLE, CORRECTION, TERMINATION, SIGN_ON_BONUS, or - in cases where there is no clear mapping - the original value passed through.

start_dateString
Optional
The day and time the payroll run started.

end_dateString
Optional
The day and time the payroll run ended.

check_dateString
Optional
The day and time the payroll run was checked.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted on the third-party.

The PayrollRun object
JSON
{
"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
}

GET

/payroll-runs

Returns a list of PayrollRun objects.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

ended_afterString
Optional
If provided, will only return payroll runs ended after this datetime.

ended_beforeString
Optional
If provided, will only return payroll runs ended before this datetime.

include_deleted_dataBoolean
Optional
Whether to include data that was deleted in the third-party service.

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

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

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')

started_afterString
Optional
If provided, will only return payroll runs started after this datetime.

started_beforeString
Optional
If provided, will only return payroll runs started before this datetime.

Response
JSON
{
"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
}
]
}
Field support by platform

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


run_typeEnum

check_dateString

end_dateString

start_dateString

run_stateEnum

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


run_typeEnum

check_dateString

end_dateString

start_dateString

remote_idString

run_stateEnum

Paychex

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


check_dateString

end_dateString

start_dateString

remote_idString

run_stateEnum

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_dateString

start_dateString

Gusto

Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


run_typeEnum

check_dateString

end_dateString

start_dateString

remote_idString

run_stateEnum

TriNet

TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


run_typeEnum

check_dateString

end_dateString

start_dateString

Paylocity

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


check_dateString

end_dateString

start_dateString

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


run_typeEnum

check_dateString

end_dateString

start_dateString

remote_idString

run_stateEnum

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


run_typeEnum

end_dateString

start_dateString

remote_idString

run_stateEnum

ADP Workforce Now

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


check_dateString

remote_idString

Factorial

Factorial

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_dateString

start_dateString

run_stateEnum
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/payroll-runs/{id}

Returns a PayrollRun object with the given id.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


idString
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{
"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
}
Field support by platform

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


run_typeEnum

check_dateString

end_dateString

start_dateString

run_stateEnum

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


run_typeEnum

check_dateString

end_dateString

start_dateString

remote_idString

run_stateEnum

Paychex

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


check_dateString

end_dateString

start_dateString

remote_idString

run_stateEnum

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_dateString

start_dateString

Gusto

Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


run_typeEnum

check_dateString

end_dateString

start_dateString

remote_idString

run_stateEnum

TriNet

TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


run_typeEnum

check_dateString

end_dateString

start_dateString

Paylocity

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


check_dateString

end_dateString

start_dateString

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


run_typeEnum

check_dateString

end_dateString

start_dateString

remote_idString

run_stateEnum

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


run_typeEnum

end_dateString

start_dateString

remote_idString

run_stateEnum

ADP Workforce Now

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


check_dateString

remote_idString

Factorial

Factorial

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_dateString

start_dateString

run_stateEnum
Hint: Use the /linked-accounts endpoint to pull platform support information.