Create a new pay schedule

POST {{baseUrl}}/v1/companies/:company_id/pay_schedules

If a company does not have any pay schedules, this endpoint will create a single pay schedule and assign it to all employees. This is a common use case during company onboarding.

If a company has an existing active pay schedule and want to support multiple pay schedules, this endpoint will create a pay schedule that is not assigned to any employee.

Be sure to check state laws to know what schedule is right for your customers.

Request Body

{"frequency"=>"<string>", "anchor_pay_date"=>"<string>", "anchor_end_of_pay_period"=>"<string>", "day_1"=>"<integer>", "day_2"=>"<integer>", "custom_name"=>"<string>"}

HEADERS

KeyDatatypeRequiredDescription
X-Gusto-API-VersionstringDetermines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;uuid&quot;:&quot;f2a69c38-e2f9-4e31-b5c5-4754fc60a052&quot;,&quot;frequency&quot;:&quot;Twice per month&quot;,&quot;anchor_pay_date&quot;:&quot;2020-05-15&quot;,&quot;anchor_end_of_pay_period&quot;:&quot;2020-05-08&quot;,&quot;day_1&quot;:15,&quot;day_2&quot;:31,&quot;name&quot;:&quot;Engineering&quot;,&quot;custom_name&quot;:&quot;A new monthly pay schedule&quot;,&quot;auto_pilot&quot;:false,&quot;active&quot;:true}