v1

latestOpenAPI 3.1.02026-07-241642423.7 KB

Update a payroll

Updates the specified payroll.

patch/payrolls/{payroll}

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. 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

typestring

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

pay_frequencystring

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

funding_payment_methodstring

Payment method for funding the payroll. One of ach or wire.

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.

bank_accountstring

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

Response

200

object required