v2023-09-01 is in the deprecation process and all prior versions have been deprecated. Click this banner to review our version upgrade guide.

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

Responses

404

Not Found

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

`invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the Errors Categories guide for more details.

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.gusto-demo.com/v1/companies/company_id/earning_types \
3
     --header 'X-Gusto-API-Version: 2024-04-01' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json'


xxxxxxxxxx
 
1
{
2
  "name": "Gym Membership Stipend",
3
  "uuid": "f4dc8972-8830-4c07-b623-349a04b040d7"
4
}

201Example response

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.

`invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the Errors Categories guide for more details.