Input type for updating the payment schedule on a ledger. Requires an account_number, ledger_number and at least one of payment_day or payment_amount to be provided. trigger and amount_strategy should be provided when updating the payment amount of a variable payment schedule.

Input fields

accountNumber : String!


            required

Number of the account for which to update the schedule.

amountStrategy : AmountStrategy

How the payment value is determined.

ledgerNumber : String!


            required

Number of the ledger associated with the current payment schedule.

paymentAmount : Int

The new fixed payment amount.

paymentDay : Int

The new day of the month at which to take payment; ranges from 1 to 28.

trigger : ScheduleTrigger

When a payment is due.

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

{
  "accountNumber": "A-73D7E460",
  "amountStrategy": "FIXED",
  "ledgerNumber": "else-particular-respond-else-particular",
  "paymentAmount": 32,
  "paymentDay": 85,
  "trigger": "PLAN"
}