POST api/account/nrlRetained

Get an overview of customer nrl accounts

Request Information

URI Parameters

None.

Body Parameters

NrlRetainedFilterDataContract
NameDescriptionTypeAdditional information
PageSize

integer

None.

PageNumber

integer

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "PageSize": 1,
  "PageNumber": 2
}

Response Information

Resource Description

NrlRetainedPagedDataContract
NameDescriptionTypeAdditional information
TotalAccountBalance

decimal number

None.

TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of NrlRetainedDataContract

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalAccountBalance": 1.0,
  "TotalCount": 2,
  "CurrentCount": 3,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "Id": 1,
      "GroupId": 2,
      "Name": "sample string 3",
      "Address": "sample string 4",
      "LandlordResidentStatus": [
        "sample string 1",
        "sample string 2"
      ],
      "NrlReference": [
        "sample string 1",
        "sample string 2"
      ],
      "AccountBalance": 5.0
    },
    {
      "Id": 1,
      "GroupId": 2,
      "Name": "sample string 3",
      "Address": "sample string 4",
      "LandlordResidentStatus": [
        "sample string 1",
        "sample string 2"
      ],
      "NrlReference": [
        "sample string 1",
        "sample string 2"
      ],
      "AccountBalance": 5.0
    }
  ]
}