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

Get rent demands for the tenant role Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The unique identifier of the requested resource.	integer	Required
startDate	The start date value supplied with the request.	date	None.
endDate	The end date value supplied with the request.	date	None.
includeOpen	The include open value supplied with the request.	boolean	Default value is True
includePaid	The include paid value supplied with the request.	boolean	Default value is True
pageSize	The page size value supplied with the request.	integer	Default value is 2147483647
pageNumber	The page number value supplied with the request.	integer	Default value is 1

Body Parameters

None.

Response Information

Resource Description

The response returned after the operation completes.

PagedCollectionDataContractOfRentDemandDataContract

Name	Description	Type	Additional information
TotalCount	The total count value.	integer	None.
CurrentCount	The current count value.	integer	None.
PageSize	The page size value.	integer	None.
PageNumber	The page number value.	integer	None.
Collection	The collection of collection.	Collection of RentDemandDataContract	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "DueDate": "2026-08-04T22:25:34.2120337Z",
      "EndDate": "2026-08-04T22:25:34.2120337Z",
      "TotalAmount": 3.0,
      "TotalOutstanding": 4.0,
      "DiscountTotalAmount": 5.0,
      "Fees": [
        "sample string 1",
        "sample string 2"
      ],
      "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,
      "IsFullRentAmount": true,
      "DaysInRentPeriod": 10,
      "DayRate": 11.0,
      "InvoiceId": 1,
      "IsProjection": true,
      "Id": 13
    },
    {
      "DueDate": "2026-08-04T22:25:34.2120337Z",
      "EndDate": "2026-08-04T22:25:34.2120337Z",
      "TotalAmount": 3.0,
      "TotalOutstanding": 4.0,
      "DiscountTotalAmount": 5.0,
      "Fees": [
        "sample string 1",
        "sample string 2"
      ],
      "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,
      "IsFullRentAmount": true,
      "DaysInRentPeriod": 10,
      "DayRate": 11.0,
      "InvoiceId": 1,
      "IsProjection": true,
      "Id": 13
    }
  ]
}