v1

latestOpenAPI 3.1.02026-07-243113441.2 MB
Earning Types

Create a custom earning type

Create a custom earning type.

If an inactive earning type exists with the same name, this will reactivate it instead of creating a new one.

scope: payrolls:write

post/v1/companies/{company_id}/earning_types

Path parameters

company_idstring 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

namestring required

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.