Update a payroll

patch

https://sandbox.checkhq.com/payrolls/{payroll}

Updates the specified payroll.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

For payrolls attached to a correction as replacements, payday may change only within the same bounds enforced at creation: in the past, on or after the open quarter start, on or after the company's start_date, and within the correction's tax year. Nested items and contractor_payments must keep payment_method manual.

Path Params

payroll

string

required

ID of the payroll to update.

Query Params

include_items

boolean

Defaults to false

Update related payroll items directly on this payroll.

include_contractor_payment

boolean

Defaults to false

Update related contractor payments directly on this payroll.

Body Params

period_start

date

The start of the date range that the payroll covers.

period_end

date

The end of the date range that the payroll covers.

payday

date

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

processing_period

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

type

string

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

One of regular, off_cycle, or amendment.

pay_frequency

string

Frequency by which employees get paid.

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

funding_payment_method

string

Payment method for funding the payroll.

One of ach or wire.

pay_schedule

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

metadata

json

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

bank_account

string

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

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400