v1

latestOpenAPI 3.1.02026-07-243113441.2 MB
Earning Types

Update an earning type

Update an earning type.

scope: payrolls:write

put/v1/companies/{company_id}/earning_types/{earning_type_uuid}

Path parameters

company_idstring required

The UUID of the company

earning_type_uuidstring required

The UUID of the earning type

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

namestring

The name of the custom earning type.

Response

Success

namestring

The name of the earning type.

uuidstring required

The ID of the earning type.

activeboolean

Whether the earning type is active.