Page Comparison

Adjust total value of the account

REST API

Use the Update Account endpoint of Customer Services API to adjust the total value of the account.

Tip

Status

colour	Yellow
title	PUT

https://<ServerURL>/CustomerServices/v1.0/accounts/{accountId}

Provide the following:

contractAmount
contractAmount can be changed to a different value only for fixedTerm accounts. If a new Term value is provided, contractAmount auto recalculates again based on the new Term value.

SOAP API

Use the AdjustAccountTotalValue call to change the total value of the account.

When the Account Total Value is changed, the account is automatically

made

converted to a Fixed Term account.

Collections will end once the Total Value has been paid. The account will remain open, but automatically close when it reaches the end of the contract period.

The Total Value of an Account is the minimum amount the Customer must pay before the Account can be closed without further penalties. All Accounts, whatever their contract or Payment Schedule have this value stored in the MinTermTotalValue field of GetCustomerAccountByAccountId.

Sample Request

Code Block

language	xml

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:deb="Debitsuccess.WebServices.WCF" xmlns:deb1="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">
   <soapenv:Header/>
   <soapenv:Body>
      <deb:AdjustAccountTotalValue>
        <deb:request>
            <deb1:DateCreated>2020-09-22</deb1:DateCreated>
            <deb1:Id>333</deb1:Id>
            <deb1:RequestInitiator>Kin333</deb1:RequestInitiator>
            <deb1:User>
               <deb1:Id>33333</deb1:Id>
               <deb1:Password>#Password</deb1:Password>
               <deb1:Username>Username</deb1:Username>
            </deb1:User>
            <deb1:AccountReferenceNo>DEA2884487</deb1:AccountReferenceNo>
            <deb1:ExternalAccountReferenceNo></deb1:ExternalAccountReferenceNo>
            <deb1:CurrentTotalValue>0</deb1:CurrentTotalValue>
            <deb1:NewTotalValue>100</deb1:NewTotalValue>
         </deb:request>
      </deb:AdjustAccountTotalValue>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

Code Block

language	xml

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <ActivityId CorrelationId="a12e2eb6-3ae4-4fa9-a8f4-e46ec62d4a0b" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">00000000-0000-0000-0000-000000000000</ActivityId>
   </s:Header>
   <s:Body>
      <AdjustAccountTotalValueResponse xmlns="Debitsuccess.WebServices.WCF">
         <AdjustAccountTotalValueResult xmlns:a="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:DateCreated>2020-10-23T15:24:31.3199435+13:00</a:DateCreated>
            <a:Id>bc32f2d7-345b-4c5e-858b-2a65bdf778b0</a:Id>
            <a:ResponseNotes>
               <a:ResponseMessageNote>
                  <a:Code>00</a:Code>
                  <a:Note>Success</a:Note>
                  <a:NoteType>Info</a:NoteType>
               </a:ResponseMessageNote>
            </a:ResponseNotes>
            <a:Status>Succeed</a:Status>
         </AdjustAccountTotalValueResult>
      </AdjustAccountTotalValueResponse>
   </s:Body>
</s:Envelope>

Adjust the minimum term of the Account

AdjustAccountMINIMUMTerm is used to change the minimum term of on on-going an ongoing account.

Note
Not applicable for fixed-term accounts.

Sample Request

Code Block

language	xml

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:deb="Debitsuccess.WebServices.WCF" xmlns:deb1="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">
   <soapenv:Header/>
   <soapenv:Body>
      <deb:AdjustAccountMinimumTerm>
         <deb:request>
            <deb1:DateCreated>2020-09-22</deb1:DateCreated>
            <deb1:Id>333</deb1:Id>
            <deb1:RequestInitiator>Kin333</deb1:RequestInitiator>
            <deb1:User>
               <deb1:Id>33333</deb1:Id>
               <deb1:Password>#Password</deb1:Password>
               <deb1:Username>Username</deb1:Username>
            </deb1:User>
            <deb1:AccountReferenceNo>DEA2884204</deb1:AccountReferenceNo>
            <deb1:ExternalAccountReferenceNo></deb1:ExternalAccountReferenceNo>
            <deb1:NewTerm>9</deb1:NewTerm>
            <deb1:NewTermType>Months</deb1:NewTermType>
      </deb:AdjustAccountMinimumTerm>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

Code Block

language	xml

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <ActivityId CorrelationId="0f408836-cb3a-43b4-8c0b-cc95be8a6ebe" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">00000000-0000-0000-0000-000000000000</ActivityId>
   </s:Header>
   <s:Body>
      <UpdateClientPhoneNumberResponse xmlns="Debitsuccess.WebServices.WCF">
         <UpdateClientPhoneNumberResult xmlns:a="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:DateCreated>2020-11-05T15:48:24.8411134+13:00</a:DateCreated>
            <a:Id>b0a49ab0-f2e5-4584-a54b-414bfb042e74</a:Id>
            <a:ResponseNotes>
               <a:ResponseMessageNote>
                  <a:Code>00</a:Code>
                  <a:Note>Success</a:Note>
                  <a:NoteType>Info</a:NoteType>
               </a:ResponseMessageNote>
            </a:ResponseNotes>
            <a:Status>Succeed</a:Status>
         </UpdateClientPhoneNumberResult>
      </UpdateClientPhoneNumberResponse>
   </s:Body>
</s:Envelope>

Versions Compared

Old Version 10

New Version Current

Key

Adjust total value of the account

REST API

SOAP API

Sample Request

Sample Response

Adjust the minimum term of the Account

Sample Request

Sample Response

Related Articles