CHcheckhq

Create an external payroll

Changed on

Creates an external payroll. Pass correction to create a replacement external payroll and attach it to a draft correction in the same request. This is the historical-payroll counterpart to Create a payroll with correction.

post/external_payrolls

Request

Request body

companystring required

ID of the company this external payroll is for.

period_startstring date required

The start of the date range that the payroll covers.

period_endstring date required

The end of the date range that the payroll covers.

paydaystring date required

The date on which employees were paid for the payroll. When correction is supplied, payday must be 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

ID of the draft correction to attach this external payroll to as a replacement when creating the payroll. Returned on external payroll responses as the correction this payroll is an operation of, or null. On update, may be included only to restate the payroll's current correction ID — a different value is rejected. Omit for ordinary external payrolls. When supplied at create, the company must have run a managed payroll; payday must be in the past and before the company's start_date; and the correction must be in draft, belong to the same company, and accept replacement payrolls. Allows creating an external payroll replacement for a company that otherwise could not use the external payroll API for that tax year. Requires correction:write or correction:admin scope to attach at create.

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