Preview pay schedule assignments for a company

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

This endpoints returns the employee changes, including pay period and transition pay periods, for changing the pay schedule.

scope: pay_schedules:write

Request Body

{"type"=>"<string>", "hourly_pay_schedule_uuid"=>"<string>", "salaried_pay_schedule_uuid"=>"<string>", "default_pay_schedule_uuid"=>"<string>", "partial_assignment"=>"<boolean>", "employees"=>[{"employee_uuid"=>"<string>", "pay_schedule_uuid"=>"<string>"}, {"employee_uuid"=>"<string>", "pay_schedule_uuid"=>"<string>"}], "departments"=>[{"department_uuid"=>"<string>", "pay_schedule_uuid"=>"<string>"}, {"department_uuid"=>"<string>", "pay_schedule_uuid"=>"<string>"}]}

HEADERS

Key	Datatype	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

{&quot;type&quot;:&quot;hourly_salaried&quot;,&quot;employee_changes&quot;:{&quot;employee_uuid&quot;:&quot;43b39ada-dc49-4879-9594-fe95f67ae434&quot;,&quot;first_name&quot;:&quot;Penny&quot;,&quot;last_name&quot;:&quot;Parker&quot;,&quot;pay_frequency&quot;:&quot;Twice per month — Salaried pay schedule&quot;,&quot;first_pay_period&quot;:{&quot;pay_schedule_uuid&quot;:&quot;3f029a58-155d-4c30-8361-cc266b2c1f11&quot;,&quot;start_date&quot;:&quot;2023-07-01&quot;,&quot;end_date&quot;:&quot;2023-08-01&quot;,&quot;check_date&quot;:&quot;2023-08-02&quot;},&quot;transition_pay_period&quot;:{&quot;start_date&quot;:&quot;2023-06-20&quot;,&quot;end_date&quot;:&quot;2023-06-30&quot;}}}