Data Dictionary Download as CSV

For Reference Only

This Data Dictionary is provided for reference only. It includes all available data in Blooma, but not all fields are accessible through the API Gateway.

ActivityEntryDto

user string

when string(date-time)

what string

type string(enum)

Available enum values: Seed, Task, File, Collateral, Component, Generation

AddressCreateDto

fullAddress string

Complete street address validated by Google Places API (e.g., "1600 Amphitheatre Parkway, Mountain View, CA 94043")

additionalFreeText string

Additional address information such as suite or unit number

placeId string

Google Places unique identifier. If provided, overrides fullAddress

latLng LatLng

AddressDto

fullAddress string

Complete street address validated by Google Places API (e.g., "1600 Amphitheatre Parkway, Mountain View, CA 94043")

placeId string

Google Places unique identifier for this address

geoLocation LatLng

zipCode string

number integer(int32)

street string

city string

county string

state string

country string

additionalFreeText string

Additional address information such as suite or unit number

AdjustableValueDto

value number(double)

adjustment number(double)

adjustmentReason string

adjustingEntity string

sourceMapping string

total number(double)

AllDealStatisticsDto

numberOfDeals integer(int32)

totalGrossLoan number(double)

avgGrossLoan number(double)

totalOriginatedLoanAmount number(double)

avgOriginatedLoanAmount number(double)

avgLtv number(double)

loanTypeDistribution array [ DistributionByLoanTypeDto ]

propertyTypeDistribution array [ DistributionByPropertyTypeDto ]

scoreDistribution array [ DistributionByScoreDto ]

stateDistribution array [ DistributionByStateDto ]

AlternativeValuationCreateDto

ownerId string

Blooma user ID (email address) of the entity owner

name string

valuation number(double)

description string

asOfDate string(date)

mainValuation boolean

AlternativeValuationDto

id string

Unique identifier for this alternative valuation

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

ownerIds array [ string ]

Blooma user IDs (email addresses) with ownership access

name string

valuationsInfoId string

ID of the parent valuation container

valuation number(double)

Alternative valuation amount (e.g., appraisal, broker opinion), in USD

description string

asOfDate string(date)

Date the valuation is effective as of (ISO 8601 format: YYYY-MM-DD)

parentId string

ID of the parent valuation, if this is a sub-valuation

descriptor string

AlternativeValuationPropertyUpdateDto

property string(enum)

Available enum values: Name, Valuation, Description, AsOfDate

value string

AlternativeValuationReportDto

id string

Unique identifier for this alternative valuation

name string

valuation number(double)

description string

asOfDate string(date)

AmenitiesDto

hasBonusRoom boolean

hasBreakfastNook boolean

hasCellar boolean

hasWineCellar boolean

hasExerciseRoom boolean

hasFamilyRoom boolean

hasGameRoom boolean

hasGreatRoom boolean

hasHobbyRoom boolean

hasLaundryRoom boolean

hasMediaRoom boolean

hasMudRoom boolean

hasHomeOffice boolean

hasSafeRoom boolean

hasSittingRoom boolean

hasStormShelter boolean

hasStudy boolean

hasSunroom boolean

hasUtilityRoom boolean

hasElevator boolean

isHandicapAccessible boolean

hasCentralVacuumSystem boolean

hasIntercom boolean

hasInstalledSoundSystem boolean

hasWetBar boolean

hasAlarmSystem boolean

hasStormShutter boolean

hasOverheadDoor boolean

hasDeck boolean

hasRvParking boolean

hasSauna boolean

hasArborPergola boolean

hasSprinklers boolean

hasGolfCourseGreen boolean

hasTennisCourt boolean

hasOtherSportCourt boolean

hasWaterFeature boolean

hasBoatLift boolean

hasBoatAccess boolean

hasOutdoorKitchenFireplace boolean

AssetFinancialItemDto

id string

Unique identifier for this asset line item

nameOfInstitution string

accountNumber string

nameOnAccount string

dataAsOf string(date)

ownership number(double)

category string(enum)

Available enum values: Cash, LiquidAsset, RetirementAccount, MarketableSecurity, Equity, NotesReceivable, OtherAsset

proforma AdjustableValueDto

warningStatus string(enum)

Available enum values: Adjusted, notValidated, validated, adjustedByBusinessRule, adjustedByUser

AssetFinancialItemPropertyUpdateDto

property string(enum)

Available enum values: NameOfInstitution, AccountNumber, NameOnAccount, DataAsOf, Ownership, Adjustment, AdjustmentReason, Category

value string

AssetFinancialItemUpdateDto

id string

Identifier of the asset item to update

updates array [ AssetFinancialItemPropertyUpdateDto ]

AssetItemCreateDto

frontEndGridLineNumber string

category string(enum)

Available enum values: Cash, LiquidAsset, RetirementAccount, MarketableSecurity, Equity, NotesReceivable, OtherAsset

nameOfInstitution string

accountNumber string

nameOnAccount string

dataAsOf string(date)

ownership number(double)

value number(double)

BalanceSheetDto

multiYearBalanceSheet array [ MultiYearBalanceSheetItemDto ]

balanceSheetInfo array [ BalanceSheetInfoDto ]

balanceSheetConfig FinancialStatementConfigDto

assetsSubtotal number(double)

Total assets, in USD

liabilitiesEquitySubtotal number(double)

Total liabilities plus equity, in USD

liabilitiesSubtotal number(double)

Total liabilities, in USD

equitySubtotal number(double)

Total equity, in USD

currentAssetsSubtotal number(double)

Total current assets (liquid within one year), in USD

nonCurrentAssetsSubtotal number(double)

Total non-current assets, in USD

currentLiabilitiesSubtotal number(double)

Total current liabilities (due within one year), in USD

longTermLiabilitiesSubtotal number(double)

Total long-term liabilities, in USD

BalanceSheetInfoDto

sourceId string

ID of the source document or data import

year integer(int32)

date string(date)

name string

fileName string

type string(enum)

Available enum values: Manual, FileUpload

userComment string

balanceSheetId string

Unique identifier for this balance sheet

items array [ BalanceSheetItemDto ]

subCategoryTotals map { number(double) }

categoryTotals map { number(double) }

BalanceSheetItemCreateDto

frontEndGridLineNumber string

description string

sourceMapping string

value number(double)

balanceSheetCategory string(enum)

Available enum values: Assets, Liabilities, Equity

balanceSheetSubCategory string(enum)

Available enum values: CurrentAssets, NonCurrentAssets, CurrentLiabilities, LongTermLiabilities, Equity

BalanceSheetItemDto

id string

Unique identifier for this balance sheet line item

description string

sourceMapping string

value number(double)

balanceSheetCategory string(enum)

Available enum values: Assets, Liabilities, Equity

balanceSheetSubCategory string(enum)

Available enum values: CurrentAssets, NonCurrentAssets, CurrentLiabilities, LongTermLiabilities, Equity

BalanceSheetItemKey

balanceSheetCategory string(enum)

Available enum values: Assets, Liabilities, Equity

balanceSheetSubCategory string(enum)

Available enum values: CurrentAssets, NonCurrentAssets, CurrentLiabilities, LongTermLiabilities, Equity

description string

BalanceSheetItemUpdateDto

id string

Identifier of the balance sheet item to update

updates array [ BalanceSheetPropertyUpdateDto ]

BalanceSheetPropertyUpdateDto

property string(enum)

Available enum values: BalanceSheetCategory, BalanceSheetSubCategory, Description, Value

value string

BalanceSheetSubmitData

name string

year integer(int32)

bulkUpdateData BulkOperationDtoBalanceSheetItemCreateDtoBalanceSheetItemUpdateDto

BaseEntityDto

id string

Unique identifier for the entity

BaseResponseDto

error ErrorDto

success boolean

BulkDealImportResultDto

success boolean

error string

createdDeals integer(int32)

BulkOperationDtoAssetItemCreateDtoAssetFinancialItemUpdateDto

itemsToCreate array [ AssetItemCreateDto ]

itemsToUpdate array [ AssetFinancialItemUpdateDto ]

itemsToDelete array [ string ]

BulkOperationDtoBalanceSheetItemCreateDtoBalanceSheetItemUpdateDto

itemsToCreate array [ BalanceSheetItemCreateDto ]

itemsToUpdate array [ BalanceSheetItemUpdateDto ]

itemsToDelete array [ string ]

BulkOperationDtoCashFlowItemCreateDtoCashFlowItemUpdateDto

itemsToCreate array [ CashFlowItemCreateDto ]

itemsToUpdate array [ CashFlowItemUpdateDto ]

itemsToDelete array [ string ]

BulkOperationDtoCommercialLivingUnitCreateDtoCommercialLivingUnitUpdateDto

itemsToCreate array [ CommercialLivingUnitCreateDto ]

itemsToUpdate array [ CommercialLivingUnitUpdateDto ]

itemsToDelete array [ string ]

BulkOperationDtoCommercialRentRollItemCreateDtoItemUpdateDtoPropertyUpdateDtoCommercialRentRollItemProperty

itemsToCreate array [ CommercialRentRollItemCreateDto ]

itemsToUpdate array [ ItemUpdateDtoPropertyUpdateDtoCommercialRentRollItemProperty ]

itemsToDelete array [ string ]

BulkOperationDtoDealContactCreateDtoDealContactUpdateDto

itemsToCreate array [ DealContactCreateDto ]

itemsToUpdate array [ DealContactUpdateDto ]

itemsToDelete array [ string ]

BulkOperationDtoDealNarrativeCreateDtoDealNarrativeUpdateDto

itemsToCreate array [ DealNarrativeCreateDto ]

itemsToUpdate array [ DealNarrativeUpdateDto ]

itemsToDelete array [ string ]

BulkOperationDtoDealRateCreateDtoDealRateUpdateDto

itemsToCreate array [ DealRateCreateDto ]

itemsToUpdate array [ DealRateUpdateDto ]

itemsToDelete array [ string ]

BulkOperationDtoDummyLoanOptionCreateDtoLoanOptionUpdateDto

itemsToCreate array [ DummyLoanOptionCreateDto ]

itemsToUpdate array [ LoanOptionUpdateDto ]

itemsToDelete array [ string ]

BulkOperationDtoFinancialTransactionCreateDtoFinancialTransactionUpdateDto

itemsToCreate array [ FinancialTransactionCreateDto ]

itemsToUpdate array [ FinancialTransactionUpdateDto ]

itemsToDelete array [ string ]

BulkOperationDtoFundSourceItemCreateDtoFundSourceItemUpdateDto

itemsToCreate array [ FundSourceItemCreateDto ]

itemsToUpdate array [ FundSourceItemUpdateDto ]

itemsToDelete array [ string ]

BulkOperationDtoFundUseItemCreateDtoFundUseItemUpdateDto

itemsToCreate array [ FundUseItemCreateDto ]

itemsToUpdate array [ FundUseItemUpdateDto ]

itemsToDelete array [ string ]

BulkOperationDtoIncomeStatementItemCreateDtoIncomeStatementItemUpdateDto

itemsToCreate array [ IncomeStatementItemCreateDto ]

itemsToUpdate array [ IncomeStatementItemUpdateDto ]

itemsToDelete array [ string ]

BulkOperationDtoLiabilityItemCreateDtoLiabilityFinancialItemUpdateDto

itemsToCreate array [ LiabilityItemCreateDto ]

itemsToUpdate array [ LiabilityFinancialItemUpdateDto ]

itemsToDelete array [ string ]

BulkOperationDtoLivingUnitCreateDtoLivingUnitUpdateDto

itemsToCreate array [ LivingUnitCreateDto ]

itemsToUpdate array [ LivingUnitUpdateDto ]

itemsToDelete array [ string ]

BulkOperationDtoRealEstateScheduleItemCreateDtoRealEstateScheduleItemUpdateDto

itemsToCreate array [ RealEstateScheduleItemCreateDto ]

itemsToUpdate array [ RealEstateScheduleItemUpdateDto ]

itemsToDelete array [ string ]

BulkOperationDtoRentComparableCreateDtoItemUpdateDtoPropertyUpdateDtoRentComparableProperty

itemsToCreate array [ RentComparableCreateDto ]

itemsToUpdate array [ ItemUpdateDtoPropertyUpdateDtoRentComparableProperty ]

itemsToDelete array [ string ]

BulkOperationDtoResidentialLivingUnitCreateDtoResidentialLivingUnitUpdateDto

itemsToCreate array [ ResidentialLivingUnitCreateDto ]

itemsToUpdate array [ ResidentialLivingUnitUpdateDto ]

itemsToDelete array [ string ]

BulkOperationDtoResidentialRentRollItemCreateDtoItemUpdateDtoPropertyUpdateDtoResidentialRentRollItemProperty

itemsToCreate array [ ResidentialRentRollItemCreateDto ]

itemsToUpdate array [ ItemUpdateDtoPropertyUpdateDtoResidentialRentRollItemProperty ]

itemsToDelete array [ string ]

BulkOperationDtoSaleComparableCreateDtoItemUpdateDtoPropertyUpdateDtoSaleComparableProperty

itemsToCreate array [ SaleComparableCreateDto ]

itemsToUpdate array [ ItemUpdateDtoPropertyUpdateDtoSaleComparableProperty ]

itemsToDelete array [ string ]

BulkOperationDtoSeedCreateDtoDealUpdateDto

itemsToCreate array [ SeedCreateDto ]

itemsToUpdate array [ DealUpdateDto ]

itemsToDelete array [ string ]

CashFlowDto

cashFlow array [ CashFlowItemDto ]

year1Name string

year2Name string

year3Name string

cashFlowBeforeLivingExpenses number(double)

livingExpenses number(double)

cashFlowAvailableForDebtService number(double)

subTotals array [ CashFlowSubTotalDto ]

CashFlowInfoDto

id string

Unique identifier for this cash flow analysis

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

ownerIds array [ string ]

Blooma user IDs (email addresses) with ownership access

valuationsInfoId string

ID of the parent valuation container

fileId string

ID of the uploaded cash flow document

comment string

revenue FinancialTransactionInfoDto

vacancyAndConcessions FinancialTransactionInfoDto

otherIncome FinancialTransactionInfoDto

operatingExpenses FinancialTransactionInfoDto

belowTheLineExpense FinancialTransactionInfoDto

effectiveIncome number(double)

Effective Gross Income (EGI) - total income minus vacancy and concessions, in USD

effectiveIncomeByYear array [ number(double) ]

totalExpenses number(double)

Total operating expenses, in USD

totalExpensesByYear array [ number(double) ]

netOperatingIncome number(double)

Net Operating Income (NOI) - effective income minus operating expenses, in USD

netOperatingIncomeByYear array [ number(double) ]

netIncome number(double)

Net income after operating expenses and below-the-line expenses, in USD

netIncomeByYear array [ number(double) ]

dcfModel DcfModelDto

finalSale number(double)

presentValues array [ number(double) ]

netPresentValue number(double)

expenseRatio number(double)

Total operating expenses divided by effective gross income, expressed as a decimal (e.g., 0.35 = 35%)

CashFlowItemCreateDto

frontEndGridLineNumber string

cashFlowCategory string(enum)

Available enum values: wages_1040, other_income_1040, interest_dividend_income, schedule_c, schedule_d, schedule_e, k1_income_partnerships_sCorps, federal_and_state_taxes, schedule_of_real_estate_noi, k1_1065_income_partnership_sCorps, k1_1120s_income_partnership_sCorps

cashFlowSubCategory string

description string

transactionType string(enum)

Available enum values: Credit, Debit

yearValuesMap map { number(double) }

yearMappingMap map { string }

CashFlowItemDto

id string

Unique identifier for this cash flow line item

warningStatus string(enum)

Available enum values: noWarning, needToAsk, Adjusted

cashFlowCategory string(enum)

Available enum values: wages_1040, other_income_1040, interest_dividend_income, schedule_c, schedule_d, schedule_e, k1_income_partnerships_sCorps, federal_and_state_taxes, schedule_of_real_estate_noi, k1_1065_income_partnership_sCorps, k1_1120s_income_partnership_sCorps

cashFlowSubCategory string

description string

year1 AdjustableValueDto

year1WarningStatus string(enum)

Available enum values: NotAdjusted, BloomaAdjusted, UserAdjusted

year2 AdjustableValueDto

year2WarningStatus string(enum)

Available enum values: NotAdjusted, BloomaAdjusted, UserAdjusted

year3 AdjustableValueDto

year3WarningStatus string(enum)

Available enum values: NotAdjusted, BloomaAdjusted, UserAdjusted

transactionType string(enum)

Available enum values: Credit, Debit

proforma number(double)

appliedRuleDescription string

CashFlowItemUpdateDto

id string

Identifier of the cash flow item to update

updates array [ CashFlowItemUpdatePropertyDto ]

CashFlowItemUpdatePropertyDto

property string(enum)

Available enum values: Year1Adjustment, Year1Reason, Year2Adjustment, Year2Reason, Year3Adjustment, Year3Reason

value string

CashFlowReportDto

id string

Unique identifier for this cash flow analysis

name string

fileId string

ID of the uploaded cash flow document

comment string

CashFlowSubTotalDto

cashFlowCategory string(enum)

Available enum values: wages_1040, other_income_1040, interest_dividend_income, schedule_c, schedule_d, schedule_e, k1_income_partnerships_sCorps, federal_and_state_taxes, schedule_of_real_estate_noi, k1_1065_income_partnership_sCorps, k1_1120s_income_partnership_sCorps

cashFlowSubCategory string

totalYear1 number(double)

totalYear2 number(double)

totalYear3 number(double)

totalProforma number(double)

CashFlowTransactionTemplateDto

category string

group string

description string

annualized number(double)

comment string

CollateralCashFlowResponseDto

success boolean

Indicates whether the API request completed successfully

error ErrorDto

id string

Unique identifier for this cash flow analysis

collateralId string

ID of the collateral property for this cash flow analysis

marketCapRate number(double)

Market-derived capitalization rate, expressed as a decimal (e.g., 0.055 = 5.5%)

mainIncomeValuationCapRate number(double)

Cap rate used in the primary income valuation, expressed as a decimal

marketValuation RevenueValuationDto

Property value using market cap rate, in USD

salesValuation number(double)

Property value from sales comparables, in USD

mainIncomeValuationId string

ID of the primary income-based valuation scenario

mainAlternativeValuationId string

ID of the primary alternative valuation (e.g., appraisal)

