Create a custom earning type

post

https://api.gusto-demo.com/v1/companies/{company_id}/earning_types

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

Path Params

company_id

string

required

The UUID of the company

Body Params

name

string

required

Defaults to Gym Membership

The name of the custom earning type.

category

string

enum

The earning type category. Only settable when the company has access to categorized custom bonus earning types.

Allowed:

included_in_overtime_pay

boolean

Whether earnings of this type are included when calculating an employee's regular rate of pay for overtime purposes. Only settable when category is Other.

Headers

X-Gusto-API-Version

string

enum

Defaults to 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.

Allowed:

Responses

201Success

404Not Found The requested resource does not exist. Make sure the provided UUID is valid.

422Unprocessable Entity This may happen when the body of your request contains errors such as invalid_attribute_value, or the request fails due to an invalid_operation. See the Errors Categories guide for more details.