POST

/Report

Usage Notes

When

Initiate report generation
Submit report parameters for processing

Requirements

ReportName required (identifies report type)
Parameters dictionary with report-specific options

Notes

Stage 1 of 3-stage workflow
All parameter values must be strings
Returns reference GUID for tracking

Description

Submits a report generation request. Returns reference GUID for status polling and retrieval.

Required Headers - See Authentication

Header	Value	Description
Content-Type	application/json	Request content type
Authorization	{accessToken}	Bearer token for API access
Version	2.0	API version identifier

Request Body

Parameter	Type	Required	Description
`reportName` >	string	> Required...	The name of the report to generate. Examples include EntityBalanceReport, TransactionSummary, DistributionReconciliation, and other business intelligence reports.
`parameters`	object	Optional	Dynamic collection of report-specific key-value parameters. All values must be strings. Available parameters vary by report type for filtering, grouping, and output control.

reportName

string

> Required...

The name of the report to generate. Examples include EntityBalanceReport, TransactionSummary, DistributionReconciliation, and other business intelligence reports.

parameters

object

Optional

Dynamic collection of report-specific key-value parameters. All values must be strings. Available parameters vary by report type for filtering, grouping, and output control.

Register Listing reports: postcode range is now optional

The Register Listing family of reports — Register Listing, Register Listing With HIN/SRN and Register Listing With Holdings — accepts an optional PostCodeMin / PostCodeMax range. Omit both parameters to receive the complete register, including overseas holders who have no Australian postcode.

Behaviour change: these two parameters used to be effectively mandatory. Omitting them left the postcode placeholder unreplaced in the report SQL, which silently returned zero rows, and supplying a range excluded every overseas holder.

Report names: pass the report's display name with spaces and slashes removed, e.g. RegisterListing, RegisterListingWithHINSRN, RegisterListingWithHoldings. Matching is exact after that normalisation.

Example Requests

bash

# Entity Balance Report
curl -X POST 'https://api.7g.com.au/Report' \
  -H 'Authorization: {accessToken}' \
  -H 'Version: 2.0' \
  -H 'Content-Type: application/json' \
  -d '{
    "reportName": "EntityBalanceReport",
    "parameters": {
      "ProductID": "123",
      "FromDate": "2024-01-01",
      "ToDate": "2024-12-31",
      "IncludeClosingBalances": "true"
    }
  }'

# Transaction Summary Report
curl -X POST 'https://api.7g.com.au/Report' \
  -H 'Authorization: {accessToken}' \
  -H 'Version: 2.0' \
  -H 'Content-Type: application/json' \
  -d '{
    "reportName": "TransactionSummary",
    "parameters": {
      "BizEntityID": "456",
      "BizTransactionTypeID": "1",
      "Status": "Complete",
      "FromDate": "2024-01-01",
      "ToDate": "2024-03-31",
      "PageSize": "500"
    }
  }'

# Register Listing With Holdings — complete register including overseas holders
# (PostCodeMin / PostCodeMax are optional; omit both for the full register)
curl -X POST 'https://api.7g.com.au/Report' \
  -H 'Authorization: {accessToken}' \
  -H 'Version: 2.0' \
  -H 'Content-Type: application/json' \
  -d '{
    "reportName": "RegisterListingWithHoldings",
    "parameters": {
      "ProductID": "123"
    }
  }'

# Register Listing — Australian holders in a postcode range only
curl -X POST 'https://api.7g.com.au/Report' \
  -H 'Authorization: {accessToken}' \
  -H 'Version: 2.0' \
  -H 'Content-Type: application/json' \
  -d '{
    "reportName": "RegisterListing",
    "parameters": {
      "ProductID": "123",
      "PostCodeMin": "2000",
      "PostCodeMax": "2999"
    }
  }'

Response Examples

json

{
  "result": true,
  "message": "Your report request has been queued for background processing. Use the Status endpoint with the provided reference value to track its progress.",
  "data": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}