Proforma Cash Flows | 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)
`proformaId`	`uuid`	Required	proforma Id Related resource: `proformas`
`periodStart`	`string`	Required	period Start
`periodEnd`	`string`	Required	period End
`periodLabel`	`string`	Required	period Label
`periodIndex`	`number`	Required	period Index
`isConstruction`	`boolean`	Optional	is Construction
`isOperating`	`boolean`	Optional	is Operating
`isSale`	`boolean`	Optional	is Sale
`grossPotentialRent`	`string`	Optional	gross Potential Rent
`vacancyLoss`	`string`	Optional	vacancy Loss
`effectiveGrossIncome`	`string`	Optional	effective Gross Income
`otherIncome`	`string`	Optional	other Income
`totalRevenue`	`string`	Optional	total Revenue
`operatingExpenses`	`string`	Optional	operating Expenses
`managementFee`	`string`	Optional	management Fee
`totalExpenses`	`string`	Optional	total Expenses
`netOperatingIncome`	`string`	Optional	net Operating Income
`capitalCalls`	`string`	Optional	capital Calls
`loanDraws`	`string`	Optional	loan Draws
`developmentSpend`	`string`	Optional	development Spend
`interestPayment`	`string`	Optional	interest Payment
`principalPayment`	`string`	Optional	principal Payment
`totalDebtService`	`string`	Optional	total Debt Service
`saleProceeds`	`string`	Optional	sale Proceeds
`saleCosts`	`string`	Optional	sale Costs
`loanPayoff`	`string`	Optional	loan Payoff
`netSaleProceeds`	`string`	Optional	net Sale Proceeds
`cashFlowBeforeDebt`	`string`	Optional	cash Flow Before Debt
`cashFlowAfterDebt`	`string`	Optional	cash Flow After Debt
`equityCashFlow`	`string`	Optional	equity Cash Flow
`cumulativeEquityCashFlow`	`string`	Optional	cumulative Equity Cash Flow
`notes`	`string`	Optional	notes
`createdAt`	`datetime`	Optional	Creation timestamp (auto)
`updatedAt`	`datetime`	Optional	Last update timestamp (auto)