Fields

changeHistory : [PaymentScheduleChangeEventType]

The recorded history of changes to this payment schedule (creation, updates and deletion), most recent first.
delayConfiguration : PaymentScheduleDelayConfigurationType

The delay configuration for this payment schedule.
id : ID! required
isExemptFromPaymentAdequacy : Boolean

If the payment schedule is exempt from payment adequacy.
isPaymentHoliday : Boolean
isVariablePaymentAmount : Boolean! required
ledgerNumber : String

The ledger number of the payment schedule.
paymentAdequacyAdjustment : Int
paymentAdequacyAdjustmentExpiryDate : Date
paymentAmount : Int! required
paymentDay : Int
paymentDayDetails : PaymentSchedulePaymentDayDetailsType

Details of the payment_day value.
paymentFrequency : PaymentFrequencyOptions

The frequency of the payment schedule.
paymentFrequencyMultiplier : Int! required
paymentHolidayReason : String! required
reason : PaymentScheduleReasonOptions

The reason the payment schedule was created.
scheduleType : ScheduleType

The method of payment for the schedule.
supplementaryLedger : SupplementaryLedgerType

The supplementary ledger for this payment schedule, if it is on one.
totalDebtAmount : Int

The sum of the payment adequacy contributions on the payment schedule that are expected to be taken before the debt repayment is complete.
trigger : ScheduleTrigger

The cause for requesting payment on a schedule.
validFrom : Date! required
validTo : Date
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

{ "changeHistory": [PaymentScheduleChangeEventType], "delayConfiguration": PaymentScheduleDelayConfigurationType, "id": "82276528", "isExemptFromPaymentAdequacy": true, "isPaymentHoliday": true, "isVariablePaymentAmount": true, "ledgerNumber": "national-until-sure-cause-dark", "paymentAdequacyAdjustment": 93, "paymentAdequacyAdjustmentExpiryDate": "2025-11-02", "paymentAmount": 46, "paymentDay": 96, "paymentDayDetails": PaymentSchedulePaymentDayDetailsType, "paymentFrequency": "Weekly", "paymentFrequencyMultiplier": 23, "paymentHolidayReason": "different-remember-girl-movement-become", "reason": "GENERAL_ACCOUNT_PAYMENT", "scheduleType": "BACS_TRANSFER", "supplementaryLedger": SupplementaryLedgerType, "totalDebtAmount": 39, "trigger": "PLAN", "validFrom": "1981-10-25", "validTo": "1996-03-22" }