Create a Pay Schedule

To create a pay schedule for a company use the POST companies/{company_id}/pay_schedules endpoint. This create a new single default pay schedule for the company.

You can also set up AutoPilot later using the PUT companies/{company_uuid}/pay_schedules/{pay_schedule_uuid} endpoint. AutoPilot will run payroll automatically one day before your payroll deadlines.

curl --request POST \
     --url https://api.gusto-demo.com/v1/companies/{company_uuid}/pay_schedules \
     --header 'accept: application/json' \
     --header 'authorization: Bearer <<COMPANY_API_TOKEN>>' \
     --header 'content-type: application/json' \
     --data '
{
     "frequency": "Twice per month",
     "anchor_pay_date": "2021-10-15",
     "anchor_end_of_pay_period": "2021-10-15",
     "day_1": 15,
     "auto_pilot": false,
     "version": "68934a3e9455fa72420237eb05902327"
}
'

const fetch = require('node-fetch');

const url = 'https://api.gusto-demo.com/v1/companies/{company_uuid}/pay_schedules';
const options = {
  method: 'POST',
  headers: {
    accept: 'application/json',
    'content-type': 'application/json',
    authorization: 'Bearer <<COMPANY_API_TOKEN>>'
  },
  body: JSON.stringify({
    frequency: 'Monthly',
    anchor_pay_date: '2021-10-15',
    anchor_end_of_pay_period: '2021-10-15',
    day_1: 15,
    auto_pilot: false,
    version: '68934a3e9455fa72420237eb05902327'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

📘

Anchor Pay Date

1. Payroll of any kind (regular, off-cycle, etc.) cannot be run in a quarter prior to the quarter that the anchor pay date falls in.
2. If payroll (regular or off-cycle) is not run by the set anchor pay date, the field will be invalidated and the pay schedule will need to be set again.
3. If the anchor pay date is changed prior to running the first payroll, form 8655 may need to be resigned by the company signatory:
   1. If the new anchor pay date chosen is in the same quarter as the initially chosen pay date, forms are not required to be resigned.
   2. If the new anchor pay date is in a different quarter, forms are required to be resigned.

Context: the anchor pay date is reported on the Federal 8655 form (authorization for Gusto to pay & file taxes on behalf of the company). Because of this, our authorization starts in the quarter associated with the anchor pay date.