Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 15 Next »

REST API

Use the Overdue status changes endpoint of Customer Services API to retrieves overdue status changes.

GET https://<ServerURL>/CustomerServices/v1.0/overdueStatusChanges

  • Besides using the date range to filter the overstatus changes to be retrieved, GET Get OverdueStatusChanges also allows two more filters such as businessAccountId and/or accountId

  • The Order field can be used to set the records retrieved to be ordered in ascending or descending order based on overdue status changes effective date.

SOAP WS

The GetOverdueStatusHistoryForDateRange retrieves the details of overdue status or cleared their overdue amount from the Debitsuccess billing system within the specified date range.

The ToOverdueStatus parameter in the response can have the following statutes:

Overdue Status

Description

0

A state of no outstanding overdue. Accounts remain at the overdue “0” status and only move forward if a payment reverses or is missed.

1

The beginning of the overdue reminder cycle. Once the customer misses a payment or a payment is reversed, we reach out to them first through an SMS and then an email. Once the overdue 1 email is sent, the overdue count moves from 0 to 1.

2 and 3

Similar to 1, for the subsequent missed/reversed payments the customers continue to receive email reminders. Each time the overdue progresses from 1 to 2 to 3.

Sample request

<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" xmlns:deb2="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core.RequestMessages">
   <soapenv:Header/>
   <soapenv:Body>
      <deb:GetOverdueStatusHistoryForDateRange>
         <deb:request>
            <deb1:DateCreated>2020-08-10T00:00:00</deb1:DateCreated>
            <deb1:Id>123</deb1:Id>
            <deb1:RequestInitiator>ReqInit1</deb1:RequestInitiator>
            <deb1:User>
               <deb1:Id>123</deb1:Id>
               <deb1:Password>#password</deb1:Password>
               <deb1:Username>username</deb1:Username>
            </deb1:User>
            <deb2:EndDate>2019-04-09</deb2:EndDate>
            <deb2:StartDate>2019-04-07</deb2:StartDate>
         </deb:request>
      </deb:GetOverdueStatusHistoryForDateRange>
   </soapenv:Body>
</soapenv:Envelope>

Sample response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <ActivityId CorrelationId="dcc706a1-1f31-4416-ae25-5bc76f018084" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">00000000-0000-0000-0000-000000000000</ActivityId>
   </s:Header>
   <s:Body>
      <GetOverdueStatusHistoryForDateRangeResponse xmlns="Debitsuccess.WebServices.WCF">
         <GetOverdueStatusHistoryForDateRangeResult xmlns:a="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core.ResponseMessages" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <DateCreated xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">2020-08-11T13:51:50.0913234+12:00</DateCreated>
            <Id xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">0e6264b4-9eab-4434-917f-53fc3ebdc805</Id>
            <ResponseNotes xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">
               <ResponseMessageNote>
                  <Code>00</Code>
                  <Note>Success</Note>
                  <NoteType>Info</NoteType>
               </ResponseMessageNote>
            </ResponseNotes>
            <Status xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">Succeed</Status>
            <a:OverdueStatusChanges xmlns:b="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core.Entities">
               <b:AccountOverdueStatusChange>
                  <b:AccountReferenceNo>DEMT874273</b:AccountReferenceNo>
                  <b:ExternalAccountReferenceNo>NZ9713208</b:ExternalAccountReferenceNo>
                  <b:FromOverdueAmount i:nil="true"/>
                  <b:FromOverdueStatus i:nil="true"/>
                  <b:FromOverdueStatusChangeDate i:nil="true"/>
                  <b:ToOverdueAmount>0.00</b:ToOverdueAmount>
                  <b:ToOverdueStatus>0</b:ToOverdueStatus>
                  <b:ToOverdueStatusChangeDate>2019-04-07T02:24:25.497</b:ToOverdueStatusChangeDate>
               </b:AccountOverdueStatusChange>
               <b:AccountOverdueStatusChange>
                  <b:AccountReferenceNo>DEMT874276</b:AccountReferenceNo>
                  <b:ExternalAccountReferenceNo>NZ9713116</b:ExternalAccountReferenceNo>
                  <b:FromOverdueAmount i:nil="true"/>
                  <b:FromOverdueStatus i:nil="true"/>
                  <b:FromOverdueStatusChangeDate i:nil="true"/>
                  <b:ToOverdueAmount>0.00</b:ToOverdueAmount>
                  <b:ToOverdueStatus>0</b:ToOverdueStatus>
                  <b:ToOverdueStatusChangeDate>2019-04-07T02:24:25.497</b:ToOverdueStatusChangeDate>
               </b:AccountOverdueStatusChange>
               <b:AccountOverdueStatusChange>
                  <b:AccountReferenceNo>DEMT874277</b:AccountReferenceNo>
                  <b:ExternalAccountReferenceNo>NZ9713084</b:ExternalAccountReferenceNo>
                  <b:FromOverdueAmount i:nil="true"/>
                  <b:FromOverdueStatus i:nil="true"/>
                  <b:FromOverdueStatusChangeDate i:nil="true"/>
                  <b:ToOverdueAmount>0.00</b:ToOverdueAmount>
                  <b:ToOverdueStatus>0</b:ToOverdueStatus>
                  <b:ToOverdueStatusChangeDate>2019-04-07T02:24:25.497</b:ToOverdueStatusChangeDate>
               </b:AccountOverdueStatusChange>
               <b:AccountOverdueStatusChange>
                  <b:AccountReferenceNo>DEMT874278</b:AccountReferenceNo>
                  <b:ExternalAccountReferenceNo>NZ9713087</b:ExternalAccountReferenceNo>
                  <b:FromOverdueAmount i:nil="true"/>
                  <b:FromOverdueStatus i:nil="true"/>
                  <b:FromOverdueStatusChangeDate i:nil="true"/>
                  <b:ToOverdueAmount>0.00</b:ToOverdueAmount>
                  <b:ToOverdueStatus>0</b:ToOverdueStatus>
                  <b:ToOverdueStatusChangeDate>2019-04-07T02:24:25.497</b:ToOverdueStatusChangeDate>
               </b:AccountOverdueStatusChange>
               <b:AccountOverdueStatusChange>
                  <b:AccountReferenceNo>DEMT874279</b:AccountReferenceNo>
                  <b:ExternalAccountReferenceNo>NZ9713100</b:ExternalAccountReferenceNo>
                  <b:FromOverdueAmount i:nil="true"/>
                  <b:FromOverdueStatus i:nil="true"/>
                  <b:FromOverdueStatusChangeDate i:nil="true"/>
                  <b:ToOverdueAmount>0.00</b:ToOverdueAmount>
                  <b:ToOverdueStatus>0</b:ToOverdueStatus>
                  <b:ToOverdueStatusChangeDate>2019-04-07T02:24:25.497</b:ToOverdueStatusChangeDate>
               </b:AccountOverdueStatusChange>
            </a:OverdueStatusChanges>
         </GetOverdueStatusHistoryForDateRangeResult>
      </GetOverdueStatusHistoryForDateRangeResponse>
   </s:Body>
</s:Envelope>

On this page:

  • No labels