POST api/account/moneyout?pageSize={pageSize}&pageNumber={pageNumber}

Get list of accounts with sorting and searching and by type of group for the accounts Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

Name	Description	Type	Additional information
pageSize	The page size value supplied with the request.	integer	Default value is 25
pageNumber	The page number value supplied with the request.	integer	Default value is 1

Body Parameters

The get accounts filter data contract supplied with the request.

GetAccountsFilterDataContract

Name	Description	Type	Additional information
SearchTerm	The search term value.	string	None.
Sort	The sort classification.	AccountSort	None.
IsAscending	Indicates whether this item is ascending.	boolean	None.
IncludeUncleared	Indicates whether include uncleared is true.	boolean	None.
GroupAccountType	The group account type value.	AccountingEnumDataContract	None.
Status	The status classification.	SystemStatuses	None.
IncludeAccountsWithNoBalance	Indicates whether include accounts with no balance is true.	boolean	None.
OrderByDescending	Indicates whether order by descending is true.	boolean	None.
IsTenant	Indicates whether this item is tenant.	boolean	None.
IsLandlord	Indicates whether this item is landlord.	boolean	None.
IsCompany	Indicates whether this item is company.	boolean	None.
RetentionAmountFilter	The retention amount filter classification.	RetentionAmountFilter	None.
AnyAccountActivitySinceLastStatement	Indicates whether any account activity since last statement is true.	boolean	None.
PageSize	The page size value.	integer	None.
PageNumber	The page number value.	integer	None.
ExcludeAccountsWithNegativeBalance	Indicates whether exclude accounts with negative balance is true.	boolean	None.
LandlordResidentStatusFilter	The collection of landlord resident status filter.	Collection of integer	None.
OnlyInArrears	Indicates whether only in arrears is true.	boolean	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "SearchTerm": "sample string 1",
  "Sort": 0,
  "IsAscending": true,
  "IncludeUncleared": true,
  "GroupAccountType": {
    "Name": "sample string 1",
    "SystemName": "sample string 2",
    "Id": 1
  },
  "Status": 0,
  "IncludeAccountsWithNoBalance": true,
  "OrderByDescending": true,
  "IsTenant": true,
  "IsLandlord": true,
  "IsCompany": true,
  "RetentionAmountFilter": 0,
  "AnyAccountActivitySinceLastStatement": true,
  "PageSize": 1,
  "PageNumber": 1,
  "ExcludeAccountsWithNegativeBalance": true,
  "LandlordResidentStatusFilter": [
    1,
    2
  ],
  "OnlyInArrears": true
}

Response Information

Resource Description

The response returned after the operation completes.

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.