GET

/BizEvent

Usage Notes

When

  • Query events by ID, account, product, or type
  • Track event status and history
  • Filter events for operational oversight

Requirements

  • At least one filter parameter or use pagination

Notes

  • Supports FilterField dot operators for flexible filtering
  • Returns paginated arrays of event records

Description

Retrieves event records with filtering by ID, account, product, or event type. Supports pagination for large result sets.

Required Headers - See Authentication

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

Query Parameters

Parameter Type Required Description
BizEventID
FilterOfInt64
Optional
Native 7G identifier for the business event record.
AccountID
FilterOfInt32
Optional
Native 7G identifier for the account associated with the event.
ExternalAccountId
FilterOfString
Optional
External system identifier for the account (alternative to AccountID).
ProductID
integer
Optional
Native 7G identifier for the product associated with the event.
ExternalProductId
string
Optional
External system identifier for the product (alternative to ProductID).
PageSize
integer
Optional
Number of records per page (maximum 1000). Defaults to 100 if not specified.
PageNumber
integer
Optional
Page number to retrieve (starts from 1). Defaults to 1 if not specified.
BizEventID
FilterOfInt64
Optional
Native 7G identifier for the business event record.
AccountID
FilterOfInt32
Optional
Native 7G identifier for the account associated with the event.
ExternalAccountId
FilterOfString
Optional
External system identifier for the account (alternative to AccountID).
ProductID
integer
Optional
Native 7G identifier for the product associated with the event.
ExternalProductId
string
Optional
External system identifier for the product (alternative to ProductID).
PageSize
integer
Optional
Number of records per page (maximum 1000). Defaults to 100 if not specified.
PageNumber
integer
Optional
Page number to retrieve (starts from 1). Defaults to 1 if not specified.

Query & Filtering

🔍 BizEvent Filtering with Dot Operators

BizEvent GET endpoint supports typed filtering with dot operators for efficient event record retrieval and history querying.

FilterOfInt64 Large event IDs
.equal .in .greaterThan .lessThan
BizEventID.equal=50001 BizEventID.in=50001,50002,50003
FilterOfInt32 Account classifications
.equal .in .greaterThan .lessThan
AccountID.equal=12345 AccountID.in=12345,12346
FilterOfString External system IDs
.equal .contains .beginsWith .endsWith
ExternalAccountId.beginsWith=EXT- ExternalAccountId.contains=TRUST
🎯 Key BizEvent Scenarios: Event Tracking → BizEventID.greaterThan=50000 (recent events) Account Events → AccountID.equal=12345 (account-specific) External System → ExternalAccountId.beginsWith=EXT- (integration patterns)

Example Requests

bash
# Get specific event by ID using equal operator
curl -X GET 'https://api.7g.com.au/BizEvent?BizEventID.equal=12345' \
  -H 'Authorization: {accessToken}' \
  -H 'Version: 2.0'

# Get events for multiple event IDs using in operator (exclude cancelled events)
curl -X GET 'https://api.7g.com.au/BizEvent?BizEventID.in=12345,12346,12347&BizEventID.notIn=12348' \
  -H 'Authorization: {accessToken}' \
  -H 'Version: 2.0'

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

# Get events for specific account using equal operator
curl -X GET 'https://api.7g.com.au/BizEvent?AccountID.equal=5678&PageSize=100' \
  -H 'Authorization: {accessToken}' \
  -H 'Version: 2.0'

# Filter by external account ID with pattern matching
curl -X GET 'https://api.7g.com.au/BizEvent?ExternalAccountId.contains=SMSF&ExternalProductId=PROD-001' \
  -H 'Authorization: {accessToken}' \
  -H 'Version: 2.0'

Response Examples

json
{
  "result": true,
  "message": "Success",
  "recordCount": 147,
  "data": [
    {
      "bizEventID": 12345,
      "bizEventTypeID": 51,
      "bizEventStatusID": 2,
      "productID": 100,
      "externalProductId": "PROD-001",
      "investmentID": 200,
      "externalInvestmentId": "INV-001",
      "accountID": 5678,
      "externalAccountId": "ACC-001",
      "accountNumber": "ACC123456",
      "bizEntityName": "Smith Family Trust",
      "bizEventDate": "2024-01-15",
      "amount": 50000.00,
      "quantity": null,
      "comment": "Deposit confirmation - bank transfer received",
      "conversionMethodID": null,
      "conversionFactor": null,
      "createdDate": "2024-01-15T09:30:00Z",
      "updatedDate": "2024-01-15T14:45:00Z"
    },
    {
      "bizEventID": 12346,
      "bizEventTypeID": 50,
      "bizEventStatusID": 1,
      "productID": 100,
      "externalProductId": "PROD-001",
      "investmentID": 200,
      "externalInvestmentId": "INV-001",
      "accountID": 5678,
      "externalAccountId": "ACC-001",
      "accountNumber": "ACC123456",
      "bizEntityName": "Smith Family Trust",
      "bizEventDate": "2024-01-20",
      "amount": 25000.00,
      "quantity": 1000.00,
      "comment": "Conversion notice - Class A to Class B units",
      "conversionMethodID": 1,
      "conversionFactor": 0.8,
      "createdDate": "2024-01-20T11:15:00Z",
      "updatedDate": null
    }
  ]
}