CHcheckhq

Update an external payroll

Changed on

Updates an external payroll. 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.

patch/external_payrolls/{payroll}

Request

Path parameters

payrollstring required

Request body

companystring

ID of the company this external payroll is for.

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

Frequency at which the external payroll was paid

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.

Response

200

Changes

  • 5a54f5eb888bRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////