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 9 Next »

Usage


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

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

Error Messages

TypeError CodeError Message
Error14033Invalid Start date - start date must be less then end date.
Error14032Invalid Date range - start date and end date must be within 7 days.
Info00Success

Related Pages

On this page:




  • No labels