Skip to main content

Input fields

accountNumber : String! required

Number of the account for which to update the schedule.

cancelConflictingSchedules : Boolean

If true, any conflicting future payment schedules on the ledger will be deleted before creating the new variable schedule.

ledgerNumber : String! required

Number of the ledger associated with the current payment schedule.

note : String

A note to be added to the payment schedule to explain the change.

targetChangeDate : Date

The date from which the variable payment schedule should start. Defaults to today.

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-8E9C8B72", "cancelConflictingSchedules": true, "ledgerNumber": "must-state-mention-yes-firm", "note": "since-population-year-executive-in", "targetChangeDate": "2023-03-02" }