v1

latestOpenAPI 3.1.02026-07-243113441.2 MB

Pay Schedules

Preview pay schedule assignments for a company

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

scope: pay_schedules:write

post/v1/companies/{company_id}/pay_schedules/assignment_preview

Path parameters

company_idstring required

The UUID of the company

Headers

X-Gusto-API-Version'2026-06-15'

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Request body

type'single' | 'hourly_salaried' | 'by_employee' | 'by_department' nullable required

The pay schedule assignment type.

hourly_pay_schedule_uuidstring

Pay schedule for hourly employees.

salaried_pay_schedule_uuidstring

Pay schedule for salaried employees.

default_pay_schedule_uuidstring

Default pay schedule for employees.

partial_assignmentboolean

Indicates whether the request provides pay schedule assignments for a partial list of employees or departments of the company. By default, this is set to false.

Response

Example response

type'single' | 'hourly_salaried' | 'by_employee' | 'by_department' nullable

The pay schedule assignment type.