mainAlternativeValuation number(double)

Primary alternative valuation (e.g., appraisal), in USD

mainAlternativeValuationDate string(date)

Date of the primary alternative valuation (ISO 8601 format: YYYY-MM-DD)

capRateLastModifiedTime string(date)

rentRollRevenues map { number(double) }

componentTotals ComponentTotalsDto

revenueValuations array [ RevenueValuationDto ]

alternativeValuations array [ AlternativeValuationDto ]

dcfModel DcfModelDto

CollateralComponentScoreDto

collateral CollateralScoreExtractDto

components array [ ComponentScoreDataDto ]

CollateralCreateDto

migrationReference string

dealId string

ID of the deal to associate this collateral with

name string

description string

address AddressCreateDto

CollateralCustomFieldOneCreateDto

name string

CollateralCustomFieldOneDto

id string

Unique identifier for this custom field value

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

name string

order integer(int32)

CollateralDto

id string

Unique identifier for the collateral property

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

ownerIds array [ string ]

Blooma user IDs (email addresses) with ownership access

dealIds array [ string ]

IDs of the deals this collateral property is associated with

address AddressDto

name string

description string

customFieldOne string

salesValuation number(double)

Property value from sales comparables, in USD

alternativeValuation number(double)

Alternative property value (e.g., appraisal, broker opinion), in USD

totalSf number(double)

Total square footage of the property

totalUnits number(double)

Total number of units in the property

floorAreaRatio number(double)

parkingRatio number(double)

walkScore number(double)

Walk Score® rating (0-100) measuring walkability to amenities

transitScore number(double)

Transit Score rating (0-100) measuring access to public transportation

bikeScore number(double)

Bike Score rating (0-100) measuring bikeability

propertyDetails PropertyDetailsDto

propertyOwnership PropertyOwnershipDto

taxAssessmentDetails TaxAssessmentDetailsDto

demographicsDetails DemographicsDetailsDto

propertyRisks PropertyRisksDto

amenities AmenitiesDto

construction boolean

CollateralEtlDto

id string

Unique identifier for the collateral property

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

ownerIds array [ string ]

Blooma user IDs (email addresses) with ownership access

dealIds array [ string ]

IDs of the deals this collateral is associated with

name string

description string

address AddressDto

subStatus string

propertyGeneralCategory string

countyLandUseDescription string

msaName string

totalSf number(double)

CollateralImportDto

frontEndGridLineNumber string

collateralCreateData CollateralCreateDto

alternativeValuationCreateData AlternativeValuationCreateDto

CollateralLookUpInfoDto

id string

Unique identifier for the collateral property

name string

fullAddress string

dealsInfo array [ DealInfoDto ]

CollateralPropertyUpdateDto

property string(enum)

Available enum values: Name, Description, YearRenovated, YearBuilt, FloorAreaRatio, ParkingRatio, AssetClass, CustomFieldOne

value string

CollateralReportDto

id string

Unique identifier for the collateral property

dealIds array [ string ]

IDs of the deals this collateral is associated with

fullAddress string

CollateralScoreExtractDto

id string

Unique identifier for the collateral property

dealIds array [ string ]

IDs of the deals this collateral is associated with

address AddressDto

floorAreaRatio number(double)

parkingRatio number(double)

walkScore number(double)

transitScore number(double)

bikeScore number(double)

yearBuilt number(double)

yearRenovated number(double)

stories number(double)

lotSize number(double)

numberOfBuildings number(double)

grossSF number(double)

sizeLotAcres number(double)

assetClass string(enum)

Available enum values: A, AB, B, BC, C, NA

totalCrimeScore number(double)

salePricePerSf number(double)

CollateralSummaryDto

id string

Unique identifier for the collateral property

address AddressDto

name string

netIncome number(double)

Net income after operating expenses and below-the-line expenses, in USD

netOperatingIncome number(double)

Net Operating Income (NOI) calculated as revenue minus operating expenses before debt service, in USD

incomeValuation number(double)

Property value derived from capitalizing NOI (NOI / Cap Rate), in USD

alternativeValuation number(double)

Alternative property value from appraisal, broker opinion, or other valuation method, in USD

salesValuation number(double)

Property value derived from sales comparable analysis, in USD

totalSF number(double)

Total square footage of the collateral property

totalUnit number(double)

Total number of units in the collateral property

yearBuilt number(double)

Year the property was originally constructed

CollateralSummaryResponseDto

success boolean

Indicates whether the API request completed successfully

error ErrorDto

collateralSummaries array [ CollateralSummaryDto ]

CollateralTotalsDto

alternativeValuation number(double)

Total alternative valuation across all collateral properties, in USD

incomeValuation number(double)

Total income-based valuation across all collateral properties, in USD

salesValuation number(double)

Total sales comparable valuation across all collateral properties, in USD

netOperatingIncome number(double)

Total NOI across all collateral properties, in USD

netIncome number(double)

Total net income across all collateral properties, in USD

userDebtService number(double)

debtServiceMethod string(enum)

Available enum values: Calculated, Manual

debtService number(double)

Total annual debt service across all loans, in USD

netCashFlow number(double)

Net cash flow after debt service (NOI - Debt Service), in USD

dscr number(double)

Overall Debt Service Coverage Ratio (NOI / Debt Service). Values > 1.0 indicate income exceeds debt obligations

debtYield number(double)

Overall debt yield (NOI / Loan Amount), expressed as a percentage. Lender-focused metric independent of property value

totalSF number(double)

Total square footage across all collateral properties

totalUnit number(double)

Total units across all collateral properties

CollateralsImportRequestDto

collaterals array [ CollateralImportDto ]

CombinedValuationCreateDto

valuationsInfoId string

ID of the parent valuation container

mainValuation boolean

name string

userValuationType string

startDate string(date)

endDate string(date)

capRateSource string(enum)

Available enum values: Market, Manual

capRate number(double)

valuationsToSum array [ string ]

valuationsToSub array [ string ]

multiplier number(double)

CommercialComponentCreateDto

migrationReference string

collateralId string

ID of the collateral property to associate this component with

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

unitMix array [ CommercialLivingUnitCreateDto ]

CommercialComponentDto

Extends ComponentDto

livingUnitsInfo CommercialLivingUnitsInfoDto

expiringLeases map { number(double) }

CommercialComponentImportDto

frontEndGridLineNumber string

createDto CommercialComponentCreateDto

CommercialComponentInfoResponseDto

success boolean

Indicates whether the API request completed successfully

error ErrorDto

id string

Unique identifier for this component

collateralId string

ID of the collateral property this component belongs to

selectedRentRollId string

ID of the primary rent roll used for revenue calculations

address AddressDto

assetType string(enum)

Commercial property category (e.g., Office, Retail, Industrial)

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)

Property use classification: Commercial

Available enum values: Unknown, Residential, Commercial, Hotel

marketTrendSummary MarketTrendSummaryDto

marketSummary MarketSummaryDto

marketData MarketDataDto

marketForecast MarketForecastDto

leaseToPreLeaseRatio number(double)

totalRentRollAnnualRevenue number(double)

Total annual revenue from the primary rent roll, in USD

rentRollVacancy number(double)

Vacancy rate derived from the primary rent roll, expressed as a decimal (e.g., 0.08 = 8%)

rentRollsOrder array [ string ]

saleValueComputationType string(enum)

Available enum values: ByUnit, BySf

salesCompUnitValuation number(double)

Property valuation based on average price per unit from sales comparables, in USD

salesCompSFValuation number(double)

Property valuation based on average price per square foot from sales comparables, in USD

livingUnitsInfo CommercialLivingUnitsInfoDto

expiringLeases map { number(double) }

CommercialLivingUnitCreateDto

frontEndGridLineNumber string

Internal value used to order list

description string

Description of commercial unit mix line item

suite string

Suite of commercial unit mix line item

floor number(double)

Floor of commercial unit mix line item

unitSize number(double)

Total square footage for this commercial unit line item

concludedAnnualPerSf number(double)

CommercialLivingUnitDto

id string

Unique identifier for this unit line item

description string

Commercial unit description

suite string

Commercial unit mix line item suite

floor number(double)

Commercial unit mix line item floor

unitSize number(double)

Square footage of the commercial unit

compsRevenue RevenueDto

Revenue projections based on comparable properties

concludedRevenue RevenueDto

Analyst-concluded achievable rent for this unit

CommercialLivingUnitPropertyUpdateDto

property string(enum)

Available enum values: Description, Suite, Floor, UnitSize, ConcludedAnnualPerSF

value string

CommercialLivingUnitUpdateDto

id string

Identifier of the living unit to update

updates array [ CommercialLivingUnitPropertyUpdateDto ]

CommercialLivingUnitsInfoDto

livingUnits array [ CommercialLivingUnitDto ]

marketVacancy number(double)

Market vacancy rate for commercial properties, expressed as a decimal (e.g., 0.10 = 10%)

totalUnits number(double)

Total number of commercial units or suites

totalSf number(double)

Total square footage of commercial space

averageUnitSize number(double)

Average size per commercial unit, in square feet

averageSqft number(double)

Commercial average unit square foot

concludedTotalRevenue RevenueDto

Total annual revenue based on analyst-concluded achievable rents, in USD

compsTotalRevenue RevenueDto

Total annual revenue based on comparable property data, in USD

CommercialRentRollComparisonDto

id string

Unique identifier for this rent roll

rentRollName string

totalMonthlyRevenuePerSf number(double)

totalAnnualRevenuePerSf number(double)

totalAnnualRevenue number(double)

vacancy number(double)

CommercialRentRollCreateDto

componentId string

ID of the property component to associate this rent roll with

name string

effectiveDate string(date)

fileId string

ID of the uploaded rent roll document

comment string

rentRollItems array [ CommercialRentRollItemCreateDto ]

CommercialRentRollDto

id string

Unique identifier for this rent roll

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

ownerIds array [ string ]

Blooma user IDs (email addresses) with ownership access

componentId string

ID of the property component this rent roll belongs to

name string

fileId string

ID of the uploaded rent roll document

effectiveDate string(date)

Date the rent roll data is effective as of

comment string

rentRollItems array [ CommercialRentRollItemDto ]

totalSf number(double)

Total square footage covered by the rent roll

totalUnits number(double)

Total units in the rent roll

totalMonthlyRevenue number(double)

Total monthly rent revenue, in USD

totalMonthlyRevenuePerSf number(double)

totalAnnualRevenue number(double)

Total annual rent revenue, in USD

totalAnnualRevenuePerSf number(double)

vacancy number(double)

Vacancy rate, expressed as a decimal (e.g., 0.10 = 10%)

tenantTurnover number(double)

Annual tenant turnover rate, expressed as a decimal (e.g., 0.20 = 20%)

expiringLeases map { number(double) }

totalCam number(double)

CommercialRentRollInfoResponseDto

success boolean

Indicates whether the API request completed successfully

error ErrorDto

id string

Unique identifier for this rent roll

componentId string

ID of the property component this rent roll belongs to

name string

fileId string

ID of the uploaded rent roll document

effectiveDate string(date)

Date the rent roll data is effective as of

comment string

totalSf number(double)

Total square footage covered by the rent roll

totalUnits number(double)

Total units in the rent roll

totalMonthlyRevenue number(double)

Total monthly rent revenue, in USD

totalMonthlyRevenuePerSf number(double)

Average monthly rent per square foot, in USD

totalAnnualRevenue number(double)

Total annual rent revenue, in USD

totalAnnualRevenuePerSf number(double)

Average annual rent per square foot, in USD

vacancy number(double)

Vacancy rate calculated from the rent roll, expressed as a decimal (e.g., 0.10 = 10%)

tenantTurnover number(double)

Annual tenant turnover rate, expressed as a decimal (e.g., 0.20 = 20%)

expiringLeases map { number(double) }

rentRollItems array [ CommercialRentRollItemDto ]

CommercialRentRollItemCreateDto

frontEndGridLineNumber string

unitNumber string

tenantName string

monthlyRent number(double)

unitSize number(double)

leaseStart string(date)

leaseEnd string(date)

leaseType string(enum)

Available enum values: NA, FullService, ModifiedGross, SingleNet, DoubleNet, TripleNet, MonthToMonth

comment string

cam number(double)

CommercialRentRollItemDto

id string

Unique identifier for this rent roll line item

unitNumber string

tenantName string

monthlyRent number(double)

Monthly base rent for this unit, in USD

unitSize number(double)

Square footage of this commercial unit

leaseStart string(date)

Lease start date (ISO 8601 format: YYYY-MM-DD)

leaseEnd string(date)

Lease end date (ISO 8601 format: YYYY-MM-DD)

annualRent number(double)

Annual base rent for this unit, in USD

monthlyRentPerSf number(double)

Monthly rent per square foot, in USD

annualRentPerSf number(double)

Annual rent per square foot, in USD

leaseType string(enum)

Type of commercial lease (e.g., TripleNet, FullService, ModifiedGross)

Available enum values: NA, FullService, ModifiedGross, SingleNet, DoubleNet, TripleNet, MonthToMonth

comment string

cam number(double)

CommercialRentRollUpdateEntityDto

entityUpdates array [ PropertyUpdateDtoRentRollProperty ]

tablePatchData BulkOperationDtoCommercialRentRollItemCreateDtoItemUpdateDtoPropertyUpdateDtoCommercialRentRollItemProperty

CompanyCreateDto

name string

addressCreate AddressCreateDto

companyType string(enum)

Available enum values: LLC, LLP, LP, Sole_Proprietorship, C_Corp, S_Corp, Non_Profit

primaryPhoneNumber string

contactId string

ID of the associated contact record

primaryEmail string

description string

riskRating string

ein string

CompanyDto

id string

Unique identifier for the company

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

name string

companyType string(enum)

Available enum values: LLC, LLP, LP, Sole_Proprietorship, C_Corp, S_Corp, Non_Profit

description string

screeningStatus string(enum)

Available enum values: nameNotFlagged, nameFlagged, flaggedAndValidated, unknown

logo string(byte)

address AddressDto

heldCompanies array [ CompanyHoldingDto ]

primaryEmail string

primaryPhoneNumber string

membersIds array [ string ]

IDs of the individual members associated with this company

companyFinancialStatements CompanyFinancialStatementsDto

companyCashFlowAvailableForDebtService number(double)

Cash flow available before debt service payments, in USD

companyDebtService number(double)

Annual debt service obligations for the company, in USD

companyCashFlowAfterDebtService number(double)

Cash flow remaining after debt service payments, in USD

companyDSCR number(double)

Company's Debt Service Coverage Ratio. Values > 1.0 indicate sufficient income to cover debt obligations

companyAssetSubtotal number(double)

Total assets of the company, in USD

companyLiabilitySubtotal number(double)

Total liabilities of the company, in USD

companyLiquidity number(double)

Liquid assets available to the company, in USD

contactId string

ID of the associated contact record

riskRating string

Internal risk rating assigned to the company (1-8 scale, where lower numbers indicate lower risk)

lastRefreshTime string(date-time)

ein string

CompanyEtlDto

id string

Unique identifier for the company

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

ownerIds array [ string ]

Blooma user IDs (email addresses) with ownership access

CompanyFinancialDataDto

companyCashFlowAvailableForDebtService number(double)

companyDebtService number(double)

companyCashFlowAfterDebtService number(double)

companyDSCR number(double)

CompanyFinancialStatementCreateDto

balanceSheetItems array [ BalanceSheetItemCreateDto ]

incomeStatementItems array [ IncomeStatementItemCreateDto ]

name string

fileName string

date string(date)

year integer(int32)

type string(enum)

Available enum values: Manual, FileUpload

userComment string

CompanyFinancialStatementsDto

financialStatementSummary FinancialStatementSummaryDto

incomeStatements array [ IncomeStatementDto ]

balanceSheets array [ BalanceSheetDto ]

CompanyHoldingDto

ownership number(double)

companyId string

ID of the company being held

CompanyImportResultDto

error string

parsedCompanies integer(int32)

CompanyInfoResponseDto

success boolean

Indicates whether the API request completed successfully

error ErrorDto

id string

Unique identifier for the company

name string

description string

Company description

logo string(byte)

address AddressDto

primaryEmail string

Company contact primary email

primaryPhoneNumber string

Company contact primary phone number

companyDebtService number(double)

Annual debt service obligations for the company entity, in USD

companyCashFlowAfterDebtService number(double)

Cash flow remaining after debt service payments, in USD

companyDSCR number(double)

Debt Service Coverage Ratio calculated as cash flow available for debt service divided by total debt service. Values > 1.0 indicate sufficient income to cover debt obligations

companyAssetSubtotal number(double)

Total assets of the company entity, in USD

companyLiabilitySubtotal number(double)

Total liabilities of the company entity, in USD

companyLiquidity number(double)

Liquid assets available to the company, in USD

contactId string

ID of the associated contact record

riskRating string

Internal risk rating assigned to the company (1-8 scale, where lower numbers indicate lower risk)

CompanyPropertyUpdateDto

property string(enum)

Available enum values: Name, CompanyType, EIN, Description, FullAddress, AdditionalAddressFreeText, PrimaryPhoneNumber, PrimaryEmail, ContactID, RiskRating

value string

CompanyReportDto

id string

Unique identifier for the company

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

name string

companyType string(enum)

Available enum values: LLC, LLP, LP, Sole_Proprietorship, C_Corp, S_Corp, Non_Profit

description string

fullAddress string

additionalAddressFreeText string

primaryPhoneNumber string

primaryEmail string

contactId string

ID of the associated contact record

riskRating string

ein string

CompanyScoreExtractDto

id string

Unique identifier for the company

CompanySummaryDto

id string

Unique identifier for the company

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

name string

primaryAddress AddressDto

companyCashFlowAvailableForDebtService number(double)

companyDebtService number(double)

companyCashFlowAfterDebtService number(double)

companyDSCR number(double)

companyAssetSubtotal number(double)

companyLiabilitySubtotal number(double)

companyLiquidity number(double)

contactId string

ID of the associated contact record

riskRating string

CompanyUpdateDto

id string

Identifier of the company to update

updates array [ CompanyPropertyUpdateDto ]

CompareReasonDto

name string

diff number(double)

score number(double)

weight number(double)

visualKeyName string

visualKeyFormatting string

visualScoreName string

ComponentAlternativeRevenuesDto

componentId string

ID of the component to set alternative revenues for

