GET

/BizEntity

Usage Notes

When

Retrieve entities by bizEntityID or externalBizEntityId
Filter entities by type, product, account, or party relationships
Synchronize entity changes using UpdatedDate or UpdatedDateFull filters

Requirements

At least one filter parameter or use pagination for bulk retrieval

Notes

Native IDs (BizEntityID, ProductID) provide better performance than external IDs
UpdatedDateFull tracks all changes including nested objects; UpdatedDate tracks main entity only
Type IDs (BizEntityTypeID, etc.) use dynamic values - query Common/Lookup for valid values
Returns complete entity structure with all nested relationships

Description

Retrieves BizEntities with comprehensive filtering using dot operators. Returns complete entity structure including accounts, parties, addresses, communications, and payment details. Supports pagination for large result sets.

Portfolio Analysis Workflow

GET /BizEntity retrieves entity structure with account relationships. For detailed portfolio analysis including investment holdings, unit balances, and valuations, use GET /BizEntity/Account/Holdings which provides:

Current investment positions and unit balances for each account
Market valuations and unrealized gains/losses
Distribution entitlements and reinvestment allocations
Historical holdings as at specific date (Date parameter)

Workflow Pattern: Use GET /BizEntity to identify entities (filter by type, product, person), then GET /BizEntity/Account/Holdings with AccountID filter to retrieve detailed portfolio positions for analysis and reporting.

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
`BizEntityID`	integer	Optional	Direct entity lookup using native identifier. Fastest performance for real-time workflows.
`ExternalBizEntityId`	string	Optional	Direct entity lookup using external identifier. Slower than BizEntityID due to secondary index.
`ProductID`	integer	Optional	Filter entities by product association. Essential for product-specific investor reporting.
`ExternalProductId`	string	Optional	Filter entities by external product identifier for cross-system product mapping.
`InvestmentID`	integer	Optional	Filter entities by investment association. More granular than ProductID for specific reporting.
`ExternalInvestmentId`	string	Optional	Filter entities by external investment identifier for cross-platform tracking.
`PersonID`	integer	Optional	Filter entities where person is party member. Essential for consolidated investor reporting.
`ExternalPersonId`	string	Optional	Filter entities by external person identifier for cross-system person tracking.
`OrganisationID`	integer	Optional	Filter entities where organisation is party member. Critical for trust structures.
`ExternalOrganisationId`	string	Optional	Filter entities by external organisation identifier for dealer group analysis.
`BizEntityTypeID`	FilterOfInt32	Optional	Filter by entity type for type-specific reporting. Critical for regulatory workflows.
`AccountID`	FilterOfInt32	Optional	Filter entities by account identifier for account-centric workflows.
`AccountNumber`	FilterOfString	Optional	Filter entities by account number pattern. More flexible than AccountID for bulk identification.
`ExternalAccountId`	FilterOfString	Optional	Filter entities by external account identifiers for cross-platform integration.
`CreatedDate`	FilterOfDateTime	Optional	Filter entities by creation timestamp. Never modified after creation - stable for historical analysis.
`UpdatedDate`	FilterOfDateTime	Optional	Filter entities by main record modification timestamp. DOES NOT capture nested changes - use UpdatedDateFull for comprehensive tracking.
`UpdatedDateFull`	string (date-time)	Optional	Filter entities where ANY part of structure was modified. Tracks deep changes across hierarchy - recommended for integration workflows.
`PageNumber`	integer	Optional	Page number to retrieve starting from 1. Use with PageSize for efficient pagination.
`PageSize`	integer	Optional	Number of records per page (maximum 1000). Essential for controlling response size.

BizEntityID

integer

Optional

Direct entity lookup using native identifier. Fastest performance for real-time workflows.

ExternalBizEntityId

string

Optional

Direct entity lookup using external identifier. Slower than BizEntityID due to secondary index.

ProductID

integer

Optional

Filter entities by product association. Essential for product-specific investor reporting.

ExternalProductId

