Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The CreateSchedule Change the date payment collections will occur on an Account. This will change the current and any future Payment Schedules that have been defined for the Account.

This function has slightly different effects depending on what Payment Frequency the Payment Schedules have set:

...

If the Payment Frequency is in {Weekly, Fortnightly, Four Weekly}, the New Payment Date will define the day of the week the payment will be collected.

...

.

Kin Chee (Unlicensed) please update this use case with a scenario and values.

Specify the following parameters:

  • Installment

  • PaymentFrequency

  • MinimumEffectiveDate

  • DeleteFutureSchedules

  • AdjustFutureSchedules

  • OverrideBillingCycleAlignment- Set to true.

  • PreviousScheduleEndDate

Info

The date specified as the

...

new payment date parameter (MinimumEffectiveDate) must be within the next payment cycle for the Account

...

.

Code Block
languagexml
<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>
         <!--Optional:-->
         <deb:request>
          
 <!--Optional:-->
            <deb1:DateCreated>?</deb1:DateCreated>
         
  <!--Optional:-->             <deb1:RequestInitiator>?</deb1:RequestInitiator>
           
<!--Optional:-->             <deb1:User>
               <!--Optional:-->
               <deb1:Id>?</deb1:Id>
               <!--Optional:-->
               <deb1:Password>?</deb1:Password>

              <!--Optional:-->
               <deb1:Username>?</deb1:Username>
            </deb1:User>
          
 <!--Optional:-->             <deb1:AccountReferenceNo>?</deb1:AccountReferenceNo>

           <!--Optional:-->
            <deb1:ExternalAccountReferenceNo>?</deb1:ExternalAccountReferenceNo>
           
<!--Optional:-->
            <deb1:AdjustFutureSchedules>?</deb1:AdjustFutureSchedules>
          
 <!--Optional:-->
            <deb1:DeleteFutureSchedules>?</deb1:DeleteFutureSchedules>
 
          <!--Optional:-->
            <deb1:NewPaySchedule>
             
 <!--Optional:-->
               <deb1:Id>?</deb1:Id>
               <!--Optional:-->
               <deb1:Description>?</deb1:Description>
               <!--Optional:-->
               <deb1:Installment>?</deb1:Installment>
              
<!--Optional:-->                <deb1:PaymentFrequency>?</deb1:PaymentFrequency>
               <!--Optional:-->
               <deb1:ScheduleId>?</deb1:ScheduleId>
              
<!--Optional:-->                <deb1:EndDate>?</deb1:EndDate>

              <!--Optional:-->
               <deb1:MinimumEffectiveDate>?</deb1:MinimumEffectiveDate>
            </deb1:NewPaySchedule>
         </deb:request>
      </deb:CreateSchedule>
   </soap:Body>
</soap:Envelope>