Documentation
Set up your workspace, run deals in bank or cash mode, and share read-only portal access—using the same terms you see in the app.
Start here
Who this documentation is for
This guide explains how EazyBroker works end to end—for brokers running a workspace and for parties using the read-only portal. It follows the same labels and flows you see inside the app.
Brokers
You manage lenders, borrowers, transactions, interest, bills, and ledgers from the dashboard. Read Part 1 before creating your first deal.
Parties (lenders & borrowers)
If your broker gave you portal credentials, Part 2 explains what you can see and where to find balances, deals, and bills—without access to the broker's full workspace.
Workflow
Recommended order of operations
The fastest path to a working desk is settings first, then parties, then transactions. Skipping settings—especially transaction mode and interest rules—means rework later.
The spine
- Create your broker account and workspace.
- Configure workspace settings (mode, timezone, interest, brokerage defaults).
- Add parties—lenders and borrowers—with the right details for your mode.
- Create transactions on the Deal Sheet.
- Settle interest (and brokerage or letters, depending on mode).
- Use Ledger, Bills, Messages, and Automations as your book grows.
Mode is locked after the first transaction
Transaction mode—Bank mode (direct lender-borrower) or Cash mode (broker-mediated)—can only be changed before the first transaction is created. Choose the mode that matches how your desk actually operates.
Step 1
Create account & workspace
Registration creates your broker login and a default workspace tied to your username.
Registration
- Open Get started on the marketing site or log in and switch to register.
- Provide name, username, email, and password. An optional referral code may apply credits.
- Your default workspace opens at /w/{username}/dashboard.
Before you operate
- Verify your email when prompted—dashboard access may be gated until verification completes.
- An active subscription is required for full dashboard use.
- You can own up to five workspaces; additional workspaces are created from Settings or the workspace switcher.
Workers (optional)
Under Settings → Workers, create staff logins with per-page read, write, delete, and undo permissions. Workers see only the pages you allow—useful when clerks handle Deal Sheet entry but should not touch settings.
Step 2 — critical
Configure settings first
Settings define how dates, interest, brokerage, and bills behave for your region and desk style. Configure these before adding parties or creating transactions.
Account & security
- Passkeys and login OTP protect your broker account.
- Set these up before sharing workspace access with workers.
Appearance
- Accent colour, sidebar layout, table density—personal display preferences on your device.
Workspace & display
- Time zone aligns deal dates and schedules with where you operate.
- Currency decimals and tenor labels control how amounts and periods appear.
- Company profile links to branding used on bills and exports.
Transactions
- Operating mode: Bank mode (direct lender-borrower) or Cash mode (broker-mediated). This is the most important choice—it changes navigation, interest settlement, and whether Brokerage or Letters modules appear.
- Separate lenders and borrowers: when enabled, pickers and lists split by party position.
- Brokerage defaults: total brokerage %, validity days, and lender/borrower share splits apply to new deals unless overridden.
Daily cash flow
- Enable the physical cash notebook module and set the running-balance baseline date if you track float outside bank rails.
Interest
- Interest formula, compounding, TDS rules (bank mode), rate input mode, and payment grace days.
- TDS is disabled in cash mode; configure TDS only when running bank mode.
Sharing & access
- Control who can join this workspace and linked workspaces on your login.
Bills calendar
- Optional pseudo-calendar labels on printed bills—for example Vikram Samvat-style overlays alongside Gregorian dates.
Workers
- Create staff accounts with limited permissions per dashboard page.
Match settings to your location
Set time zone and calendar preferences to match how your market talks about dates. Bills and pseudo-date ribbons pull from these settings.
Operating modes
Bank mode vs cash mode
EazyBroker supports two desk styles. The mode you pick in Settings → Transactions shapes navigation, interest math, settlement screens, and which modules appear.
Bank mode (direct lender-borrower)
- Lender and borrower deal directly; the broker tracks and earns brokerage.
- Single interest rate on each transaction.
- TDS applies when both parties are marked TDS applicable.
- Brokerage page is visible—track lender and borrower brokerage separately with receipts and analytics.
- Letters page is hidden.
- Party bank details appear on bills.
- Interest settlement is unified: net after TDS, full payment only.
Cash mode (broker-mediated)
- The broker sits between lender and borrower; money and paper flow through the desk.
- Separate lender and borrower interest rates; broker spread is the difference.
- TDS is disabled in cash mode.
- Letters page is visible—track letters of exchange through the chain.
- Brokerage page is hidden; brokerage is handled through cash-interest settlement, not a separate ops workspace.
- Party bank details are not used on bills or in workflows.
- Interest settlement is per side: borrower interest received and lender interest paid separately.
Step 3
Create parties
Parties are lender and borrower contacts you manage—they are not login accounts for the broker application unless you separately enable the party portal.
Party positions
- Lender: funds are lent out through your book.
- Borrower: funds are borrowed.
- Both (universal): one contact can act as lender or borrower on different deals.
What to capture
- Name, false name, phone, email, PAN, notes, and category.
- TDS applicable flag (bank mode only—used when both sides are flagged).
- Bank details: required for bill print surfaces in bank mode; not used in cash mode.
Bulk import
Import parties from CSV. Cash-mode workspaces require lender_rate_percent and borrower_rate_percent columns on transaction imports; party import follows the standard column set.
Parties vs portal logins
Creating a party does not give them app access. Portal access is optional and configured on the party edit form after purchasing Party Portal Access in the Store.
Step 4
Deal Sheet & transactions
The Deal Sheet is your primary operations surface—create new deals, review deals for a date, and renew or close maturing deals without losing chain context.
Creating a transaction
- Pick lender and borrower parties, principal, tenor, and rates (single rate in bank mode; lender and borrower rates in cash mode).
- Brokerage amounts and validity follow your workspace defaults unless you override per deal.
- Saving creates the transaction chain root and schedules interest from your Interest settings.
After creation
- Interest schedules appear under Interest.
- Ledger entries record principal and charge movements.
- Bills can be generated for demand notices and settlement paperwork.
- In cash mode, letter tracking attaches to the chain for letters of exchange.
Renewals and closures
Renew maturing deals from the Deal Sheet without rebuilding context in a spreadsheet. The chain preserves history across renewals—important for letters in cash mode (one letter per chain).
Bank mode
Settlement after the deal (bank mode)
Bank modeIn bank mode, interest and brokerage are settled through dedicated workspaces after deals are running.
Interest
- Open Interest for schedules, overdue buckets, and settlement.
- Interest settlement is a single card: net after TDS, full payment only.
- TDS lines appear when both lender and borrower are marked TDS applicable.
Brokerage
- The Brokerage page tracks lender-side and borrower-side brokerage independently.
- Record receipts, view summary and analytics, and reconcile follow-ups in one place.
- Brokerage defaults from Settings → Transactions apply unless overridden per transaction.
Ledger & bills
- Ledger is the canonical narrative—every movement tied to a transaction, filterable and exportable.
- Bills show charges & settlement with ratePercent and bank columns from party records.
- Printed bills show full transaction notes, and when interest is paid: paid status, payment date, and optional payment remark (no Due/Unpaid text on print).
Cash mode
Settlement after the deal (cash mode)
Cash modeIn cash mode, the broker mediates interest and paper. Settlement is per side, and letters track formal exchange alongside the ledger.
Interest
- Borrower interest received and lender interest paid are settled separately.
- Net payable, full payment only—no unified TDS card.
- Broker spread is embedded in the rate difference between lender and borrower sides.
Letters
- Letters of exchange: borrower letter received when loan goes to lender; lender letter returned when the chain is fully repaid.
- One letter per chain across renewals—the chain root carries letter status.
- Track borrowerLetterReceived and lenderLetterReturned with dates, reference, and notes.
Brokerage in cash mode
Brokerage is not tracked on a separate Brokerage page. Per-transaction brokerage amounts still exist, but settlement flows through cash-interest handling. Use Interest and Deal Sheet for operational follow-up.
Ledger wording
Ledger entries use broker-mediated labels—for example interest paid to broker and interest received from broker—reflecting that cash flows through your desk.
Reference
Dashboard page reference
Every item in the sidebar serves a specific purpose. Some pages appear only in certain modes or after purchasing add-ons in the Store.
Core operations
- Overview — cockpit for principal at risk, interest due, brokerage, maturities, and recent activity.
- Parties — counterparty management, categories, rate monitor, CSV import.
- Deal Sheet — transaction grid, renewals, and date-based review.
Money & paper
- Brokerage — bank mode only; receipts, summary, analytics.
- Interest — schedules, settlement, analytics.
- Ledger — canonical movement narrative, exportable.
- Bills — print and demand notices.
- Daily cash flow — optional physical float notebook.
- Letters — cash mode only; letters of exchange tracking.
Communication & automation
- Messages — requires Messaging Pro from the Store; broker–party chat with slash commands.
- Maya AI — requires Maya AI Pro from the Store.
- Automations — owner-only workflows triggered manually, on a schedule, or by activity events.
Administration
- Store — subscription plans, billing history, and referral tracking.
- Company — branding that feeds bills.
- Activity log — audit trail of workspace actions.
- Settings — all configuration sections described above.
Advanced
Messages & Automations
Once your book is running, Messages and Automations reduce manual follow-up—when enabled through the Store.
Messages
- Purchase Messaging Pro in the Store to unlock Messages for your workspace.
- Conversations with parties; slash commands for quick lookups and settlements.
- Broker commands include settlement shortcuts—/brokerage pay is bank mode only; letter commands are cash mode only.
- Parties with portal access can use read-only commands such as my profile, remaining interest, brokerage summary, bill, and ledger.
Automations
- Owner-only: workers cannot configure automations.
- Triggers: manual run, schedule (once, daily, weekly, monthly), or when something happens (activity events).
- Steps: wait, send message, run command (read-only), send push to broker, send party report, send bills.
- Party targets: one party, selected parties, all parties, party category, party from trigger event, or filtered audience.
- Report kinds: pending interest, pending brokerage, pending letters, transactions (period), ledger (period).
For brokers
Enable party portal access
The party portal lets lenders and borrowers sign in read-only to see their slice of the book. Brokers set it up; parties do not self-register.
Purchase entitlement
- Open Store and purchase Party Portal Access.
- Without this add-on, portal fields on parties show a prompt to buy access.
Configure per party
- Edit a party → Party portal (optional).
- Portal username is assigned automatically: {workspaceSlug}_{partySlug} (numeric suffix if needed for global uniqueness).
- Set a portal password (minimum 8 characters). You may store a readable copy to share with the party.
- Remove portal password to disable sign-in for that party.
Share credentials
Give the party their portal username and password. They use the same site login as brokers, with portal credentials—not your broker email.
For parties
How parties sign in
Party sessions are read-only. You see only data linked to your party record—not the broker's full workspace or other parties.
Sign in
- Open Party portal sign-in from the marketing site or go to /portal.
- Enter portal username and password provided by your broker.
- After sign-in, your home is /p/{portalKey}/portal.
Multi-account features
- Connect party account — link another party's credentials to view their data without signing out.
- Combined view — select two or more linked accounts for an aggregated read-only overview and deal sheet.
Same site, different session
Portal users are not broker users. Your session kind is party, and every page is read-only.
For parties
Portal page reference
Navigation mirrors the broker dashboard where it applies to your side of deals—balances, transactions, and exports without edit access.
Always available
- Overview — net position, outstanding receivable/payable, lifecycle health, shortcuts.
- My profile — read-only profile, transaction lifecycle, ledger, analytics, and settlement status for your side.
- Deal Sheet — read-only lifecycle and settlement for your transactions.
- Interest — schedules and settlement status (read-only).
- Ledger — movements tied to your deals.
- Bills — bills linked to your side of transactions (read-only).
Mode-dependent
- Brokerage — visible in bank mode; in cash mode this route redirects to Interest.
- Letters-related context appears in deal views in cash mode.
Add-ons
- Messages — available when your broker has Messaging Pro.
- Maya AI — available when your broker has Maya AI Pro.
- App settings — device preferences on the native Android app.
Help
Portal troubleshooting
If sign-in fails or pages are missing, the cause is usually entitlement or password state on the broker side.
Common messages
- Party portal is not enabled for this brokerage — broker has not purchased Party Portal Access in the Store.
- Portal access expired — broker's Party Portal add-on is no longer active.
- Portal access is disabled — contact your broker; you may be routed to /portal/disabled.
- Cannot sign in — broker may have removed your portal password.
What to ask your broker
- Confirm Party Portal Access is active in their Store.
- Confirm your portal username and that a password is set on your party record.
- Confirm you are using portal credentials, not the broker's email login.
Quick reference
Bank vs cash at a glance
Use this table when onboarding staff or explaining the product to parties. For full detail, see the mode-specific settlement sections above.
| Area | Bank mode | Cash mode |
|---|---|---|
| Navigation | Brokerage visible; Letters hidden | Letters visible; Brokerage hidden |
| Interest rates | Single rate per transaction | Separate lender and borrower rates; broker spread |
| TDS | When both parties are TDS applicable | Disabled |
| Interest settlement | Unified; net after TDS; full payment only | Per side: borrower received / lender paid |
| Brokerage ops | Dedicated Brokerage page | Embedded in cash-interest flow; no Brokerage page |
| Letters | Not available | Letters of exchange per chain |
| Party bank details | Used on bills | Not used |
| Bills charges label | Charges & settlement | Charges (cash mode) |
Terms
Glossary
Definitions as used inside EazyBroker.
Core terms
- Parties — lender and borrower contacts managed by the broker; not app logins unless portal is enabled.
- Deal Sheet — primary grid for creating and managing transactions.
- Transaction mode — bank (direct lender-borrower) or cash (broker-mediated).
- Chain — a transaction and its renewals; letter status in cash mode attaches to the chain root.
- Subscription — active plan unlocks full dashboard access for your workspace.
- Workers — staff logins with limited dashboard permissions.
- Entitlements — Store purchases that unlock Messages, Party Portal, Maya AI, worker slots, and transaction credits.