Create a new single pay schedule

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

Creates a new single default pay schedule for the company.

This creates one pay schedule during company onboarding and cannot be used if the company has processed a payroll. Creating multiple pay schedules at this time is not supported. To change a pay schedule, the end user will need to login to Gusto to edit their pay schedule.

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

scope: pay_schedules:write

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
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;id&quot;:1,&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}