revenues number(double)

ComponentDto

id string

Unique identifier for this component

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

ownerIds array [ string ]

Blooma user IDs (email addresses) with ownership access

collateralId string

ID of the collateral property this component belongs to

unitMixComment string

selectedRentRollId string

ID of the primary rent roll used for revenue calculations

address AddressDto

assetType string(enum)

Property category (e.g., Multi_Family_Apartments, Office, Retail, Hotel)

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)

Property use classification: Residential, Commercial, or Hotel

Available enum values: Unknown, Residential, Commercial, Hotel

marketTrendSummary MarketTrendSummaryDto

marketSummary MarketSummaryDto

marketData MarketDataDto

marketForecast MarketForecastDto

leaseToPreLeaseRatio number(double)

totalRentRollAnnualRevenue number(double)

Total annual revenue from the primary rent roll, in USD

rentRollVacancy number(double)

Vacancy rate from the primary rent roll, expressed as a decimal (e.g., 0.08 = 8%)

rentRollsOrder array [ string ]

saleValueComputationType string(enum)

Available enum values: ByUnit, BySf

salesCompUnitValuation number(double)

Property valuation based on average price per unit from sales comparables, in USD

salesCompSFValuation number(double)

Property valuation based on average price per square foot from sales comparables, in USD

type string

ComponentEtlDto

id string

Unique identifier for this component

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

ownerIds array [ string ]

Blooma user IDs (email addresses) with ownership access

collateralId string

ID of the collateral property this component belongs to

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

address AddressDto

componentType string(enum)

Available enum values: Unknown, Residential, Commercial, Hotel

selectedRentRollId string

ID of the primary rent roll used for revenue calculations

rentRollVacancy number(double)

marketVacancy Percentage

ComponentInfoDto

id string

Unique identifier for this component

assetType string(enum)

Property category (e.g., Multi_Family_Apartments, Office, Retail, Hotel)

Available enum values: None, Mixed, Hotel, Industrial, Multi_Family_Apartments, Office, Retail, Self_Storage, Land, Special_Purpose, Senior_Housing, Distribution_Warehouse, Flex_Office, Portfolio

totalSf number(double)

Total square footage of the component

totalUnits number(double)

Total units in the component

saleValue number(double)

Property value from sales comparables, in USD

totalMarketAnnualRevenue number(double)

Annual revenue based on market rents, in USD

totalRentRollAnnualRevenue number(double)

Annual revenue from the primary rent roll, in USD

marketVacancy number(double)

Market vacancy rate, expressed as a decimal (e.g., 0.06 = 6%)

rentRollVacancy number(double)

Vacancy rate from the rent roll, expressed as a decimal (e.g., 0.08 = 8%)

ComponentInfoResponseDto

success boolean

Indicates whether the API request completed successfully

error ErrorDto

id string

Unique identifier for this component

collateralId string

ID of the collateral property this component belongs to

selectedRentRollId string

ID of the primary rent roll used for revenue calculations

address AddressDto

assetType string(enum)

Property category (e.g., Multi_Family_Apartments, Office, Retail, Hotel)

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)

Property use classification: Residential, Commercial, or Hotel

Available enum values: Unknown, Residential, Commercial, Hotel

marketTrendSummary MarketTrendSummaryDto

marketSummary MarketSummaryDto

marketData MarketDataDto

marketForecast MarketForecastDto

leaseToPreLeaseRatio number(double)

totalRentRollAnnualRevenue number(double)

Total annual revenue from the primary rent roll, in USD

rentRollVacancy number(double)

Vacancy rate derived from the primary rent roll, expressed as a decimal (e.g., 0.08 = 8%)

rentRollsOrder array [ string ]

saleValueComputationType string(enum)

Available enum values: ByUnit, BySf

salesCompUnitValuation number(double)

Property valuation based on average price per unit from sales comparables, in USD

salesCompSFValuation number(double)

Property valuation based on average price per square foot from sales comparables, in USD

ComponentPropertyUpdateDto

property string(enum)

Available enum values: ServiceLevel, HotelFlag, SalesComputationType, LeaseToPreLeaseRatio, SelectedRentRoll, UnitMixComment

value string

ComponentReportDto

id string

Unique identifier for this component

collateralId string

ID of the collateral property this component belongs to

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

ComponentScoreDataDto

id string

Unique identifier for this component

collateralId string

ID of the collateral property this component belongs to

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)

salesCompUnitValuation number(double)

salesCompSFValuation number(double)

salesComparablesInfoScoreExtractDto SalesComparablesInfoScoreExtractDto

rentComparablesInfoScoreExtractDto RentComparablesInfoScoreExtractDto

livingUnitsInfoScoreExtractDto LivingUnitsInfoScoreExtractDto

rentRollScoreExtractDto RentRollScoreExtractDto

ComponentScoreExtractDto

id string

Unique identifier for this component

collateralId string

ID of the collateral property this component belongs to

selectedRentRollId string

ID of the primary rent roll used for revenue calculations

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)

salesCompUnitValuation number(double)

salesCompSFValuation number(double)

marketVacancy number(double)

salesComparablesInfoScoreExtractDto SalesComparablesInfoScoreExtractDto

rentComparablesInfoScoreExtractDto RentComparablesInfoScoreExtractDto

livingUnitsInfoScoreExtractDto LivingUnitsInfoScoreExtractDto

ComponentSummaryDto

id string

Unique identifier for this component

collateralId string

ID of the collateral property this component belongs to

assetType string(enum)

Property category (e.g., Multi_Family_Apartments, Office, Retail, Hotel)

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)

Property use classification: Residential, Commercial, or Hotel

Available enum values: Unknown, Residential, Commercial, Hotel

leaseToPreLeaseRatio number(double)

totalUnits number(double)

Total number of units (apartments, suites, or rooms) in the component

totalSf number(double)

Total square footage of the component

saleValue number(double)

Property value from sales comparables, in USD

totalMarketAnnualRevenue number(double)

Annual revenue based on market rents, in USD

totalConcludedRentAnnualRevenue number(double)

Annual revenue based on analyst-concluded achievable rents, in USD

marketVacancy number(double)

Market vacancy rate, expressed as a decimal (e.g., 0.06 = 6%)

selectedRentRollId string

ID of the primary rent roll used for revenue calculations

totalRentRollAnnualRevenue number(double)

Total annual revenue from the primary rent roll, in USD

rentRollVacancy number(double)

Vacancy rate derived from the primary rent roll, expressed as a decimal (e.g., 0.08 = 8%)

ComponentSummaryResponseDto

success boolean

Indicates whether the API request completed successfully

error ErrorDto

componentSummary array [ ComponentSummaryDto ]

ComponentTotalsDto

componentsData array [ ComponentInfoDto ]

totalSaleValue number(double)

Total sales comparable valuation across all components, in USD

totalSf number(double)

Total square footage across all components

totalUnits number(double)

Total units across all components

ComponentVacancyDto

componentId string

ID of the component to set vacancy for

vacancyValue VacancyValueDto

ComponentsImportRequestDto

hotel array [ HotelComponentImportDto ]

commercial array [ CommercialComponentImportDto ]

residential array [ ResidentialComponentImportDto ]

CreateCommercialDealDto

ownerId string

Blooma user ID (email address) of the deal owner

dealName string

address AddressCreateDto

propertyType string(enum)

Commercial property category (e.g., Office, Retail, Industrial)

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)

Requested or originated loan amount, in USD

loanTerm number(double)

Loan maturity term, in months

commercialLivingUnitCreateDto array [ CommercialLivingUnitCreateDto ]

CreateHotelDealDto

ownerId string

Blooma user ID (email address) of the deal owner

dealName string

address AddressCreateDto

propertyType string(enum)

Hotel property category

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)

Requested or originated loan amount, in USD

loanTerm number(double)

Loan maturity term, in months

hotelLivingUnitCreateDto HotelLivingUnitCreateDto

CreateResidentialDealDto

ownerId string

Blooma user ID (email address) of the deal owner

dealName string

address AddressCreateDto

propertyType string(enum)

Residential property category (e.g., Multi_Family_Apartments)

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)

Requested or originated loan amount, in USD

loanTerm number(double)

Loan maturity term, in months

residentialLivingUnitCreateDto array [ ResidentialLivingUnitCreateDto ]

CreateResponseDto

error ErrorDto

createdEntityId string

UUID of the newly created entity

success boolean

Indicates whether the API request completed successfully

CredentialDto

email string

password string

CrimeRisksDto

crimeTotalRisk number(double)

forcibleRape RiskDto

forcibleRobbery RiskDto

larceny RiskDto

burglary RiskDto

aggravatedAssault RiskDto

motorVehicleTheft RiskDto

crime RiskDto

murder RiskDto

CrossDealCollateralReportDto

body array [ DealCollateralPairDto ]

CrossDealCollateralReportFilterDto

collateralIds array [ string ]

IDs of the collateral properties to include in the report

CrossDealCollateralReportResponseDto

success boolean

Indicates whether the API request completed successfully

error ErrorDto

body array [ DealCollateralPairDto ]

CustomFieldConfigurationCreateDto

name string

CustomFieldConfigurationDto

id string

Unique identifier for this custom field configuration

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

name string

entityType string(enum)

Available enum values: Deal

orderedValues array [ string ]

CustomFieldDto

name string

value string

CustomFieldEtlDto

name string

value string

DcfModelDto

discountRate number(double)

Discount rate used for present value calculations, expressed as a decimal (e.g., 0.08 = 8%)

revenueGrowth array [ number(double) ]

Annual revenue growth rate assumption, expressed as a decimal (e.g., 0.03 = 3%)

expenseGrowth array [ number(double) ]

Annual expense growth rate assumption, expressed as a decimal (e.g., 0.025 = 2.5%)

DealCollateralPairDto

collateralId string

Unique identifier for the collateral property

dealId string

Unique identifier for the deal

DealContactCreateDto

frontEndGridLineNumber string

role string(enum)

Available enum values: Borrower, Guarantor_Sponsor, Broker, ReferralIndividual

participation number(double)

contactId string

ID of the contact to associate with the deal

DealContactPropertyUpdateDto

property string(enum)

Available enum values: Role, Participation

value string

DealContactUpdateDto

id string

Identifier of the deal contact relationship to update

updates array [ DealContactPropertyUpdateDto ]

DealCreateResult

error ErrorDto

dealId string

Unique identifier for the newly created deal

fileId string

ID of the uploaded file associated with the deal

success boolean

DealEtlDto

id string

Unique identifier for the deal

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

ownerIds array [ string ]

Blooma user IDs (email addresses) with ownership access

name string

state string(enum)

Available enum values: NewDeal, Originated, Completed, Rejected, Prep

subStatus string

rejectReason string

rejectNote string

priority string(enum)

Available enum values: Low, Medium, High

address AddressDto

geoLocation GeoJsonPoint

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

loanType string(enum)

Available enum values: Unknown, Acquisition, Acquisition_Construction, Refinance, Refinance_Construction, Construction, Stabilization, Bridge, Permanent

loanPaymentStructure string(enum)

Available enum values: InterestOnly, P_I_Amortization

projectTotalCost number(double)

grossLoan number(double)

originatedLoanAmount number(double)

indexRate number(double)

rateSpread number(double)

interestRateFloor number(double)

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)

loanTerm number(double)

extensionTerm number(double)

remainingLoanTerm number(double)

amortizationTerm number(double)

ltc number(double)

ltv number(double)

riskRating string

cashFlow number(double)

debtService number(double)

netCashFlow number(double)

dscr number(double)

assets number(double)

liabilities number(double)

netWorth number(double)

netWorthRatio number(double)

liquidity number(double)

liquidityRatio number(double)

mainScore number(double)

mainOriginationScore array [ SeedScoreEtlDto ]

originationDate string(date)

closedDate string(date)

alternativeValuation number(double)

loanNumber string

requestedLoanAmount number(double)

customFields array [ CustomFieldEtlDto ]

maturityDate string(date)

ownerId string

Blooma user ID (email address) of the deal owner

DealFundsInfoDto

id string

fundsLoansInfo FundsLoansInfoDto

fundsSourcesInfo FundsSourcesInfoDto

fundsUsesInfo FundsUsesInfoDto

DealFundsInfoResponseDto

success boolean

Indicates whether the API request completed successfully

error ErrorDto

id string

Unique identifier for the deal funds analysis

fundsLoansInfo FundsLoansInfoDto

fundsSourcesInfo FundsSourcesInfoDto

fundsUsesInfo FundsUsesInfoDto

DealIdAndNameDto

id string

Unique identifier for the deal

seedName string

DealIdsResponseDto

success boolean

Indicates whether the API request completed successfully

error ErrorDto

dealIds array [ string ]

List of all accessible deal IDs

DealInfoDto

id string

Unique identifier for the deal

name string

DealLTVsDto

alternativeLTV number(double)

incomeLTV number(double)

salesLTV number(double)

DealLoanPricingOptionsDto

id string

Unique identifier for this loan pricing options set

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

dealOption LoanOptionDto

userOptions array [ LoanOptionDto ]

DealNarrativeCreateDto

frontEndGridLineNumber string

dealNarrativeCategory string(enum)

Available enum values: Transaction_Overview, Strengths, Risks_And_Mitigants, Property_Location, Sponsor_Guarantor, Property_Management, Property_Performance, Underwriting_Notes, Third_Parties, Market, Additional_Information, Generated_Narrative

description string

DealNarrativePropertyUpdateDto

property string(enum)

Available enum values: DealNarrativeCategory, Description

value string

DealNarrativeUpdateDto

id string

Identifier of the narrative to update

updates array [ DealNarrativePropertyUpdateDto ]

DealPropertyUpdateDto

property string(enum)

The deal field to update. Only include properties that require changes — omit any properties where no update is needed.

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

The new value for the specified property. The expected format depends on the selected property — refer to Bulk Update Deals for accepted value types per property.

DealRateCreateDto

frontEndGridLineNumber string

rateType string(enum)

Available enum values: OriginationFee, ExitFee, ServicingFee, ExtensionFee1, ExtensionFee2, ExtensionFee3, ExtensionFee4, ExtensionFee5, Fee4506TRequest, AppraisalFee, BrokerFee, BusinessCreditReport, BusinessEvaluationFee, ConstructionCostReviewFee, DixielineFundControlFee, DMV, DMVProcessingFee, DocumentationFee, EnvironmentalReportFee, InspectionFee, LifeOfLoanFloodFee, Other, OutsideAppraisalReviewFee, RecordingFees, SBAGuaranteeFee, SBAPackagingFees, SBAServicingFees, SubEscrowFee, TaxServiceFee, TitleInsuranceEndorsementsFee, UCCSearchesFilingFees, UPSDeliveryFee, WireTransferFee, UnderwritingFee

measureType string(enum)

Available enum values: Percentage, Amount

percentageAmount number(double)

amount number(double)

term number(double)

DealRatePropertyUpdateDto

property string(enum)

Available enum values: MeasureType, PercentageAmount, Amount, Term

value string

DealRateUpdateDto

id string

Identifier of the rate to update

updates array [ DealRatePropertyUpdateDto ]

DealReportDto

id string

Unique identifier for the deal

seedName string

loanId string

Lender's internal loan identifier or tracking number

loansPackageId string

ID of the loans package this deal belongs to

DealScoreDataDto

dealId string

Unique identifier for the deal

deal DealScoreExtractDto

collaterals array [ CollateralComponentScoreDto ]

persons map { array [ PersonScoreExtractDto ] }

DealScoreExtractDto

id string

Unique identifier for the deal

name string

loanType string(enum)

Available enum values: Unknown, Acquisition, Acquisition_Construction, Refinance, Refinance_Construction, Construction, Stabilization, Bridge, Permanent

loanPaymentStructure string(enum)

Available enum values: InterestOnly, P_I_Amortization

projectTotalCost number(double)

grossLoan number(double)

originatedLoanAmount number(double)

requestedLoanAmount number(double)

indexRate number(double)

rateSpread number(double)

interestRateFloor number(double)

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)

loanTerm number(double)

extensionTerm number(double)

remainingLoanTerm number(double)

amortizationTerm number(double)

ltc number(double)

ltv number(double)

riskRating string

cashFlow number(double)

debtService number(double)

netCashFlow number(double)

assets number(double)

liabilities number(double)

netWorth number(double)

netWorthRatio number(double)

liquidity number(double)

liquidityRatio number(double)

originationDate string(date)

borrowerRequiredCloseDate string(date)

closedDate string(date)

loanTermEnding string(date)

collateralTotals CollateralTotalsDto

dealLTVs DealLTVsDto

valuationUsedInLtv string(enum)

Available enum values: None, Alternative, Income, Sales

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

companies array [ SeedCompanyDto ]

persons array [ SeedPersonDto ]

rates array [ RateDto ]

globalFinancialInfo map { GlobalFinancialInfoDto }

lenderReturns LenderReturnsDto

dscr number(double)

DealSizingRequestDto

ltv number(double)

Target Loan-to-Value ratio, expressed as a decimal (e.g., 0.75 = 75%)

dscr number(double)

Target Debt Service Coverage Ratio (e.g., 1.25)

debtYield number(double)

Target debt yield, expressed as a percentage

interestRate number(double)

Interest rate assumption, expressed as a decimal (e.g., 0.065 = 6.5%)

amortizationTerm number(double)

Amortization period assumption, in months

DealSizingResponseDto

dscrIo number(double)

Maximum loan amount based on DSCR with interest-only payments, in USD

dscrAmortization number(double)

Maximum loan amount based on DSCR with amortizing payments, in USD

debtYield number(double)

Maximum loan amount based on debt yield constraint, in USD

ltv number(double)

Maximum loan amount based on LTV constraint, in USD

DealTimeSeriesDto

timestamp string(date-time)

metadata MetadataDto

value string

dealState string(enum)

Available enum values: NewDeal, Originated, Completed, Rejected, Prep

DealTotalsDto

associatedDealsNumber number(double)

loanAmountSum number(double)

weightedAverageLtv number(double)

weightedAverageDscr number(double)

debtServiceSum number(double)

DealUpdateDto

id string

Identifier of the deal to update

updates array [ DealPropertyUpdateDto ]

DealValuationsReportDto

id string

Unique identifier for the deal

valuationsInfoSummaries array [ ValuationsInfoSummaryDto ]

DealsContactsImportResultDto

errors array [ string ]

success boolean

