Update an external payroll

patch

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

Updates an external payroll.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

For external payrolls attached to a correction as replacements, payday may change only within the same bounds enforced at creation: in the past, before the company's start_date, and within the correction's tax year.

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

Path Params

payroll

string

required

Body Params

company

string

ID of the company this external payroll is for.

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 were paid for the payroll. For payrolls attached to a correction, must remain in the past, before the company's start_date, and within the correction's tax year.

pay_frequency

string

Frequency at which the external payroll was paid

correction

string

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.

items

array of objects

The set of external payroll items associated with the payroll.

items

contractor_payments

array of objects

The set of contractor payments associated with the payroll.

contractor_payments

metadata

json

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

Response

200200