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

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.

GroupType

GroupAccountType

None.

Status

SystemStatus

None.

IncludeAccountsWithNoBalance

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "SearchTerm": "sample string 1",
  "Sort": 0,
  "IsAscending": true,
  "IncludeUncleared": true,
  "GroupType": 0,
  "Status": 0,
  "IncludeAccountsWithNoBalance": true
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'GetAccountsFilterDataContract'.

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,
      "NumberOfItems": 5,
      "LastStatementDate": "2018-11-15T05:05:29.7114536Z",
      "Id": 6
    },
    {
      "Name": "sample string 1",
      "Total": 2.0,
      "Deductions": 3.0,
      "ToPay": 4.0,
      "NumberOfItems": 5,
      "LastStatementDate": "2018-11-15T05:05:29.7114536Z",
      "Id": 6
    }
  ]
}