Data Models¶
AddressCreateDto¶
fullAddress
string
The street address, must be a validated address by Google (e.g. 1600 Amphitheatre Parkway, Mountain View, CA
).
additionalFreeText
string
additional address information, such as suite number
placeId
string
The google unique identity of the deal place in the Google Places database and on Google Maps, if used it will override the fullAddress
.
latLng
LatLng
Reference to different Dto
AddressDto¶
fullAddress
string
placeId
string
geoLocation
LatLng
zipCode
string
number
integer(int32)
street
string
city
string
county
string
state
string
country
string
additionalFreeText
string
CollateralSummaryDto¶
id
string
address
AddressDto
name
string
netIncome
number(double)
netOperatingIncome
number(double)
incomeValuation
number(double)
alternativeValuation
number(double)
salesValuation
number(double)
totalSF
number(double)
totalUnit
number(double)
CollateralSummaryResponseDto¶
success
boolean
error
ErrorDto
collateralSummary
array [ CollateralSummaryDto ]
CommercialComponentInfoResponseDto¶
success
boolean
error
ErrorDto
id
string
collateralId
string
selectedRentRollId
string
address
AddressDto
assetType
string(enum)
Available enum values: None
, Mixed
, Hotel
, Industrial
, Multi_Family_Apartments
, Office
, Retail
, Self_Storage
, Land
, Special_Purpose
, Senior_Housing
, Distribution_Warehouse
, Flex_Office
, Portfolio
componentType
string(enum)
Available enum values: Unknown
, Residential
, Commercial
, Hotel
marketTrendSummary
MarketTrendSummaryDto
marketSummary
MarketSummaryDto
marketData
MarketDataDto
marketForecast
MarketForecastDto
leaseToPreLeaseRatio
number(double)
totalRentRollAnnualRevenue
number(double)
rentRollVacancy
number(double)
rentRollsOrder
array [ string ]
saleValueComputationType
string(enum)
Available enum values: ByUnit
, BySf
salesCompUnitValuation
number(double)
salesCompSFValuation
number(double)
livingUnitsInfo
CommercialLivingUnitsInfoDto
expiringLeases
map { number(double) }
CommercialLivingUnitCreateDto¶
frontEndGridLineNumber
string
description
string
suite
string
floor
number(double)
unitSize
number(double)
CommercialLivingUnitDto¶
id
string
description
string
suite
string
floor
number(double)
unitSize
number(double)
compsRevenue
RevenueDto
concludedRevenue
RevenueDto
CommercialLivingUnitsInfoDto¶
livingUnits
array [ CommercialLivingUnitDto ]
marketVacancy
number(double)
totalUnits
number(double)
totalSf
number(double)
averageUnitSize
number(double)
averageSqft
number(double)
concludedTotalRevenue
RevenueDto
compsTotalRevenue
RevenueDto
CommercialRentRollInfoResponseDto¶
success
boolean
error
ErrorDto
id
string
componentId
string
name
string
fileId
string
effectiveDate
string(date)
comment
string
totalSf
number(double)
totalUnits
number(double)
totalMonthlyRevenue
number(double)
totalMonthlyRevenuePerSf
number(double)
totalAnnualRevenue
number(double)
totalAnnualRevenuePerSf
number(double)
vacancy
number(double)
tenantTurnover
number(double)
expiringLeases
map { number(double) }
rentRollItems
array [ CommercialRentRollItemDto ]
CommercialRentRollItemDto¶
id
string
unitNumber
string
tenantName
string
monthlyRent
number(double)
unitSize
number(double)
leaseStart
string(date)
leaseEnd
string(date)
annualRent
number(double)
monthlyRentPerSf
number(double)
annualRentPerSf
number(double)
leaseType
string(enum)
Available enum values: NA
, FullService
, ModifiedGross
, SingleNet
, DoubleNet
, TripleNet
, MonthToMonth
comment
string
CompanyInfoResponseDto¶
success
boolean
error
ErrorDto
id
string
name
string
description
string
logo
array [ string(byte) ]
address
AddressDto
primaryEmail
string
primaryPhoneNumber
string
companyDebtService
number(double)
companyCashFlowAfterDebtService
number(double)
companyDSCR
number(double)
companyAssetSubtotal
number(double)
companyLiabilitySubtotal
number(double)
companyLiquidity
number(double)
contactId
string
riskRating
string
ein
string
ComponentInfoResponseDto¶
success
boolean
error
ErrorDto
id
string
collateralId
string
selectedRentRollId
string
address
AddressDto
assetType
string(enum)
Available enum values: None
, Mixed
, Hotel
, Industrial
, Multi_Family_Apartments
, Office
, Retail
, Self_Storage
, Land
, Special_Purpose
, Senior_Housing
, Distribution_Warehouse
, Flex_Office
, Portfolio
componentType
string(enum)
Available enum values: Unknown
, Residential
, Commercial
, Hotel
marketTrendSummary
MarketTrendSummaryDto
marketSummary
MarketSummaryDto
marketData
MarketDataDto
marketForecast
MarketForecastDto
leaseToPreLeaseRatio
number(double)
totalRentRollAnnualRevenue
number(double)
rentRollVacancy
number(double)
rentRollsOrder
array [ string ]
saleValueComputationType
string(enum)
Available enum values: ByUnit
, BySf
salesCompUnitValuation
number(double)
salesCompSFValuation
number(double)
ComponentSummaryDto¶
id
string
collateralId
string
componentType
string(enum)
Available enum values: Unknown
, Residential
, Commercial
, Hotel
assetType
string(enum)
Available enum values: None
, Mixed
, Hotel
, Industrial
, Multi_Family_Apartments
, Office
, Retail
, Self_Storage
, Land
, Special_Purpose
, Senior_Housing
, Distribution_Warehouse
, Flex_Office
, Portfolio
leaseToPreLeaseRatio
number(double)
totalUnits
number(double)
totalSf
number(double)
saleValue
number(double)
totalMarketAnnualRevenue
number(double)
totalConcludedRentAnnualRevenue
number(double)
marketVacancy
number(double)
selectedRentRollId
string
totalRentRollAnnualRevenue
number(double)
rentRollVacancy
number(double)
ComponentSummaryResponseDto¶
success
boolean
error
ErrorDto
componentSummary
array [ ComponentSummaryDto ]
CreateCommercialDealDto¶
ownerId
string
dealName
string
address
AddressCreateDto
propertyType
string(enum)
Available enum values: None
, Mixed
, Hotel
, Industrial
, Multi_Family_Apartments
, Office
, Retail
, Self_Storage
, Land
, Special_Purpose
, Senior_Housing
, Distribution_Warehouse
, Flex_Office
, Portfolio
loanType
string(enum)
Available enum values: Unknown
, Acquisition
, Acquisition_Construction
, Refinance
, Refinance_Construction
, Construction
, Stabilization
, Bridge
, Permanent
loanAmount
number(double)
loanTerm
number(double)
commercialLivingUnitCreateDto
array [ CommercialLivingUnitCreateDto ]
CreateHotelDealDto¶
ownerId
string
dealName
string
address
AddressCreateDto
propertyType
string(enum)
Available enum values: None
, Mixed
, Hotel
, Industrial
, Multi_Family_Apartments
, Office
, Retail
, Self_Storage
, Land
, Special_Purpose
, Senior_Housing
, Distribution_Warehouse
, Flex_Office
, Portfolio
loanType
string(enum)
Available enum values: Unknown
, Acquisition
, Acquisition_Construction
, Refinance
, Refinance_Construction
, Construction
, Stabilization
, Bridge
, Permanent
loanAmount
number(double)
loanTerm
number(double)
hotelLivingUnitCreateDto
HotelLivingUnitCreateDto
CreateResidentialDealDto¶
ownerId
string
dealName
string
address
AddressCreateDto
propertyType
string(enum)
Available enum values: None
, Mixed
, Hotel
, Industrial
, Multi_Family_Apartments
, Office
, Retail
, Self_Storage
, Land
, Special_Purpose
, Senior_Housing
, Distribution_Warehouse
, Flex_Office
, Portfolio
loanType
string(enum)
Available enum values: Unknown
, Acquisition
, Acquisition_Construction
, Refinance
, Refinance_Construction
, Construction
, Stabilization
, Bridge
, Permanent
loanAmount
number(double)
loanTerm
number(double)
residentialLivingUnitCreateDto
array [ ResidentialLivingUnitCreateDto ]
CreateResponseDto¶
success
boolean
error
ErrorDto
createdEntityId
string
DealIdsResponseDto¶
success
boolean
error
ErrorDto
dealIds
array [ string ]
DealPropertyUpdateDto¶
property
string(enum)
Available enum values: State
, Owner
, LoanType
, Status
, Priority
, SeedName
, Note
, MainImageFileId
, ProjectTotalCost
, GrossLoan
, IsSyndicatedLoan
, ParticipationGrossLoan
, OriginatedLoanAmount
, RateSpread
, LoanPaymentStructure
, IndexRate
, InterestRateFloor
, LoanTerm
, ExtensionTerm
, AmortizationTerm
, Description
, LoanId
, RateIndex
, OriginationDate
, ClosingDate
, RiskRating
, ProfileName
, UserSelectedLtv
, ClosedDate
, UserDebtService
, DebtServiceMethod
, RequestedLoanAmount
, CustomField1
, CustomField2
, LoansPackageId
value
string
DealUpdateDto¶
id
string
updates
array [ DealPropertyUpdateDto ]
ErrorDto¶
target
string
code
string(enum)
Available enum values: Duplicated
, MissingMandatoryField
, InvalidCreateValues
, Existing
, ValidationError
, MissingEntity
message
string
details
array [ ErrorDto ]
HighlightDto¶
title
string
bullets
array [ string ]
HotelComponentInfoResponseDto¶
success
boolean
error
ErrorDto
id
string
collateralId
string
selectedRentRollId
string
address
AddressDto
assetType
string(enum)
Available enum values: None
, Mixed
, Hotel
, Industrial
, Multi_Family_Apartments
, Office
, Retail
, Self_Storage
, Land
, Special_Purpose
, Senior_Housing
, Distribution_Warehouse
, Flex_Office
, Portfolio
componentType
string(enum)
Available enum values: Unknown
, Residential
, Commercial
, Hotel
marketTrendSummary
MarketTrendSummaryDto
marketSummary
MarketSummaryDto
marketData
MarketDataDto
marketForecast
MarketForecastDto
leaseToPreLeaseRatio
number(double)
totalRentRollAnnualRevenue
number(double)
rentRollVacancy
number(double)
rentRollsOrder
array [ string ]
saleValueComputationType
string(enum)
Available enum values: ByUnit
, BySf
salesCompUnitValuation
number(double)
salesCompSFValuation
number(double)
livingUnitsInfo
HotelLivingUnitsInfoDto
serviceLevel
string(enum)
Available enum values: LimitedService
, FullService
, Luxury
hotelFlag
HotelFlag
HotelFlag¶
hotelFlag
string
HotelLivingUnitCreateDto¶
numUnits
number(double)
adr
number(double)
occupancy
number(double)
sqFt
number(double)
HotelLivingUnitDto¶
id
string
numUnits
number(double)
adr
number(double)
occupancy
number(double)
sqFt
number(double)
roomNightsPerMonth
number(double)
revPar
number(double)
monthlyRevenue
number(double)
HotelLivingUnitsInfoDto¶
livingUnits
array [ HotelLivingUnitDto ]
marketVacancy
number(double)
totalUnits
number(double)
totalSf
number(double)
totalMonthlyRevenue
number(double)
totalAnnualRevenue
number(double)
averageUnitSize
number(double)
LatLng¶
lat
number(double)
Latitude
lng
number(double)
Longitude
MainMarketDto¶
marketId
integer(int64)
sectorId
integer(int64)
gradeId
number(double)
marketPublish
string
sectorPublish
string
grade
string
ageMedian
number(double)
assetValueMomentum
number(double)
caprateEconomic
number(double)
commentary
string
commuteTimeMean
number(double)
cppi
number(double)
crimeRateQuintile
string
desirability
number(double)
desirabilityQuintile
string
fiscalHealthTaxQuintile
string
homeownershipRate
number(double)
homeValueMedianCensus
number(double)
housingAffordability
number(double)
housingAffordabilityQuintile
string
incomeHhiMedianCensus
number(double)
inventory
number(double)
inventoryGrowth5Yr
number(double)
irrBetaQuintile
string
irrLiquidityAdjustment
number(double)
irrRiskAdjusted
number(double)
irrRiskPremium
number(double)
irrUnlevered
number(double)
latitude
number(double)
longitude
number(double)
marketAbbr
string
mrevpafGrowth
number(double)
mrevpafGrowth5Yr
number(double)
mrevpafGrowthYoyCredit
number(double)
noiGrowthLt
number(double)
occupancy
number(double)
populationDegreeCollegeCensusPct
number(double)
rankGradeId
integer(int64)
rentEffective
number(double)
rentGrossMedian
number(double)
strength1
string
strength2
string
strength3
string
supplyBarrierQuintile
string
walkScoreDescription
string
weakness1
string
weakness2
string
weakness3
string
timestampUpdate
string
MarketDataDto¶
mainMarket
MainMarketDto
subMarket
SubMarketDto
MarketForecastDto¶
marketId
integer(int64)
dateFcReleaseId
integer(int64)
scenarioId
integer(int64)
sectorId
integer(int64)
fcPublish
string
marketPublish
string
scenarioPublish
string
sectorPublish
string
dateFcRelease
string(date)
date
string(date)
caprateNominal
number(double)
cppiIndex
number(double)
demandGrowth
number(double)
mrevpafGrowth
number(double)
ncfGrowth
number(double)
noiGrowth
number(double)
occupancy
number(double)
rentGrowth
number(double)
supplyGrowth
number(double)
timestampUpdate
string
MarketSummaryDto¶
weakness1
string
weakness2
string
weakness3
string
strength1
string
strength2
string
strength3
string
MarketTrendSummaryDto¶
lastUpdated
string(date-time)
rent
HighlightDto
sections
array [ SectionDto ]
NAType¶
PersonInfoResponseDto¶
success
boolean
error
ErrorDto
id
string
contactId
string
firstName
string
middleName
string
lastName
string
socialSecurityNumber
string
description
string
primaryPhoneNumber
string
primaryEmail
string
image
array [ string(byte) ]
address
AddressDto
personalNetWorth
number(double)
personalLiquidity
number(double)
personalDSCR
number(double)
personalCashFlowAfterDebtService
number(double)
personDebtRatio
number(double)
RentRollUnitTypeSummaryDto¶
totalUnits
number(double)
bedrooms
number(double)
bathrooms
number(double)
avgSf
number(double)
avgMonthlyRevenuePerSf
number(double)
avgMonthlyRevenuePerUnit
number(double)
ResidentialComponentInfoResponseDto¶
success
boolean
error
ErrorDto
id
string
collateralId
string
selectedRentRollId
string
address
AddressDto
assetType
string(enum)
Available enum values: None
, Mixed
, Hotel
, Industrial
, Multi_Family_Apartments
, Office
, Retail
, Self_Storage
, Land
, Special_Purpose
, Senior_Housing
, Distribution_Warehouse
, Flex_Office
, Portfolio
componentType
string(enum)
Available enum values: Unknown
, Residential
, Commercial
, Hotel
marketTrendSummary
MarketTrendSummaryDto
marketSummary
MarketSummaryDto
marketData
MarketDataDto
marketForecast
MarketForecastDto
leaseToPreLeaseRatio
number(double)
totalRentRollAnnualRevenue
number(double)
rentRollVacancy
number(double)
rentRollsOrder
array [ string ]
saleValueComputationType
string(enum)
Available enum values: ByUnit
, BySf
salesCompUnitValuation
number(double)
salesCompSFValuation
number(double)
livingUnitsInfo
ResidentialLivingUnitsInfoDto
expiringLeases
map { number(double) }
ResidentialLivingUnitCreateDto¶
frontEndGridLineNumber
string
description
string
bedrooms
number(double)
bathrooms
number(double)
unitSize
number(double)
numUnits
number(double)
ResidentialLivingUnitDto¶
id
string
description
string
bedrooms
number(double)
bathrooms
number(double)
unitSize
number(double)
numUnits
number(double)
compsRevenue
RevenueDto
concludedRevenue
RevenueDto
ResidentialLivingUnitsInfoDto¶
livingUnits
array [ ResidentialLivingUnitDto ]
marketVacancy
number(double)
totalSf
number(double)
totalUnits
number(double)
averageUnitSize
number(double)
concludedTotalRevenue
RevenueDto
compsTotalRevenue
RevenueDto
ResidentialRentRollInfoResponseDto¶
success
boolean
error
ErrorDto
id
string
componentId
string
name
string
fileId
string
effectiveDate
string(date)
comment
string
totalSf
number(double)
totalUnits
number(double)
totalMonthlyRevenue
number(double)
totalMonthlyRevenuePerSf
number(double)
totalAnnualRevenue
number(double)
totalAnnualRevenuePerSf
number(double)
vacancy
number(double)
tenantTurnover
number(double)
expiringLeases
map { number(double) }
unitTypeSummaryTable
array [ RentRollUnitTypeSummaryDto ]
rentRollItems
array [ ResidentialRentRollItemDto ]
ResidentialRentRollItemDto¶
id
string
unitNumber
string
tenantName
string
monthlyRent
number(double)
unitSize
number(double)
leaseStart
string(date)
leaseEnd
string(date)
annualRent
number(double)
monthlyRentPerSf
number(double)
annualRentPerSf
number(double)
unitType
string
bedrooms
number(double)
bathrooms
number(double)
RevenueDto¶
monthly
number(double)
monthlyPerSf
number(double)
monthlyPerUnit
number(double)
annual
number(double)
annualPerSf
number(double)
annualPerUnit
number(double)
SectionDto¶
title
string
para
string
SeedInfoResponseDto¶
success
boolean
error
ErrorDto
id
string
loanId
string
seedName
string
loanType
string(enum)
Available enum values: Unknown
, Acquisition
, Acquisition_Construction
, Refinance
, Refinance_Construction
, Construction
, Stabilization
, Bridge
, Permanent
maturityDate
string(date)
riskRating
string
rateIndexType
string(enum)
Available enum values: WSJ Prime
, 1 M LIBOR
, 3 M LIBOR
, 6 M LIBOR
, 1 YR LIBOR
, 5 YR LIBOR
, FHLB 3 YR
, FHLB 5 YR
, FHLB 7 YR
, 1 YR T WKLY
, 2 YR TREAS
, 3 YR TREAS
, 5 YR TREAS
, 7 YR TREAS
, 10 YR TREAS
, 2 YR SWAP
, 5 YR SWAP
, 7 YR SWAP
, 10 YR SWAP
, CD Rate
, Fixed
, SOFR
, 1 M TERM SOFR
, 90 day SOFR
, 180 DAY SOFR
, AMERIBOR - Term 30
, 1 M AVG SOFR
interestRate
number(double)
rateSpread
number(double)
loanPaymentStructure
string(enum)
Available enum values: InterestOnly
, P_I_Amortization
componentType
string(enum)
Available enum values: None
, Mixed
, Hotel
, Industrial
, Multi_Family_Apartments
, Office
, Retail
, Self_Storage
, Land
, Special_Purpose
, Senior_Housing
, Distribution_Warehouse
, Flex_Office
, Portfolio
debtService
number(double)
companyIds
array [ string ]
personIds
array [ string ]
originatedLoanAmount
number(double)
originationDate
string(date)
grossLoan
number(double)
participationGrossLoan
number(double)
ltc
number(double)
SubMarketDto¶
marketId
integer(int64)
subMarketId
integer(int64)
sectorId
integer(int64)
marketPublish
string
subMarketPublish
string
sectorPublish
string
ageMedian
number(double)
capRateNominal
number(double)
commuteTimeMean
number(double)
crimeRateQuintile
string
desirability
number(double)
desirabilityQuintile
string
employmentGrowthCivilian
number(double)
grade
string
homeValueMedianCensus
integer(int64)
housingAffordability
number(double)
housingAffordabilityQuintile
string
incomeHhiMedianCensus
number(double)
occupancy
number(double)
populationDegreeCollegeCensusPct
number(double)
rankGradeId
integer(int64)
rentEffective
number(double)
rentGrossMedian
number(double)
supplyBarrierQuintile
string
walkScoreDescription
string
timeStampUpdate
string
UpdateDealsRequestDto¶
itemsToUpdate
array [ DealUpdateDto ]
UpdateDealsResponseDto¶
success
boolean
error
ErrorDto
errors
array [ UpdateEngineError ]
updatedEntities
array [ string ]
UpdateEngineError¶
id
string
operation
string(enum)
Available enum values: Create
, Update
, Delete
errorType
string(enum)
Available enum values: IdNotFound
, MissingMandatoryField
, IllegalValue
description
string
fieldName
string