DeleteResponseDto

error ErrorDto

numberOfDeletedEntities integer(int64)

success boolean

DemographicsDetailsDto

civilianLaborForceCount number(double)

employmentCount number(double)

unemploymentCount number(double)

unemploymentRatePercent number(double)

Unemployment rate, expressed as a percentage

yearOfEmploymentData number(double)

yearOfDemographicData number(double)

populationMedianAge number(double)

Median age of the population

ageAveProjected5Year number(double)

householdCount number(double)

Total number of households

householdAverageSize number(double)

householdHighProjected5YearCount number(double)

householdLowProjected5YearCount number(double)

averageHouseholdIncome number(double)

Average household income, in USD

medianHouseholdIncome number(double)

Median household income, in USD

averageHouseholdIncome5YearForecast number(double)

medianHouseholdIncome5YearForecast number(double)

employeeTotalCount number(double)

totalPopulationCount number(double)

populationDiff2000Percent number(double)

populationDiff2010Percent number(double)

population5YearForecast number(double)

DistributionByLoanTypeDto

loanType string(enum)

Available enum values: Unknown, Acquisition, Acquisition_Construction, Refinance, Refinance_Construction, Construction, Stabilization, Bridge, Permanent

numOfDeals integer(int32)

DistributionByPropertyTypeDto

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

numOfDeals integer(int32)

DistributionByScoreDto

scoreBucket integer(int32)

numOfDeals integer(int32)

DistributionByStateDto

state string

numOfDeals integer(int32)

DummyLoanOptionCreateDto

frontEndGridLineNumber string

dummyField string

EmptyResponseDto

error ErrorDto

success boolean

EntireDealTemplateDto

dealId string

ID of the deal this template applies to

placeholdersValues map { string }

rentRolls array [ RentRollTemplateDto ]

orderedValuations array [ ValuationTemplateDto ]

EntityDescriptorDto

id string

Unique identifier for the entity

description string

ErrorDetailDto

errorType string(enum)

Available enum values: ValidationError, BadRequest, InternalError, MissingEntity

fieldName string

message string

frontEndGridLineNumber string

entityId string

ID of the entity that caused the error

ErrorDto

errorType string(enum)

Available enum values: ValidationError, BadRequest, InternalError, MissingEntity

message string

entityId string

ID of the entity that caused the error

details array [ ErrorDetailDto ]

ExistsResponseDto

error ErrorDto

exists boolean

success boolean

FileMetadataDto

id string

Unique identifier for the uploaded file

mainUrl string

size integer(int64)

uploadedBy string

creationTime string(date-time)

FinancialCalculationSummaryDto

id string

Unique identifier for this financial calculation summary

collateralsValuationSummary array [ RevenueValuationSummaryDto ]

dealValuationSummary RevenueValuationSummaryDto

FinancialStatementBulkOperationDto

notes string

assetsBulkUpdate BulkOperationDtoAssetItemCreateDtoAssetFinancialItemUpdateDto

liabilitiesBulkUpdate BulkOperationDtoLiabilityItemCreateDtoLiabilityFinancialItemUpdateDto

empty boolean

FinancialStatementConfigCreateDto

name string

active boolean

ids array [ string ]

type string(enum)

Available enum values: BalanceSheet, IncomeStatement

FinancialStatementConfigDto

id string

Unique identifier for this financial statement configuration

name string

active boolean

ids array [ string ]

FinancialStatementConfigEditDto

name string

ids array [ string ]

FinancialStatementEditDto

date string(date)

name string

FinancialStatementSummaryDto

incomeStatements array [ FinancialStatementSummaryItemDto ]

balanceSheets array [ FinancialStatementSummaryItemDto ]

FinancialStatementSummaryItemDto

id string

Unique identifier for this financial statement

year integer(int32)

name string

fileName string

type string(enum)

Available enum values: Manual, FileUpload

FinancialTransactionCreateDto

frontEndGridLineNumber string

category string(enum)

Available enum values: VacancyAndConcessions, OtherIncome, OperatingExpense, FixedCharges, BelowTheLineExpense, Revenue

description string

amount number(double)

measureType string(enum)

Available enum values: Unspecified, PercentOfRentRollVacancy, PercentOfRevenue, PercentOfEffectiveIncome, PercentOfSalesCompValuation, PercentOfTotalOperatingExpenses, Amount, PercentOfComponentRevenues, AmountPerSf, AmountPerUnit

group string

FinancialTransactionDto

id string

description string

group string

amount number(double)

Transaction amount, in USD

measureType string(enum)

How the amount is calculated (e.g., PercentOfRevenue, Amount, AmountPerSf, AmountPerUnit)

Available enum values: Unspecified, PercentOfRentRollVacancy, PercentOfRevenue, PercentOfEffectiveIncome, PercentOfSalesCompValuation, PercentOfTotalOperatingExpenses, Amount, PercentOfComponentRevenues, AmountPerSf, AmountPerUnit

annualized number(double)

Annualized amount, in USD

annualizedPerSf number(double)

Annualized amount per square foot, in USD

annualizedPerUnit number(double)

Annualized amount per unit, in USD

annualizedPercentageEGI number(double)

Annualized amount as a percentage of Effective Gross Income (EGI), expressed as a decimal

annualizedByYear array [ number(double) ]

comment string

FinancialTransactionGroupDto

group string

totalAmount number(double)

Total amount for this transaction group, in USD

totalPerSf number(double)

Total amount per square foot, in USD

totalPerUnit number(double)

Total amount per unit, in USD

totalPercentageEGI number(double)

Total as a percentage of Effective Gross Income (EGI), expressed as a decimal

transactions array [ FinancialTransactionDto ]

FinancialTransactionInfoDto

total number(double)

totalByYear array [ number(double) ]

groupedTransactions array [ FinancialTransactionGroupDto ]

FinancialTransactionPropertyUpdateDto

property string(enum)

Available enum values: Description, Amount, MeasureType, Category, Group, Comment

value string

FinancialTransactionUpdateDto

id string

Identifier of the financial transaction to update

updates array [ FinancialTransactionPropertyUpdateDto ]

FundSourceItemCreateDto

frontEndGridLineNumber string

sourcesOfFunds string

amount number(double)

loanPaymentStructure string(enum)

Available enum values: InterestOnly, P_I_Amortization

amortizationTerm number(double)

interestRate number(double)

FundSourceItemDto

id string

Unique identifier for this funding source line item

sourcesOfFunds string

amount number(double)

Amount from this funding source, in USD

loanPaymentStructure string(enum)

Available enum values: InterestOnly, P_I_Amortization

amortizationTerm number(double)

Amortization term if this source is a loan, in months

interestRate number(double)

Interest rate for this source if it's a loan, expressed as a decimal

dollarPerUnit number(double)

Amount per unit, in USD

dollarPerSF number(double)

Amount per square foot, in USD

percentOfTotal number(double)

Percentage of total sources, expressed as a decimal (e.g., 0.75 = 75%)

default boolean

isDefault boolean

FundSourceItemPropertyUpdateDto

property string(enum)

Available enum values: sourcesOfFunds, amount, loanPaymentStructure, amortizationTerm, interestRate

value string

FundSourceItemUpdateDto

id string

Identifier of the fund source item to update

updates array [ FundSourceItemPropertyUpdateDto ]

FundUseItemCreateDto

frontEndGridLineNumber string

usesOfFunds string

amount number(double)

FundUseItemDto

id string

Unique identifier for this funding use line item

usesOfFunds string

amount number(double)

Amount allocated to this use, in USD

dollarPerUnit number(double)

Amount per unit, in USD

dollarPerSF number(double)

Amount per square foot, in USD

percentOfTotal number(double)

Percentage of total uses, expressed as a decimal (e.g., 0.60 = 60%)

default boolean

isDefault boolean

FundUseItemPropertyUpdateDto

property string(enum)

Available enum values: usesOfFunds, amount

value string

FundUseItemUpdateDto

id string

Identifier of the fund use item to update

updates array [ FundUseItemPropertyUpdateDto ]

FundsLoanItemDto

sourcesOfFunds string

amount number(double)

Loan amount for this funding source, in USD

loanPaymentStructure string(enum)

Available enum values: InterestOnly, P_I_Amortization

amortizationTerm number(double)

Amortization period for this loan, in months

interestRate number(double)

Interest rate for this loan, expressed as a decimal (e.g., 0.065 = 6.5%)

dealIncomeValuation number(double)

Total deal income-based valuation, in USD

dealNOI number(double)

Total deal Net Operating Income, in USD

debtYield number(double)

Debt yield for this loan (NOI / Loan Amount), expressed as a percentage

ltv number(double)

Loan-to-Value ratio for this loan, expressed as a decimal (e.g., 0.75 = 75%)

dscr number(double)

Debt Service Coverage Ratio for this loan. Values > 1.0 indicate income exceeds debt obligations

FundsLoansInfoDto

loanFundsItems array [ FundsLoanItemDto ]

avgLTV number(double)

Weighted average LTV across all loans, expressed as a decimal

totalDSCR number(double)

Overall DSCR across all loans

totalDebtYield number(double)

Overall debt yield across all loans, expressed as a percentage

FundsSourcesInfoDto

fundSourceItems array [ FundSourceItemDto ]

totalAmount number(double)

Total funding from all sources, in USD

totalDollarPerUnit number(double)

Total funding per unit, in USD

totalDollarPerSF number(double)

Total funding per square foot, in USD

balanceBetweenUsesAndSources number(double)

Difference between total uses and total sources (should be near zero for balanced budgets), in USD

balanceName string

FundsUsesInfoDto

fundUseItems array [ FundUseItemDto ]

totalAmount number(double)

Total funding allocated to all uses, in USD

totalDollarPerUnit number(double)

Total uses per unit, in USD

totalDollarPerSF number(double)

Total uses per square foot, in USD

GeoJsonPoint

x number(double)

y number(double)

type string

coordinates array [ number(double) ]

GetOperationResultDtoDealSizingRequestDto

result DealSizingRequestDto

success boolean

error string

GetOperationResultDtoDealSizingResponseDto

result DealSizingResponseDto

success boolean

error string

GetOperationResultDtoPortfolioStressTestsDto

result PortfolioStressTestsDto

success boolean

error string

GetOperationResultDtoStressTestResultsDto

result StressTestResultsDto

success boolean

error string

GlobalFinancialInfoDto

totalCashFlow number(double)

totalDebtService number(double)

totalNetCashFlow number(double)

totalDSCR number(double)

totalAssets number(double)

totalLiabilities number(double)

totalEquity number(double)

totalLiquidity number(double)

HighlightDto

title string

Title of REIS market summary section

bullets array [ string ]

HotelComponentCreateDto

migrationReference string

collateralId string

ID of the collateral property to associate this component with

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

unitMix HotelLivingUnitCreateDto

serviceLevel string(enum)

Available enum values: LimitedService, FullService, Luxury

hotelFlag string

HotelComponentDto

Extends ComponentDto

livingUnitsInfo HotelLivingUnitsInfoDto

serviceLevel string(enum)

Available enum values: LimitedService, FullService, Luxury

hotelFlag HotelFlag

HotelComponentImportDto

frontEndGridLineNumber string

createDto HotelComponentCreateDto

HotelComponentInfoResponseDto

success boolean

Indicates whether the API request completed successfully

error ErrorDto

id string

Unique identifier for this component

collateralId string

ID of the collateral property this component belongs to

selectedRentRollId string

ID of the primary rent roll used for revenue calculations

address AddressDto

assetType string(enum)

Hotel property category

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)

Property use classification: Hotel

Available enum values: Unknown, Residential, Commercial, Hotel

marketTrendSummary MarketTrendSummaryDto

marketSummary MarketSummaryDto

marketData MarketDataDto

marketForecast MarketForecastDto

leaseToPreLeaseRatio number(double)

totalRentRollAnnualRevenue number(double)

Total annual revenue from the primary rent roll, in USD

rentRollVacancy number(double)

Vacancy rate derived from the primary rent roll, expressed as a decimal (e.g., 0.08 = 8%)

rentRollsOrder array [ string ]

saleValueComputationType string(enum)

Available enum values: ByUnit, BySf

salesCompUnitValuation number(double)

Property valuation based on average price per unit (room) from sales comparables, in USD

salesCompSFValuation number(double)

Property valuation based on average price per square foot from sales comparables, in USD

livingUnitsInfo HotelLivingUnitsInfoDto

serviceLevel string(enum)

Available enum values: LimitedService, FullService, Luxury

hotelFlag HotelFlag

Brand affiliation of the hotel (e.g., Marriott, Hilton, independent)

HotelFlag

hotelFlag string

Brand the hotel operates under (e.g., Marriott, Hilton, Hyatt, or independent)

HotelLivingUnitCreateDto

numUnits number(double)

Total number of rooms in the hotel

adr number(double)

Stabilized Average Daily Rate (ADR), in USD

occupancy number(double)

Stabilized occupancy rate, expressed as a decimal (e.g., 0.72 = 72%)

sqFt number(double)

Total square footage of hotel rooms

HotelLivingUnitDto

id string

Unique identifier for this unit line item

numUnits number(double)

Total number of rooms in the hotel

adr number(double)

Average Daily Rate (ADR) - average room revenue per occupied room per day, in USD

occupancy number(double)

Stabilized occupancy rate, expressed as a decimal (e.g., 0.72 = 72%)

sqFt number(double)

Total square footage of hotel rooms

roomNightsPerMonth number(double)

Total available room nights per month (rooms × days)

revPar number(double)

Revenue Per Available Room (RevPAR) calculated as ADR × Occupancy, in USD

monthlyRevenue number(double)

Total monthly room revenue, in USD

HotelLivingUnitPropertyUpdateDto

property string(enum)

Available enum values: NumUnits, Adr, Occupancy, SqFt

value string

HotelLivingUnitsInfoDto

livingUnits array [ HotelLivingUnitDto ]

marketVacancy number(double)

Market vacancy rate for hotel properties, expressed as a decimal (e.g., 0.25 = 25% vacancy)

totalUnits number(double)

Total number of hotel rooms

totalSf number(double)

Total square footage of hotel space

totalMonthlyRevenue number(double)

Total monthly room revenue, in USD

totalAnnualRevenue number(double)

Total annual room revenue, in USD

averageUnitSize number(double)

Average room size, in square feet

ImportDealContactDto

frontEndGridLineNumber string

dealId string

ID of the deal to associate the contact with

contactId string

ID of the contact to associate

role string(enum)

Available enum values: Borrower, Guarantor_Sponsor, Broker, ReferralIndividual

ImportReportDto

id string

Unique identifier for this import report

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

startedImportCount integer(int32)

completed boolean

importResults array [ ImportResultDto ]

ImportResponseDto

error ErrorDto

reportId string

ID of the import report to check status

success boolean

ImportResultDto

frontEndGridLineNumber string

createdId string

ID of the entity that was created

errors array [ ErrorDetailDto ]

ImportedCollateralCreateDto

address AddressCreateDto

appraisedValue number(double)

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

residentialUnixMixData array [ ImportedResidentialLivingUnitsCreateDto ]

commercialUnitMixData ImportedCommercialLivingUnitsCreateDto

hotelUnitMixData ImportedHotelLivingUnitsCreateDto

ImportedCommercialLivingUnitsCreateDto

sf number(double)

ImportedDealCreateDto

ownerId string

Blooma user ID (email address) of the deal owner

dealName string

state string(enum)

Available enum values: NewDeal, Originated, Completed, Rejected, Prep

status string

grossLoan number(double)

requestedLoanAmount number(double)

syndicatedLoan boolean

participationGrossLoan number(double)

loanType string(enum)

Available enum values: Unknown, Acquisition, Acquisition_Construction, Refinance, Refinance_Construction, Construction, Stabilization, Bridge, Permanent

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

indexRate number(double)

rateSpread number(double)

loanTerm number(double)

extensionTerm number(double)

loanId string

Lender's internal loan identifier or tracking number

originationDate string(date)

originatedLoanAmount number(double)

maturityDateMethod string(enum)

Available enum values: Estimated, Actual

maturityDate string(date)

amortizationTerm number(double)

loanPaymentStructure string(enum)

Available enum values: InterestOnly, P_I_Amortization

projectTotalCost number(double)

riskRating string

userDebtService number(double)

loansPackageId string

ID of the loans package to associate this deal with

customField1 string

customField2 string

ImportedDealDataCreateDto

dealData ImportedDealCreateDto

collateralData array [ ImportedCollateralCreateDto ]

ImportedHotelLivingUnitsCreateDto

numberOfRooms number(double)

totalSf number(double)

adr number(double)

occupancy number(double)

ImportedResidentialLivingUnitsCreateDto

bedrooms number(double)

numUnits number(double)

avgSf number(double)

IncomeStatementDto

incomeStatementConfig FinancialStatementConfigDto

multiYearIncomeStatement array [ MultiYearIncomeStatementItemDto ]

incomeStatementInfo array [ IncomeStatementInfoDto ]

postDistributionCashFlow number(double)

netIncome number(double)

Net income after all expenses, in USD

contributionsSubtotal number(double)

otherExpensesSubtotal number(double)

noi number(double)

Net Operating Income (revenue minus operating expenses), in USD

operatingExpensesSubtotal number(double)

Total operating expenses, in USD

incomeSubtotal number(double)

revenueSubtotal number(double)

Total revenue, in USD

otherIncomeSubtotal number(double)

IncomeStatementInfoDto

sourceId string

ID of the source document or data import

year integer(int32)

date string(date)

name string

fileName string

type string(enum)

Available enum values: Manual, FileUpload

userComment string

incomeStatementId string

Unique identifier for this income statement

items array [ IncomeStatementItemDto ]

subCategoryTotals map { number(double) }

categoryTotals map { number(double) }

netIncome number(double)

postDistributionCashFlow number(double)

noi number(double)

IncomeStatementItemCreateDto

frontEndGridLineNumber string

description string

sourceMapping string

value number(double)

incomeStatementCategory string(enum)

Available enum values: Income, Expenses, OtherExpenses, ContributionsDistributions

incomeStatementSubCategory string(enum)

Available enum values: Revenue, OtherIncome, OperatingExpenses, OtherExpenses, ContributionsDistributions

companyTransactionType string(enum)

Available enum values: Credit, Debit

IncomeStatementItemDto

id string

Unique identifier for this income statement line item

description string

sourceMapping string

value number(double)

