POST api/DBA/GetYSLeasePricingDetails

Request Information

URI Parameters

None.

Body Parameters

LeasePriceParams
NameDescriptionTypeAdditional information
unitId

integer

None.
dbaId

integer

None.
leaseDate

date

None.
availableDate

date

None.

Request Formats

application/json, text/json

Sample: 
{
  "unitId": 1,
  "dbaId": 1,
  "leaseDate": "2025-09-27T12:22:19.9335336-05:00",
  "availableDate": "2025-09-27T12:22:19.9335336-05:00"
}

application/xml, text/xml

Sample: 
<LeasePriceParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.YottaResident.WebAPIs.Models">
  <availableDate>2025-09-27T12:22:19.9335336-05:00</availableDate>
  <dbaId>1</dbaId>
  <leaseDate>2025-09-27T12:22:19.9335336-05:00</leaseDate>
  <unitId>1</unitId>
</LeasePriceParams>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

YSUnitLeasePricingModel
NameDescriptionTypeAdditional information
blockCloseoutDateSetting

string

None.
unitLeaseDetails

Collection of UnitLeaseDetails

None.
unitLeaseMonths

Collection of UnitLeaseMonths

None.
ysLeaseTerms

Collection of YSLeaseTerms

None.

Response Formats

application/json, text/json

Sample: 
{
  "blockCloseoutDateSetting": "sample string 1",
  "unitLeaseDetails": [
    {
      "CalendarDate": "2025-09-27T12:22:19.9491583-05:00",
      "MonthYear": "sample string 2",
      "IsBlocked": true,
      "LeaseTermId": 4,
      "NetLeaseRent": 5.0,
      "EndDate": "2025-09-27T12:22:19.9491583-05:00"
    },
    {
      "CalendarDate": "2025-09-27T12:22:19.9491583-05:00",
      "MonthYear": "sample string 2",
      "IsBlocked": true,
      "LeaseTermId": 4,
      "NetLeaseRent": 5.0,
      "EndDate": "2025-09-27T12:22:19.9491583-05:00"
    }
  ],
  "unitLeaseMonths": [
    {
      "MonthYear": "sample string 1",
      "MinNetLeaseRent": 2.0,
      "ValidDays": 3,
      "Year": 4,
      "Month": 5,
      "MinDate": "2025-09-27T12:22:19.9491583-05:00",
      "MaxDate": "2025-09-27T12:22:19.9491583-05:00",
      "TermInMonths": 8,
      "LeaseTermId": 9,
      "MinRentMaxDate": "2025-09-27T12:22:19.9491583-05:00"
    },
    {
      "MonthYear": "sample string 1",
      "MinNetLeaseRent": 2.0,
      "ValidDays": 3,
      "Year": 4,
      "Month": 5,
      "MinDate": "2025-09-27T12:22:19.9491583-05:00",
      "MaxDate": "2025-09-27T12:22:19.9491583-05:00",
      "TermInMonths": 8,
      "LeaseTermId": 9,
      "MinRentMaxDate": "2025-09-27T12:22:19.9491583-05:00"
    }
  ],
  "ysLeaseTerms": [
    {
      "LeaseTermId": 1,
      "Description": "sample string 2",
      "TermInMonths": "sample string 3"
    },
    {
      "LeaseTermId": 1,
      "Description": "sample string 2",
      "TermInMonths": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample: 
<YSUnitLeasePricingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.YottaResident.WebAPIs.Models">
  <blockCloseoutDateSetting>sample string 1</blockCloseoutDateSetting>
  <unitLeaseDetails>
    <UnitLeaseDetails>
      <CalendarDate>2025-09-27T12:22:19.9491583-05:00</CalendarDate>
      <EndDate>2025-09-27T12:22:19.9491583-05:00</EndDate>
      <IsBlocked>true</IsBlocked>
      <LeaseTermId>4</LeaseTermId>
      <MonthYear>sample string 2</MonthYear>
      <NetLeaseRent>5</NetLeaseRent>
    </UnitLeaseDetails>
    <UnitLeaseDetails>
      <CalendarDate>2025-09-27T12:22:19.9491583-05:00</CalendarDate>
      <EndDate>2025-09-27T12:22:19.9491583-05:00</EndDate>
      <IsBlocked>true</IsBlocked>
      <LeaseTermId>4</LeaseTermId>
      <MonthYear>sample string 2</MonthYear>
      <NetLeaseRent>5</NetLeaseRent>
    </UnitLeaseDetails>
  </unitLeaseDetails>
  <unitLeaseMonths>
    <UnitLeaseMonths>
      <LeaseTermId>9</LeaseTermId>
      <MaxDate>2025-09-27T12:22:19.9491583-05:00</MaxDate>
      <MinDate>2025-09-27T12:22:19.9491583-05:00</MinDate>
      <MinNetLeaseRent>2</MinNetLeaseRent>
      <MinRentMaxDate>2025-09-27T12:22:19.9491583-05:00</MinRentMaxDate>
      <Month>5</Month>
      <MonthYear>sample string 1</MonthYear>
      <TermInMonths>8</TermInMonths>
      <ValidDays>3</ValidDays>
      <Year>4</Year>
    </UnitLeaseMonths>
    <UnitLeaseMonths>
      <LeaseTermId>9</LeaseTermId>
      <MaxDate>2025-09-27T12:22:19.9491583-05:00</MaxDate>
      <MinDate>2025-09-27T12:22:19.9491583-05:00</MinDate>
      <MinNetLeaseRent>2</MinNetLeaseRent>
      <MinRentMaxDate>2025-09-27T12:22:19.9491583-05:00</MinRentMaxDate>
      <Month>5</Month>
      <MonthYear>sample string 1</MonthYear>
      <TermInMonths>8</TermInMonths>
      <ValidDays>3</ValidDays>
      <Year>4</Year>
    </UnitLeaseMonths>
  </unitLeaseMonths>
  <ysLeaseTerms>
    <YSLeaseTerms>
      <Description>sample string 2</Description>
      <LeaseTermId>1</LeaseTermId>
      <TermInMonths>sample string 3</TermInMonths>
    </YSLeaseTerms>
    <YSLeaseTerms>
      <Description>sample string 2</Description>
      <LeaseTermId>1</LeaseTermId>
      <TermInMonths>sample string 3</TermInMonths>
    </YSLeaseTerms>
  </ysLeaseTerms>
</YSUnitLeasePricingModel>