GET api/tenancy/rentDemands/csv?tenant={tenant}&includeOpen={includeOpen}&includePaid={includePaid}
Get rent demands for the tenant role
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
tenant | integer |
Required |
|
includeOpen | boolean |
Default value is True |
|
includePaid | boolean |
Default value is True |
Body Parameters
None.
Response Information
Resource Description
Dezrez.Core.DataContracts.External.Api.Lettings.Query.Rent.RentDemandDataContractName | Description | Type | Additional information |
---|---|---|---|
DueDate | date |
None. |
|
EndDate | date |
None. |
|
TotalAmount | decimal number |
None. |
|
TotalOutstanding | decimal number |
None. |
|
DiscountTotalAmount | decimal number |
None. |
|
Fees | Collection of string |
None. |
|
FeeAmount | decimal number |
None. |
|
LandlordPayment | decimal number |
None. |
|
Items | Collection of Dezrez.Core.DataContracts.External.Api.Lettings.Query.Rent.RentItemDataContract |
None. |
|
IsPaid | boolean |
None. |
|
IsForecast | boolean |
None. |
|
IsFullRentAmount | boolean |
None. |
|
DaysInRentPeriod | integer |
None. |
|
DayRate | decimal number |
None. |
|
InvoiceId | integer |
None. |
|
IsProjection | boolean |
None. |
|
Id | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "DueDate": "2024-10-11T18:06:57.1361663Z", "EndDate": "2024-10-11T18:06:57.1361663Z", "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 }