RetailHardHat Developer docs

REST API documentation

Permit Payments

Fee payments associated with permits

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)
permitIduuidRequiredpermit Id

Related resource: permits

amountstringRequiredamount
paymentDatedatetimeOptionalpayment Date
dueDatedatetimeOptionaldue Date
paymentMethodstringOptionalpayment Method
statusenumOptionalstatus

Values: pending, paid, overdue, waived

descriptionstringRequireddescription
receiptNumberstringOptionalreceipt Number
notesstringOptionalnotes
createdAtdatetimeOptionalCreation timestamp (auto)
updatedAtdatetimeOptionalLast update timestamp (auto)