incomeStatementCategory string(enum)

Available enum values: Income, Expenses, OtherExpenses, ContributionsDistributions

incomeStatementSubCategory string(enum)

Available enum values: Revenue, OtherIncome, OperatingExpenses, OtherExpenses, ContributionsDistributions

transactionType string(enum)

Available enum values: Credit, Debit

IncomeStatementItemKey

description string

incomeStatementSubCategory string(enum)

Available enum values: Revenue, OtherIncome, OperatingExpenses, OtherExpenses, ContributionsDistributions

incomeStatementCategory string(enum)

Available enum values: Income, Expenses, OtherExpenses, ContributionsDistributions

transactionType string(enum)

Available enum values: Credit, Debit

IncomeStatementItemUpdateDto

id string

Identifier of the income statement item to update

updates array [ IncomeStatementPropertyUpdateDto ]

IncomeStatementPropertyUpdateDto

property string(enum)

Available enum values: IncomeStatementCategory, IncomeStatementSubCategory, CompanyTransactionType, Description, Value

value string

IncomeStatementSubmitData

name string

year integer(int32)

bulkUpdateData BulkOperationDtoIncomeStatementItemCreateDtoIncomeStatementItemUpdateDto

InvalidEntityDto

entityId string

ID of the invalid entity

reasons array [ string ]

InvalidValidationResult

entityType string(enum)

Available enum values: Deal, ActivityLog, Collateral, Component, RentComparables, SaleComparables, ResidentialRentRolls, CommercialRentRolls, Status, Rate, Person, Company, ActivityTrailProcess, File, DealLoanPricingOptions, DealFunds, StressTest, LoansPackage, ValuationsInfo, AlternativeValuation, RevenueValuation, ETL, AssetPulse

invalidEntities array [ InvalidEntityDto ]

ItemUpdateDtoPropertyUpdateDtoCommercialRentRollItemProperty

id string

Identifier of the rent roll item to update

updates array [ PropertyUpdateDtoCommercialRentRollItemProperty ]

ItemUpdateDtoPropertyUpdateDtoRentComparableProperty

id string

Identifier of the rent comparable to update

updates array [ PropertyUpdateDtoRentComparableProperty ]

ItemUpdateDtoPropertyUpdateDtoResidentialRentRollItemProperty

id string

Identifier of the rent roll item to update

updates array [ PropertyUpdateDtoResidentialRentRollItemProperty ]

ItemUpdateDtoPropertyUpdateDtoSaleComparableProperty

id string

Identifier of the sales comparable to update

updates array [ PropertyUpdateDtoSaleComparableProperty ]

LatLng

lat number(double)

lng number(double)

LenderReturnsDto

equityMultiple number(double)

cashReturn number(double)

LiabilityFinancialItemDto

id string

Unique identifier for this liability line item

name string

description string

maturityDate string(date)

monthlyPayment number(double)

category string(enum)

Available enum values: CreditCard, InstallmentDebt, OtherLiability

proforma AdjustableValueDto

warningStatus string(enum)

Available enum values: Adjusted, notValidated, validated, adjustedByBusinessRule, adjustedByUser

LiabilityFinancialItemPropertyUpdateDto

property string(enum)

Available enum values: Name, Description, MaturityDate, MonthlyPayment, Adjustment, AdjustmentReason, Category

value string

LiabilityFinancialItemUpdateDto

id string

Identifier of the liability item to update

updates array [ LiabilityFinancialItemPropertyUpdateDto ]

LiabilityItemCreateDto

frontEndGridLineNumber string

category string(enum)

Available enum values: CreditCard, InstallmentDebt, OtherLiability

name string

description string

maturityDate string(date)

monthlyPayment number(double)

value number(double)

LinkedEntitiesDto

entityId string

Unique identifier for the entity

entityType string(enum)

Available enum values: Deal, ActivityLog, Collateral, Component, RentComparables, SaleComparables, ResidentialRentRolls, CommercialRentRolls, Status, Rate, Person, Company, ActivityTrailProcess, File, DealLoanPricingOptions, DealFunds, StressTest, LoansPackage, ValuationsInfo, AlternativeValuation, RevenueValuation, ETL, AssetPulse

LivingUnitCreateDto

frontEndGridLineNumber string

bedrooms number(double)

bathrooms number(double)

monthlyAskingRent number(double)

unitSize number(double)

numberOfUnits number(double)

LivingUnitDto

id string

Unique identifier for this living unit line item

bedrooms number(double)

bathrooms number(double)

monthlyAskingRent number(double)

unitSize number(double)

numberOfUnits number(double)

totalMonthlyRevenue number(double)

askingRentPerSqft number(double)

LivingUnitPropertyUpdateDto

property string(enum)

Available enum values: Bedrooms, Bathrooms, MonthlyAskingRent, UnitSize, NumberOfUnits

value string

LivingUnitUpdateDto

id string

Identifier of the living unit to update

updates array [ LivingUnitPropertyUpdateDto ]

LivingUnitsInfoScoreExtractDto

totalSf number(double)

totalUnits number(double)

totalMonthlyRevenue number(double)

totalAnnualRevenue number(double)

averageUnitSize number(double)

marketVacancy number(double)

LoanOptionDto

parameters OptionParametersDto

maxLoan MaxLoanDto

LoanOptionPropertyUpdateDto

property string(enum)

Available enum values: ProductName, RateType, AmortizationTerm, InterestRate, NOI, IncomeValuation, MaxLTV, MinDSCR, MaxDebtYield

value string

LoanOptionUpdateDto

id string

Identifier of the loan option to update

updates array [ LoanOptionPropertyUpdateDto ]

LoansPackageCreateDto

externalId string

External identifier from the lender's system

name string

commitmentAmount number(double)

LoansPackageDto

id string

Unique identifier for the loans package

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

externalId string

External identifier from the lender's system

name string

commitmentAmount number(double)

Total loan commitment amount for the package, in USD

dealTotals DealTotalsDto

LoansPackageEtlDto

id string

Unique identifier for the loans package

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

ownerIds array [ string ]

Blooma user IDs (email addresses) with ownership access

LoansPackageReportDto

id string

Unique identifier for the loans package

name string

externalId string

External identifier from the lender's system

LoansPackageScoreExtractDto

id string

Unique identifier for the loans package

LoansPackageSummaryDto

id string

Unique identifier for the loans package

externalId string

External identifier from the lender's system

name string

commitmentAmount number(double)

associatedDealsNumber number(double)

loanAmountSum number(double)

weightedAverageLtv number(double)

weightedAverageDscr number(double)

debtServiceSum number(double)

LoansPackageUpdateEntityDto

entityUpdates array [ PropertyUpdateDtoLoansPackageProperty ]

LocationRisksDto

enhancedHazardhubFlood RiskDto

enhancedWildfire RiskDto

tsunami RiskDto

fireProtection RiskDto

femaAllFlood RiskDto

enhancedTornadoParams RiskDto

enhancedHurricaneParams RiskDto

faultEarthquake RiskDto

enhancedHailParams RiskDto

moldIndex RiskDto

brownfield RiskDto

earthquake RiskDto

ust RiskDto

MainMarketDto

marketId integer(int64)

Unique identifier for the metropolitan market

sectorId integer(int64)

Unique ID to identify the property sector of a given company under Green Street's coverage

gradeId number(double)

The ID number assigned to a letter grade

marketPublish string

Published name of a market

sectorPublish string

Property sector name

grade string

Relative long-term rent growth potential (A+ to D scale)

ageMedian number(double)

Median age of main market's population

assetValueMomentum number(double)

Compares the year-over-year and trailing-twelve month change in asset values

caprateEconomic number(double)

A property yield based on estimated economic NOI relative to current operating real estate values

commentary string

Market commentary in the market snapshots

commuteTimeMean number(double)

Mean commute time of main market's population

cppi number(double)

Time series of unleveraged U.S. commercial property values that captures the prices at which commercial real estate transactions are being negotiated and contracted

crimeRateQuintile string

Measures the level of crime in the main market. A higher number corresponds with more crime and is a simple average ofviolent crime and property crime indices based on FBI data

desirability number(double)

Measures how desirable a market is to live in. Takes into account the perception of corruption, population migration trends, and climate / pollution

desirabilityQuintile string

Measures how desirable the main market is to live in. This metric takes into account millennial growth patterns, weather, taxes, walkability, school rating, crime, the general health of its population, and a foodie score

fiscalHealthTaxQuintile string

Measures the financial viability and solvency of a market. This quintile bucket indicates where an MSA scores relative to Green Street's Top-50 markets

homeownershipRate number(double)

The percentage of homes that are owned by their occupants

homeValueMedianCensus number(double)

Median home value (from census)

housingAffordability number(double)

A measure of affluence that combines the median home price and mortgage-to-rent ratio in the main market

housingAffordabilityQuintile string

The quintile associated with Housing Affordability

incomeHhiMedianCensus number(double)

Median household income based on census

inventory number(double)

The total inventory for the selected sector

inventoryGrowth5Yr number(double)

Annualized 5-year growth of inventory within a market

irrBetaQuintile string

Green Street's market betas measure the volatility of asset values and cash flows

irrLiquidityAdjustment number(double)

Liquidity adjustment is calculated based on historic transaction volume relative to Green Street's top 50 markets and applied to the risk-adjusted IRR

irrRiskAdjusted number(double)

This metric estimates the unlevered risk-adjusted returns that real estate investors expect to achieve by combining current cap rates, a cap-ex reserve, intermediate cash flow growth, and inflation expectations.

irrRiskPremium number(double)

The risk premium ascribed to Green Street's unlevered return expectations. The risk premium is determined based on market performance during the GFC

irrUnlevered number(double)

The discount rate that sets estimated discounted cash flows equal to the initial investment. By combining current cap rates, a cap-ex reserve, intermediate cash flow growth, and long-term growth expectations, it is possible to estimate the unlevered returns that real estate investors can expect to achieve. Green Street's unlevered IRR does not include adjustments for liquidity or market risk

latitude number(double)

The latitude of a given market

longitude number(double)

The longitude of a given market

marketAbbr string

The abbreviated market name

mrevpafGrowth number(double)

Annualized M-RevPAF (change in rent times the change in occupancy) forecast over the next five years

mrevpafGrowth5Yr number(double)

Annualized M-RevPAF (combination of rent and occupancy) growth forecast over the next five years

mrevpafGrowthYoyCredit number(double)

The year-over-year growth in M-RevPAF, which combines two key operating metrics (rent and occupancy) into a single value

noiGrowthLt number(double)

Green Street's estimate of NOI growth from year 6 of an investment horizon to perpetuity

occupancy number(double)

Market-wide occupancy rate, expressed as a decimal (e.g., 0.94 = 94%)

populationDegreeCollegeCensusPct number(double)

Percentage of population 25 or older with a bachelor's or advanced degree

rankGradeId integer(int64)

Ranking of Market Grades ID metric

rentEffective number(double)

Average effective rent per unit per month (net of concessions), in USD

rentGrossMedian number(double)

The median gross rent level of an area reported by the US Census Bureau. This figure provides information on the monthly housing costs for renters

strength1 string

Strength of the market

strength2 string

Strength of the market

strength3 string

Strength of the market

supplyBarrierQuintile string

The quintile associated with supply barriers

walkScoreDescription string

Walk Score® analyzes hundreds of walking routes to nearby amenities. Points are awarded based on the distance to amenities. Amenities within a 5 minute walk are given maximum points. A decay function is used to give points to more distant amenities up to a 30 minute walk

weakness1 string

Weakness of the market

weakness2 string

Weakness of the market

weakness3 string

Weakness of the market

timestampUpdate string

The date that data was last updated

MarketDataDto

mainMarket MainMarketDto

subMarket SubMarketDto

MarketForecastDto

marketId integer(int64)

Identification number assigned to each market

dateFcReleaseId integer(int64)

A unique identifier to denote a specific Forecast Scenarios release

scenarioId integer(int64)

A unique identifier to indicate which of Green Street's Forecast Scenarios the corresponding data refers to

sectorId integer(int64)

Unique ID to identify the property sector of a given company under Green Street's coverage

fcPublish string

Indicates which Forecast Release (date) is being referenced

marketPublish string

Published name of a market

scenarioPublish string

Indicates which of Green Street's Forecast Scenarios the corresponding data refers to

sectorPublish string

Property sector name

dateFcRelease string(date)

Indicates the quarter in which this specific release of Forecast Scenario data relate to

date string(date)

Date of Market forecast

caprateNominal number(double)

Represents the expected first year yield a property buyer expects to realize on their investment, calculated as: Nominal Net Operating Income (NOI) / Property Value

cppiIndex number(double)

Time series of unleveraged U.S. commercial property values that captures the prices at which commercial real estate transactions are being negotiated and contracted.

demandGrowth number(double)

Net absorption within a market. Measures the total space that became physically occupied minus the portion which became physically vacant

mrevpafGrowth number(double)

Annualized M-RevPAF (change in rent times the change in occupancy) forecast over the next five years

ncfGrowth number(double)

Net cash flow growth

noiGrowth number(double)

NOI growth

occupancy number(double)

Percentage of total unit count that is physically occupied

rentGrowth number(double)

Green Street's forecasted rent growth expectations

supplyGrowth number(double)

Year-over-year growth of inventory

timestampUpdate string

The date that data was last updated

MarketSummaryDto

weakness1 string

Weakness of the market

weakness2 string

Weakness of the market

weakness3 string

Weakness of the market

strength1 string

Strength of the market

strength2 string

Strength of the market

strength3 string

Strength of the market

MarketTrendSummaryDto

lastUpdated string(date-time)

Date and time of last update for market info

rent HighlightDto

sections array [ SectionDto ]

MaxLoanDto

dscr number(double)

debtYield number(double)

ltv number(double)

MetadataDto

entityId string

Unique identifier for the entity

label string

MultiVariableAnalysisDto

stressTestType string(enum)

Available enum values: Low, Medium, High, Custom, Baseline

debtYield number(double)

Debt yield under the stress scenario, expressed as a percentage

proformaIncomeLtv number(double)

revenueChange number(double)

Revenue change applied in the stress scenario, expressed as a decimal (e.g., -0.10 = -10%)

expensesChange number(double)

Expense change applied in the stress scenario, expressed as a decimal (e.g., 0.15 = +15%)

capRateChange number(double)

Cap rate change applied in the stress scenario, expressed as a decimal

vacancyChange number(double)

Vacancy change applied in the stress scenario, expressed as a decimal

interestRateChange number(double)

Interest rate change applied in the stress scenario, expressed as a decimal

dscr number(double)

DSCR under the stress scenario. Values > 1.0 indicate income exceeds debt obligations

MultiYearBalanceSheetItemDto

itemKey BalanceSheetItemKey

values array [ SingleYearValue ]

proforma number(double)

MultiYearIncomeStatementItemDto

itemKey IncomeStatementItemKey

values array [ SingleYearValue ]

proforma number(double)

NAType

NarrativeDto

id string

Unique identifier for this narrative

category string(enum)

Available enum values: Transaction_Overview, Strengths, Risks_And_Mitigants, Property_Location, Sponsor_Guarantor, Property_Management, Property_Performance, Underwriting_Notes, Third_Parties, Market, Additional_Information, Generated_Narrative

description string

NoteDto

owner string

creationTime string(date-time)

text string

NotificationsDataDto

notificationsUserId string

User ID for the notifications service

hmacSignature string

OptionParametersDto

id string

Unique identifier for this loan option

productName string

rateType string(enum)

Available enum values: InterestOnly, P_I_Amortization

interestRate number(double)

amortizationTerm number(double)

noi number(double)

incomeValuation number(double)

maxLtv number(double)

minDscr number(double)

maxDebtYield number(double)

OrphanedEntityDto

entityId string

ID of the orphaned entity

entityType string(enum)

Available enum values: Deal, ActivityLog, Collateral, Component, RentComparables, SaleComparables, ResidentialRentRolls, CommercialRentRolls, Status, Rate, Person, Company, ActivityTrailProcess, File, DealLoanPricingOptions, DealFunds, StressTest, LoansPackage, ValuationsInfo, AlternativeValuation, RevenueValuation, ETL, AssetPulse

missingLinkedEntities array [ LinkedEntitiesDto ]

Percentage

value number(double)

PersonCreateDto

firstName string

middleName string

lastName string

addressCreate AddressCreateDto

socialSecurityNumber string

creditScore number(double)

creditNarrative string

contactId string

ID of the associated contact record

primaryPhoneNumber string

primaryEmail string

birthDate string(date)

description string

riskRating string

PersonDto

id string

Unique identifier for the person

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

firstName string

middleName string

lastName string

socialSecurityNumber string

description string

riskRating string

Internal risk rating assigned to the individual (1-8 scale, where lower numbers indicate lower risk)

birthDate string(date)

address AddressDto

primaryPhoneNumber string

primaryEmail string

screeningStatus string(enum)

Available enum values: nameNotFlagged, nameFlagged, flaggedAndValidated, unknown

lastRefreshTime string(date-time)

image string(byte)

companies array [ CompanyHoldingDto ]

realEstateSchedule RealEstateScheduleDto

cashFlow CashFlowDto

financialStatement PersonalFinancialStatementDto

personalNetWorth number(double)

Total net worth of the individual, in USD

personalLiquidity number(double)

Liquid assets available to the individual, in USD

personalDSCR number(double)

Individual's Debt Service Coverage Ratio. Values > 1.0 indicate sufficient income to cover debt obligations

personalCashFlowAfterDebtService number(double)

Cash flow remaining after debt service payments, in USD

personDebtRatio number(double)

Total debt divided by total assets, expressed as a decimal (e.g., 0.35 = 35%)

personalAssetSubtotal number(double)

Total assets of the individual, in USD

personalLiabilitySubtotal number(double)

Total liabilities of the individual, in USD

personDebtService number(double)

Annual debt service obligations for the individual, in USD

personalCashFlowAvailableForDebtService number(double)

Cash flow available before debt service payments, in USD

creditScore number(double)

Individual's credit score

creditNarrative string

contactId string

ID of the associated contact record

PersonEtlDto

id string

Unique identifier for the person

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

ownerIds array [ string ]

Blooma user IDs (email addresses) with ownership access

firstName string

lastName string

PersonFinancialDataDto

personalCashFlowAvailableForDebtService number(double)

personDebtService number(double)

personalCashFlowAfterDebtService number(double)

