GET api/YieldStar/GetYSLeasePricingDetails/{id}/{leaseStartDate}/{leaseCalendarException}/{availableDate}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required
leaseStartDate

date

Required
leaseCalendarException

boolean

Required
availableDate

date

Required

Body Parameters

None.

Response Information

Resource Description

YSUnitLeasePricingModel
NameDescriptionTypeAdditional information
blockCloseoutDateSetting

string

None.
unitLeaseDetails

Collection of UnitLeaseDetails

None.
unitLeaseMonths

Collection of UnitLeaseMonths

None.
unitLeaseRents

Collection of UnitLeaseRent

None.
unitLeaseDeposit

Collection of UnitLeaseDeposit

None.
ysLeaseTerms

Collection of YSLeaseTerms

None.

Response Formats

application/json, text/json

Sample: 
{
  "blockCloseoutDateSetting": "sample string 1",
  "unitLeaseDetails": [
    {
      "calendarDate": "2025-12-06T10:11:12.1469414-06:00",
      "monthYear": "sample string 2",
      "dayPremium": 3.0,
      "monthlyPremium": 4.0,
      "weeklyPremium": 5.0,
      "unitLeaseRent": 6.0,
      "netLeaseRent": 7.0,
      "isBlocked": true,
      "termInMonths": 9,
      "leaseTermId": 10,
      "endDate": "2025-12-06T10:11:12.1469414-06:00"
    },
    {
      "calendarDate": "2025-12-06T10:11:12.1469414-06:00",
      "monthYear": "sample string 2",
      "dayPremium": 3.0,
      "monthlyPremium": 4.0,
      "weeklyPremium": 5.0,
      "unitLeaseRent": 6.0,
      "netLeaseRent": 7.0,
      "isBlocked": true,
      "termInMonths": 9,
      "leaseTermId": 10,
      "endDate": "2025-12-06T10:11:12.1469414-06:00"
    }
  ],
  "unitLeaseMonths": [
    {
      "monthYear": "sample string 1",
      "minNetLeaseRent": 2.0,
      "validDays": 3,
      "year": 4,
      "month": 5,
      "minDate": "2025-12-06T10:11:12.1469414-06:00",
      "maxDate": "2025-12-06T10:11:12.1469414-06:00",
      "termInMonths": 8,
      "leaseTermId": 9,
      "minRentMaxDate": "2025-12-06T10:11:12.1469414-06:00"
    },
    {
      "monthYear": "sample string 1",
      "minNetLeaseRent": 2.0,
      "validDays": 3,
      "year": 4,
      "month": 5,
      "minDate": "2025-12-06T10:11:12.1469414-06:00",
      "maxDate": "2025-12-06T10:11:12.1469414-06:00",
      "termInMonths": 8,
      "leaseTermId": 9,
      "minRentMaxDate": "2025-12-06T10:11:12.1469414-06:00"
    }
  ],
  "unitLeaseRents": [
    {
      "transactionCodeId": 1,
      "transactionTypeId": 2,
      "amount": 3.0,
      "includeInRent": true
    },
    {
      "transactionCodeId": 1,
      "transactionTypeId": 2,
      "amount": 3.0,
      "includeInRent": true
    }
  ],
  "unitLeaseDeposit": [
    {
      "individalApplicantAmount": 1.0,
      "administrationAmount": 2.0,
      "escrowDepositAmount": 3.0
    },
    {
      "individalApplicantAmount": 1.0,
      "administrationAmount": 2.0,
      "escrowDepositAmount": 3.0
    }
  ],
  "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:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <blockCloseoutDateSetting>sample string 1</blockCloseoutDateSetting>
  <unitLeaseDetails>
    <UnitLeaseDetails>
      <CalendarDate>2025-12-06T10:11:12.1469414-06:00</CalendarDate>
      <MonthYear>sample string 2</MonthYear>
      <DayPremium>3</DayPremium>
      <MonthlyPremium>4</MonthlyPremium>
      <WeeklyPremium>5</WeeklyPremium>
      <UnitLeaseRent>6</UnitLeaseRent>
      <NetLeaseRent>7</NetLeaseRent>
      <IsBlocked>true</IsBlocked>
      <TermInMonths>9</TermInMonths>
      <LeaseTermId>10</LeaseTermId>
      <EndDate>2025-12-06T10:11:12.1469414-06:00</EndDate>
    </UnitLeaseDetails>
    <UnitLeaseDetails>
      <CalendarDate>2025-12-06T10:11:12.1469414-06:00</CalendarDate>
      <MonthYear>sample string 2</MonthYear>
      <DayPremium>3</DayPremium>
      <MonthlyPremium>4</MonthlyPremium>
      <WeeklyPremium>5</WeeklyPremium>
      <UnitLeaseRent>6</UnitLeaseRent>
      <NetLeaseRent>7</NetLeaseRent>
      <IsBlocked>true</IsBlocked>
      <TermInMonths>9</TermInMonths>
      <LeaseTermId>10</LeaseTermId>
      <EndDate>2025-12-06T10:11:12.1469414-06:00</EndDate>
    </UnitLeaseDetails>
  </unitLeaseDetails>
  <unitLeaseMonths>
    <UnitLeaseMonths>
      <MonthYear>sample string 1</MonthYear>
      <MinNetLeaseRent>2</MinNetLeaseRent>
      <ValidDays>3</ValidDays>
      <Year>4</Year>
      <Month>5</Month>
      <MinDate>2025-12-06T10:11:12.1469414-06:00</MinDate>
      <MaxDate>2025-12-06T10:11:12.1469414-06:00</MaxDate>
      <TermInMonths>8</TermInMonths>
      <LeaseTermId>9</LeaseTermId>
      <MinRentMaxDate>2025-12-06T10:11:12.1469414-06:00</MinRentMaxDate>
    </UnitLeaseMonths>
    <UnitLeaseMonths>
      <MonthYear>sample string 1</MonthYear>
      <MinNetLeaseRent>2</MinNetLeaseRent>
      <ValidDays>3</ValidDays>
      <Year>4</Year>
      <Month>5</Month>
      <MinDate>2025-12-06T10:11:12.1469414-06:00</MinDate>
      <MaxDate>2025-12-06T10:11:12.1469414-06:00</MaxDate>
      <TermInMonths>8</TermInMonths>
      <LeaseTermId>9</LeaseTermId>
      <MinRentMaxDate>2025-12-06T10:11:12.1469414-06:00</MinRentMaxDate>
    </UnitLeaseMonths>
  </unitLeaseMonths>
  <unitLeaseRents>
    <UnitLeaseRent>
      <TransactionCodeId>1</TransactionCodeId>
      <TransactionTypeId>2</TransactionTypeId>
      <Amount>3</Amount>
      <IncludeInRent>true</IncludeInRent>
    </UnitLeaseRent>
    <UnitLeaseRent>
      <TransactionCodeId>1</TransactionCodeId>
      <TransactionTypeId>2</TransactionTypeId>
      <Amount>3</Amount>
      <IncludeInRent>true</IncludeInRent>
    </UnitLeaseRent>
  </unitLeaseRents>
  <unitLeaseDeposit>
    <UnitLeaseDeposit>
      <individalApplicantAmount>1</individalApplicantAmount>
      <administrationAmount>2</administrationAmount>
      <escrowDepositAmount>3</escrowDepositAmount>
    </UnitLeaseDeposit>
    <UnitLeaseDeposit>
      <individalApplicantAmount>1</individalApplicantAmount>
      <administrationAmount>2</administrationAmount>
      <escrowDepositAmount>3</escrowDepositAmount>
    </UnitLeaseDeposit>
  </unitLeaseDeposit>
  <ysLeaseTerms>
    <YSLeaseTerms>
      <LeaseTermId>1</LeaseTermId>
      <Description>sample string 2</Description>
      <TermInMonths>sample string 3</TermInMonths>
    </YSLeaseTerms>
    <YSLeaseTerms>
      <LeaseTermId>1</LeaseTermId>
      <Description>sample string 2</Description>
      <TermInMonths>sample string 3</TermInMonths>
    </YSLeaseTerms>
  </ysLeaseTerms>
</YSUnitLeasePricingModel>