Create an external payroll

Creates an external payroll.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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 — use it when the replacement should be recorded as pay history outside the managed payroll flow.

Replacement external payrolls

When correction is supplied:

  • The company must have run a managed payroll.
  • payday must be in the past, before the company's start_date, and within the correction's tax year.
  • The correction must be in draft, belong to the same company, and accept replacement payrolls.
  • The caller must have correction:write or correction:admin scope.

Supplying correction also allows creating an external payroll replacement for a company that otherwise could not use the external payroll API for that tax year.

External payroll responses include correction as the ID of the correction this payroll is an operation of, or null. On update, correction may be included only to restate the payroll's current correction ID; a different value is rejected.

External payrolls attached to a correction reject Validate an external payroll, Approve an external payroll, Reopen an external payroll, and Preview an external payroll with error type payroll_managed_by_correction.

See Correcting Pay History for the full void-and-replace workflow.

Body Params
string
required

ID of the company this external payroll is for.

date
required

The start of the date range that the payroll covers.

date
required

The end of the date range that the payroll covers.

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.

string

Frequency at which the external payroll was paid

string

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.

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
json

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

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json