POST api/tenancy/{id}/rentdifferencewithschedule

Gets the rent split/consolidate summary for determining next rent amounts.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

Dezrez.Core.DataContracts.External.Api.Lettings.Command.UpdateRentAmountDataContract
NameDescriptionTypeAdditional information
RentAmount

decimal number

None.

PriceType

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

RentSchedule

Dezrez.Core.DataContracts.External.Api.Events.ScheduledEvents.Command.RecurringScheduleDataContract

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "RentAmount": 1.0,
  "PriceType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "RentSchedule": {
    "Frequency": 1,
    "StartDate": "2024-10-11T17:22:43.654588Z",
    "DaysOfWeek": [
      1,
      1
    ],
    "DayOfMonth": 1,
    "Interval": 2,
    "IsSplit": true,
    "AnniversaryDay": 4,
    "AnniversaryMonth": 5,
    "IsNewTenancy": true
  }
}

Response Information

Resource Description

Dezrez.Core.DataContracts.External.Api.Lettings.Query.Rent.RentDayDifferenceDataContract
NameDescriptionTypeAdditional information
DaysDifference

integer

None.

Amount

decimal number

None.

NextRentAmountSplit

decimal number

None.

NextRentAmountConsolidate

decimal number

None.

DateDue

date

None.

NextFullRentDate

date

None.

NextSplitRentDate

date

None.

Response Formats

application/json, text/json

Sample:
{
  "DaysDifference": 1,
  "Amount": 2.0,
  "NextRentAmountSplit": 3.0,
  "NextRentAmountConsolidate": 4.0,
  "DateDue": "2024-10-11T17:22:43.654588Z",
  "NextFullRentDate": "2024-10-11T17:22:43.654588Z",
  "NextSplitRentDate": "2024-10-11T17:22:43.654588Z"
}