🎯 Distribution Resource

Investment distribution workflow management

Distribution lifecycle management from declaration through allotment to final payment. Handles corporate actions, dividend distributions, and reinvestment planning with account-level tracking, tax component management, and automated payment processing.

8
Endpoints
26+1
DTO Properties
3-Stage
Workflow
DRP/Tax
Automation

🎯 Corporate Action Engine

Distribution and corporate action processing system. Handles the full lifecycle from declaration through allotment calculation to final payment execution, supporting dividends, distributions, and reinvestment programs.

🔄 4-Stage Workflow

Structured workflow: Create (define parameters) → Declare (account selection & calculation) → Distribute (payment execution) → Allotment (DRP unit allocation). Account-level specifications happen at declaration time using preCalculatedAccounts, includeAccounts, or excludeAccounts arrays.

📈 Key Features

Pro-rata calculations, tax component management, DRP/DRIP processing, withholding tax automation, account-specific balances, and flexible account selection (pre-calculated, include, exclude, or all eligible).

Available Endpoints

Core Distribution Management

GET Get Distributions Advanced filtering and account details
POST Create Distribution New distribution with tax components
PUT Update Distribution Complete replacement update
DELETE Delete Distribution Remove distribution (restricted if processed)

Distribution Workflow

POST Declare Formal declaration with account selection (pre-calculated, include, exclude, or all)
POST Process Allotment Calculate distribution per account
POST Distribute Final payment processing

Account-Level Operations

GET Get Distribution Accounts Read-only access to account-specific distribution details

Note: Account-level modifications are now performed during declaration using the preCalculatedAccounts, includeAccounts, or excludeAccounts arrays in the /Distribution/Declare endpoint. This provides a cleaner architecture where all account decisions happen at declaration time rather than through separate management endpoints.

Core Data Transfer Objects

DistributionDTO POST, PUT, GET responses Distribution structure (26 properties + TaxComponents array)
DistributionAccountDTO Account endpoints, nested Account-specific data (21 properties) with balances and DRP
DistributionAllotmentDTO Allotment POST endpoint Allotment processing parameters and calculations
DistributionDeclareDTO Declare POST endpoint Declaration parameters with product and dates
DistributionDistributeDTO Distribute POST endpoint Final payment execution parameters
TaxComponentDTO Nested in DistributionDTO Tax breakdown and withholding calculations

Filter Data Transfer Objects

GET endpoints use filter classes to bind query parameters. These are request-only structures for filtering and pagination.

DistributionAccountFilter GET /Distribution/Account 8 properties: 6 ID lookups (CorporateActionID, ExternalCorporateActionId, ProductID, ExternalProductId, AccountID, ExternalAccountId) + pagination (PageNumber, PageSize with default 1000)

Note: The main GET /Distribution endpoint uses direct query parameters (CorporateActionID or ExternalCorporateActionId) rather than a filter class, as it retrieves a single distribution by ID.

Business Rules & Constraints

Sequential Workflow Processing

  • Step 1 - Create: Must create distribution first (define parameters, tax components, DRP settings)
  • Step 2 - Declare: Lock eligible investors and calculate distribution amounts per account with account selection (preCalculatedAccounts/includeAccounts/excludeAccounts)
  • Step 3 - Distribute: Process payments to investors
  • Step 4 - Allotment: Allocate DRP units to reinvestment participants (optional)
  • Each stage creates immutable audit records with complete transaction history

Distribution Features

  • DistributionDTO supports 26 properties + TaxComponents array for tax breakdown
  • DistributionAccountDTO provides 21 account-specific properties including balances, fees, tax details
  • DRP/DRIP processing supports automatic reinvestment with separate investment allocation
  • Tax component management handles withholding tax calculations and refunds

Data Integrity & Business Logic

  • Corporate Action ID provides consistent linking across all workflow stages
  • Record date snapshot determines eligible account holdings for distribution calculations
  • Payment date validation ensures distributions process on appropriate business dates
  • Pro-rata calculations automatically handle unit-based and percentage-based distributions

Reporting & Audit Integration

  • All distribution operations generate reportable events for compliance reporting
  • Report resource provides async generation of distribution statements and summaries
  • Audit trails maintained for regulatory and tax reporting requirements
  • See Report resource for distribution reporting and analysis

Transaction Integration

🔗 Automatic BizTransaction Creation

Distribution workflow operations automatically create immutable BizTransaction records:

  • Allotment Processing: Creates BizTransaction/Allotment records for each account
  • DRP Processing: Generates BizTransaction/Deposit for reinvestment allocations
  • Cash Distributions: Links to payment processing and settlement tracking

See BizTransaction Allotment for detailed integration.