personalDSCR number(double)

personalAssetSubtotal number(double)

personalLiabilitySubtotal number(double)

personalLiquidity number(double)

PersonInfoResponseDto

success boolean

Indicates whether the API request completed successfully

error ErrorDto

id string

Unique identifier for the person

contactId string

ID of the associated contact record

firstName string

middleName string

lastName string

description string

primaryPhoneNumber string

Person contact primary phone number

primaryEmail string

Person contact primary email address

image string(byte)

address AddressDto

personalNetWorth number(double)

Total net worth of the individual, in USD

personalLiquidity number(double)

Liquid assets available to the individual, in USD

personalDSCR number(double)

Individual's Debt Service Coverage Ratio calculated as cash flow available for debt service divided by total debt service. Values > 1.0 indicate sufficient income to cover debt obligations

personalCashFlowAfterDebtService number(double)

Cash flow remaining after debt service payments, in USD

personDebtRatio number(double)

Total debt divided by total assets, expressed as a decimal (e.g., 0.35 = 35%)

PersonPropertyUpdateDto

property string(enum)

Available enum values: FirstName, MiddleName, LastName, SocialSecurityNumber, Description, BirthDate, AddressLine, AdditionalAddressFreeText, PrimaryPhone, PrimaryEmail, CreditScore, CreditNarrative, ContactID, RiskRating

value string

PersonReportDto

id string

Unique identifier for the person

firstName string

middleName string

lastName string

socialSecurityNumber string

description string

birthDate string(date)

fullAddress string

additionalAddressFreeText string

primaryPhoneNumber string

primaryEmail string

creditScore number(double)

creditNarrative string

contactId string

ID of the associated contact record

riskRating string

PersonScoreExtractDto

id string

Unique identifier for the person

firstName string

lastName string

screeningStatus string(enum)

Available enum values: nameNotFlagged, nameFlagged, flaggedAndValidated, unknown

personalNetWorth number(double)

personalLiquidity number(double)

personalDSCR number(double)

personalCashFlowAfterDebtService number(double)

personDebtRatio number(double)

personalAssetSubtotal number(double)

personalLiabilitySubtotal number(double)

personDebtService number(double)

personalCashFlowAvailableForDebtService number(double)

creditScore number(double)

PersonSummaryDto

id string

Unique identifier for the person

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

firstName string

lastName string

middleName string

address AddressDto

personalNetWorth number(double)

personalLiquidity number(double)

personalDSCR number(double)

personalCashFlowAfterDebtService number(double)

personDebtRatio number(double)

personalAssetSubtotal number(double)

personalLiabilitySubtotal number(double)

personDebtService number(double)

personalCashFlowAvailableForDebtService number(double)

creditScore number(double)

creditNarrative string

contactId string

ID of the associated contact record

riskRating string

PersonUpdateDto

id string

Identifier of the person to update

updates array [ PersonPropertyUpdateDto ]

PersonalFinancialStatementDto

notes string

assets array [ AssetFinancialItemDto ]

liabilities array [ LiabilityFinancialItemDto ]

assetsCategoriesSubtotals map { number(double) }

liabilitiesCategoriesSubtotals map { number(double) }

liabilitiesCategoriesAnnualSubtotals map { number(double) }

PersonsImportResultDto

error string

parsedPersons integer(int32)

PortfolioStressTestsDto

averageByLoanAmount StressTestResultsDto

stressTestErrors array [ StressTestErrorDto ]

allStressResults array [ StressTestResultsDto ]

PropertyDetailsDto

yearBuilt number(double)

Year the property was originally constructed

yearRenovated number(double)

Year of most recent major renovation

stories number(double)

lotSize number(double)

Lot size, in square feet

parcelNumber string

numberOfBuildings number(double)

grossSF number(double)

Gross square footage

zoning string

sizeLotAcres number(double)

assetClass string(enum)

Available enum values: A, AB, B, BC, C, NA

fipsCode string

countyLandUseDescription string

parkingSpaces number(double)

propertyGeneralCategory string

censusBlockGroup number(double)

censusTract string

msaName string

msaCode string

stateCode string

countyCode string

PropertyOwnershipDto

salePrice number(double)

saleDate string

taxDelinquency string

seller array [ string ]

buyer array [ string ]

ownerName string

ownerState string

ownerStreetAddress array [ string ]

recordedOwnerFirstName string

recordedOwnerLastName string

recordedOwnerMiddleName string

recordedOwnerName string

ownerType string

armsLengthTransaction number(double)

mortgageAmount number(double)

mortgageRecordedDate string

mortgageInterestRate number(double)

mortgageLenderName string

mortgageTerm number(double)

mortgageInterestRateIndexCode number(double)

mortgageAdjustableRateIndexCode number(double)

PropertyRisksDto

locationRisks LocationRisksDto

crimeRisks CrimeRisksDto

PropertyUpdateDtoCommercialRentRollItemProperty

property string(enum)

Available enum values: UnitNumber, TenantName, MonthlyRent, UnitSize, LeaseStart, LeaseEnd, LeaseType, Comment, Cam

value string

PropertyUpdateDtoLoansPackageProperty

property string(enum)

Available enum values: ExternalId, Name, CommitmentAmount

value string

PropertyUpdateDtoRentComparableProperty

property string(enum)

Available enum values: Name, YearBuilt, YearRenovated, Stories, AssetClass, Vacancy, DataAsOf

value string

PropertyUpdateDtoRentComparablesProperty

property string(enum)

Available enum values: ExcludeOthers

value string

PropertyUpdateDtoRentRollProperty

property string(enum)

Available enum values: Name, EffectiveDate, ComponentId, Comment

value string

PropertyUpdateDtoResidentialRentRollItemProperty

property string(enum)

Available enum values: UnitNumber, TenantName, MonthlyRent, UnitSize, LeaseStart, LeaseEnd, UnitType, Bedrooms, Bathrooms

value string

PropertyUpdateDtoRevenueValuationProperty

property string(enum)

Available enum values: Name, StartDate, EndDate, CapRate, RevenueSource, SelectedRentRolls, CapRateSource, VacancySource, ComponentsVacancies, ComponentsAlternativeRevenues, UserValuationType, Comment, Archive

value string

PropertyUpdateDtoSaleComparableProperty

property string(enum)

Available enum values: Name, YearBuilt, YearRenovated, Stories, AssetClass, Vacancy, DataAsOf, SaleDate, SalePrice, NOI, TotalUnits, BuildingArea, LotSize, CapRate, SellerNames, BuyerNames

value string

PropertyUpdateDtoSaleComparablesProperty

property string(enum)

Available enum values: ExcludeOthers

value string

PropertyUpdateDtoValuationsInfoProperty

property string(enum)

Available enum values: MarketCapRate, MainAlternativeValuationId, MainIncomeValuationId

value string

RankingDataDto

totalProximityScore number(double)

compareReasons array [ CompareReasonDto ]

RateDto

id string

Unique identifier for this rate

rateType string(enum)

Available enum values: OriginationFee, ExitFee, ServicingFee, ExtensionFee1, ExtensionFee2, ExtensionFee3, ExtensionFee4, ExtensionFee5, Fee4506TRequest, AppraisalFee, BrokerFee, BusinessCreditReport, BusinessEvaluationFee, ConstructionCostReviewFee, DixielineFundControlFee, DMV, DMVProcessingFee, DocumentationFee, EnvironmentalReportFee, InspectionFee, LifeOfLoanFloodFee, Other, OutsideAppraisalReviewFee, RecordingFees, SBAGuaranteeFee, SBAPackagingFees, SBAServicingFees, SubEscrowFee, TaxServiceFee, TitleInsuranceEndorsementsFee, UCCSearchesFilingFees, UPSDeliveryFee, WireTransferFee, UnderwritingFee

measureType string(enum)

Available enum values: Percentage, Amount

percentageAmount number(double)

amount number(double)

term number(double)

ReadResponseDtoCommercialRentRollDto

error ErrorDto

entity CommercialRentRollDto

success boolean

ReadResponseDtoDealValuationsReportDto

error ErrorDto

entity DealValuationsReportDto

success boolean

ReadResponseDtoImportReportDto

error ErrorDto

entity ImportReportDto

success boolean

ReadResponseDtoLoansPackageDto

error ErrorDto

entity LoansPackageDto

success boolean

ReadResponseDtoRentComparablesDto

error ErrorDto

entity RentComparablesDto

success boolean

ReadResponseDtoRentRollsImportReportDto

error ErrorDto

entity RentRollsImportReportDto

success boolean

ReadResponseDtoResidentialRentRollDto

error ErrorDto

entity ResidentialRentRollDto

success boolean

ReadResponseDtoSaleComparablesDto

error ErrorDto

entity SaleComparablesDto

success boolean

ReadResponseDtoValuationsInfoDto

error ErrorDto

entity ValuationsInfoDto

success boolean

RealEstateDto

id string

Unique identifier for this real estate schedule line item

owner string

address AddressDto

propertyType string

propertyName string

rentableArea number(double)

numOfUnits number(double)

underConstruction boolean

constructionPercentageCompleted number(double)

percentageOwned number(double)

Ownership percentage, expressed as a decimal (e.g., 0.50 = 50%)

marketValue number(double)

Current market value of the property, in USD

originalLoanCommitment number(double)

currentLoanBalance number(double)

Outstanding loan balance, in USD

lender string

interestRate number(double)

Loan interest rate, expressed as a decimal (e.g., 0.045 = 4.5%)

monthlyPayment number(double)

Monthly debt service payment, in USD

annualRevenue number(double)

Annual property revenue, in USD

annualOperatingExpenses number(double)

Annual operating expenses, in USD

debtServiceCoverageRatio number(double)

DSCR for this property. Values > 1.0 indicate income exceeds debt obligations

personalGuaranty boolean

recourse number(double)

valueOwned number(double)

loanBalanceOwed number(double)

equityValue number(double)

Equity value (market value minus loan balance), in USD

annualNOI number(double)

Annual Net Operating Income, in USD

annualDebtService number(double)

Annual debt service payment, in USD

ownerDebtService number(double)

excessCashFlow number(double)

excessCashFlowOwned number(double)

RealEstateScheduleDto

realEstates array [ RealEstateDto ]

totalRealEstateValue number(double)

totalRealEstateDebt number(double)

totalRealEstateEquity number(double)

totalOwnerDebtService number(double)

RealEstateScheduleItemCreateDto

frontEndGridLineNumber string

owner string

fullAddress string

propertyType string

propertyName string

rentableArea number(double)

numOfUnits number(double)

underConstruction boolean

constructionPercentageCompleted number(double)

percentageOwned number(double)

marketValue number(double)

originalLoanCommitment number(double)

currentLoanBalance number(double)

lender string

interestRate number(double)

monthlyPayment number(double)

annualRevenue number(double)

annualOperatingExpenses number(double)

personalGuaranty boolean

recourse number(double)

RealEstateScheduleItemPropertyUpdateDto

property string(enum)

Available enum values: Owner, FullAddress, PropertyType, PropertyName, RentableArea, NumberOfUnits, UnderConstruction, ConstructionPercentageCompleted, PercentageOwned, MarketValue, OriginalLoanCommitment, CurrentLoanBalance, Lender, InterestRate, MonthlyPayment, AnnualRevenue, AnnualOperatingExpenses, PersonalGuaranty, Recourse

value string

RealEstateScheduleItemUpdateDto

id string

Identifier of the real estate schedule item to update

updates array [ RealEstateScheduleItemPropertyUpdateDto ]

RentComparableCreateDto

frontEndGridLineNumber string

name string

address AddressCreateDto

yearBuilt number(double)

yearRenovated number(double)

stories number(double)

assetClass string(enum)

Available enum values: A, AB, B, BC, C, NA

vacancy number(double)

dataAsOf string(date)

livingUnits array [ LivingUnitCreateDto ]

RentComparableDto

id string

Unique identifier for this rent comparable property

source string

name string

address AddressDto

yearBuilt number(double)

Year the property was constructed

yearRenovated number(double)

stories number(double)

totalUnits number(double)

Total units in the comparable property

dataAsOf string(date)

vacancy number(double)

Vacancy rate, expressed as a decimal

assetClass string(enum)

Available enum values: A, AB, B, BC, C, NA

ranking RankingDataDto

ignore boolean

updatedBy string(enum)

Available enum values: system, ignoredByUser, enabledByUser

createdByUser boolean

distance number(double)

askingRent number(double)

Total asking rent for the comparable property, in USD

totalSize number(double)

Total square footage of the comparable property

averageUnitSize number(double)

Average unit size, in square feet

livingUnits array [ LivingUnitDto ]

amenities array [ string ]

RentComparablesCreateDto

componentId string

ID of the property component to associate these comparables with

comparables array [ RentComparableCreateDto ]

RentComparablesDto

id string

Unique identifier for this rent comparables set

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

ownerIds array [ string ]

Blooma user IDs (email addresses) with ownership access

componentId string

ID of the property component these comparables belong to

lastRefreshTime string(date-time)

profileName string

comparables array [ RentComparableDto ]

unitTypeToWeightedAvgs map { WeightedAvgsDto }

averageAskingRent number(double)

averageTotalSize number(double)

RentComparablesInfoScoreExtractDto

averageAskingRent number(double)

RentComparablesSummaryDto

id string

Unique identifier for this rent comparables set

unitTypeToWeightedAvgs map { WeightedAvgsDto }

averageAskingRent number(double)

averageTotalSize number(double)

RentComparablesUpdateEntityDto

entityUpdates array [ PropertyUpdateDtoRentComparablesProperty ]

tablePatchData BulkOperationDtoRentComparableCreateDtoItemUpdateDtoPropertyUpdateDtoRentComparableProperty

RentRollEtlDto

id string

Unique identifier for this rent roll

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

ownerIds array [ string ]

Blooma user IDs (email addresses) with ownership access

name string

effectiveDate string(date)

rentRollItems array [ RentRollItemEtlDto ]

RentRollImportDto

frontEndGridLineNumber string

componentId string

ID of the property component to import the rent roll to

componentType string(enum)

Available enum values: Unknown, Residential, Commercial, Hotel

rentRollName string

asOfDate string(date)

defaultRentRoll boolean

unitNumber string

tenantName string

monthlyRent number(double)

unitSize number(double)

leaseStart string(date)

leaseEnd string(date)

unitType string

bedrooms number(double)

bathrooms number(double)

leaseType string(enum)

Available enum values: NA, FullService, ModifiedGross, SingleNet, DoubleNet, TripleNet, MonthToMonth

RentRollImportItemResultDto

componentId string

ID of the component the rent roll was imported to

rentRollName string

success boolean

errors array [ ErrorDetailDto ]

RentRollItemEtlDto

id string

Unique identifier for this rent roll line item

tenantName string

annualRent number(double)

unitSize number(double)

leaseEnd string(date)

RentRollItemTemplateDto

leaseType string

leaseExpiration string(date)

leaseStart string(date)

monthlyRent number(double)

bedrooms number(double)

bathrooms number(double)

tenantName string

unitNumber string

unitSize number(double)

unitType string

cam number(double)

comment string

RentRollLookUpInfoDto

rentRollId string

Unique identifier for the rent roll

rentRollName string

isPrimary boolean

effectiveDate string(date)

RentRollReportDto

id string

Unique identifier for this rent roll

componentId string

ID of the property component this rent roll belongs to

componentType string(enum)

Available enum values: Unknown, Residential, Commercial, Hotel

rentRollName string

unitNumber string

tenantName string

RentRollScoreExtractDto

id string

Unique identifier for this rent roll

totalSf number(double)

totalUnits number(double)

totalMonthlyRevenue number(double)

totalAnnualRevenue number(double)

vacancy number(double)

tenantTurnOver number(double)

RentRollSummaryDto

id string

Unique identifier for this rent roll

name string

fileId string

ID of the uploaded rent roll document

totalSf number(double)

totalUnits number(double)

totalMonthlyRevenue number(double)

totalAnnualRevenue number(double)

vacancy number(double)

tenantTurnover number(double)

RentRollTemplateDto

id string

Unique identifier for this rent roll template

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

ownerIds array [ string ]

Blooma user IDs (email addresses) with ownership access

collateralIndex integer(int32)

componentIndex integer(int32)

collateralId string

ID of the collateral property

componentId string

ID of the property component

assetType string

name string

effectiveDate string(date)

comment string

items array [ RentRollItemTemplateDto ]

RentRollUnitTypeSummaryDto

totalUnits number(double)

Total units of this unit type

bedrooms number(double)

Number of bedrooms for this unit type

bathrooms number(double)

Number of bathrooms for this unit type

avgSf number(double)

Average square footage for this unit type

avgMonthlyRevenuePerSf number(double)

Average monthly rent per square foot, in USD

avgMonthlyRevenuePerUnit number(double)

Average monthly rent per unit, in USD

RentRollsImportReportDto

id string

Unique identifier for this rent roll import report

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

totalParsedEntities integer(int32)

importedResults array [ RentRollImportItemResultDto ]

RentRollsImportRequestDto

rentRolls array [ RentRollImportDto ]

RentRollsLookupInfoDto

componentId string

ID of the property component

componentName string

rentRollsInfo array [ RentRollLookUpInfoDto ]

ResidentialCompareResponseDto

error ErrorDto

compareData map { array [ ResidentialRentRollComparisonDto ] }

success boolean

ResidentialComponentCreateDto

migrationReference string

collateralId string

ID of the collateral property to associate this component with

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

unitMix array [ ResidentialLivingUnitCreateDto ]

ResidentialComponentDto

Extends ComponentDto

livingUnitsInfo ResidentialLivingUnitsInfoDto

expiringLeases map { number(double) }

ResidentialComponentImportDto

frontEndGridLineNumber string

createDto ResidentialComponentCreateDto

ResidentialComponentInfoResponseDto

success boolean

Indicates whether the API request completed successfully

error ErrorDto

id string

Unique identifier for this component

collateralId string

ID of the collateral property this component belongs to

selectedRentRollId string

ID of the primary rent roll used for revenue calculations

address AddressDto

assetType string(enum)

Residential property category (e.g., Multi_Family_Apartments)

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)

Property use classification: Residential

Available enum values: Unknown, Residential, Commercial, Hotel

marketTrendSummary MarketTrendSummaryDto

marketSummary MarketSummaryDto

marketData MarketDataDto

marketForecast MarketForecastDto

