📢 BizEvent Resource

Event notice recording and retrieval

BizEvent records business event notices for deposit, redemption, and conversion operations. Events track pending operations before they become BizTransactions.

5
Endpoints
3
Notice Types
5
Operations
7
Filter Fields

Usage Notes

When

  • Record event notices for pending deposits, redemptions, and conversions
  • Query event history for workflow tracking
  • Cancel pending events before processing

Requirements

  • Valid Bearer token with event permissions

Notes

  • Event notices precede actual transactions (pending state)
  • NoticeOfConversion creates TWO linked event records
  • Events can be cancelled via PUT /BizEvent/Cancel

Available Endpoints

Event Management

GET Get Events Filtering and event history
PUT Cancel Event Cancel pending event records

Event Creation

POST NoticeOfDeposit Create deposit event records
POST NoticeOfRedemption Create redemption event records
POST NoticeOfConversion Create conversion event records

Core Data Transfer Objects

NoticeOfDepositDTO NoticeOfDeposit POST endpoint Request body (20 properties) including account/investment specification, amount, transaction date, payment details (cheque fields), and entry fee configuration
NoticeOfRedemptionDTO NoticeOfRedemption POST endpoint Request body (11 properties) including account/investment specification, quantity/amount options, transaction date, comment, and external transaction identifier
NoticeOfConversionDTO NoticeOfConversion POST endpoint Request body (15 properties) with source/target investment specifications, conversion method and factor, quantity/amount options, and external transaction identifier
BizEventDTO GET responses, event records Event record structure with event type, product/investment/account references, amounts, dates, comments, and status information

Filter Data Transfer Objects

GET endpoint uses a filter class to bind query parameters. This is a request-only structure for filtering and pagination.

BizEventFilter GET /BizEvent 7 filter fields: BizEventID, BizEventTypeID, AccountNumber, AccountID, ExternalAccountId (FilterField), ProductID, ExternalProductId (direct) + pagination

Request & Response Patterns

Identifier Patterns

  • Dual identifiers supported: Native 7G IDs (ProductID, AccountID, InvestmentID) and external IDs (externalProductId, externalAccountId, externalInvestmentId)
  • Either native or external identifier required for product, account, and investment references
  • BizEventID is the unique identifier for event records returned by the API

Multi-Record Operations

  • NoticeOfConversion returns 2 linked event records: source investment redemption and target investment allotment
  • NoticeOfDeposit and NoticeOfRedemption return single event records
  • GET endpoint returns paginated arrays of event records with filtering support

Filtering Capabilities

  • GET /BizEvent supports FilterField dot operators for BizEventID, AccountID, ExternalAccountId, BizEventTypeID, AccountNumber
  • Direct filtering available for ProductID and ExternalProductId
  • Standard pagination via PageSize and PageNumber parameters