Sign in

v1

latestOpenAPI 3.1.02026-07-243113441.2 MB
External Payrolls

Update an external payroll

Update an external payroll with a list of external payroll items.

scope: external_payrolls:write

put/v1/companies/{company_uuid}/external_payrolls/{external_payroll_id}

Path parameters

company_uuidstring required

The UUID of the company

external_payroll_idstring required

The UUID of the external payroll

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

replace_fieldsboolean

Patch update external payroll items when set to true, otherwise it will overwrite the previous changes.

Example request

{
  "external_payroll_items": [
    {
      "employee_uuid": "44f7cba9-7a3d-4f08-b7bd-6fcf5211f8ca",
      "earnings": [
        {
          "earning_type": "CompanyPayType",
          "earning_id": 1,
          "amount": "10000.00",
          "hours": "80.0"
        }
      ],
      "benefits": [
        {
          "benefit_id": 22,
          "company_contribution_amount": "100.00",
          "employee_deduction_amount": "50.00"
        }
      ],
      "taxes": [
        {
          "tax_id": 1,
          "amount": "400.00"
        }
      ]
    }
  ]
}

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.