GetOverdueStatusHistoryForDateRange

Usage

Retrieves the details of overdue status or amount changes from the Debitsuccess billing system within the specified date range.

Since this API call does not have pagination, our recommendation is to apply smaller date ranges (not more than 30 days) otherwise, you may receive timeout errors.

Parameters

Name	Data Type	Length		Description
User
Username	String		Required	Provided by Debitsuccess
Password	String		Required	Provided by Debitsuccess
RequestInitiator	String	100	Optional	Optional – allows requesting user to be logged
StartDate	DateTime		Required	Start of the reporting period Must be formatted as yyyy-MM-dd
EndDate	DateTime?		Optional	End of the reporting period Must be formatted as yyyy-MM-dd

Response

Name	Data Type	Description
DateCreated	DateTime	Date/time message was processed
Id	String	Unique ID for the age
ResponseNotes ()		Collection of validation messages
Code	String
Note	String
NoteType	Enum	Error, Warning, Info
Status	Enum	Failed, Succeed, Unknown
OverdueStatusChanges ()
AccountReferenceNo	String	Debitsuccess Reference number
ExternalAccountReferenceNo	String	Your account identifier
FromOverdueStatus	Int	Previous Overdue Status value
FromOverdueStatusChangeDate	DateTime	Date that overdue status changed last
FromOverdueAmount	Decimal (10, 2)	Previous Overdue Amount
ToOverdueStatus	Int	New Overdue Status value
ToOverdueStatusChangeDate	DateTime	Date that overdue status changed
ToOverdueAmount	Decimal (10, 2)	Overdue Amount at time of overdue status change

Note: Overdue amounts returned by this message are based on cleared funds, so if Debitsuccess collected a bank account payment yesterday, an update to the overdue amount will not be returned until the payment has cleared.

Error Messages

Type	Error Code	Error Message
Error	14033	Invalid Start date - start date must be less then end date.
Error	14032	Invalid Date range - start date and end date must be within 7 days.
Info	00	Success

Related Pages

Page:

Retrieve overdue accounts in a given period

On this page:

REST API

GET OverdueStatusChanges