CHcheckhq

Update a payroll

Changed on

Updates the specified payroll.

patch/payrolls/{payroll} (COPY)

Request

Path parameters

payrollstring required

ID of the payroll to update.

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 four_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, four_day will mean the approval deadline is on Monday, 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, off-cycle, or amendment payroll.<br><br>One of regular, off_cycle, or amendment.

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.

metadatastring json

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

Response

200

object required

Changes