Preview pay schedule assignments for a company

post https://api.gusto-demo.com/v1/companies/{company_id}/pay_schedules/assignment_preview

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

scope: pay_schedules:write

Path Params

company_id

string

required

The UUID of the company

Body Params

type

string | null

required

The pay schedule assignment type.

hourly_pay_schedule_uuid

string

Pay schedule for hourly employees.

salaried_pay_schedule_uuid

string

Pay schedule for salaried employees.

default_pay_schedule_uuid

string

Default pay schedule for employees.

partial_assignment

boolean

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.

employees

array of objects

List of employees and their pay schedules.

employees

departments

array of objects

List of departments and their pay schedules.

departments

Headers

X-Gusto-API-Version

string

Defaults to 2024-03-01

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

Responses

404

Not Found

The requested resource does not exist. Make sure the provided UUID is valid.

`invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the Errors Categories guide for more details.

xxxxxxxxxx
curl --request POST \
     --url https://api.gusto-demo.com/v1/companies/company_id/pay_schedules/assignment_preview \
     --header 'X-Gusto-API-Version: 2024-03-01' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{"type":"single"}'

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

200Example response

422Unprocessable Entity This may happen when the body of your request contains errors such as invalid_attribute_value, or the request fails due to an invalid_operation. See the Errors Categories guide for more details.

`invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the Errors Categories guide for more details.