Common ModelsPayroll runs

/payroll-runs

Returns a list of PayrollRun objects.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

created_afterdatetimeOptional
If provided, will only return objects created after this datetime.
created_beforedatetimeOptional
If provided, will only return objects created before this datetime.
cursorstringOptional
The pagination cursor value.
ended_afterdatetimeOptional
If provided, will only return payroll runs ended after this datetime.
ended_beforedatetimeOptional
If provided, will only return payroll runs ended before this datetime.
include_deleted_databooleanOptional
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
include_remote_databooleanOptional

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

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

modified_afterdatetimeOptional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforedatetimeOptional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeintegerOptional
Number of results to return per page. The maximum limit is 100.
remote_fieldsenumOptional

Deprecated. Use show_enum_origins.

Allowed values:
remote_idstringOptional
The API provider's ID for the given object.
run_typeenumOptional
If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS') * `REGULAR` - REGULAR * `OFF_CYCLE` - OFF_CYCLE * `CORRECTION` - CORRECTION * `TERMINATION` - TERMINATION * `SIGN_ON_BONUS` - SIGN_ON_BONUS
Allowed values:
show_enum_originsenumOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
Allowed values:
started_afterdatetimeOptional
If provided, will only return payroll runs started after this datetime.
started_beforedatetimeOptional
If provided, will only return payroll runs started before this datetime.

Response

nextstring or null
previousstring or null
resultslist of objects or null
<MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA9WXYW/iOBCG/0rljyiQpSy3W6TTiTYttLuEHKR3W60qa3CGYHDiYDulYbX//RSS9sJdb6W2aa/7jdjj18kz7+DxN8LAYChVRnpkobgmFolkgIL0iAeZkkJM0phYBBLuQoRlFL05JBbRaZJIZTA44ygCPVQ4Jz1iR6hCbKYxn3MM7Dzc5rHBUIHhMtb2/bLmfLeOWETweIVBnzGZxuZHQkVgE4rIfzzm09oQiySgtVkomYaLCa5T1D/UzN9HYISxAdEMwIBdWd9UhcBDY/mbByjQYOCAAQcNsvwTy70WxiS6Z9sLFElrt28rwBsbYxuU4Uygtrudo8MPR91mqbLb/Tcail/bjeV6JmcfGjRkgkLaGPns1vXPN+4yfO+evL91t5ddd7vausvVuwYNoTHyR92xf9UZO/32+IEAOv3ly9Efx87xhdtg29OOu7zauD5rj3y2mm3POxcDtrkY/n7rbq8OR85lx/VPuxcD2R6fTPToZCJH/VaLWKSaSdL7+q06UBqk73gHf0q1mkvF8MCVm/1l5xGEWMFTZAQS3kzSmeCspTstiGArY9joFpORHWHAwe47Hr2Xpa7c0Ok6BYWtJA7vEsFlfJ8F0iOn7rDvnpw6+5bo3wAXMBNIekal+C8fk95XwhbIVjQAg8QiGCVCZog0KSqCqjTOc49xcBeiMJIGKQ/ysjCgTDFxnc+sU64w8EBBhAZVrn/93XqInAPZ7uvqAeYJMHOpojvVtwQqN/r+E03ALPKhNKbaFMEVkhZJY75Oc8QYm7x61WPpDlJtZL1od5JU73xIeS72k0Cu2LUKPP9tsgSf5eLzqRQ3GNRLmuud6CvgfSsYx5k2qIaTejgWaqVVX4Tif/nyiRQfScuDjC3wtibTFWLlAUM/y1D+3HX9dBd6kAnJuMlqI1vIVdnSz4OofRbEb4nxPcJn1/G07x1MU8ZQ6zNgRipdD8p9zT2ex+yLDM/etZbJ65V5BeHTWfmKu2jq4eMrHqN5PU+VPNTuuvTYjufZLrv8NDjwVE3tzeWnwUueFM8tyVqP2RzcBCGo6Q/ub3Q0RBh+XHtvCeH/1Mrk17YA6jpCyo6wFH3VXubliD7ufnP9/S8MT5rTuREAAA==" />