Skip to main content

RecurringContributionScheduleInput

No description

input RecurringContributionScheduleInput {
  dayOfMonth: Int
  daysOfWeek: [DaysOfWeek!]
  minRunDate: LocalDate!
  skipThirdCycleOfMonth: Boolean
  strategy: RecurringContributionStrategy!
  strategyOption: RecurringContributionStrategyOption
}

Fields​

RecurringContributionScheduleInput.dayOfMonth ● Int scalar​

The day of the month on which the contributions will be made. Required if the strategy is 'MONTHLY'.

RecurringContributionScheduleInput.daysOfWeek ● [DaysOfWeek!] list enum​

The days of the week on which the contributions will be made. Required if the strategy is 'WEEKLY' or 'BI_WEEKLY'. Do not set otherwise.

RecurringContributionScheduleInput.minRunDate ● LocalDate! non-null scalar​

The date from which the schedule starts. The first contribution is scheduled on the first date that corresponds to the schedule strategy and strategyOption that is on or after this date. If this is before the benefit start date, the contributions will not begin until on or after the benefit start date.

A scheduled date on a weekend or bank holiday moves to the previous business day, so a contribution can run before this date. For example, a scheduled date on a Sunday runs on the Friday before. If the previous business day is before today or before the benefit start date, the contribution runs on the next business day instead.

RecurringContributionScheduleInput.skipThirdCycleOfMonth ● Boolean scalar​

Skips the third pay cycle in months that contain three biweekly cycles ("Biweekly 24"), yielding 24 contributions per year instead of 26. Only supported when the strategy is 'BI_WEEKLY' with exactly one entry in 'daysOfWeek'. Omitting this yields the standard 26-per-year biweekly schedule.

RecurringContributionScheduleInput.strategy ● RecurringContributionStrategy! non-null enum​

The frequency at which the contributions will be made

RecurringContributionScheduleInput.strategyOption ● RecurringContributionStrategyOption enum​

Determines the days of the month on which the contributions will be made. Required if the strategy is 'SEMI_MONTHLY'. Do not set otherwise.

Member Of​

SetRecurringContributionScheduleForBenefitInput input