POST api/tenancy/{id}/createrentdemand

Create custom rent demand for the tenancy 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	Tenant Role Id	integer	Required

Body Parameters

RentDemandDataContract with start and end date and amount filled in

RentDemandDataContract

Name	Description	Type	Additional information
DueDate	The due date, expressed as a date and time.	date	None.
EndDate	The end date, expressed as a date and time.	date	None.
TotalAmount	The total amount value.	decimal number	None.
TotalOutstanding	The total outstanding value.	decimal number	None.
DiscountTotalAmount	The discount total amount value.	decimal number	None.
Fees	The collection of fees.	Collection of string	None.
FeeAmount	The fee amount value.	decimal number	None.
LandlordPayment	The landlord payment value.	decimal number	None.
Items	The collection of items.	Collection of RentItemDataContract	None.
IsPaid	Indicates whether this item is paid.	boolean	None.
IsForecast	Indicates whether this item is forecast.	boolean	None.
IsFullRentAmount	Indicates whether this item is full rent amount.	boolean	None.
DaysInRentPeriod	The days in rent period value.	integer	None.
DayRate	The day rate value.	decimal number	None.
InvoiceId	The unique identifier of the related invoice resource.	integer	None.
IsProjection	Indicates whether this item is projection.	boolean	None.
Id	The unique identifier of this resource.	integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "DueDate": "2026-07-23T10:37:11.4659749Z",
  "EndDate": "2026-07-23T10:37:11.4659749Z",
  "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
}

Response Information

Resource Description

The response returned after the operation completes.

InvoiceDataContract

