POST api/tenancy/{id}/generaterentdemand?dueDate={dueDate}&futureDemand={futureDemand}
Create next rent demand for the tenancy
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
Tenant Role Id |
integer |
Required |
dueDate |
(Optional) Due date if not provided calculated from next rent date |
date |
None. |
futureDemand |
(Optional) Generates the next rent demand (if no due date) that's in the future, if false it will generate the next in the schedule |
boolean |
Default value is True |
Body Parameters
None.
Response Information
Resource Description
Dezrez.Core.DataContracts.Accounts.Invoices.Query.InvoiceDataContractName | Description | Type | Additional information |
---|---|---|---|
RecipientAccountId | integer |
None. |
|
LiableAccountId | integer |
None. |
|
RecipientAccountName | string |
None. |
|
RecipientGroupId | integer |
None. |
|
LiableAccountName | string |
None. |
|
LiableAccountBalance | decimal number |
None. |
|
LiableGroupId | decimal number |
None. |
|
Status | string |
None. |
|
DueDate | date |
None. |
|
CreatedDate | date |
None. |
|
RentPeriodEndDate | date |
None. |
|
InvoiceNumber | integer |
None. |
|
Description | string |
None. |
|
InvoiceType | string |
None. |
|
InvoiceSubType | string |
None. |
|
TotalAmount | decimal number |
None. |
|
SubTotalAmount | decimal number |
None. |
|
TaxTotalAmount | decimal number |
None. |
|
DiscountTotalAmount | decimal number |
None. |
|
TotalOutstanding | decimal number |
None. |
|
TotalPaid | decimal number |
None. |
|
Notes | string |
None. |
|
Payments | Collection of Dezrez.Core.DataContracts.Accounts.Invoices.Query.InvoicePaymentDataContract |
None. |
|
Allocations | Collection of Dezrez.Core.DataContracts.Accounts.Invoices.Query.InvoiceAllocationCollectionDataContract |
None. |
|
InvoiceItems | Collection of Dezrez.Core.DataContracts.Accounts.Invoices.Query.InvoiceItemDetailDataContract |
None. |
|
LinkedFees | Collection of Dezrez.Core.DataContracts.Accounts.Invoices.Query.LinkedFeeDataContract |
None. |
|
PropertyId | integer |
None. |
|
TenancyRoleId | integer |
None. |
|
Address | string |
None. |
|
RelatedInvoiceId | integer |
None. |
|
CustomInvoiceNumber | string |
None. |
|
DocumentIds | Collection of integer |
None. |
|
PropertyAccountId | integer |
None. |
|
PreviewReziDocumentRef | string |
None. |
|
Id | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "RecipientAccountId": 1, "LiableAccountId": 2, "RecipientAccountName": "sample string 3", "RecipientGroupId": 4, "LiableAccountName": "sample string 5", "LiableAccountBalance": 6.0, "LiableGroupId": 7.0, "Status": "sample string 8", "DueDate": "2024-10-08T08:42:52.071673Z", "CreatedDate": "2024-10-08T08:42:52.071673Z", "RentPeriodEndDate": "2024-10-08T08:42:52.071673Z", "InvoiceNumber": 11, "Description": "sample string 12", "InvoiceType": "sample string 13", "InvoiceSubType": "sample string 14", "TotalAmount": 15.0, "SubTotalAmount": 16.0, "TaxTotalAmount": 17.0, "DiscountTotalAmount": 18.0, "TotalOutstanding": 19.0, "TotalPaid": 20.0, "Notes": "sample string 21", "Payments": [ { "PaymentNumber": "sample string 1", "Amount": 2.0, "Date": "2024-10-08T08:42:52.071673Z", "Id": 4 }, { "PaymentNumber": "sample string 1", "Amount": 2.0, "Date": "2024-10-08T08:42:52.071673Z", "Id": 4 } ], "Allocations": [ { "Date": "2024-10-08T08:42:52.071673Z", "Amount": 2.0, "Description": "sample string 3", "AllocationItems": [ { "Date": "2024-10-08T08:42:52.071673Z", "Amount": 2.0, "InvoiceId": 3, "InvoiceItemId": 4, "InvoiceItemDescription": "sample string 5", "Protected": true, "ProtectedDate": "2024-10-08T08:42:52.071673Z", "LandlordProtected": true, "Id": 9 }, { "Date": "2024-10-08T08:42:52.071673Z", "Amount": 2.0, "InvoiceId": 3, "InvoiceItemId": 4, "InvoiceItemDescription": "sample string 5", "Protected": true, "ProtectedDate": "2024-10-08T08:42:52.071673Z", "LandlordProtected": true, "Id": 9 } ], "Id": 4 }, { "Date": "2024-10-08T08:42:52.071673Z", "Amount": 2.0, "Description": "sample string 3", "AllocationItems": [ { "Date": "2024-10-08T08:42:52.071673Z", "Amount": 2.0, "InvoiceId": 3, "InvoiceItemId": 4, "InvoiceItemDescription": "sample string 5", "Protected": true, "ProtectedDate": "2024-10-08T08:42:52.071673Z", "LandlordProtected": true, "Id": 9 }, { "Date": "2024-10-08T08:42:52.071673Z", "Amount": 2.0, "InvoiceId": 3, "InvoiceItemId": 4, "InvoiceItemDescription": "sample string 5", "Protected": true, "ProtectedDate": "2024-10-08T08:42:52.071673Z", "LandlordProtected": true, "Id": 9 } ], "Id": 4 } ], "InvoiceItems": [ { "TaxAmount": 1.0, "SubTotalAmount": 2.0, "TotalOutstanding": 3.0, "Amount": 4.0, "Name": "sample string 5", "IsTaxable": true, "TaxitemId": 1, "Discount": 7.0, "DiscountName": "sample string 8", "DiscountDate": "2024-10-08T08:42:52.071673Z", "Type": 0, "RelatedEntityId": 9, "CreditNoteItems": [ { "Amount": 1.0, "InvoiceItemId": 2, "CreditNoteId": 3, "Reason": "sample string 4", "InvoiceNumber": 5, "Id": 6 }, { "Amount": 1.0, "InvoiceItemId": 2, "CreditNoteId": 3, "Reason": "sample string 4", "InvoiceNumber": 5, "Id": 6 } ], "RefundItems": [ { "Amount": 1.0, "InvoiceItemId": 2, "InvoiceId": 3, "RefundId": 4, "Id": 5 }, { "Amount": 1.0, "InvoiceItemId": 2, "InvoiceId": 3, "RefundId": 4, "Id": 5 } ], "Id": 10 }, { "TaxAmount": 1.0, "SubTotalAmount": 2.0, "TotalOutstanding": 3.0, "Amount": 4.0, "Name": "sample string 5", "IsTaxable": true, "TaxitemId": 1, "Discount": 7.0, "DiscountName": "sample string 8", "DiscountDate": "2024-10-08T08:42:52.071673Z", "Type": 0, "RelatedEntityId": 9, "CreditNoteItems": [ { "Amount": 1.0, "InvoiceItemId": 2, "CreditNoteId": 3, "Reason": "sample string 4", "InvoiceNumber": 5, "Id": 6 }, { "Amount": 1.0, "InvoiceItemId": 2, "CreditNoteId": 3, "Reason": "sample string 4", "InvoiceNumber": 5, "Id": 6 } ], "RefundItems": [ { "Amount": 1.0, "InvoiceItemId": 2, "InvoiceId": 3, "RefundId": 4, "Id": 5 }, { "Amount": 1.0, "InvoiceItemId": 2, "InvoiceId": 3, "RefundId": 4, "Id": 5 } ], "Id": 10 } ], "LinkedFees": [ { "LiableAccountId": 1, "RecipientAccountId": 2, "FeeId": 3, "ExternalReference": 4, "Id": 5 }, { "LiableAccountId": 1, "RecipientAccountId": 2, "FeeId": 3, "ExternalReference": 4, "Id": 5 } ], "PropertyId": 1, "TenancyRoleId": 1, "Address": "sample string 22", "RelatedInvoiceId": 1, "CustomInvoiceNumber": "sample string 23", "DocumentIds": [ 1, 2 ], "PropertyAccountId": 1, "PreviewReziDocumentRef": "sample string 24", "Id": 25 }