GET
/BizEvent
When to Use
- Track transaction event notifications and processing status
- Monitor investor communication events for regulatory compliance
- Audit event delivery and confirmation across portfolios
- Retrieve event history for specific accounts or products
Common Scenarios
- Event Status Monitoring: Track notice delivery and processing
- Compliance Auditing: Verify regulatory notification requirements
- Portfolio Analysis: Review all events for specific products or accounts
- Error Resolution: Identify failed or cancelled events for remediation
Prerequisites
- Valid Bearer token with event read permissions
- Knowledge of productID or accountID values for targeted filtering
- Understanding of event types and status codes
Considerations
- Event data is paginated for large datasets - use pageSize and pageNumber effectively
- Event processing status indicates delivery confirmation and system integration
- Historical events may include cancelled or superseded notices
- Compliance events have mandatory retention periods and audit requirements
Description
Retrieves business event records with comprehensive filtering options using dot operators for advanced querying. Returns complete event lifecycle data including processing status, stakeholder information, delivery confirmation, and regulatory compliance tracking. Essential for monitoring transaction notifications, investor communications, and system integration workflows across the 7G platform.
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 |
---|---|---|---|
BizEventID |
FilterOfInt64 | Optional |
Direct event lookup using native 7G event identifier. Most efficient method for single event retrieval and audit workflows. |
AccountID |
FilterOfInt32 | Optional |
Filter events by native account identifier. Essential for account-level event tracking, compliance monitoring, and audit trails. |
ExternalAccountId |
FilterOfString | Optional |
Filter events by external account references. Critical for cross-system integration, external ID mapping, and regulatory compliance workflows. |
ProductID |
integer | Optional |
Filter events by product association. Use to focus on specific investment product workflows and regulatory notifications. |
ExternalProductId |
string | Optional |
Filter events by external product references. Important for product mapping across systems and portfolio management integration. |
PageSize |
integer | Optional |
Number of records per page (maximum 1000). Default is system-defined. Essential for managing large event datasets efficiently. |
PageNumber |
integer | Optional |
Page number to retrieve (starts from 1). Default is 1. Use with PageSize for systematic pagination through event history. |
BizEventID
Direct event lookup using native 7G event identifier. Most efficient method for single event retrieval and audit workflows.
AccountID
Filter events by native account identifier. Essential for account-level event tracking, compliance monitoring, and audit trails.
ExternalAccountId
Filter events by external account references. Critical for cross-system integration, external ID mapping, and regulatory compliance workflows.
ProductID
Filter events by product association. Use to focus on specific investment product workflows and regulatory notifications.
ExternalProductId
Filter events by external product references. Important for product mapping across systems and portfolio management integration.
PageSize
Number of records per page (maximum 1000). Default is system-defined. Essential for managing large event datasets efficiently.
PageNumber
Page number to retrieve (starts from 1). Default is 1. Use with PageSize for systematic pagination through event history.
Query & Filtering
🔍 7G Event Lifecycle Filtering with Dot Operators
BizEvent is 7G's event management engine supporting advanced typed filtering for efficient event tracking, regulatory compliance monitoring, and system integration workflows.
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 "Version: 2.0" \
-H "Authorization: {accessToken}"
# 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 "Version: 2.0" \
-H "Authorization: {accessToken}"
# Get all events for a product
curl -X GET "https://api.7g.com.au/BizEvent?ProductID=100&PageSize=50&PageNumber=1" \
-H "Version: 2.0" \
-H "Authorization: {accessToken}"
# Get events for specific account using Equal operator
curl -X GET "https://api.7g.com.au/BizEvent?AccountID.Equal=5678&PageSize=100" \
-H "Version: 2.0" \
-H "Authorization: {accessToken}"
# Filter by external account ID with pattern matching
curl -X GET "https://api.7g.com.au/BizEvent?ExternalAccountId.Contains=SMSF&ExternalProductId=PROD-001" \
-H "Version: 2.0" \
-H "Authorization: {accessToken}"
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
}
]
}