GET

/Investment

When to Use

  • Retrieve investment products by investmentID or externalInvestmentId
  • Validate investment availability and trading restrictions
  • Access investment structure details including APIR codes and classifications
  • Check allotment cutoff dates and distribution settings
  • Retrieve all investments for a specific product

Prerequisites

  • InvestmentID, ExternalInvestmentId, or ProductID for queries

Considerations

  • Investments past AllotmentCutoffDate reject new allocations even if IsActive=true
  • NoOfDecimalPlaces setting affects pricing precision for all transactions
  • AllowDistribution and distributionPeriodID determine distribution eligibility
  • APIR codes (securityCode) required for Australian investment products

Description

Retrieves investment products with comprehensive filtering options. Returns complete investment configuration including allotment settings, distribution parameters, pricing decimals, security codes, and regulatory reporting flags.

Investment Lifecycle Management

  • StartDate - When the investment becomes available
  • EndDate - Investment maturity or closure date
  • AllotmentCutoffDate - Last date for accepting new investments
  • IsActive - Current availability for transactions

Required Headers - See Authentication

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

Query Parameters

Parameter Type Required Description
InvestmentID
 integer
Optional
Native investment identifier for direct lookup returning complete configuration including allotment rules, distribution settings, and pricing parameters.
ExternalInvestmentId
 string
Optional
External investment identifier for cross-system integration (requires ProductID or ExternalProductId for scoping).
ProductID
 integer
Optional
Filter investments by parent product identifier returning all unit/share classes within the specified product.
ExternalProductId
 string
Optional
External product identifier for cross-system integration returning all investments within the externally-identified product.
AsAtDate
 DateOnly
Optional
Query investment data as of specific date. Returns TotalQuantity aggregate of holdings across all accounts on specified date.
PageNumber
 integer
Optional
Result page number for paginated queries (1-indexed, use with PageSize for large result sets).
PageSize
 integer
Optional
Records per page (maximum 1000, recommended: 50-100 for UI, 500-1000 for batch processing).
InvestmentID
integer
Optional
Native investment identifier for direct lookup returning complete configuration including allotment rules, distribution settings, and pricing parameters.
ExternalInvestmentId
string
Optional
External investment identifier for cross-system integration (requires ProductID or ExternalProductId for scoping).
ProductID
integer
Optional
Filter investments by parent product identifier returning all unit/share classes within the specified product.
ExternalProductId
string
Optional
External product identifier for cross-system integration returning all investments within the externally-identified product.
AsAtDate
DateOnly
Optional
Query investment data as of specific date. Returns TotalQuantity aggregate of holdings across all accounts on specified date.
PageNumber
integer
Optional
Result page number for paginated queries (1-indexed, use with PageSize for large result sets).
PageSize
integer
Optional
Records per page (maximum 1000, recommended: 50-100 for UI, 500-1000 for batch processing).

Example Requests

bash
# Get a specific investment
curl -X GET https://api.7g.com.au/Investment?InvestmentID=12345 \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

# Get investment by external ID and product
curl -X GET "https://api.7g.com.au/Investment?ExternalInvestmentId=INV-001&ProductID=100" \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

# Get all investments for a product with pagination
curl -X GET "https://api.7g.com.au/Investment?ProductID=100&PageSize=50&PageNumber=1" \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

# Get investments using external product ID
curl -X GET "https://api.7g.com.au/Investment?ExternalProductId=FUND-001" \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

# Get all investments with pagination
curl -X GET "https://api.7g.com.au/Investment?PageSize=25&PageNumber=1" \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

Response Examples

json
{
  "result": true,
  "message": null,
  "recordCount": 1,
  "data": [
    {
      "investmentID": 12345,
      "externalInvestmentId": "INV-001",
      "allowAllotment": true,
      "allotmentCutoffDate": "2024-12-31",
      "allowDistribution": true,
      "allotmentMinAmount": 1000.00,
      "allotmentMaxAmount": 1000000.00,
      "calcDividendIncludingFirstDay": false,
      "couponRate": 5.25,
      "description": "High Growth Equity Fund - Class A",
      "distributionPeriodID": 2,
      "distributionTermID": 1,
      "endDate": "2030-12-31",
      "isActive": true,
      "isIncludedInAnnualReporting": true,
      "securityCode": "HGF001A",
      "maxCapital": 50000000.00,
      "name": "High Growth Equity Fund A",
      "noOfDecimalPlaces": 4,
      "ordinal": 1,
      "productID": 100,
      "externalProductId": "FUND-001",
      "roundingMethodID": 1,
      "startDate": "2020-01-01",
      "termDays": null,
      "termMonths": 36,
      "termTypeID": 2,
      "topUpMaxAmount": 500000.00,
      "topUpMinAmount": 500.00,
      "investmentTypeID": 1,
      "totalQuantity": 125000.5000
    }
  ]
}
POST Create Investment PUT Update Investment DELETE Delete Investment GET Get InvestmentPrice