Update an earning type

put

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

Update an earning type.

scope: payrolls:write

Path Params

company_id

string

required

The UUID of the company

earning_type_uuid

string

required

The UUID of the earning type

Body Params

name

string

The name of the custom earning type.

category

string

The earning type category. Set at creation and immutable afterward — submitting a value that differs from the current one returns a 422. Submitting the current value (e.g. when echoing back the full resource) is allowed.

included_in_overtime_pay

boolean

Whether earnings of this type are included in overtime pay calculations. Editable only when the category is Other; otherwise immutable — submitting a value that differs from the current one returns a 422. Submitting the current value (e.g. when echoing back the full resource) is allowed.

Headers

X-Gusto-API-Version

string

enum

Defaults to 2024-04-01

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

200Success

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.