PayScheduleCreateRequest

Type: object
- firstPayPeriodStartDate
  Type: stringFormat: date
  required
  
  Start date anchoring the first Pay Period PayrollKit will process for this schedule. This does not need to be the Employer's first-ever Pay Period.
- frequency
  Type: "weekly" or "monthly"enum
  required
  
  A weekly schedule creates consecutive seven-day periods. A monthly schedule starts each period on the same numbered day as firstPayPeriodStartDate, or the month's final day when that number does not exist, and ends the day before the next period starts.
- nonBankingDayRule
  Type: "no_adjustment" or "previous_banking_day" or "next_banking_day"enum
  required
  
  Chooses the Planned Payment Date when the Contractual Payment Date is not a banking day:
  
  no_adjustment: keep the Contractual Payment Date.
  
  previous_banking_day: use the nearest earlier banking day.
  
  next_banking_day: use the nearest later banking day.
  
  The Reported Payment Date remains the Contractual Payment Date.
- partnerPayScheduleId
  Type: string
  min length:
  1
  max length:
  200
  required
  
  Stable, case-sensitive Pay Schedule ID from the Partner product. It must be unique within the Employer's PAYE Scheme and cannot be changed after creation.
- paymentDateRule
  Type: "period_end" or "last_calendar_day" or "fixed_weekday"enum
  required
  
  Chooses the Contractual and Reported Payment Date:
  
  period_end: the final day of the Pay Period.
  
  last_calendar_day: the final calendar day of the month in which the Pay Period ends.
  
  fixed_weekday: the first paymentWeekday on or after the Pay Period ends.
- bankHolidayRegion
  Type: "england_and_wales" or "scotland" or "northern_ireland"enum
  
  UK bank-holiday calendar used with previous_banking_day or next_banking_day. Saturdays and Sundays are never banking days.
- paymentWeekday
  Type: stringenum
  
  Weekday used only when paymentDateRule is fixed_weekday.
  
  values
  mondaytuesdaywednesdaythursdayfridaysaturdaysunday