RetailHardHat Developer docs

REST API documentation

Proforma Scenarios

What-if scenarios for pro forma analysis

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.

FieldTypeModel requirementDescription
idstringOptionalUnique identifier (auto-generated)
dealIduuidRequireddeal Id
namestringRequiredname
descriptionstringOptionaldescription
baseProformaIduuidRequiredbase Proforma Id
comparisonProformaIdsarrayOptionalcomparison Proforma Ids
sensitivityVariablestringOptionalsensitivity Variable
sensitivityRangejsonOptionalsensitivity Range
createdBystringOptionalcreated By
createdAtdatetimeOptionalCreation timestamp (auto)
updatedAtdatetimeOptionalLast update timestamp (auto)