Input fields

endDate : Date

The date on which the instalment schedule will end.
frequency : InstalmentPeriodEnum default: MONTHLY

The based unit of frequency at which payments are to be taken.
frequencyMultiplier : Int default: 1

The multiple of the frequency at which payment are taken; should be between 1 and 11.
monthlyGrossAmount : Int! required

The monthly amount to be paid as part of the instalment schedule.
paymentDay : Int default: 1

The day of the month/week at which to take payment; allowed values: -28 to 28 (excl. 0) for 'MONTHLY', -7 to 7 (excl. 0) for 'WEEKLY'. Negative values count backwards from the end of the month/week.
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "endDate": "2025-01-21", "frequency": "WEEKLY", "frequencyMultiplier": 26, "monthlyGrossAmount": 30, "paymentDay": 15 }