GET

/Report

When to Use

  • Download regulatory report data after GET /Report/Status confirms completion
  • Retrieve tax reporting datasets for investor distribution
  • Extract completed financial statements for board presentation materials
  • Download transaction audit trails for compliance evidence

Prerequisites

  • Reference GUID obtained from POST /Report
  • Report processing completed (verified via GET /Report/Status returning "complete")

Considerations

  • Only retrieve after GET /Report/Status confirms "complete" status
  • Reports are purged automatically after 24 hours
  • Large reports may require 60+ second timeouts
  • Response structure varies by report type

Description

Retrieves completed report data using the reference GUID from POST /Report, returning structured JSON results ready for consumption, analysis, or external system integration. This is the final stage of the 3-stage asynchronous report workflow (Request → Monitor → Retrieve), delivering the actual report payload after GET /Report/Status confirms completion. Response structure is dynamically determined by report type - EntityBalanceReport returns hierarchical entity/account data, TransactionSummary returns flat transaction arrays, DistributionReconciliation returns calculation breakdowns with tax components.

Report Retrieval Workflow Context

This endpoint completes the asynchronous report generation lifecycle:

  1. Stage 1 - Request (POST /Report): Submit report parameters, receive tracking GUID
  2. Stage 2 - Monitor (GET /Report/Status): Poll until status="complete" (5-30 second intervals)
  3. Stage 3 - Retrieve (GET /Report): Download results using GUID - available for 24 hours before automatic purging

Response Structure Components (all report types):

  • Metadata: reportName, generatedDate, parameters used in generation request
  • Results Array: Core report data - structure varies by report type (hierarchical objects for EntityBalanceReport, flat arrays for TransactionSummary)
  • Summary Object: Aggregate totals, record counts, generation time for quick analysis and validation

Required Headers - See Authentication

HeaderValueDescription
Authorization{accessToken}Bearer token for API access
Version2.0API version identifier

Query Parameters

Parameter Type Required Description
reference >
string
The GUID reference returned from the POST /Report endpoint to identify the specific report request.
reference
string
The GUID reference returned from the POST /Report endpoint to identify the specific report request.

Example Requests

bash
# Get completed report results
curl -X GET "https://api.7g.com.au/Report?reference=a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

# Alternative with explicit reference parameter
curl -X GET "https://api.7g.com.au/Report" \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0" \
  -G -d "reference=a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Response Examples

json
{
  "result": true,
  "message": "",
  "data": {
    "reportName": "EntityBalanceReport",
    "generatedDate": "2024-01-15T09:30:00Z",
    "parameters": {
      "ProductID": "123",
      "FromDate": "2024-01-01",
      "ToDate": "2024-12-31",
      "IncludeClosingBalances": "true"
    },
    "results": [
      {
        "entityID": 12345,
        "externalBizEntityId": "ENT-001",
        "entityName": "Sample Investment Fund",
        "totalBalance": 1250000.00,
        "currency": "AUD",
        "lastTransactionDate": "2024-01-12",
        "accounts": [
          {
            "accountID": 789,
            "externalAccountId": "ACC-001",
            "accountNumber": "ACC-2024-001",
            "balance": 750000.00,
            "units": 306122.45,
            "lastTransactionDate": "2024-01-10"
          },
          {
            "accountID": 790,
            "externalAccountId": "ACC-002",
            "accountNumber": "ACC-2024-002",
            "balance": 500000.00,
            "units": 204081.63,
            "lastTransactionDate": "2024-01-12"
          }
        ]
      }
    ],
    "summary": {
      "totalEntities": 1,
      "totalAccounts": 2,
      "grandTotalBalance": 1250000.00,
      "grandTotalUnits": 510204.08,
      "averageBalance": 625000.00,
      "reportGenerationTime": "00:00:45"
    }
  }
}