Reports¶

CalcBridge provides comprehensive reporting capabilities for compliance documentation, portfolio analysis, and stakeholder communication. This guide covers report types, generation, customization, export options, and scheduling.

Overview¶

Reports in CalcBridge transform your calculation and compliance data into professional, actionable documents for trustees, regulators, and internal stakeholders.

Key Capabilities¶

Available Report Types¶

Compliance Reports¶

Portfolio Reports¶

What-If Reports¶

Audit Reports¶

Generating Reports¶

Via UI¶

Via API¶

# Generate a compliance summary report
curl -X POST https://api.calcbridge.io/api/v1/reports/generate \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "report_type": "compliance_summary",
    "workbook_id": "550e8400-e29b-41d4-a716-446655440000",
    "format": "pdf",
    "options": {
      "include_charts": true,
      "include_recommendations": true
    }
  }'

Response:

{
  "report_id": "rpt_abc123",
  "status": "generating",
  "estimated_duration_seconds": 30
}

Check Report Status¶

curl -X GET https://api.calcbridge.io/api/v1/reports/{report_id} \
  -H "Authorization: Bearer $TOKEN"

Response (when ready):

{
  "report_id": "rpt_abc123",
  "status": "ready",
  "download_url": "https://api.calcbridge.io/api/v1/reports/rpt_abc123/download",
  "expires_at": "2025-01-16T10:30:00Z",
  "metadata": {
    "format": "pdf",
    "pages": 12,
    "size_bytes": 245678
  }
}

Customizing Reports¶

Report Sections¶

Most reports allow you to include or exclude sections:

Example - Custom sections:

curl -X POST https://api.calcbridge.io/api/v1/reports/generate \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "report_type": "detailed_compliance",
    "workbook_id": "...",
    "format": "pdf",
    "sections": [
      "executive_summary",
      "test_results",
      "charts",
      "recommendations"
    ]
  }'

Filtering and Grouping¶

Control what data appears in reports:

Example - Filtered report:

curl -X POST https://api.calcbridge.io/api/v1/reports/generate \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "report_type": "breach_report",
    "workbook_id": "...",
    "format": "pdf",
    "filters": {
      "status": ["failed", "warning"],
      "cushion_threshold": 5.0
    }
  }'

Branding¶

Customize report appearance with your organization's branding:

Configure branding in Settings > Organization > Report Branding.

Exporting Reports¶

Available Formats¶

Download Reports¶

# Download PDF
curl -X GET https://api.calcbridge.io/api/v1/reports/{report_id}/download \
  -H "Authorization: Bearer $TOKEN" \
  -o report.pdf

# Download as Excel
curl -X GET https://api.calcbridge.io/api/v1/reports/{report_id}/download?format=xlsx \
  -H "Authorization: Bearer $TOKEN" \
  -o report.xlsx

Sharing Reports¶

Share reports with external stakeholders:

1. Generate the report
2. Click Share on the report
3. Configure sharing options:
   • Expiration date
   • Password protection (optional)
   • Download limit (optional)
4. Copy the secure share link
5. Send to recipients

Scheduled Reports¶

Automate recurring report generation with schedules.

Creating a Schedule¶

curl -X POST https://api.calcbridge.io/api/v1/reports/schedules \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Weekly Compliance Report",
    "report_type": "compliance_summary",
    "workbook_id": "...",
    "format": "pdf",
    "schedule": {
      "frequency": "weekly",
      "day_of_week": "monday",
      "time": "08:00",
      "timezone": "America/New_York"
    },
    "delivery": {
      "email": ["compliance@example.com", "trustee@example.com"],
      "include_attachment": true
    }
  }'

Schedule Frequencies¶

Managing Schedules¶

Report History¶

Access all generated reports:

1. Navigate to Reports > History
2. Filter by:
   • Date range
   • Report type
   • Status
   • Creator
3. View report details
4. Download or share

Reports are retained based on your subscription tier:

Report Templates¶

Create reusable report templates for consistent reporting.

Creating a Template¶

1. Navigate to Reports > Templates
2. Click New Template
3. Configure:
   • Base report type
   • Default sections
   • Default filters
   • Branding options
4. Save the template

Using a Template¶

1. Click New Report
2. Select From Template
3. Choose the template
4. Modify as needed
5. Generate

Best Practices¶

For Trustee Reports¶

1. Use Detailed Compliance report type
2. Include all test results and calculations
3. Add executive summary for quick review
4. Include historical trend for context
5. Generate in PDF format for archival

For Internal Review¶

1. Use Compliance Summary for quick checks
2. Export to Excel for further analysis
3. Include charts for visual communication
4. Schedule daily generation for monitoring

For Audit Support¶

1. Use Calculation Audit report type
2. Include full data lineage
3. Generate in multiple formats (PDF + JSON)
4. Retain reports per audit requirements
5. Document report generation in audit trail