Zamok Kiosk API
    Preparing search index...
    • Parameters

      • state: {
            shelby: {
                achAccountHolderInfo: null | AchAccountHolderInfo;
                bills: BillItem[];
                billsLoading: boolean;
                lookupState: LookupState;
                parcels: SearchResultItem[];
                paymentContactInfo: null | ContactInfo;
                paymentPreviews: ShelbyPaymentPreviews;
                paymentRecording: { error?: string; loading: boolean; recorded: boolean };
                taxBillInfo: TaxBillInfoState;
                taxBills: TaxBill[];
                workflows: ShelbyWorkflowsState;
            };
        }

      Returns {
          achAccountHolderInfo: null | AchAccountHolderInfo;
          bills: BillItem[];
          billsLoading: boolean;
          lookupState: LookupState;
          parcels: SearchResultItem[];
          paymentContactInfo: null | ContactInfo;
          paymentPreviews: ShelbyPaymentPreviews;
          paymentRecording: { error?: string; loading: boolean; recorded: boolean };
          taxBillInfo: TaxBillInfoState;
          taxBills: TaxBill[];
          workflows: ShelbyWorkflowsState;
      }

      • achAccountHolderInfo: null | AchAccountHolderInfo

        Stores ACH account-holder and bank-account input, or null.

        The object includes holder names, routing/account numbers, optional input sources, checkKept, and scanInProgress. Clear, lookup, and session-reset actions restore null.

      • bills: BillItem[]

        Stores display-ready BillItem[] for the selected property.

        Each item is { id, year, amount, parcelId?, notPayable? }. loadBills replaces the array. Selecting another property, submitting a lookup, or resetting the session clears it.

      • billsLoading: boolean

        Indicates whether bills are loading for the selected property.

        A property with an id sets this state to true. loadBills, loadBillsFailure, and sessionReset set it to false.

      • lookupState: LookupState

        Tracks property lookup progress as { loading: boolean, error?: string }.

        submitLookup starts loading, loadParcels completes successfully, loadParcelsFailure stores its error, and sessionReset restores { loading: false }.

      • parcels: SearchResultItem[]

        Stores SearchResultItem[] returned by the active lookup.

        loadParcels replaces the array. submitLookup and sessionReset clear it. Each item has id, address, amountOwed, and optional property labels.

      • paymentContactInfo: null | ContactInfo

        Stores payer contact data or null.

        Contact data has optional nullable firstName, lastName, email, and phone. setPaymentContactInfo replaces it; clearing contact data, submitting another lookup, or resetting the session restores null.

      • paymentPreviews: ShelbyPaymentPreviews

        Stores card-fee previews as { loading, amountInCents?, credit?, debit?, error? }.

        A request stores its amount and starts loading; success stores credit/debit previews; failure stores the amount and error. Clearing previews, changing property or lookup context, and sessionReset restore { loading: false }.

      • paymentRecording: { error?: string; loading: boolean; recorded: boolean }

        Tracks Shelby payment recording as { loading: boolean, recorded: boolean, error?: string }.

        recordPaymentWithShelby starts recording. PAY_BILL_SUCCESS or PAY_BILL_FAILURE completes it only while loading is true; the local failure action always stores its error. Contact clearing, recording reset, a new lookup, and sessionReset restore the initial state.

      • taxBillInfo: TaxBillInfoState

        Stores the current property, bill ID, and formatted payment amount.

        State is { selectedProperty?: SearchResultItem, selectedBillId?: string, selectedAmount?: string }. Selecting a property also clears selectedBillId. clearTaxBillInfo, submitLookup, and sessionReset restore all properties to undefined.

      • taxBills: TaxBill[]

        Stores the complete PayIt TaxBill[] records corresponding to bills.

        loadBills stores payload.taxBills. Selecting another property, submitting a lookup, or resetting the session clears the array.

      • workflows: ShelbyWorkflowsState

        Stores { paperBillWorkflowOpen?, billLookupWorkflowOpen? } modal flags.

        Each toggle action inverts its corresponding flag. closeBillLookupWorkflow only closes bill lookup, and sessionReset restores both flags to false.