CHcheckhq

Update a payroll

Changed on

Updates the specified payroll. For payrolls attached to a correction as replacements, payday may change only within the same bounds enforced at creation, and nested items and contractor_payments must keep payment_method manual. correction may be included only to restate the payroll's current correction ID; a different value is rejected.

patch/payrolls/{payroll}

Request

Path parameters

payrollstring required

ID of the payroll to update.

Query parameters

include_itemsboolean

Update related payroll items directly on this payroll.

include_contractor_paymentboolean

Update related contractor payments directly on this payroll.

Request body

period_startstring date

The start of the date range that the payroll covers.

period_endstring date

The end of the date range that the payroll covers.

paydaystring date

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

processing_periodstring

The processing period of the payroll. <br><br>One of three_day, two_day, or one_day.<br><br>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.<br><br>The possible values for this field are constrained by the processing periods the company is approved for.<br><br>Default: processing_period of the company

typestring

Indicates whether the payroll is a regular or off-cycle payroll.<br><br>One of regular or off_cycle. Other payroll types, such as amendment and balancing, are created by Check and can't be set through the API.

pay_frequencystring

Frequency by which employees get paid.<br><br>One of weekly, biweekly, semimonthly, monthly, quarterly, or annually.

funding_payment_methodstring

Payment method for funding the payroll. <br><br>One of ach, wire, or parafin. <br><br>ach and wire can be set when creating or updating a payroll. parafin is set by Check when a payroll advance is accepted and cannot be set or changed via the API.

pay_schedulestring

ID of the pay schedule that the payroll relates to.

correctionstring

May be included only to restate this payroll's current correction ID; matching the current value is accepted as a no-op. A different value is rejected. Omitted leaves the correction unchanged.

metadatastring json

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

bank_accountstring

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

Response

200

object required

Changes