System Field Dictionary & Validation Matrix¶

Purpose¶

This technical reference catalogs all core user interface fields, data types, validation regexes, and statutory constraints across the deal creation, extension, payback, and reconciliation modules in Cashy-Hub.

1. Deal Creation Fields¶

Customer¶

Field Name	Property Key	Field Type	Mandatory?	UI Control	Validation & Constraints
Customer Type	`customer.type`	Selection	Yes	Radio Group	Choose `Guest`, `Create New`, or `Registered`.
Search Customer	—	Text	No	Search Input	Triggers customer lookup as you type name, email, or phone.
First Name	`customer.firstname`	Text	Conditional	Text Input	Required for `Create New` or `Registered`; optional for `Guest`.
Last Name	`customer.lastname`	Text	Conditional	Text Input	Required for `Create New` or `Registered`; optional for `Guest`.
Email *	`customer.email`	Text	Yes	Email Input	Valid email address format. Required for all customer types.
Phone (Optional)	`customer.phone`	Text	No	Telephone Input	Optional contact telephone number.

Deal Metadata¶

Field Name	Property Key	Field Type	Mandatory?	UI Control	Validation & Constraints
Company *	`company`	Dropdown	Yes	Dropdown	Select operating company.
Branch / Shop *	`branch`	Dropdown	Yes	Dropdown	Filtered based on selected company.
DEAL TYPE	`dealType`	Selection	Yes	Toggle Button	`Pawn` or `Purchase`.
Pawn Duration (days)	`duration`	Number	Yes	Number Input	Pawn AT: Minimum 30 days. Pawn DE: Minimum 90 days. Purchase: Locked to `0` days.
Due Date (Task)	`dueDate`	Date	System	Date Display	Automatically calculated: `bookingDate + duration`.

Items¶

Field Name	Property Key	Field Type	Mandatory?	UI Control	Validation & Constraints
Category *	`category`	Selector	Yes	Category Picker	Vehicle Exclusivity: Vehicle categories cannot be mixed with non-vehicle categories.
Item Title *	`title`	Text	Yes	Text Input	Collateral headline description (cannot be left empty).
VIN *	`vin`	Text	Conditional	Text Input	Exactly 17 alphanumeric characters (mandatory for motor vehicles).
Market Value *	`marketValue`	Amount (€)	Yes	Number Input	Estimated second-hand market value.
Calculated Payout	`calculatedPayout`	Amount (€)	System	Read-only Text	Automated loan calculation based on company loan-to-value percentage.
Payout *	`payout`	Amount (€)	Yes	Number Input	Disbursed loan principal. Minimum € 100.01 for pawns (credit is not allowed under € 100.00).
Storage Label	`storageLabel`	Text	No	Text Input	Physical vault shelf, bin, or parking space label (e.g. `BOX-B12`).

Transport & Payout¶

Field Name	Property Key	Field Type	Mandatory?	UI Control	Validation & Constraints
Transport Method *	`transportMethod`	Dropdown	Yes	Dropdown	`Shop` (in-store counter) or `Shipment` (logistics delivery).
Preferred Payout Method *	`payoutMethod`	Dropdown	Yes	Dropdown	`Cash`, `Bank Transfer`, or `Paypal`.
IBAN *	`iban`	Text	Conditional	Text Input	Standard International Bank Account Number format. Mandatory if payout method is `Bank Transfer`.
Paypal Address *	`paypalAddress`	Text	Conditional	Email Input	Valid email address. Mandatory if payout method is `Paypal`.

Additional Notes¶

Field Name	Property Key	Field Type	Mandatory?	UI Control	Validation & Constraints
Notes	`comment`	Text	No	Multiline Box	Optional special handling instructions or customer notes (4 lines).

2. Deal Extension Fields¶

Field Name	Property Key	Field Type	Mandatory?	Validation & Constraints
Duration (Months)	`durationMonths`	Number	Yes	Extension term selection (e.g. 1, 2, or 3 months).
Loan Adjustment	`adjustmentType`	Selection	Yes	Choose between `No Adjustment`, `Partial Redemption` (pay down principal), or `Additional Payout` (borrow more).
Redemption Amount	`redemptionAmount`	Amount (€)	Conditional	Mandatory if adjustment type is Partial Redemption.
Additional Payout	`additionalPayoutAmount`	Amount (€)	Conditional	Mandatory if adjustment type is Additional Payout.
Parent Fees Due Today	`parentFeesDueToday`	Amount (€)	Yes	Accrued interest and storage fees that must be settled today.
Next Contract Fee Rate	`nextContractChildFeeRate`	Dropdown	Yes	Approved rate tier for the renewal period (e.g. Standard (4% / month)).
Allow online extension	`allowOnlineExtension`	Toggle	No	Controls whether the customer can extend this contract digitally online.
Payment Type	`paymentType`	Selection	Yes	Customer payment method for settling fees today (`Cash`, `Card`, etc.).
Select CashBook	`cashBook`	Dropdown	Yes	Active branch CashBook drawer to record payment.

3. Deal Payback Fields¶

Field Name	Property Key	Field Type	Mandatory?	Validation & Constraints
Adjusted Fees	`adjustedFees`	Amount (€)	No	Defaults to accrued interest and fees. Can be adjusted downward for approved waivers or discounts.
Notes	`notes`	Text	Conditional	Mandatory if fees are adjusted: The Continue button remains disabled until an audit justification is typed.
Remove items from storage automatically	`removeItems`	Toggle	Yes	Defaults to enabled (automatically releases collateral from vault storage).
Payment Type	`paymentType`	Selection	Yes	Customer payment method for redemption (`Cash`, `Card`, etc.).
Select CashBook	`cashBook`	Dropdown	Yes	Active branch CashBook drawer to record payback settlement.