GET api/tenancy/{id}/rentdemands?startDate={startDate}&endDate={endDate}&includeOpen={includeOpen}&includePaid={includePaid}&pageSize={pageSize}&pageNumber={pageNumber}
Get rent demands for the tenant role
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | integer |
Required |
|
startDate | date |
None. |
|
endDate | date |
None. |
|
includeOpen | boolean |
Default value is True |
|
includePaid | boolean |
Default value is True |
|
pageSize | integer |
Default value is 2147483647 |
|
pageNumber | integer |
Default value is 1 |
Body Parameters
None.
Response Information
Resource Description
PagedCollectionDataContractOfDezrez.Core.DataContracts.External.Api.Lettings.Query.Rent.RentDemandDataContractName | Description | Type | Additional information |
---|---|---|---|
TotalCount | integer |
None. |
|
CurrentCount | integer |
None. |
|
PageSize | integer |
None. |
|
PageNumber | integer |
None. |
|
Collection | Collection of Dezrez.Core.DataContracts.External.Api.Lettings.Query.Rent.RentDemandDataContract |
None. |
Response Formats
application/json, text/json
Sample:
{ "TotalCount": 1, "CurrentCount": 2, "PageSize": 1, "PageNumber": 1, "Collection": [ { "DueDate": "2024-10-06T03:43:52.2222985Z", "EndDate": "2024-10-06T03:43:52.2222985Z", "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": "2024-10-06T03:43:52.2222985Z", "EndDate": "2024-10-06T03:43:52.2222985Z", "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 } ] }