leaseToPreLeaseRatio number(double)

totalRentRollAnnualRevenue number(double)

Total annual revenue from the primary rent roll, in USD

rentRollVacancy number(double)

Vacancy rate derived from the primary rent roll, expressed as a decimal (e.g., 0.08 = 8%)

rentRollsOrder array [ string ]

saleValueComputationType string(enum)

Available enum values: ByUnit, BySf

salesCompUnitValuation number(double)

Property valuation based on average price per unit from sales comparables, in USD

salesCompSFValuation number(double)

Property valuation based on average price per square foot from sales comparables, in USD

livingUnitsInfo ResidentialLivingUnitsInfoDto

expiringLeases map { number(double) }

ResidentialLivingUnitCreateDto

frontEndGridLineNumber string

Internal value used to order list

description string

Residentail unit mix line item description

bedrooms number(double)

Number of bedrooms for this unit type

bathrooms number(double)

Number of bathrooms for this unit type

unitSize number(double)

Average square footage for this unit type

numUnits number(double)

Number of units of this type (e.g., 20 one-bedroom units)

concludedMonthlyPerUnit number(double)

concludedMonthlyPerSf number(double)

ResidentialLivingUnitDto

id string

Unique identifier for this unit line item

description string

Unit description in multifamily unit mix

bedrooms number(double)

Number of bedrooms in the unit

bathrooms number(double)

Number of bathrooms in the unit

unitSize number(double)

Square footage of the unit

numUnits number(double)

Number of units of this unit type in the unit mix

compsRevenue RevenueDto

Revenue projections based on comparable properties

concludedRevenue RevenueDto

Analyst-concluded achievable rent for this unit type

ResidentialLivingUnitPropertyUpdateDto

property string(enum)

Available enum values: Bathrooms, Bedrooms, Description, UnitSize, NumUnits, ConcludedMonthlyPerUnit, ConcludedMonthlyPerSf

value string

ResidentialLivingUnitUpdateDto

id string

Identifier of the living unit to update

updates array [ ResidentialLivingUnitPropertyUpdateDto ]

ResidentialLivingUnitsInfoDto

livingUnits array [ ResidentialLivingUnitDto ]

marketVacancy number(double)

Market vacancy rate for multi-family properties, expressed as a decimal (e.g., 0.05 = 5%)

totalSf number(double)

Total square footage of residential space

totalUnits number(double)

Total number of residential units

averageUnitSize number(double)

Average size per residential unit, in square feet

concludedTotalRevenue RevenueDto

Total annual revenue based on analyst-concluded achievable rents, in USD

compsTotalRevenue RevenueDto

Total annual revenue based on comparable property data, in USD

ResidentialRentRollComparisonDto

rentRollId string

Unique identifier for this rent roll

rentRollName string

avgMonthlyRevenuePerSf number(double)

avgMonthlyRevenuePerUnit number(double)

totalAnnualRevenue number(double)

vacancy number(double)

ResidentialRentRollCreateDto

componentId string

ID of the property component to associate this rent roll with

name string

effectiveDate string(date)

fileId string

ID of the uploaded rent roll document

comment string

rentRollItems array [ ResidentialRentRollItemCreateDto ]

ResidentialRentRollDto

id string

Unique identifier for this rent roll

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

ownerIds array [ string ]

Blooma user IDs (email addresses) with ownership access

componentId string

ID of the property component this rent roll belongs to

name string

fileId string

ID of the uploaded rent roll document

effectiveDate string(date)

Date the rent roll data is effective as of

comment string

rentRollItems array [ ResidentialRentRollItemDto ]

totalSf number(double)

Total square footage covered by the rent roll

totalUnits number(double)

Total units in the rent roll

totalMonthlyRevenue number(double)

Total monthly rent revenue, in USD

totalMonthlyRevenuePerSf number(double)

totalAnnualRevenue number(double)

Total annual rent revenue, in USD

totalAnnualRevenuePerSf number(double)

vacancy number(double)

Vacancy rate, expressed as a decimal (e.g., 0.08 = 8%)

tenantTurnover number(double)

Annual tenant turnover rate, expressed as a decimal (e.g., 0.30 = 30%)

expiringLeases map { number(double) }

unitTypeSummaryTable array [ RentRollUnitTypeSummaryDto ]

ResidentialRentRollInfoResponseDto

success boolean

Indicates whether the API request completed successfully

error ErrorDto

id string

Unique identifier for this rent roll

componentId string

ID of the property component this rent roll belongs to

name string

fileId string

ID of the uploaded rent roll document

effectiveDate string(date)

Date the rent roll data is effective as of

comment string

totalSf number(double)

Total square footage covered by the rent roll

totalUnits number(double)

Total units in the rent roll

totalMonthlyRevenue number(double)

Total monthly rent revenue, in USD

totalMonthlyRevenuePerSf number(double)

Average monthly rent per square foot, in USD

totalAnnualRevenue number(double)

Total annual rent revenue, in USD

totalAnnualRevenuePerSf number(double)

Average annual rent per square foot, in USD

vacancy number(double)

Vacancy rate calculated from the rent roll, expressed as a decimal (e.g., 0.08 = 8%)

tenantTurnover number(double)

Annual tenant turnover rate, expressed as a decimal (e.g., 0.30 = 30%)

expiringLeases map { number(double) }

unitTypeSummaryTable array [ RentRollUnitTypeSummaryDto ]

rentRollItems array [ ResidentialRentRollItemDto ]

ResidentialRentRollItemCreateDto

frontEndGridLineNumber string

unitNumber string

tenantName string

monthlyRent number(double)

unitSize number(double)

leaseStart string(date)

leaseEnd string(date)

unitType string

bedrooms number(double)

bathrooms number(double)

ResidentialRentRollItemDto

id string

Unique identifier for this rent roll line item

unitNumber string

tenantName string

monthlyRent number(double)

Monthly rent for this unit, in USD

unitSize number(double)

Square footage of this unit

leaseStart string(date)

Lease start date (ISO 8601 format: YYYY-MM-DD)

leaseEnd string(date)

Lease end date (ISO 8601 format: YYYY-MM-DD)

annualRent number(double)

Annual rent for this unit, in USD

monthlyRentPerSf number(double)

Monthly rent per square foot, in USD

annualRentPerSf number(double)

Annual rent per square foot, in USD

unitType string

bedrooms number(double)

Number of bedrooms

bathrooms number(double)

Number of bathrooms

ResidentialRentRollUpdateEntityDto

entityUpdates array [ PropertyUpdateDtoRentRollProperty ]

tablePatchData BulkOperationDtoResidentialRentRollItemCreateDtoItemUpdateDtoPropertyUpdateDtoResidentialRentRollItemProperty

RevenueDto

monthly number(double)

Monthly revenue, in USD

monthlyPerSf number(double)

Monthly revenue per square foot, in USD

monthlyPerUnit number(double)

Monthly revenue per unit, in USD

annual number(double)

Annual revenue, in USD

annualPerSf number(double)

Annual revenue per square foot, in USD

annualPerUnit number(double)

Annual revenue per unit, in USD

RevenueValuationCreateDto

mainValuation boolean

valuationsInfoId string

ID of the parent valuation container

name string

startDate string(date)

endDate string(date)

capRate number(double)

revenueSource string(enum)

Available enum values: Market, SelectedRentRoll, Alternative, ConcludedRent

capRateSource string(enum)

Available enum values: Market, Manual

vacancySource string(enum)

Available enum values: Market, RentRoll, Manual

componentsVacancies array [ ComponentVacancyDto ]

componentAlternativeRevenues array [ ComponentAlternativeRevenuesDto ]

selectedRentRolls array [ SelectedRentRollDto ]

userValuationType string

RevenueValuationDto

id string

Unique identifier for this revenue valuation scenario

capRate number(double)

Capitalization rate used to calculate property value (NOI / Cap Rate), expressed as a decimal (e.g., 0.06 = 6%)

name string

valuationsInfoId string

ID of the parent valuation container

startDate string(date)

Valuation period start date (ISO 8601 format: YYYY-MM-DD)

endDate string(date)

Valuation period end date (ISO 8601 format: YYYY-MM-DD)

expensesSourceId string

ID of the expense source valuation

userValuationType string

comment string

revenueSource string(enum)

Source of revenue data (Market, SelectedRentRoll, ConcludedRent, or Alternative)

Available enum values: Market, SelectedRentRoll, Alternative, ConcludedRent

capRateSource string(enum)

Source of cap rate (Market or Manual)

Available enum values: Market, Manual

vacancySource string(enum)

Source of vacancy assumption (Market, RentRoll, or Manual)

Available enum values: Market, RentRoll, Manual

cashFlow CashFlowInfoDto

totalValuation number(double)

Total property value calculated from this valuation scenario, in USD

parentId string

ID of the parent valuation, if this is a sub-valuation

descriptor string

archive boolean

componentsVacancies map { VacancyValueDto }

componentsSelectedRentRolls map { string }

metrics array [ ValuationMetricsDto ]

RevenueValuationReportDto

id string

Unique identifier for this revenue valuation scenario

name string

expensesSourceId string

ID of the expense source valuation

userValuationType string

comment string

revenueSource string(enum)

Available enum values: Market, SelectedRentRoll, Alternative, ConcludedRent

capRateSource string(enum)

Available enum values: Market, Manual

vacancySource string(enum)

Available enum values: Market, RentRoll, Manual

cashFlow CashFlowReportDto

totalValuation number(double)

RevenueValuationSummaryDto

id string

Unique identifier for this revenue valuation scenario

address AddressDto

name string

revenue FinancialTransactionInfoDto

vacancyAndConcessions FinancialTransactionInfoDto

otherIncome FinancialTransactionInfoDto

operatingExpenses FinancialTransactionInfoDto

belowTheLineExpense FinancialTransactionInfoDto

effectiveIncome number(double)

totalExpenses number(double)

netOperatingIncome number(double)

incomeValuation number(double)

netIncome number(double)

capRate number(double)

RevenueValuationUpdateEntityDto

entityUpdates array [ PropertyUpdateDtoRevenueValuationProperty ]

RiskDto

score string

text string

value number(double)

SaleComparableCreateDto

frontEndGridLineNumber string

name string

address AddressCreateDto

yearBuilt number(double)

yearRenovated number(double)

stories number(double)

assetClass string(enum)

Available enum values: A, AB, B, BC, C, NA

vacancy number(double)

dataAsOf string(date)

totalUnits number(double)

saleDate string(date)

salePrice number(double)

buildingArea number(double)

lotSize integer(int32)

capRate number(double)

sellerNames array [ string ]

buyerNames array [ string ]

noitotal number(double)

SaleComparableDto

id string

Unique identifier for this sales comparable property

source string

name string

address AddressDto

yearBuilt number(double)

Year the property was constructed

yearRenovated number(double)

stories number(double)

totalUnits number(double)

Total units in the comparable property

dataAsOf string(date)

vacancy number(double)

Vacancy rate at time of sale, expressed as a decimal

assetClass string(enum)

Available enum values: A, AB, B, BC, C, NA

ranking RankingDataDto

ignore boolean

updatedBy string(enum)

Available enum values: system, ignoredByUser, enabledByUser

createdByUser boolean

distance number(double)

saleDate string(date)

Date of property sale

salePrice number(double)

Property sale price, in USD

buildingArea number(double)

Building area, in square feet

lotSize integer(int32)

capRate number(double)

Capitalization rate at time of sale, expressed as a decimal (e.g., 0.055 = 5.5%)

sellerNames array [ string ]

buyerNames array [ string ]

averageUnitSize number(double)

pricePerUnit number(double)

Sale price divided by total units, in USD

pricePerSf number(double)

Sale price divided by building area, in USD per square foot

noitotal number(double)

SaleComparablesCreateDto

componentId string

ID of the property component to associate these comparables with

comparables array [ SaleComparableCreateDto ]

SaleComparablesDto

id string

Unique identifier for this sales comparables set

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

ownerIds array [ string ]

Blooma user IDs (email addresses) with ownership access

componentId string

ID of the property component these comparables belong to

lastRefreshTime string(date-time)

profileName string

comparables array [ SaleComparableDto ]

averagePricePerUnit number(double)

averagePricePerSF number(double)

averageCapRate number(double)

SaleComparablesSummaryDto

id string

Unique identifier for this sales comparables set

averagePricePerUnit number(double)

averagePricePerSF number(double)

averageCapRate number(double)

SaleComparablesUpdateEntityDto

entityUpdates array [ PropertyUpdateDtoSaleComparablesProperty ]

tablePatchData BulkOperationDtoSaleComparableCreateDtoItemUpdateDtoPropertyUpdateDtoSaleComparableProperty

SalesComparablesInfoScoreExtractDto

averagePricePerUnit number(double)

averagePricePerSF number(double)

averageCapRate number(double)

ScoreChangeDo

changeDate string(date-time)

scores array [ SeedScoreDto ]

SearchResponseDtoCommercialRentRollComparisonDto

error ErrorDto

entities array [ CommercialRentRollComparisonDto ]

success boolean

SearchResponseDtoEntityDescriptorDto

error ErrorDto

entities array [ EntityDescriptorDto ]

success boolean

SearchResponseDtoLoansPackageSummaryDto

error ErrorDto

entities array [ LoansPackageSummaryDto ]

success boolean

SearchResponseDtoRentComparablesSummaryDto

error ErrorDto

entities array [ RentComparablesSummaryDto ]

success boolean

SearchResponseDtoRentRollSummaryDto

error ErrorDto

entities array [ RentRollSummaryDto ]

success boolean

SearchResponseDtoSaleComparablesSummaryDto

error ErrorDto

entities array [ SaleComparablesSummaryDto ]

success boolean

SearchResponseDtoValuationsInfoDto

error ErrorDto

entities array [ ValuationsInfoDto ]

success boolean

SectionDto

title string

taken directly from data source as is

para string

taken directly from data source as is

SeedBreakPointsDto

maxLtv SeedBreakPointsMaxLtvDto

minDirectDSCR SeedBreakPointsMinDscrDto

minDebtYield SeedBreakPointsMinDebtYieldDto

SeedBreakPointsMaxLtvDto

minValue number(double)

minIncome number(double)

maxCapRate number(double)

maxVacancy number(double)

maxExpenses number(double)

SeedBreakPointsMinDebtYieldDto

minIncome number(double)

maxVacancy number(double)

maxExpenses number(double)

SeedBreakPointsMinDscrDto

minIncome number(double)

maxVacancy number(double)

maxExpenses number(double)

maxInterestRate number(double)

SeedCompanyDto

id string

Unique identifier for this deal-company relationship

role string(enum)

Available enum values: Borrower, Guarantor_Sponsor, Broker, ReferralIndividual

participation number(double)

financialData CompanyFinancialDataDto

SeedCreateDto

ownerId string

Blooma user ID (email address) of the deal owner

status string

state string(enum)

Available enum values: NewDeal, Originated, Completed, Rejected, Prep

priority string(enum)

Available enum values: Low, Medium, High

seedName string

description string

loanId string

Lender's internal loan identifier or tracking number

loansPackageId string

ID of the loans package to associate this deal with

customField1 string

customField2 string

loanType string(enum)

Available enum values: Unknown, Acquisition, Acquisition_Construction, Refinance, Refinance_Construction, Construction, Stabilization, Bridge, Permanent

loanPaymentStructure string(enum)

Available enum values: InterestOnly, P_I_Amortization

projectTotalCost number(double)

grossLoan number(double)

loanTerm number(double)

extensionTerm number(double)

rateSpread number(double)

interestRateFloor number(double)

indexRate number(double)

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

amortizationTerm number(double)

borrowerRequiredCloseDate string(date)

originationDate string(date)

originatedLoanAmount number(double)

maturityDateMethod string(enum)

Available enum values: Estimated, Actual

maturityDate string(date)

userDebtService number(double)

riskRating string

requestedLoanAmount number(double)

syndicatedLoan boolean

participationGrossLoan number(double)

noTrail boolean

SeedDto

id string

Unique identifier for the deal

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

ownerIds array [ string ]

Blooma user IDs (email addresses) with ownership access

state string(enum)

Available enum values: NewDeal, Originated, Completed, Rejected, Prep

status string

seedName string

Display name for the deal. Note: "seed" is legacy terminology for "deal"

description string

loanId string

Lender's internal loan identifier or tracking number

loansPackageId string

ID of the loans package this deal belongs to

priority string(enum)

Available enum values: Low, Medium, High

mainImageFileId string

ID of the primary image file for this deal

reason string

rejectNote NoteDto

loanType string(enum)

Available enum values: Unknown, Acquisition, Acquisition_Construction, Refinance, Refinance_Construction, Construction, Stabilization, Bridge, Permanent

loanPaymentStructure string(enum)

Available enum values: InterestOnly, P_I_Amortization

projectTotalCost number(double)

syndicatedLoan boolean

participationGrossLoan number(double)

Participation loan amount for syndicated loans, in USD

grossLoan number(double)

Current loan amount (unpaid principal balance for portfolio loans, or requested amount for pipeline deals), in USD

originatedLoanAmount number(double)

Original loan amount at time of origination, in USD

indexRate number(double)

rateSpread number(double)

Spread added to the index rate, expressed as a decimal. For fixed-rate loans, equals the total interest rate

interestRateFloor number(double)

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)

Total note rate, expressed as a decimal (e.g., 0.0675 = 6.75%)

loanTerm number(double)

Loan maturity term, in months

extensionTerm number(double)

remainingLoanTerm number(double)

amortizationTerm number(double)

Loan amortization period, in months

maturityDateMethod string(enum)

Available enum values: Estimated, Actual

maturityDate string(date)

ltc number(double)

Loan-to-Cost ratio, expressed as a decimal (e.g., 0.75 = 75%)

ltv number(double)

Loan-to-Value ratio, expressed as a decimal (e.g., 0.72 = 72%)

riskRating string

Internal risk rating assigned to the loan (1-8 scale, where lower numbers indicate lower risk)

cashFlow number(double)

Combined cash flow available for debt service across all borrowers, in USD

debtService number(double)

Annual debt service (principal + interest or interest-only payment), in USD

netCashFlow number(double)

Net cash flow after debt service (NOI - Debt Service), in USD

assets number(double)

liabilities number(double)

netWorth number(double)

Combined net worth of all borrowers and guarantors, in USD

netWorthRatio number(double)

liquidity number(double)

