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

NameDescriptionTypeAdditional information
pageSize

integer

Default value is 25

pageNumber

integer

Default value is 1

Body Parameters

GetAccountsFilterDataContract
NameDescriptionTypeAdditional 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.

Request Formats

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
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PagedCollectionDataContractOfAccountPaymentDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of AccountPaymentDataContract

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "Name": "sample string 1",
      "Total": 2.0,
      "Deductions": 3.0,
      "ToPay": 4.0,
      "Received": 5.0,
      "AllDisbursements": 6.0,
      "NumberOfItems": 7,
      "LastStatementDate": "2020-12-04T08:30:23.1670582Z",
      "AssociatedGroupId": 8,
      "Id": 9
    },
    {
      "Name": "sample string 1",
      "Total": 2.0,
      "Deductions": 3.0,
      "ToPay": 4.0,
      "Received": 5.0,
      "AllDisbursements": 6.0,
      "NumberOfItems": 7,
      "LastStatementDate": "2020-12-04T08:30:23.1670582Z",
      "AssociatedGroupId": 8,
      "Id": 9
    }
  ]
}