📊 Report Resource

Financial reporting and document generation

Report generation and management system for financial statements, compliance reports, and custom documentation. Supports asynchronous report processing, multiple output formats, status tracking, and automated delivery workflows.

4
Endpoints
Async
Processing
3+
Export Formats
Real-time
Status Tracking
📈

Report Generation

Financial statements, compliance reports, and custom documentation with template-based generation and parameter control.

⏱️

Async Processing

Background report generation with status tracking, progress monitoring, and completion notifications for large datasets.

📁

Multi-Format Export

PDF, Excel, CSV, and custom format support with automated delivery and secure file management.

Available Endpoints

Core Operations

GET Get Reports Retrieve reports with status tracking and async progress
POST Create Report Generate financial report with multi-format export options
DELETE Delete Report Remove report (auto-cleanup after retention period)
GET Get Report Status Track async generation with real-time progress updates

Common Use Cases

📋

Compliance Reporting

Generate AUSTRAC, ASIC, and ATO regulatory reports with automated scheduling, multi-entity aggregation, and secure distribution. Supports FATCA/CRS classification reports, beneficial ownership declarations, and transaction monitoring summaries.

💼

Investor Statements

Produce periodic portfolio statements, transaction summaries, distribution histories, and performance reports for investors. Configurable date ranges, multi-investment consolidation, and PDF/Excel export with branded templates.

📊

Analytics & Reconciliation

Create data-driven insights reports with custom parameters, filters, and aggregation options. Holdings reconciliation reports, fee analysis summaries, and investment performance analytics with benchmark comparisons.

⚡

Bulk Report Generation

Process large-scale batch report generation for month-end, quarter-end, and year-end reporting cycles. Track multiple concurrent report generation jobs with real-time progress monitoring and automated error handling.

Core Data Transfer Objects

ReportDTO POST /Report endpoint Report request structure (2 properties): ReportName (required string identifying report type) + Parameters (flexible Dictionary<string,string> for report-specific options like date ranges, entity filters, output formats)

Asynchronous Report Generation Workflow

Report generation follows a 3-stage asynchronous workflow designed for large dataset processing without blocking API operations. This architecture enables complex financial calculations, multi-entity aggregations, and format-intensive exports while maintaining system responsiveness and providing real-time progress tracking.

1

Request Submission

Submit report generation request via POST /Report with parameters (reportType, dateRange, entityFilters, outputFormat)

POST /Report
→
2

Background Processing

Report queued for async generation. Track progress via status polling with percentage completion and time estimates

GET /Report/Status
→
3

Retrieval & Storage

Completed report stored as Document record. Download via Document resource or access through GET /Report with reportID

GET /Report, Document/File/GET

Status Polling Pattern

Poll GET /Report/Status endpoint at 2-5 second intervals during generation. Status values: Queued → Processing → Completed / Failed. Completed reports include downloadURL and documentID for retrieval via Document resource.

Business Rules & Constraints

Async Processing & Status Tracking

  • Reports queue for background processing with status lifecycle: Queued → Processing → Completed / Failed
  • Status polling: GET /Report/Status supports 2-5 second polling intervals with percentage completion and estimated time remaining
  • Concurrent limit: Maximum 5 concurrent report generation jobs per user
  • Timeout handling: Long-running reports (>10 minutes) automatically fail with error messages for retry logic

Report Types & Configuration

  • Transaction reports: BizTransaction summaries with date range, entity filters, transaction type filters (Deposit, Redemption, Transfer, Conversion)
  • Distribution reports: Corporate action histories, dividend summaries, DRP participation analysis
  • Holdings reports: Current and historical position reports with NAV calculations, CGT cost base tracking
  • Compliance reports: AUSTRAC TTR, ASIC regulatory reports, FATCA/CRS classification summaries
  • Tax reports: Annual tax statements, distribution tax components, CGT realized/unrealized gains with ATO-compliant formatting

Validation & Integration

  • Date range validation: Start date must precede end date with maximum 10-year span
  • Permission validation: Entity parameters checked against user access rights for data security
  • Template enforcement: Regulatory compliance reports follow AUSTRAC, ASIC, and ATO formatting requirements
  • Document integration: Generated reports automatically stored as Document records with metadata linkage for retrieval
  • Multi-entity consolidation: Support for consolidated reports across multiple BizEntity records for family office reporting

Processing & Delivery

  • Multi-format export: Simultaneous PDF, Excel, CSV generation from single request
  • Report caching: Frequently requested reports (same parameters within 24 hours) served from cache
  • Batch scheduling: Support for recurring report generation with configurable frequency (daily, weekly, monthly, quarterly, annual)
  • Automated retention: Reports automatically archived after 90 days and deleted after 365 days per regulatory retention policies