GetActiveAccounts

Usage

Retrieves a list of all active accounts.

This can be specified at a single contract prefix or facility account level. Closed accounts will not be included.

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		Optional	Provided by Debitsuccess (allows customer accounts to be split into different organizational groups if required).
PageNumber	String	6	Optional	Optional – allows requesting user to request a specific page ID where there is a large number of results.

Name	Data Type	Description
DateCreated	DateTime	Date/time message was processed
Id	String	Unique ID for the message
ResponseNotes ()		Collection of validation messages
Code	String
Note	String
NoteType	Enum	Error, Warning, Info
Status	Enum	Failed, Succeed, Unknown
TotalActiveAccounts	String	Total number of active accounts within the Facility or Facility Account requested.
TotalPageCount	String	Total pages where there is a large set of active accounts to be returned.
GetActiveAccounts ()
FacilityName	String	Name of the facility
ContractPrefix	String
AccountReferenceNo	String	Debitsuccess Reference Number
ExternalAccountReferenceNo	String	Your account identifier
FirstName	String
LastName	String

A maximum of 100 records are returned per page.

Type	Error Code	Error Message
Error	02	Invalid user credentials
Error	14060	Invalid PageNumber - PageNumber must not be less than 1.
Error	14058	No active facility account found for the User
Error	13150	No contract found for given contract prefix
Error	14061	Invalid PageNumber - PageNumber must not be greater than page count.

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

On this page:

REST API

GET Accounts