Name	Description	Type	Additional information
RecipientAccountId	The unique identifier of the related recipient account resource.	integer	None.
LiableAccountId	The unique identifier of the related liable account resource.	integer	None.
RecipientAccountName	The recipient account name value.	string	None.
RecipientGroupId	The unique identifier of the related recipient group resource.	integer	None.
LiableAccountName	The liable account name value.	string	None.
LiableAccountBalance	The liable account balance value.	decimal number	None.
LiableGroupId	The unique identifier of the related liable group resource.	decimal number	None.
Status	The status value.	string	None.
DueDate	The due date, expressed as a date and time.	date	None.
CreatedDate	The created date, expressed as a date and time.	date	None.
RentPeriodEndDate	The rent period end date, expressed as a date and time.	date	None.
InvoiceNumber	The invoice number value.	integer	None.
Description	The description value.	string	None.
InvoiceType	The invoice type value.	string	None.
InvoiceSubType	The invoice sub type value.	string	None.
TotalAmount	The total amount value.	decimal number	None.
SubTotalAmount	The sub total amount value.	decimal number	None.
TaxTotalAmount	The tax total amount value.	decimal number	None.
DiscountTotalAmount	The discount total amount value.	decimal number	None.
TotalOutstanding	The total outstanding value.	decimal number	None.
TotalPaid	The total paid value.	decimal number	None.
Notes	The notes value.	string	None.
Payments	The collection of payments.	Collection of InvoicePaymentDataContract	None.
Allocations	The collection of allocations.	Collection of InvoiceAllocationCollectionDataContract	None.
InvoiceItems	The collection of invoice items.	Collection of InvoiceItemDetailDataContract	None.
LinkedFees	The collection of linked fees.	Collection of LinkedFeeDataContract	None.
PropertyId	The unique identifier of the related property resource.	integer	None.
TenancyRoleId	The unique identifier of the related tenancy role resource.	integer	None.
Address	The address value.	string	None.
RelatedInvoiceId	The unique identifier of the related related invoice resource.	integer	None.
CustomInvoiceNumber	The custom invoice number value.	string	None.
DocumentIds	The unique identifiers of the related document resources.	Collection of integer	None.
PropertyAccountId	The unique identifier of the related property account resource.	integer	None.
InternalInvoiceNumber	The internal invoice number value.	integer	None.
PreviewReziDocumentRef	The preview rezi document ref value.	string	None.
IsRecurring	Indicates whether this item is recurring.	boolean	None.
ScheduleFrequency	The schedule frequency value.	integer	None.
ScheduleOccurrences	The schedule occurrences value.	integer	None.
ScheduleInterval	The schedule interval value.	integer	None.
ScheduleStartDate	The schedule start date, expressed as a date and time.	date	None.
ScheduleEndDate	The schedule end date, expressed as a date and time.	date	None.
ScheduleNextRunDate	The schedule next run date, expressed as a date and time.	date	None.
ScheduleIsActive	Indicates whether schedule is active is true.	boolean	None.
ScheduleDaysOfTheWeek	The schedule days of the week value.	integer	None.
ScheduleId	The unique identifier of the related schedule resource.	integer	None.
ScheduleDisplayText	The schedule display text value.	string	None.
Id	The unique identifier of this resource.	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": "2026-07-23T10:37:11.4659749Z",
  "CreatedDate": "2026-07-23T10:37:11.4659749Z",
  "RentPeriodEndDate": "2026-07-23T10:37:11.4659749Z",
  "InvoiceNumber": 1,
  "Description": "sample string 11",
  "InvoiceType": "sample string 12",
  "InvoiceSubType": "sample string 13",
  "TotalAmount": 14.0,
  "SubTotalAmount": 15.0,
  "TaxTotalAmount": 16.0,
  "DiscountTotalAmount": 17.0,
  "TotalOutstanding": 18.0,
  "TotalPaid": 19.0,
  "Notes": "sample string 20",
  "Payments": [
    {
      "PaymentNumber": "sample string 1",
      "Amount": 2.0,
      "Date": "2026-07-23T10:37:11.4659749Z",
      "Id": 4
    },
    {
      "PaymentNumber": "sample string 1",
      "Amount": 2.0,
      "Date": "2026-07-23T10:37:11.4659749Z",
      "Id": 4
    }
  ],
  "Allocations": [
    {
      "Date": "2026-07-23T10:37:11.4659749Z",
      "Amount": 2.0,
      "Regarding": "sample string 3",
      "Description": "sample string 4",
      "AllocationItems": [
        {
          "Date": "2026-07-23T10:37:11.4659749Z",
          "Amount": 2.0,
          "InvoiceId": 3,
          "InvoiceItemId": 4,
          "InvoiceItemDescription": "sample string 5",
          "Protected": true,
          "ProtectedDate": "2026-07-23T10:37:11.4659749Z",
          "LandlordProtected": true,
          "Id": 9
        },
        {
          "Date": "2026-07-23T10:37:11.4659749Z",
          "Amount": 2.0,
          "InvoiceId": 3,
          "InvoiceItemId": 4,
          "InvoiceItemDescription": "sample string 5",
          "Protected": true,
          "ProtectedDate": "2026-07-23T10:37:11.4659749Z",
          "LandlordProtected": true,
          "Id": 9
        }
      ],
      "Id": 5
    },
    {
      "Date": "2026-07-23T10:37:11.4659749Z",
      "Amount": 2.0,
      "Regarding": "sample string 3",
      "Description": "sample string 4",
      "AllocationItems": [
        {
          "Date": "2026-07-23T10:37:11.4659749Z",
          "Amount": 2.0,
          "InvoiceId": 3,
          "InvoiceItemId": 4,
          "InvoiceItemDescription": "sample string 5",
          "Protected": true,
          "ProtectedDate": "2026-07-23T10:37:11.4659749Z",
          "LandlordProtected": true,
          "Id": 9
        },
        {
          "Date": "2026-07-23T10:37:11.4659749Z",
          "Amount": 2.0,
          "InvoiceId": 3,
          "InvoiceItemId": 4,
          "InvoiceItemDescription": "sample string 5",
          "Protected": true,
          "ProtectedDate": "2026-07-23T10:37:11.4659749Z",
          "LandlordProtected": true,
          "Id": 9
        }
      ],
      "Id": 5
    }
  ],
  "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": "2026-07-23T10:37:11.4659749Z",
      "Type": 0,
      "RelatedEntityId": 9,
      "CreditNoteItems": [
        {
          "Amount": 1.0,
          "InvoiceItemId": 2,
          "CreditNoteId": 3,
          "Reason": "sample string 4",
          "InvoiceNumber": 5,
          "InvoiceId": 6,
          "CreatedDate": "2026-07-23T10:37:11.4659749Z",
          "Id": 8
        },
        {
          "Amount": 1.0,
          "InvoiceItemId": 2,
          "CreditNoteId": 3,
          "Reason": "sample string 4",
          "InvoiceNumber": 5,
          "InvoiceId": 6,
          "CreatedDate": "2026-07-23T10:37:11.4659749Z",
          "Id": 8
        }
      ],
      "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": "2026-07-23T10:37:11.4659749Z",
      "Type": 0,
      "RelatedEntityId": 9,
      "CreditNoteItems": [
        {
          "Amount": 1.0,
          "InvoiceItemId": 2,
          "CreditNoteId": 3,
          "Reason": "sample string 4",
          "InvoiceNumber": 5,
          "InvoiceId": 6,
          "CreatedDate": "2026-07-23T10:37:11.4659749Z",
          "Id": 8
        },
        {
          "Amount": 1.0,
          "InvoiceItemId": 2,
          "CreditNoteId": 3,
          "Reason": "sample string 4",
          "InvoiceNumber": 5,
          "InvoiceId": 6,
          "CreatedDate": "2026-07-23T10:37:11.4659749Z",
          "Id": 8
        }
      ],
      "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 21",
  "RelatedInvoiceId": 1,
  "CustomInvoiceNumber": "sample string 22",
  "DocumentIds": [
    1,
    2
  ],
  "PropertyAccountId": 1,
  "InternalInvoiceNumber": 1,
  "PreviewReziDocumentRef": "sample string 23",
  "IsRecurring": true,
  "ScheduleFrequency": 1,
  "ScheduleOccurrences": 1,
  "ScheduleInterval": 1,
  "ScheduleStartDate": "2026-07-23T10:37:11.4659749Z",
  "ScheduleEndDate": "2026-07-23T10:37:11.4659749Z",
  "ScheduleNextRunDate": "2026-07-23T10:37:11.4659749Z",
  "ScheduleIsActive": true,
  "ScheduleDaysOfTheWeek": 24,
  "ScheduleId": 25,
  "ScheduleDisplayText": "Occurs daily for 1 time",
  "Id": 26
}