Deal Distribution Packages | 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)
`distributionId`	`uuid`	Required	distribution Id Related resource: `dealDistributions`
`documentType`	`enum`	Required	document Type Values: `proforma_presentation`, `executive_summary`, `financials`, `site_plan`, `floor_plan`, `market_study`, `environmental`, `title_report`, `survey`, `lease_abstract`, `rent_roll`, `other`
`documentName`	`string`	Required	document Name
`documentUrl`	`string`	Optional	document Url
`storageKey`	`string`	Optional	storage Key
`documentVersion`	`number`	Optional	document Version
`originalDocumentId`	`uuid`	Optional	original Document Id
`fileHash`	`string`	Optional	file Hash
`fileSize`	`number`	Optional	file Size
`displayOrder`	`number`	Optional	display Order
`isRequired`	`boolean`	Optional	is Required
`createdAt`	`datetime`	Optional	Creation timestamp (auto)