string

Optional

Filter entities by external product identifier for cross-system product mapping.

InvestmentID

integer

Optional

Filter entities by investment association. More granular than ProductID for specific reporting.

ExternalInvestmentId

string

Optional

Filter entities by external investment identifier for cross-platform tracking.

PersonID

integer

Optional

Filter entities where person is party member. Essential for consolidated investor reporting.

ExternalPersonId

string

Optional

Filter entities by external person identifier for cross-system person tracking.

OrganisationID

integer

Optional

Filter entities where organisation is party member. Critical for trust structures.

ExternalOrganisationId

string

Optional

Filter entities by external organisation identifier for dealer group analysis.

BizEntityTypeID

FilterOfInt32

Optional

Filter by entity type for type-specific reporting. Critical for regulatory workflows.

AccountID

FilterOfInt32

Optional

Filter entities by account identifier for account-centric workflows.

AccountNumber

FilterOfString

Optional

Filter entities by account number pattern. More flexible than AccountID for bulk identification.

ExternalAccountId

FilterOfString

Optional

Filter entities by external account identifiers for cross-platform integration.

CreatedDate

FilterOfDateTime

Optional

Filter entities by creation timestamp. Never modified after creation - stable for historical analysis.

UpdatedDate

FilterOfDateTime

Optional

Filter entities by main record modification timestamp. DOES NOT capture nested changes - use UpdatedDateFull for comprehensive tracking.

UpdatedDateFull

string (date-time)

Optional

Filter entities where ANY part of structure was modified. Tracks deep changes across hierarchy - recommended for integration workflows.

PageNumber

integer

Optional

Page number to retrieve starting from 1. Use with PageSize for efficient pagination.

PageSize

integer

Optional

Number of records per page (maximum 1000). Essential for controlling response size.

Query & Filtering

🔍 7G Query & Filtering with Dot Operators

BizEntity is 7G's primary investor resource supporting advanced typed filtering for efficient entity management and cross-system integration.

FilterOfInt32 Numeric filtering

.equal .in .greaterThan .lessThan

BizEntityTypeID.equal=4 ProductID.in=10,20,30

FilterOfString Text pattern matching

.equal .contains .beginsWith .endsWith

AccountNumber.beginsWith=7G- ExternalAccountId.contains=SMSF

FilterOfDateTime Date/time ranges

.equal .greaterThan .lessThan .in

CreatedDate.greaterThan=2024-01-01T00:00:00Z UpdatedDate.lessThan=2024-12-31T23:59:59Z

🎯 Key BizEntity Scenarios: Entity Types → BizEntityTypeID.equal=[value] (use lookup endpoint for valid IDs) Account Patterns → AccountNumber.beginsWith=7G- Change Tracking → UpdatedDateFull.greaterThan=2024-01-01

📖 Complete Query & Filtering Guide

Example Requests

bash

# Get a specific entity by native ID (fastest lookup)
curl -X GET 'https://api.7g.com.au/BizEntity?BizEntityID=12345' \
  -H 'Authorization: {accessToken}' \
  -H 'Version: 2.0'

# Get entity by external ID (dual-ID system)
curl -X GET 'https://api.7g.com.au/BizEntity?ExternalBizEntityId=EXT-001' \
  -H 'Authorization: {accessToken}' \
  -H 'Version: 2.0'

# Get SMSF entities using dot operators
curl -X GET 'https://api.7g.com.au/BizEntity?BizEntityTypeID.equal=4&PageSize=50' \
  -H 'Authorization: {accessToken}' \
  -H 'Version: 2.0'

# Advanced filtering: Multiple entity types created in 2024 with pagination (exclude partnerships)
curl -X GET 'https://api.7g.com.au/BizEntity?BizEntityTypeID.in=1,2,3&BizEntityTypeID.notIn=5&CreatedDate.greaterThanOrEqual=2024-01-01T00:00:00Z&PageNumber=1&PageSize=100' \
  -H 'Authorization: {accessToken}' \
  -H 'Version: 2.0'

