Overview
Dividend reporting provides visibility into profit distributions over time, allowing you to track dividend pools, view member allocations, analyze distribution patterns, and provide transparency to members about how retained earnings are shared.What you can view: Pool lists with filtering and sorting, individual pool details with member allocations, member dividend history, and organization-level analytics.
Accessing Dividend Information
Dividend Pools List
View all dividend pools (draft and distributed) with filtering and sorting options.
Information displayed:
- Period label: Descriptive name (e.g., “Q1 2026 Dividend”)
- Period dates: Start and end dates of dividend period
- Amount: Total pool amount to distribute
- Status: Draft (journalEntryId = null) or Distributed (journalEntryId populated)
- Distribution date: Transaction date of journal entry (if distributed)
- Eligible members count: Number of active members who received/will receive dividends
Individual Pool Details
View detailed information about a specific dividend pool, including calculated member allocations.
Pool details shown:
- Period label, start date, end date
- Total pool amount
- Status (draft or distributed)
- Distribution method (equal or by_contribution)
- Time-weighting setting (enabled or disabled)
- Distribution basis (equal split, participation days, contribution amount, time-weighted contribution)
- Journal entry details (if distributed)
- Member name and email
- Calculated dividend amount
- Distribution basis value (participation days, contribution amount, etc.)
- Percentage of total pool
- SAVINGS account scope key (if distributed)
Member Dividend History
View all dividends received by a specific member across all pools.
Member history includes:
- Pool period label
- Distribution date
- Dividend amount received
- Pool total amount
- Percentage of pool received
- Cumulative total dividends
Filtering and Searching
Filter by Status
Draft pools (journalEntryId = null):
- Pools created but not yet distributed
- Member allocations are calculated but not posted
- Can still be edited or deleted
- No journal entry created yet
journalEntryId ≠ null):
- Pools that have been finalized
- Journal entry created, SAVINGS accounts credited
- Cannot be edited or deleted (permanent)
- Locked for audit trail
Filter by Date Range
Filter pools by period end date within a specific range. Examples:- Filters on
periodEndfield startDate: Include pools where periodEnd ≥ startDateendDate: Include pools where periodEnd ≤ endDate
Sorting Pools
Sort dividend pools by different criteria. Sort options:- periodEnd: Sort by period end date (default: descending)
- periodStart: Sort by period start date
- createdAt: Sort by pool creation date
- totalAmount: Sort by pool amount
- status: Sort by status (distributed vs. draft)
- desc: Descending (most recent/largest first) - default
- asc: Ascending (oldest/smallest first)
Sorting Member Allocations
Within a pool’s member allocations, sort by different criteria. Sort options:- amount: Sort by dividend amount
- organizationUserName: Sort by member name
- organizationUserEmail: Sort by member email
Search Members
Search for specific members within a pool’s allocations. Search by:- Member name (partial match)
- Member email (partial match)
Pagination
Both pool lists and member allocations support pagination. Pool list pagination:- Pools: No limit (all pools returned)
- Member allocations: No limit (all members returned)
- Maximum limit: 100 (pools), 100 (member allocations)
Key Dividend Metrics
Total Dividends Distributed
Sum of all distributed pools = total retained earnings distributed to members Calculation:Average Dividend per Member
Total distributed ÷ number of unique members who received dividends Calculation:- Query all distributed pools
- Count unique members who received dividends
- Divide total distributed by member count
Note: This is a simple average. Actual member amounts vary based on distribution method (equal vs. by_contribution) and time-weighting.
Dividend Payout Ratio
Dividends ÷ net profit = percentage of profit distributed to members Calculation:- High ratio (70-80%): More profit to members, less retained for growth
- Medium ratio (50-60%): Balanced approach
- Low ratio (20-40%): More retained for reserves and expansion
- Reserves: Allocated to emergency fund, equipment, etc.
- Retained earnings: Kept for future operations and growth
Individual Member Totals
For each member, calculate cumulative dividends received. Query:- List of all pools where member received dividend
- Amount received in each pool
- Period label and distribution date
- Cumulative total
Balance Sheet Integration
Dividends move funds from retained earnings to member savings accounts. Before distribution:Important: Dividends credit member SAVINGS accounts (liability), NOT a separate “Member Equity” account. This increases member balances they can withdraw or leave to compound.
Dividend Analytics
Access organization-level dividend analytics and trends. Endpoint:- Query all pools with appropriate filters
- Sum amounts, count pools, group by period
- Use response data to calculate custom analytics
Reporting to Members
Quarterly Dividend Report
After each distribution, communicate with members: Report template:Member Dividend Statement
Provide individual members with personalized dividend summary:Distribution Method Impact
Equal Distribution
All active members receive the same amount (or time-weighted equal shares). Pool details display:By Contribution Distribution
Members receive dividends proportional to their savings contributions. Pool details display:Common Use Cases
View All Distributed Pools for 2026
Find Largest Draft Pools
View Member’s Dividend History
Search for Pool by Label
Filter pools list in UI by typing pool label (e.g., “Q1 2026”).View Pool with Specific Members
Best Practices
Dividend reporting best practices:Frequency:
- Review pools list after each distribution
- Provide member statements quarterly or annually
- Monitor draft pools regularly (don’t leave in draft too long)
- Share distribution method with all members
- Explain time-weighting if enabled
- Publish dividend schedule at start of year
- Make pool details accessible to all members (not just board)
- Send announcement within 1 week of distribution
- Include individual statements for members
- Explain any changes to distribution policy
- Celebrate milestones (e.g., “Total 50M distributed since inception!”)
- Track dividend trends year-over-year
- Compare draft vs. distributed pools
- Monitor payout ratio (don’t distribute 100% of profit)
- Identify members who haven’t received dividends (inactive members)
- Export pool data for annual reports
- Keep records of approval decisions (if governance requires)
- Document distribution method changes in meeting minutes
- Archive member statements for audit trail
- Explain how to view dividends in their account
- Clarify difference between SAVINGS balance and dividends
- Show how to check transaction history
- Explain withdrawal vs. compound options
Troubleshooting
Cannot find distributed pool
Possible causes:- Status filter set to “Draft” only
- Date range filter excludes pool’s period end date
- Searching for wrong pool label
Member allocation shows zero
Possible causes:- Member was inactive (isActive = false) at distribution time
- Member had no savings (in by_contribution method)
- Member’s calculated allocation rounded to zero
- Check member’s active status during pool period
- Verify member had savings balance (for by_contribution method)
- Review distribution method and time-weighting settings
Pool total doesn’t match sum of member allocations
Cause: Viewing draft pool with members filtered by search Explanation:- Search filters member allocations display
- Pool total remains unchanged
- Sum of visible allocations may not equal pool total
- Clear search filter to see all members
- Verify sum of all member allocations equals pool total
Member disputes dividend amount
Investigation steps:
Common explanations:
- Member joined mid-period (time-weighted equal)
- Member had lower savings (by_contribution method)
- Member was inactive during distribution
Analytics shows all zeros
Cause: Analytics endpoint returns placeholder data (not yet implemented) Solution:- Use pools list endpoint to manually calculate analytics
- Query pools with appropriate filters
- Sum amounts and count pools in application code
- Await future release with full analytics implementation
Permissions Required
| Action | Permission | Scope |
|---|---|---|
| View all pools | dividends:read | ANY |
| View pool details | dividends:read | ANY |
| View member allocations | dividends:read | ANY |
| View specific member’s dividends | dividends:read | organizationUserId (scoped) |
| View analytics | dividends:read | ANY |
Typical roles:
- Administrators and Accountants:
dividends:read(ANY scope) - can view all pools and all member allocations - Regular members:
dividends:read(own organizationUserId scope) - can only view their own dividend history
Technical Details
API Endpoints
List pools:Related Topics
Dividends Overview
Understand dividend pools and distribution methods
Creating Dividend Pools
Set up new dividend pools
Distributing Dividends
Calculate allocations and make payments
Balance Sheet
View how dividends affect equity and liabilities
Income Statement
Calculate net profit for dividend allocation
Retained Earnings
Understand retained earnings accounting