Sign in

v1

latestOpenAPI 3.1.02026-07-243113441.2 MB
External Payrolls

Create an external payroll for a company

Creates a new external payroll for a company.

scope: external_payrolls:write

post/v1/companies/{company_uuid}/external_payrolls

Path parameters

company_uuidstring required

The UUID of the company

Headers

X-Gusto-API-Version'2026-06-15'

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Request body

check_datestring date required

The check date of the external payroll.

payment_period_start_datestring date required

The start date of the external payroll payment period.

payment_period_end_datestring date required

The end date of the external payroll payment period.

Example request

{
  "check_date": "2022-06-03",
  "payment_period_start_date": "2022-05-15",
  "payment_period_end_date": "2022-05-30"
}

Response

Success

uuidstring required

The UUID of the external payroll.

company_uuidstring

The UUID of the company.

check_datestring

External payroll's check date.

payment_period_start_datestring

External payroll's pay period start date.

payment_period_end_datestring

External payroll's pay period end date.

status'unprocessed' | 'processed'

The status of the external payroll. The status will be unprocessed when the external payroll is created and transition to processed once tax liabilities are entered and finalized. Once in the processed status all actions that can edit an external payroll will be disabled.