The CreateSchedule Change changes the date payment collections will occur on an Accountaccount. This will change the current and any future Payment Schedules that have been defined for the Accountaccount.
Kin Chee (Unlicensed) please update this use case with a scenario and values.
Specify the following parameters:
Installment
Specify the installment amount >=$1PaymentFrequency
MinimumEffectiveDate
DeleteFutureSchedules
AdjustFutureSchedules
OverrideBillingCycleAlignment- Set to true.
PreviousScheduleEndDateSpecify the frequency of the payment: OneOff, Weekly, Fortnightly, FourWeekly, Monthly, BiMonthly, Quarterly
MinimumEffectiveDate
The newly created schedule will start on theMinimumEffectiveDate
provided but will not automatically be aligned with an existing schedule.
Info |
---|
The date specified as the new payment date parameter (MinimumEffectiveDate) must be within the next payment cycle for the Account. |
DeleteFutureSchedules
TheDeleteFutureSchedules
property will cause any schedules that have been set-up to come into effect after this schedule to be discarded and replaced with this schedule. Set to true.AdjustFutureSchedules
TheAdjustFutureSchedules
property will ensure the frequency of future, already defined schedules, are set to the frequency defined in this new schedule. Set to true.OverrideBillingCycleAlignment
This property overrides default behaviour and sets the start date of the new payment schedule to be theMinimumEffectiveDate
. Set to true.PreviousScheduleEndDate
thePreviousScheduleEndDate
property must also be set to close the payment schedule immediately prior appropriately.
Scenario
In the scenario where the new schedule is to start soon after the next payment date, it will likely be appropriate to set the PreviousScheduleEndDate
property prior to the next payment date. This will prevent the account from being billed twice in a short time frame.
For example, when changing the payment schedule from weekly on Wednesdays to weekly on Thursdays the PreviousScheduleEndDate
might be set to the forthcoming Tuesday.
Sample request message
Code Block | ||
---|---|---|
| ||
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:deb="Debitsuccess.WebServices.WCF" xmlns:deb1="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core"> <soap:Header/> <soap:Body> <deb:CreateSchedule> <deb:request> <deb1:DateCreated>?</deb1:DateCreated> <deb1:RequestInitiator>?</deb1:RequestInitiator> <deb1:User> <deb1:Id>?</deb1:Id> <deb1:Password>?</deb1:Password> <deb1:Username>?</deb1:Username> </deb1:User> <deb1:AccountReferenceNo>?</deb1:AccountReferenceNo> <deb1:ExternalAccountReferenceNo>?</deb1:ExternalAccountReferenceNo> <deb1:AdjustFutureSchedules>?</deb1:AdjustFutureSchedules> <deb1:DeleteFutureSchedules>?</deb1:DeleteFutureSchedules> <deb1:NewPaySchedule> <deb1:Id>?</deb1:Id> <deb1:Description>?</deb1:Description> <deb1:Installment>?</deb1:Installment> <deb1:PaymentFrequency>?</deb1:PaymentFrequency> <deb1:ScheduleId>?</deb1:ScheduleId> <deb1:EndDate>?</deb1:EndDate> <deb1:MinimumEffectiveDate>?</deb1:MinimumEffectiveDate> </deb1:NewPaySchedule> </deb:request> </deb:CreateSchedule> </soap:Body> </soap:Envelope> |
Sample response message
Code Block | ||
---|---|---|
| ||