GuidesReferenceChangelogAPI Upgrades
Reference

Update a payroll

patch
https://sandbox.checkhq.com/payrolls/

Updates the specified payroll.

Path Params
string
required

ID of the payroll to update.

Query Params
boolean
Defaults to false

Update related payroll items directly on this payroll.

boolean
Defaults to false

Update related contractor payments directly on this payroll.

Body Params
date

The start of the date range that the payroll covers.

date

The end of the date range that the payroll covers.

date

The date on which employees will be paid for the payroll.

string

The processing period of the payroll.

One of three_day, two_day, or one_day.

The processing period determines the approval deadline of the payroll. For a payroll with a Friday payday, three_day will mean the approval deadline is on Tuesday, whereas two_day will mean the approval deadline is on Wednesday.

The possible values for this field are constrained by the processing periods the company is approved for.

Default: processing_period of the company

string

Indicates whether the payroll is a regular, off-cycle, or amendment payroll.

One of regular, off_cycle, or amendment.

string

Frequency by which employees get paid.

One of weekly, biweekly, semimonthly, monthly, quarterly, or annually.

string

Payment method for funding the payroll.

One of ach or wire.

string

ID of the pay schedule that the payroll relates to.

off_cycle_options
object

Additional configuration options controlling off_cycle payroll behavior.

items
array of objects

The set of payroll items associated with the payroll. Must set include_items=true.

items
contractor_payments
array of objects

The set of contractor payments associated with the payroll. Must set include_contractor_payments=true.

contractor_payments
json

Additional loosely structured information to associate with the payroll. Values must be string.

string

ID of the bank account that will be used to fund the payroll.

Responses

Updated 6 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 6 months ago