v1

latestOpenAPI 3.1.02026-07-241642423.7 KB

Create a pay schedule

Creates a new pay schedule.

post/pay_schedules

Request body

companystring required

ID of the company that this pay schedule relates to.

namestring

Human-readable name of the pay schedule.

pay_frequencystring required

Frequency by which employees get paid.<br><br>One of weekly, biweekly, semimonthly, monthly, quarterly, or annually.

first_paydaystring date required

The payday date of the first payroll the company will run on Check on this pay schedule.

second_paydaystring

The payday date of the second payroll the company will run on Check on this pay schedule. This field should only be used with the semimonthly frequency to specify custom paydays besides the 15th and last day of the month. second_payday must be between one day and one month after first_payday.

first_period_endstring date required

The period end date of the first payroll the company will run on Check on this pay schedule.

metadatastring json

Additional loosely structured information to associate with the pay schedule

Response

200

idstring

companystring

namestring

pay_frequencystring

first_paydaystring

second_paydaystring

first_period_endstring

metadataobject

Example response

{
  "id": "psc_ARONfuK7dWUk1xFlQM77",
  "company": "com_fOBk0fGUbJ76z3hF6hc6",
  "name": "Pay schedule 2",
  "pay_frequency": "semimonthly",
  "first_payday": "2023-04-23",
  "second_payday": "2023-05-09",
  "first_period_end": "2023-04-15"
}