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
Common Scenarios
- Transaction Pre-Validation: Query InvestmentID=12345 to verify IsActive=true and AllotmentCutoffDate hasn't passed before allowing deposit/redemption transactions
- Product Selection Interface: Use ProductID=100 with pagination to display all unit classes (Class A, B, wholesale, retail) for investor selection in client portals
- APIR Code Regulatory Verification: Retrieve investment by ExternalInvestmentId to confirm securityCode (APIR) matches ASIC registration for compliance reporting
- Pricing Precision Configuration: Check NoOfDecimalPlaces setting before creating InvestmentPrice records to ensure pricing accuracy matches fund terms
- Distribution Eligibility Check: Verify AllowDistribution=true and distributionPeriodID settings before initiating distribution declaration workflows
- External System Synchronization: Query by ExternalInvestmentId + ExternalProductId to synchronize investment configurations between 7G and fund manager platforms
Prerequisites
- Valid Bearer token with investment read permissions
- InvestmentID, ExternalInvestmentId, or ProductID for targeted queries
Important Considerations
⚠️ Investment Lifecycle and Trading Windows
- AllotmentCutoffDate Enforcement: Investments past their cutoff date reject new allocation requests even if IsActive=true - validate dates before transaction processing
- Wholesale vs Retail Classification: Investment eligibility depends on investor sophistication status and minimum investment thresholds - verify client qualifications
- Distribution Period Dependencies: Distribution frequency settings affect cash flow planning and tax reporting - understand periodType classifications
- APIR Code Compliance: Australian investment products require valid APIR codes for regulatory reporting - ensure completeness for compliance submissions
- Performance Optimization: Native InvestmentID provides significantly faster lookup performance than ExternalInvestmentId filtering for high-volume operations
- Pricing Decimal Precision: NoOfDecimalPlaces setting affects transaction calculation accuracy and must align with product pricing requirements
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 availableEndDate
- Investment maturity or closure dateAllotmentCutoffDate
- Last date for accepting new investmentsIsActive
- Current availability for transactions
Required Headers - See Authentication
Header | Value | Description |
---|---|---|
Authorization | {accessToken} | Bearer token for API access |
Version | 2.0 | API 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. |
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
Native investment identifier for direct lookup returning complete configuration including allotment rules, distribution settings, and pricing parameters.
ExternalInvestmentId
External investment identifier for cross-system integration (requires ProductID or ExternalProductId for scoping).
ProductID
Filter investments by parent product identifier returning all unit/share classes within the specified product.
ExternalProductId
External product identifier for cross-system integration returning all investments within the externally-identified product.
PageNumber
Result page number for paginated queries (1-indexed, use with PageSize for large result sets).
PageSize
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
}
]
}