POST api/account/pm/list?pageSize={pageSize}&pageNumber={pageNumber}

Get list of accounts with sorting and searching and by type of group for the accounts

Request Information

URI Parameters

Name	Description	Type	Additional information
pageSize		integer	Default value is 25
pageNumber		integer	Default value is 1

Body Parameters

GetAccountsFilterDataContract

Name	Type	Additional information
SearchTerm	string	None.
Sort	AccountSort	None.
IsAscending	boolean	None.
IncludeUncleared	boolean	None.
GroupAccountType	AccountingEnumDataContract	None.
Status	SystemStatuses	None.
IncludeAccountsWithNoBalance	boolean	None.
OrderByDescending	boolean	None.
IsTenant	boolean	None.
IsLandlord	boolean	None.
IsCompany	boolean	None.
RetentionAmountFilter	RetentionAmountFilter	None.
AnyAccountActivitySinceLastStatement	boolean	None.
PageSize	integer	None.
PageNumber	integer	None.
ExcludeAccountsWithNegativeBalance	boolean	None.
LandlordResidentStatusFilter	Collection of integer	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
  ]
}

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.