GetClosedAccountsForDateRange

Usage

Retrieves a list of all closed accounts within a date range.

This can be specified at a single contract prefix or facility account level.

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
ContractPrefix	String	6	Optional	Provided by Debitsuccess (allows customer accounts to be split into different organisational groups if required).
StartDate	DateTime		Required	Start of the report period
EndDate	DateTime		Optional	End of the report period

^{If Contract Prefix is not given, then return all the cancelled accounts from the facility/facility account assigned to the user.}

^{The following is a list of the different combinations of parameters which can be used for this method:}

^{Providing StartDate and EndDate parameters returns account details for all accounts that have had details changed during the specified period.}
^{Providing the StartDate parameter returns account details for all accounts that have had details changed after the specified date.}

Response

Name	Data Type	Description
DateCreated	DateTime	Date/time message was processed
Id	String	Unique ID for message
ResponseNotes ()		Collection of validation messages
Code	String
Note	String
NoteType	Enum	Error, Warning, Info
Status	Enum	Failed, Succeed, Unknown
Accounts ()
ContractPrefix	String
AccountReferenceNo	String	Debitsuccess Reference Number
ExternalAccountReferenceNo	String	External account reference
FirstName	String
LastName	String
CancelReason	String
CustomCancelReason	String
DateAccountClosed	Date Time

Error Messages

Type	Error Code	Error Message
Warning	14202	Start date is required
Warning	14203	Start date cannot be in the future
Invalid Value	13090	Start date must not be after end date
Invalid Value	14109	Start date and End date cannot be more than 1 month apart
Invalid Value	13001	Invalid Contract Prefix

Related Pages

Filter by label

There are no items with the selected labels at this time.

On this page: