GET

/Common/Lookup

When to Use

Populate dropdown lists and selection controls in user interfaces
Validate field values against supported system options before submitting data
Discover available lookup categories and their supported values
Build dynamic forms that adapt to system configuration changes

Common Scenarios

Form Population: Use Field="BizEntityType" to get entity type options for dropdown lists
Validation Lists: Retrieve all lookup categories to build comprehensive validation logic
Dynamic UI Building: Use specific field lookups to create adaptive user interfaces
Data Validation: Verify field values against system-supported options before submission
System Discovery: Explore available lookup categories and their configurations

Prerequisites

No authentication required - publicly accessible endpoint
Field name or category for targeted lookup

Considerations

Lookup data is relatively static but may change with system updates
Use 'info' parameter to discover all available lookup categories
Cache lookup results appropriately to reduce API calls
Validate user selections against current lookup values
Some lookups may be empty or unavailable in certain system configurations
Field names are case-sensitive and must match exactly

Description

Provides metadata lookup services for fields marked as 'Support GetLookupData' throughout the 7G system. This endpoint returns standardized ID-Value pairs for various system-defined categories such as address types, entity statuses, investment types, and taxation components. Use the 'info' parameter to discover all available lookup categories, then query specific categories to get their supported values.

📋 Available Lookup Categories (57 Total)

Recommended: Call with Name='info' to retrieve the complete list of all 57 available lookup categories with their associated database fields.

Quick Reference by Category:

Entity & Identity (13): bizEntityStatusID, bizEntityTypeID, gender, individualTitleID, titleID, legalGuardianTitleID, relationshipTypeID, identificationTypeID, investorTypeID, customerCategoryID, employmentStatusID, communicationPreferenceID, transferTypeID
Locations (5): addressTypeID, countryCode, birthCountryCode, formationCountryCode, taxationCountryCode, stateCode
Transactions (11): bizTransactionTypeID, bizTransactionStatusID, bizEventTypeID, bizEventStatusID, paymentMethodID, paymentTypeID, reasonID, adjustmentType, movementReasonCode, priceMethod, transferTypeID
Investments & Units (7): investmentTypeID, unitClassTypeID, unitValuationMethod, roundingMethodID, termTypeID, conversionMethod, conversionMethodID
Distributions & Tax (6): distributionTermID, distributionPeriodID, drpTypeID, drpIndicatorID, TaxComponent, taxOfficeTypeID
Accounts & Payments (4): accountTypeID, accountStatusID, currencyID, paymentTypeID
Communications & Documents (4): communicationTypeID, documentTypeID, statementType, statementTypeID
Compliance (7): crsfatcaParticipationID, fatcaType, financialnstitutionType, nonReportingFinancialInstitutionType, organisationCategoryID, sourceOfFundsID, purposeOfInvestmentID

Required Headers

No Authorization Header Required - This endpoint is publicly accessible without authentication.

Header	Value	Description
Version	2.0	API version identifier

Query Parameters

Parameter	Type	Required	Description
`Name`	string	Optional	Lookup category name (e.g., 'addressTypeID', 'bizEntityStatusID', 'TaxComponent'). Use 'info' to retrieve complete list of all 57 available categories. Case-sensitive - must match exact category name.

Name

string

Optional

Lookup category name (e.g., 'addressTypeID', 'bizEntityStatusID', 'TaxComponent'). Use 'info' to retrieve complete list of all 57 available categories. Case-sensitive - must match exact category name.

Example Requests

bash

# Get list of available lookup categories
curl -X GET "https://api.7g.com.au/Common/Lookup?Name=info" \
  -H "Version: 2.0"

# Get address type options
curl -X GET "https://api.7g.com.au/Common/Lookup?Name=addressTypeID" \
  -H "Version: 2.0"

# Get business entity status options
curl -X GET "https://api.7g.com.au/Common/Lookup?Name=bizEntityStatusID" \
  -H "Version: 2.0"

# Get investment type options
curl -X GET "https://api.7g.com.au/Common/Lookup?Name=investmentTypeID" \
  -H "Version: 2.0"

Response Examples

json

{
  "result": true,
  "message": "",
  "recordCount": 57,
  "data": [
    { "id": "accountStatusID", "value": "Account.accountStatusID" },
    { "id": "addressTypeID", "value": "InvestorAddress.addressTypeID" },
    { "id": "bizEntityTypeID", "value": "BizEntity.BizEntityTypeID" },
    { "id": "bizTransactionTypeID", "value": "BizTransactionType.BizTransactionTypeID" },
    { "id": "communicationTypeID", "value": "InvestorCommunication.communicationTypeID" },
    { "id": "distributionTermID", "value": "UnitClass.distributionTermID, DistributionImports.distributionTermID" },
    { "id": "investmentTypeID", "value": "Investment.investmentTypeID" },
    { "id": "paymentTypeID", "value": "PaymentDetail.paymentTypeID" },
    { "id": "TaxComponent", "value": "Distribution.TaxComponents.TaxComponent" },
    { "id": "titleID", "value": "person.TitleID" }
    ...
    // Note: Total 57 categories available. Call with Name='info' to retrieve complete list.
  ]
}