Skip to content

Deal Checkpoints Configuration

Purpose

This administrative guide details how to configure custom business checkpoints and connect central Cashy deal status triggers to store workflow milestones in Cashy-Hub under Org Settings (/org-settings).


1. Navigating to Deal Checkpoints

  1. Click the Settings gear icon in the persistent top navigation bar (restricted to users with superadmin privileges).
  2. Select Org Settings from the dropdown.
  3. In the left navigation sidebar of /org-settings, select the Deal Checkpoints tab (deal_checkpoints).

2. Checkpoints Table Structure

The Checkpoints management console displays all active milestone mappings:

Column Header Visual Presentation Description
CHECKPOINT NAME Bold Title + ID: {checkpointName} The business milestone label displayed on Kanban cards and wizard stages (e.g. Appraisal Complete, Vault Locked).
TRIGGER STATUS Sequence of badges with arrows (PILL → PILL) The underlying central Cashy deal statuses that trigger or satisfy this checkpoint (e.g. PAYED_AND_STORED → PENDING_PAYBACK).
ACTIONS Edit & Delete Icon Buttons Modify trigger mapping or remove obsolete checkpoints.

3. Creating a Deal Checkpoint (CreateDealCheckpointModal)

  1. Click the primary button: + Create Checkpoint.
  2. Complete the modal form:
  3. Checkpoint Name *: Enter the human-readable stage name.
  4. Internal Identifier *: Unique camelCase or snake_case key.
  5. Deal Status Triggers *: Select one or more system deal status codes from the multi-select dropdown that should advance a deal into this checkpoint.
  6. Stage Sequence: Configure transition sequence ordering.
  7. Click Save Checkpoint.
  8. The system updates the table and dispatches an updateDealCheckpointsCount custom event to refresh sidebar counters.