GET api/tenancy/{id}/rentdemands?startDate={startDate}&endDate={endDate}&includeForecast={includeForecast}&pageSize={pageSize}&pageNumber={pageNumber}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

startDate

date

None.

endDate

date

None.

includeForecast

boolean

Default value is True

pageSize

integer

Default value is 25

pageNumber

integer

Default value is 1

Body Parameters

None.

Response Information

Resource Description

PagedCollectionDataContractOfRentDemandDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of RentDemandDataContract

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "DueDate": "2018-11-16T22:20:00.8648392Z",
      "TotalAmount": 2.0,
      "TotalOutstanding": 3.0,
      "DiscountTotalAmount": 4.0,
      "Fees": "sample string 5",
      "FeeAmount": 6.0,
      "LandlordPayment": -8.0,
      "Items": [
        {
          "Amount": 1.0,
          "Discount": 2.0,
          "FeeAmount": 3.0,
          "AmountPayable": -4.0,
          "Id": 4
        },
        {
          "Amount": 1.0,
          "Discount": 2.0,
          "FeeAmount": 3.0,
          "AmountPayable": -4.0,
          "Id": 4
        }
      ],
      "IsPaid": true,
      "IsForecast": true,
      "Id": 9
    },
    {
      "DueDate": "2018-11-16T22:20:00.8648392Z",
      "TotalAmount": 2.0,
      "TotalOutstanding": 3.0,
      "DiscountTotalAmount": 4.0,
      "Fees": "sample string 5",
      "FeeAmount": 6.0,
      "LandlordPayment": -8.0,
      "Items": [
        {
          "Amount": 1.0,
          "Discount": 2.0,
          "FeeAmount": 3.0,
          "AmountPayable": -4.0,
          "Id": 4
        },
        {
          "Amount": 1.0,
          "Discount": 2.0,
          "FeeAmount": 3.0,
          "AmountPayable": -4.0,
          "Id": 4
        }
      ],
      "IsPaid": true,
      "IsForecast": true,
      "Id": 9
    }
  ]
}