Proformas | RetailHardHat REST API docs

Supported operations

This resource provides field metadata only. No dedicated CRUD endpoint is advertised.

Field reference

Required means required by the underlying data model, not necessarily caller-supplied. The server derives protected identity and ownership fields; endpoint validation controls which fields are accepted. Sensitive credential fields are omitted here.

Field	Type	Model requirement	Description
`id`	`string`	Optional	Unique identifier (auto-generated)
`dealId`	`uuid`	Required	deal Id Related resource: `deals`
`budgetId`	`uuid`	Optional	budget Id
`forecastId`	`uuid`	Optional	forecast Id
`name`	`string`	Required	name
`version`	`number`	Optional	version
`status`	`enum`	Optional	status Values: `draft`, `pending_review`, `ic_approved`, `rejected`, `finalized`, `superseded`
`isCurrent`	`boolean`	Optional	is Current
`scenarioType`	`enum`	Optional	scenario Type Values: `base_case`, `upside`, `downside`, `alternative`, `sensitivity`
`parentProformaId`	`uuid`	Optional	parent Proforma Id
`acquisitionDate`	`string`	Optional	acquisition Date
`constructionStartDate`	`string`	Optional	construction Start Date
`constructionEndDate`	`string`	Optional	construction End Date
`stabilizationDate`	`string`	Optional	stabilization Date
`exitDate`	`string`	Optional	exit Date
`holdPeriodMonths`	`number`	Optional	hold Period Months
`cashFlowPeriodType`	`enum`	Optional	cash Flow Period Type Values: `monthly`, `quarterly`, `annual`
`cashFlowStartDate`	`string`	Optional	cash Flow Start Date
`cashFlowEndDate`	`string`	Optional	cash Flow End Date
`grossPotentialRent`	`string`	Optional	gross Potential Rent
`rentPerSF`	`string`	Optional	rent Per S F
`rentPerUnit`	`string`	Optional	rent Per Unit
`annualRentEscalation`	`string`	Optional	annual Rent Escalation
`vacancyRate`	`string`	Optional	vacancy Rate
`collectionLoss`	`string`	Optional	collection Loss
`otherIncome`	`string`	Optional	other Income
`otherIncomeNotes`	`string`	Optional	other Income Notes
`exitCapRate`	`string`	Optional	exit Cap Rate
`salePrice`	`string`	Optional	sale Price
`saleCostsPercent`	`string`	Optional	sale Costs Percent
`operatingExpenses`	`string`	Optional	operating Expenses
`expensePerSF`	`string`	Optional	expense Per S F
`expensePerUnit`	`string`	Optional	expense Per Unit
`expenseRatio`	`string`	Optional	expense Ratio
`annualExpenseEscalation`	`string`	Optional	annual Expense Escalation
`managementFeePercent`	`string`	Optional	management Fee Percent
`totalDevelopmentCost`	`string`	Optional	total Development Cost
`landAcquisitionCost`	`string`	Optional	land Acquisition Cost
`hardCosts`	`string`	Optional	hard Costs
`softCosts`	`string`	Optional	soft Costs
`financingCosts`	`string`	Optional	financing Costs
`contingency`	`string`	Optional	contingency
`seniorLoanAmount`	`string`	Optional	senior Loan Amount
`seniorLtc`	`string`	Optional	senior Ltc
`seniorInterestRate`	`string`	Optional	senior Interest Rate
`seniorTermMonths`	`number`	Optional	senior Term Months
`seniorOriginationFee`	`string`	Optional	senior Origination Fee
`seniorExitFee`	`string`	Optional	senior Exit Fee
`mezzLoanAmount`	`string`	Optional	mezz Loan Amount
`mezzInterestRate`	`string`	Optional	mezz Interest Rate
`mezzTermMonths`	`number`	Optional	mezz Term Months
`preferredEquityAmount`	`string`	Optional	preferred Equity Amount
`preferredReturn`	`string`	Optional	preferred Return
`totalEquity`	`string`	Optional	total Equity
`sponsorEquity`	`string`	Optional	sponsor Equity
`investorEquity`	`string`	Optional	investor Equity
`promoteFeePercent`	`string`	Optional	promote Fee Percent
`projectIrr`	`string`	Optional	project Irr
`equityIrr`	`string`	Optional	equity Irr
`equityMultiple`	`string`	Optional	equity Multiple
`cashOnCash`	`string`	Optional	cash On Cash
`totalProfit`	`string`	Optional	total Profit
`developmentSpread`	`string`	Optional	development Spread
`totalSources`	`string`	Optional	total Sources
`totalUses`	`string`	Optional	total Uses
`sourcesUsesBalanced`	`boolean`	Optional	sources Uses Balanced
`keyAssumptions`	`string`	Optional	key Assumptions
`riskFactors`	`string`	Optional	risk Factors
`notes`	`string`	Optional	notes
`submittedBy`	`string`	Optional	submitted By
`submittedAt`	`datetime`	Optional	submitted At
`approvedBy`	`string`	Optional	approved By
`approvedAt`	`datetime`	Optional	approved At
`rejectedBy`	`string`	Optional	rejected By
`rejectedAt`	`datetime`	Optional	rejected At
`rejectionReason`	`string`	Optional	rejection Reason
`finalizedBy`	`string`	Optional	finalized By
`finalizedAt`	`datetime`	Optional	finalized At
`createdBy`	`string`	Optional	created By
`createdAt`	`datetime`	Optional	Creation timestamp (auto)
`updatedAt`	`datetime`	Optional	Last update timestamp (auto)