Proforma Sources | 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`
`sourceType`	`enum`	Required	source Type Values: `equity`, `senior_debt`, `mezzanine_debt`, `preferred_equity`, `seller_financing`, `other`
`name`	`string`	Required	name
`amount`	`string`	Optional	amount
`percentOfTotal`	`string`	Optional	percent Of Total
`interestRate`	`string`	Optional	interest Rate
`termMonths`	`number`	Optional	term Months
`originationFee`	`string`	Optional	origination Fee
`exitFee`	`string`	Optional	exit Fee
`fundingSchedule`	`string`	Optional	funding Schedule
`notes`	`string`	Optional	notes
`displayOrder`	`number`	Optional	display Order
`createdAt`	`datetime`	Optional	Creation timestamp (auto)
`updatedAt`	`datetime`	Optional	Last update timestamp (auto)