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
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Gusto-API-Version | string | Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used. | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"uuid":"f2a69c38-e2f9-4e31-b5c5-4754fc60a052","frequency":"Twice per month","anchor_pay_date":"2020-05-15","anchor_end_of_pay_period":"2020-05-08","day_1":15,"day_2":31,"name":"Engineering","custom_name":"A new monthly pay schedule","auto_pilot":false,"active":true}