Payroll Runs

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

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_dataRemoteData[]
Optional
remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.
field_mappingsObject
Optional
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_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"
    }
  }
}
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 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_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_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
Which fields should be returned in non-normalized form.
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_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"
        }
      }
    }
  ]
}
Field support by platform

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
remote_dataRemoteData[]
pathstring
dataobject
run_stateEnum
start_dateString

Gusto

Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

check_dateString
end_dateString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
run_stateEnum
run_typeEnum
start_dateString

Paychex

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

check_dateString
end_dateString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
run_stateEnum
start_dateString

Paylocity

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

check_dateString
end_dateString
remote_dataRemoteData[]
pathstring
dataobject
start_dateString

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

check_dateString
end_dateString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
run_stateEnum
run_typeEnum
start_dateString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

end_dateString
start_dateString

TriNet

TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

check_dateString
end_dateString
remote_dataRemoteData[]
pathstring
dataobject
run_typeEnum
start_dateString

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

check_dateString
end_dateString
remote_dataRemoteData[]
pathstring
dataobject
run_stateEnum
run_typeEnum
start_dateString

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

check_dateString
end_dateString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
run_stateEnum
run_typeEnum
start_dateString

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

end_dateString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
run_stateEnum
run_typeEnum
start_dateString
Not seeing a platform that you're looking for? Submit a request for it here.
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.
remote_fieldsString
Optional
Deprecated. Use show_enum_origins.
show_enum_originsString
Optional
Which fields should be returned in non-normalized form.
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_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"
    }
  }
}
Field support by platform

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
remote_dataRemoteData[]
pathstring
dataobject
run_stateEnum
start_dateString

Gusto

Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

check_dateString
end_dateString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
run_stateEnum
run_typeEnum
start_dateString

Paychex

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

check_dateString
end_dateString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
run_stateEnum
start_dateString

Paylocity

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

check_dateString
end_dateString
remote_dataRemoteData[]
pathstring
dataobject
start_dateString

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

check_dateString
end_dateString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
run_stateEnum
run_typeEnum
start_dateString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

end_dateString
start_dateString

TriNet

TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

check_dateString
end_dateString
remote_dataRemoteData[]
pathstring
dataobject
run_typeEnum
start_dateString

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

check_dateString
end_dateString
remote_dataRemoteData[]
pathstring
dataobject
run_stateEnum
run_typeEnum
start_dateString

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

check_dateString
end_dateString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
run_stateEnum
run_typeEnum
start_dateString

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

end_dateString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
run_stateEnum
run_typeEnum
start_dateString
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.

Previous

Pay Groups

Next Up

Teams