Merge HR, Payroll, and Directory

Payroll Runs

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

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. In cases where there is no clear mapping, the original value passed through will be returned.

run_typeEnum

Optional

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_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 by third party webhooks.

created_atString

Required

modified_atString

Required

This is the datetime that this object was last updated by Merge

field_mappingsObject

Optional

remote_dataRemoteData[]

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_was_deleted": true,
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
}

GET

/payroll-runs

Beta

https://api.merge.dev/api/hris/v1/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, only objects synced by Merge after this date time will be returned.

modified_beforeString

Optional

If provided, only objects synced by Merge before this date time will be returned.

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_was_deleted": true,
      "created_at": "2021-09-15T00:00:00Z",
      "modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
    }
  ]
}

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

check_dateString

remote_idString

Factorial

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

end_dateString

remote_dataRemoteData[]

pathstring

datastring

run_stateEnum

start_dateString

Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

check_dateString

end_dateString

remote_idString

run_stateEnum

run_typeEnum

start_dateString

OysterHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

remote_dataRemoteData[]

pathstring

datastring

remote_idString

run_stateEnum

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

check_dateString

end_dateString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

run_stateEnum

start_dateString

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

check_dateString

end_dateString

remote_idString

run_typeEnum

start_dateString

Rippling

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_dateString

end_dateString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

run_stateEnum

run_typeEnum

start_dateString

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

end_dateString

start_dateString

TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

check_dateString

end_dateString

remote_dataRemoteData[]

pathstring

datastring

run_typeEnum

start_dateString

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

check_dateString

end_dateString

remote_idString

run_stateEnum

run_typeEnum

start_dateString

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

check_dateString

end_dateString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

run_stateEnum

run_typeEnum

start_dateString

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

end_dateString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

run_stateEnum

run_typeEnum

start_dateString

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

GET

/payroll-runs/{id}

Beta

https://api.merge.dev/api/hris/v1/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_was_deleted": true,
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
}

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

check_dateString

remote_idString

Factorial

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

end_dateString

remote_dataRemoteData[]

pathstring

datastring

run_stateEnum

start_dateString

Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

check_dateString

end_dateString

remote_idString

run_stateEnum

run_typeEnum

start_dateString

OysterHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

remote_dataRemoteData[]

pathstring

datastring

remote_idString

run_stateEnum

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

check_dateString

end_dateString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

run_stateEnum

start_dateString

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

check_dateString

end_dateString

remote_idString

run_typeEnum

start_dateString

Rippling

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_dateString

end_dateString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

run_stateEnum

run_typeEnum

start_dateString

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

end_dateString

start_dateString

TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

check_dateString

end_dateString

remote_dataRemoteData[]

pathstring

datastring

run_typeEnum

start_dateString

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

check_dateString

end_dateString

remote_idString

run_stateEnum

run_typeEnum

start_dateString

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

check_dateString

end_dateString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

run_stateEnum

run_typeEnum

start_dateString

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

end_dateString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

run_stateEnum

run_typeEnum

start_dateString

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

Pay Groups

Next Up

Get Started

API Reference

Previous

Next Up