Total liquid assets available to all borrowers and guarantors, in USD

liquidityRatio number(double)

seedScoreInfo SeedScoreInfoDto

notes array [ NoteDto ]

originationDate string(date)

borrowerRequiredCloseDate string(date)

closedDate string(date)

loanTermEnding string(date)

cachedAddress AddressDto

collateralTotals CollateralTotalsDto

collateralsOrder array [ string ]

dealLTVs DealLTVsDto

valuationUsedInLtv string(enum)

Available enum values: None, Alternative, Income, Sales

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

companies map { array [ SeedCompanyDto ] }

persons map { array [ SeedPersonDto ] }

rates array [ RateDto ]

originatedSeedScore array [ SeedScoreDto ]

scoreHistory array [ ScoreChangeDo ]

globalFinancialInfo map { GlobalFinancialInfoDto }

lenderReturns LenderReturnsDto

fundsSourcesInfo FundsSourcesInfoDto

fundsUsesInfo FundsUsesInfoDto

narratives array [ NarrativeDto ]

requestedLoanAmount number(double)

customField1 string

customField2 string

customFields array [ CustomFieldDto ]

lastRefreshTime string(date-time)

dscr number(double)

Debt Service Coverage Ratio. Values > 1.0 indicate income exceeds debt obligations

ownerId string

Blooma user ID (email address) of the deal owner

SeedInfoResponseDto

success boolean

Indicates whether the API request completed successfully

error ErrorDto

id string

Unique identifier for the deal

loanId string

Lender's internal loan identifier or tracking number

seedName string

Display name for the deal. Note: "seed" is legacy terminology for "deal"

loanType string(enum)

Available enum values: Unknown, Acquisition, Acquisition_Construction, Refinance, Refinance_Construction, Construction, Stabilization, Bridge, Permanent

maturityDate string(date)

Maturity date

riskRating string

Internal risk rating assigned to the loan (1-8 scale, where lower numbers indicate lower risk)

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)

Total note rate, expressed as a decimal (e.g., 0.0675 = 6.75%)

rateSpread number(double)

Spread added to the index rate to calculate the total note rate, expressed as a decimal (e.g., 0.0225 = 2.25%). For fixed-rate loans, this equals the total interest rate

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)

Annual debt service (principal + interest or interest-only payment), in USD

companyIds array [ string ]

IDs of the company entities associated with this deal

personIds array [ string ]

IDs of the person entities associated with this deal

originatedLoanAmount number(double)

Original loan amount at time of origination, in USD

originationDate string(date)

date-time of origination

grossLoan number(double)

Current loan amount (unpaid principal balance for portfolio loans, or requested amount for pipeline deals), in USD

participationGrossLoan number(double)

Participation loan amount for syndicated loans, in USD

ltc number(double)

Loan-to-Cost ratio, expressed as a decimal (e.g., 0.75 = 75%). Used for construction and renovation financing

ltv number(double)

Loan-to-Value ratio, expressed as a decimal (e.g., 0.72 = 72%)

amortizationTerm number(double)

Loan amortization period in months

loanTerm number(double)

Loan maturity term in months

interestRateFloor number(double)

Minimum interest rate for floating-rate loans, expressed as a decimal (e.g., 0.045 = 4.5%)

collateralTotals CollateralTotalsDto

SeedPersonDto

id string

Unique identifier for this deal-person relationship

role string(enum)

Available enum values: Borrower, Guarantor_Sponsor, Broker, ReferralIndividual

participation number(double)

financialData PersonFinancialDataDto

SeedScoreDto

profileName string

mainScore number(double)

mainReason string

scoreReasons array [ SeedScoreReasonDto ]

SeedScoreEtlDto

profileName string

mainScore number(double)

mainReason string

SeedScoreInfoDto

seedScore array [ SeedScoreDto ]

selectedSeedScore SeedScoreDto

SeedScoreReasonDto

score number(double)

weight number(double)

name string

value string

contribution number(double)

displayName string

valueFormat string

subReasons array [ SeedScoreReasonDto ]

SeedSummaryDto

id string

Unique identifier for the deal

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

ownerIds array [ string ]

Blooma user IDs (email addresses) with ownership access

state string(enum)

Available enum values: NewDeal, Originated, Completed, Rejected, Prep

status string

priority string(enum)

Available enum values: Low, Medium, High

seedName string

loanType string(enum)

Available enum values: Unknown, Acquisition, Acquisition_Construction, Refinance, Refinance_Construction, Construction, Stabilization, Bridge, Permanent

loanId string

Lender's internal loan identifier or tracking number

grossLoan number(double)

originatedLoanAmount number(double)

requestedLoanAmount number(double)

seedMainAddress AddressDto

mainImageFileId string

ID of the primary image file for this deal

ltv number(double)

mainDealScore number(double)

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

originationDate string(date)

loanTerm number(double)

remainingLoanTerm number(double)

borrowerRequiredCloseDate string(date)

closedDate string(date)

maturityDateMethod string(enum)

Available enum values: Estimated, Actual

maturityDate string(date)

loansPackageId string

ID of the loans package this deal belongs to

dscr number(double)

amortizationTerm number(double)

loanPaymentStructure string(enum)

Available enum values: InterestOnly, P_I_Amortization

interestRate number(double)

valuationUsedInLtv string(enum)

Available enum values: None, Alternative, Income, Sales

debtService number(double)

incomeValuation number(double)

netOperatingIncome number(double)

ownerId string

Blooma user ID (email address) of the deal owner

SelectedRentRollDto

componentId string

ID of the component

rentRollId string

ID of the rent roll to select as primary

SingleVariableAnalysisDto

change number(double)

ltv SingleVariableLtvAnalysisDto

directDSCR SingleVariableDscrAnalysisDto

debtYield SingleVariableDebtYieldAnalysisDto

SingleVariableDebtYieldAnalysisDto

income number(double)

vacancy number(double)

expenses number(double)

SingleVariableDscrAnalysisDto

income number(double)

vacancy number(double)

expenses number(double)

SingleVariableLtvAnalysisDto

value number(double)

income number(double)

capRate number(double)

vacancy number(double)

expenses number(double)

SingleYearValue

value number(double)

StatusCreateDto

statusName string

parentState string(enum)

Available enum values: NewDeal, Originated, Completed, Rejected, Prep

StatusDto

id string

Unique identifier for this status

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

name string

order integer(int32)

parentState string(enum)

Available enum values: NewDeal, Originated, Completed, Rejected, Prep

StressTestBaselineDto

revenueBaseline number(double)

expensesBaseline number(double)

capRateBaseline number(double)

vacancyBaseline number(double)

interestRateBaseline number(double)

StressTestChangeDto

revenueChange number(double)

expensesChange number(double)

capRateChange number(double)

vacancyChange number(double)

interestRateChange number(double)

StressTestConfigurationDto

selectedStressTestType string(enum)

Available enum values: Low, Medium, High, Custom, Baseline

customStressTestValues StressTestChangeDto

StressTestErrorDto

dealId string

Unique identifier for the deal that failed stress testing

dealName string

error string

StressTestLimitsDto

maxLtv number(double)

maxDSCR number(double)

maxDebtYield number(double)

StressTestResultsDto

seedId string

Unique identifier for the deal being stress tested

fullAddress string

dealName string

grossLoan number(double)

Current loan amount, in USD

originationDate string(date)

Date the loan was originated

selectedStressTestType string(enum)

Available enum values: Low, Medium, High, Custom, Baseline

multiVariableAnalysis array [ MultiVariableAnalysisDto ]

singleVariableAnalysis array [ SingleVariableAnalysisDto ]

stressTestLimits StressTestLimitsDto

breakPoints SeedBreakPointsDto

baselines StressTestBaselineDto

SubMarketDto

marketId integer(int64)

Unique identifier for the metropolitan market

subMarketId integer(int64)

Unique identifier for this submarket within the metropolitan area

sectorId integer(int64)

Unique ID to identify the property sector of a given company under Green Street's coverage

marketPublish string

Published name of a market

subMarketPublish string

Submarket name

sectorPublish string

Property sector name

ageMedian number(double)

The median age of the population

capRateNominal number(double)

Expected first-year property yield (Nominal NOI / Property Value), expressed as a decimal (e.g., 0.055 = 5.5%)

commuteTimeMean number(double)

The mean commute time in minutes

crimeRateQuintile string

Measures the level of crime. A higher number corresponds with more crime and is a simple average of violent crime and property crime indices based on FBI data

desirability number(double)

Measures how desirable a market is to live in. Takes into account the perception of corruption, population migration trends, and climate / pollution

desirabilityQuintile string

Measures how desirable a market is to live in. This metric takes into account millennial growth patterns, weather, taxes, walkability, school rating, crime, the general health of its population, and a foodie score

employmentGrowthCivilian number(double)

Annualized job growth for civilians

grade string

Relative long-term rent growth potential for this submarket (A+ to D scale)

homeValueMedianCensus integer(int64)

Estimate of how much the property (house and lot) would sell for

housingAffordability number(double)

A measure of affluence that combines the median home price and mortgage-to-rent ratio

housingAffordabilityQuintile string

The quintile associated with Housing Affordability

incomeHhiMedianCensus number(double)

Median household income

occupancy number(double)

Submarket occupancy rate, expressed as a decimal (e.g., 0.95 = 95%)

populationDegreeCollegeCensusPct number(double)

Percentage of population 25 or older with a bachelor's or advanced degree

rankGradeId integer(int64)

Ranking of Market Grades ID metric

rentEffective number(double)

Average effective rent per unit per month (net of concessions) in this submarket, in USD

rentGrossMedian number(double)

The median gross rent level of an area reported by the US Census Bureau. This figure provides information on the monthly housing costs for renters

supplyBarrierQuintile string

The quintile associated with Green Street's Supply Barriers Score

walkScoreDescription string

Walk Score® analyzes hundreds of walking routes to nearby amenities. Points are awarded based on the distance to amenities. Amenities within a 5 minute walk are given maximum points. A decay function is used to give points to more distant amenities up to a 30 minute walk

timeStampUpdate string

The date that data was last updated

TaxAssessmentDetailsDto

isOwnerOccupied boolean

taxBillAmount number(double)

assessedValueLand number(double)

assessedValueTotal number(double)

marketValueYear number(double)

marketValueTotal number(double)

taxAssessmentYear number(double)

TokenHolder

accessToken string

idToken string

refreshToken string

tokenType string

expiresIn integer(int64)

scope string

expiresAt string(date-time)

UpdateCollateralRequestDto

propertiesToUpdates array [ CollateralPropertyUpdateDto ]

UpdateCompaniesResultsDto

updatedIds array [ string ]

IDs of the companies that were successfully updated

errors array [ UpdateEngineError ]

error string

UpdateComponentResultDto

success boolean

error string

errors array [ UpdateEngineError ]

updatedEntity unknown

UpdateDealsRequestDto

itemsToUpdate array [ DealUpdateDto ]

UpdateDealsResponseDto

success boolean

Indicates whether the API request completed successfully

error ErrorDto

errors array [ UpdateEngineError ]

updatedEntities array [ string ]

UpdateDealsResultsDto

success boolean

error string

errors array [ UpdateEngineError ]

updatedEntities array [ string ]

UpdateDefaultRatesResultDto

success boolean

error string

errors array [ UpdateEngineError ]

updatedEntity array [ RateDto ]

UpdateEngineError

id string

Identifier of the entity that failed to update

operation string(enum)

Available enum values: Create, Update, Delete

errorType string(enum)

Type of update error (e.g., IdNotFound, MissingMandatoryField, IllegalValue)

Available enum values: IdNotFound, MissingMandatoryField, IllegalValue

description string

fieldName string

UpdateLoanPricingOptionsResultDto

success boolean

error string

errors array [ UpdateEngineError ]

dealLoanOptions DealLoanPricingOptionsDto

UpdatePersonsResultsDto

updatedPersonsIds array [ string ]

IDs of the persons that were successfully updated

errors array [ UpdateEngineError ]

error string

UpdateResponseDto

success boolean

Indicates whether the API request completed successfully

error ErrorDto

UpdateResponseDtoCommercialRentRollDto

error ErrorDto

updatedEntity CommercialRentRollDto

success boolean

UpdateResponseDtoLoansPackageDto

error ErrorDto

updatedEntity LoansPackageDto

success boolean

UpdateResponseDtoRentComparablesDto

error ErrorDto

updatedEntity RentComparablesDto

success boolean

UpdateResponseDtoResidentialRentRollDto

error ErrorDto

updatedEntity ResidentialRentRollDto

success boolean

UpdateResponseDtoSaleComparablesDto

error ErrorDto

updatedEntity SaleComparablesDto

success boolean

UpdateResponseDtoValuationsInfoDto

error ErrorDto

updatedEntity ValuationsInfoDto

success boolean

UpdateResultDtoBaseEntityDto

success boolean

error string

errors array [ UpdateEngineError ]

updatedEntity BaseEntityDto

UpdateResultDtoCollateralDto

success boolean

error string

errors array [ UpdateEngineError ]

updatedEntity CollateralDto

UpdateResultDtoCompanyDto

success boolean

error string

errors array [ UpdateEngineError ]

updatedEntity CompanyDto

UpdateResultDtoDealFundsInfoDto

success boolean

error string

errors array [ UpdateEngineError ]

updatedEntity DealFundsInfoDto

UpdateResultDtoPersonDto

success boolean

error string

errors array [ UpdateEngineError ]

updatedEntity PersonDto

UpdateResultDtoSeedDto

success boolean

error string

errors array [ UpdateEngineError ]

updatedEntity SeedDto

UploadCashFlowRequest

dealId string

ID of the deal to upload cash flow for

ownerId string

Blooma user ID (email address) of the entity owner

comment string

periods array [ string(enum) ]

years array [ string ]

file string(binary)

uploadOrigin string(enum)

Available enum values: OMDeal, DealFileUpload, ContactFileUpload

UserDto

email string

name string

roles array [ string(enum) ]

notificationsId string

Notifications service identifier for this user

knowiToken string

UserSummaryDto

email string

name string

UserValuationTypeCreateDto

name string

UserValuationTypeDto

id string

Unique identifier for this user valuation type

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

name string

order integer(int32)

VacancyValueDto

amountValue number(double)

Vacancy as a dollar amount, in USD

percentageValue number(double)

Vacancy as a percentage of revenue, expressed as a decimal (e.g., 0.05 = 5%)

ValuationMetricsDto

dealId string

ID of the deal this valuation applies to

dscr number(double)

Debt Service Coverage Ratio for this valuation scenario. Values > 1.0 indicate income exceeds debt obligations

ltv number(double)

Loan-to-Value ratio for this valuation scenario, expressed as a decimal (e.g., 0.72 = 72%)

debtYield number(double)

Debt yield (NOI / Loan Amount) for this valuation scenario, expressed as a percentage

ValuationTemplateDto

id string

Unique identifier for this valuation template

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

ownerIds array [ string ]

Blooma user IDs (email addresses) with ownership access

collateralIndex integer(int32)

valuationIndex integer(int32)

name string

startDate string(date)

endDate string(date)

capRate number(double)

comment string

userValuationType string

cashFlow array [ CashFlowTransactionTemplateDto ]

componentsSelectedRentRolls map { string }

collateralId string

ID of the collateral property

ValuationsInfoCreateDto

collateralId string

ID of the collateral property to create valuations for

salesValuation number(double)

mainAlternativeValuationId string

ID of the valuation to designate as the primary alternative valuation

mainIncomeValuationId string

ID of the valuation to designate as the primary income valuation

marketCapRate number(double)

dcfModel DcfModelDto

ValuationsInfoDto

id string

Unique identifier for this valuation container

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

ownerIds array [ string ]

Blooma user IDs (email addresses) with ownership access

collateralId string

ID of the collateral property this valuation applies to

marketCapRate number(double)

Market-derived capitalization rate, expressed as a decimal (e.g., 0.055 = 5.5%)

mainIncomeValuationCapRate number(double)

Cap rate used in the primary income valuation, expressed as a decimal

marketValuation RevenueValuationDto

Property value using market cap rate, in USD

salesValuation number(double)

Property value from sales comparables, in USD

mainIncomeValuationId string

ID of the primary income-based valuation scenario

mainAlternativeValuationId string

ID of the primary alternative valuation (e.g., appraisal)

mainAlternativeValuation number(double)

Primary alternative valuation (e.g., appraisal), in USD

mainAlternativeValuationDate string(date)

Date of the primary alternative valuation

capRateLastModifiedTime string(date)

rentRollRevenues map { number(double) }

componentTotals ComponentTotalsDto

revenueValuations array [ RevenueValuationDto ]

alternativeValuations array [ AlternativeValuationDto ]

dcfModel DcfModelDto

ValuationsInfoEtlDto

id string

Unique identifier for this valuation container

lastModifiedTime string(date-time)

modifiedBy string

creationTime string(date-time)

createdBy string

migrationReference string

ownerIds array [ string ]

Blooma user IDs (email addresses) with ownership access

collateralId string

ID of the collateral property

marketCapRate number(double)

mainIncomeValuationCapRate number(double)

salesValuation number(double)

mainIncomeValuationId string

ID of the primary income-based valuation scenario

mainAlternativeValuationId string

ID of the primary alternative valuation

mainAlternativeValuation number(double)

mainAlternativeValuationDate string(date)

ValuationsInfoReportDto

id string

Unique identifier for this valuation container

collateralId string

ID of the collateral property

mainIncomeValuationId string

ID of the primary income-based valuation scenario

mainAlternativeValuationId string

ID of the primary alternative valuation

revenueValuations array [ RevenueValuationReportDto ]

alternativeValuations array [ AlternativeValuationReportDto ]

cashFlows array [ CashFlowReportDto ]

ValuationsInfoScoreExtractDto

id string

Unique identifier for this valuation container

ValuationsInfoSummaryDto

collateralId string

ID of the collateral property

valuationsInfoId string

Unique identifier for this valuation container

ValuationsInfoUpdateEntityDto

entityUpdates array [ PropertyUpdateDtoValuationsInfoProperty ]

WeightedAvgsDto

totalUnitsForUnitType number(double)

avgUnits number(double)

avgSF number(double)

avgAskingRent number(double)

avgPriceSF number(double)

totalMonthlyRent number(double)

totalAnnualRent number(double)

YearlyGrowthUpdateDto

updateValues map { number(double) }