# Pattern matching: Entities with 7G account numbers updated recently
curl -X GET 'https://api.7g.com.au/BizEntity?AccountNumber.beginsWith=7G-&UpdatedDateFull.greaterThan=2024-06-01T00:00:00Z&PageSize=50' \
  -H 'Authorization: {accessToken}' \
  -H 'Version: 2.0'

# Text search: Find entities with SMSF in account numbers (paginated results)
curl -X GET 'https://api.7g.com.au/BizEntity?AccountNumber.contains=SMSF&ExternalAccountId.beginsWith=EXT-&PageNumber=1&PageSize=25' \
  -H 'Authorization: {accessToken}' \
  -H 'Version: 2.0'

Response Examples

json

{
  "result": true,
  "message": "",
  "recordCount": 1,
  "data": [
    {
      "bizEntityID": 12345,
      "externalBizEntityId": "EXT-001",
      "bizEntityTypeID": 4,
      "bizEntityStatusID": 1,
      "name": "Smith Super Fund",
      "legalName": "John Smith & Mary Smith ATF Smith Super Fund",
      "description": "Self-managed superannuation fund established 2024",
      "customerCode": "SMSF-001",
      "taxationCountryCode": "AUS",
      "createdDate": "2024-01-15T08:30:00Z",
      "advisorNumber": "ADV-12345",
      "communicationPreferenceCopyParentBizEntity": false,
      "isDirectorInterest": false,
      "isExecutiveInterest": false,
      "accounts": [
        {
          "accountID": 789,
          "externalAccountId": "ACC-001",
          "productID": 100,
          "externalProductId": "PROD-100",
          "accountNumber": "7G-SMSF-789",
          "currencyID": 1,
          "drpTypeID": 1,
          "drpValue": 0.00,
          "accountStatusID": 1,
          "balance": 125000.00
        }
      ],
      "addresses": [
        {
          "addressID": 321,
          "externalAddressId": "ADDR-001",
          "addressTypeID": 1,
          "addressLine": "123 Collins Street",
          "suburb": "Melbourne",
          "postcode": "3000",
          "stateCode": "VIC",
          "countryCode": "AUS"
        }
      ],
      "communications": [
        {
          "communicationID": 654,
          "externalCommunicationId": "COMM-001",
          "communicationTypeID": 1,
          "name": "admin@smithsuperfund.com.au"
        }
      ],
      "paymentDetails": [
        {
          "paymentDetailID": 111,
          "externalPaymentDetailId": "PAY-001",
          "paymentTypeID": 1,
          "bsb": "062000",
          "accountNumber": "12345678",
          "accountName": "Smith Super Fund",
          "isForDeposit": true,
          "isForDistribution": true,
          "isForRedemption": true,
          "isForOther": false
        }
      ],
      "bizEntityParties": [
        {
          "bizEntityPartyID": 456,
          "organisationID": null,
          "externalOrganisationId": null,
          "personID": 101,
          "externalPersonId": "PERSON-001",
          "isPrimaryContact": true,
          "isIncomeReceiving": true,
          "isSignatory": true,
          "isAuthorisedNominee": false,
          "isPowerOfAttorney": false,
          "ordinal": 1
        }
      ],
      "bizEntityParents": [
        {
          "bizEntityID": 12345,
          "externalBizEntityId": "EXT-001",
          "parentBizEntityID": 10001,
          "parentExternalBizEntityId": "PARENT-001",
          "dealerGroupBizEntityID": null,
          "externalDealerGroupBizEntityId": null,
          "activeFrom": "2024-01-01",
          "activeTo": null
        }
      ]
    }
  ]
}

Usage Notes

When

Requirements

Notes

Description

Portfolio Analysis Workflow

Required Headers - See Authentication

Query Parameters

Query & Filtering

🔍 7G Query & Filtering with Dot Operators

Example Requests

Response Examples

Related Endpoints

Connection Lost