POST

/BizEvent/NoticeOfConversion

Usage Notes

When

  • Record pending conversion between investments
  • Pre-register conversions for workflow tracking

Requirements

  • Source and target investments must exist
  • Account must hold source investment

Notes

  • Creates TWO linked event records (source redemption and target allotment)
  • Response returns array with both event records; the target event's parentBizEventID references the source event
  • Each leg carries its own external transaction identifier (fromExternalBizTransactionId / toExternalBizTransactionId), returned as externalTransactionId on the matching event

Description

Creates conversion event notices representing a pending investment conversion. Returns TWO linked event records.

Required Headers - See Authentication

HeaderValueDescription
Content-Typeapplication/jsonRequest content type
Authorization{accessToken}Bearer token for API access
Version2.0API version identifier

Request Body

Parameter Type Required Description
productID >
integer
Native 7G identifier for the product.
fromExternalBizTransactionId
 string
Optional
Your external transaction identifier for the source (From) leg of the conversion. Returned as externalTransactionId on the source event record.
toExternalBizTransactionId
 string
Optional
Your external transaction identifier for the target (To) leg of the conversion. Returned as externalTransactionId on the target event record.
externalProductId >
string
External system identifier for the product (alternative to productID).
fromInvestmentID >
integer
Native 7G identifier for the source investment.
fromExternalInvestmentId >
string
External system identifier for the source investment (alternative to fromInvestmentID).
fromSecurityCode >
string
Source investment's business-facing security code. Resolved within the supplied productID / externalProductId scope.
toInvestmentID >
integer
Native 7G identifier for the target investment.
toExternalInvestmentId >
string
External system identifier for the target investment (alternative to toInvestmentID).
toSecurityCode >
string
Target investment's business-facing security code. Resolved within the supplied productID / externalProductId scope.
accountID >
integer
Native 7G identifier for the account.
externalAccountId >
string
External system identifier for the account (alternative to accountID).
amount
 decimal
Optional
Monetary value of the conversion.
quantity
 decimal
Optional
Number of units being converted from the source investment.
comment
 string
Optional
Additional notes or reason for conversion.
transactionDate >
string (date)
Effective date for the conversion. Format: YYYY-MM-DD. Cannot be empty or default value.
conversionFactor
 decimal
Optional
Multiplier for unit conversion calculations between source and target investments.
conversionMethod
 string
Optional
Method identifier for the conversion calculation.
productID
integer
Native 7G identifier for the product.
fromExternalBizTransactionId
string
Optional
Your external transaction identifier for the source (From) leg of the conversion. Returned as externalTransactionId on the source event record.
toExternalBizTransactionId
string
Optional
Your external transaction identifier for the target (To) leg of the conversion. Returned as externalTransactionId on the target event record.
externalProductId
string
External system identifier for the product (alternative to productID).
fromInvestmentID
integer
Native 7G identifier for the source investment.
fromExternalInvestmentId
string
External system identifier for the source investment (alternative to fromInvestmentID).
fromSecurityCode
string
Source investment's business-facing security code. Resolved within the supplied productID / externalProductId scope.
toInvestmentID
integer
Native 7G identifier for the target investment.
toExternalInvestmentId
string
External system identifier for the target investment (alternative to toInvestmentID).
toSecurityCode
string
Target investment's business-facing security code. Resolved within the supplied productID / externalProductId scope.
accountID
integer
Native 7G identifier for the account.
externalAccountId
string
External system identifier for the account (alternative to accountID).
amount
decimal
Optional
Monetary value of the conversion.
quantity
decimal
Optional
Number of units being converted from the source investment.
comment
string
Optional
Additional notes or reason for conversion.
transactionDate
string (date)
Effective date for the conversion. Format: YYYY-MM-DD. Cannot be empty or default value.
conversionFactor
decimal
Optional
Multiplier for unit conversion calculations between source and target investments.
conversionMethod
string
Optional
Method identifier for the conversion calculation.
💡

Three Ways to Identify Each Side

Each side (From and To) supports the three-key identifier model. For each side, supply exactly one of the native ID, external ID, or security code. Both sides resolve within the same productID / externalProductId scope - conversions are product-internal.

A miss on either side returns the matching From or To error string (see IDs & External References).

Example Requests

bash
curl -X POST 'https://api.7g.com.au/BizEvent/NoticeOfConversion' \
  -H 'Authorization: {accessToken}' \
  -H 'Version: 2.0' \
  -H 'Content-Type: application/json' \
  -d '{
    "productID": 100,
    "fromInvestmentID": 200,
    "toInvestmentID": 201,
    "accountID": 5678,
    "fromExternalBizTransactionId": "CONV-001-FROM",
    "toExternalBizTransactionId": "CONV-001-TO",
    "amount": 25000.00,
    "comment": "Class A to Class B conversion per investor request",
    "transactionDate": "2024-02-15",
    "conversionFactor": 0.85,
    "conversionMethod": "NAV_Based"
  }'

Response Examples

json
{
  "result": true,
  "message": "Notice(s) of conversion has been saved.",
  "recordCount": 2,
  "data": [
    {
      "bizEventID": 50003,
      "bizEventTypeID": 50,
      "bizEventStatusID": 1,
      "productID": 100,
      "externalProductId": "PROD-001",
      "investmentID": 200,
      "externalInvestmentId": "INV-CLASS-A",
      "accountID": 5678,
      "externalAccountId": "ACC-001",
      "accountNumber": "ACC123456",
      "bizEntityName": "Smith Family Trust",
      "bizEventDate": "2024-02-15",
      "amount": 25000.00,
      "quantity": 1000.00,
      "comment": "Class A to Class B conversion per investor request (source redemption)",
      "conversionMethodID": 1,
      "conversionFactor": 0.85,
      "createdDate": "2024-02-15T10:15:00Z",
      "updatedDate": null,
      "parentBizEventID": null,
      "externalTransactionId": "CONV-001-FROM"
    },
    {
      "bizEventID": 50004,
      "bizEventTypeID": 50,
      "bizEventStatusID": 1,
      "productID": 100,
      "externalProductId": "PROD-001",
      "investmentID": 201,
      "externalInvestmentId": "INV-CLASS-B",
      "accountID": 5678,
      "externalAccountId": "ACC-001",
      "accountNumber": "ACC123456",
      "bizEntityName": "Smith Family Trust",
      "bizEventDate": "2024-02-15",
      "amount": 25000.00,
      "quantity": 850.00,
      "comment": "Class A to Class B conversion per investor request (target allotment)",
      "conversionMethodID": 1,
      "conversionFactor": 0.85,
      "createdDate": "2024-02-15T10:15:00Z",
      "updatedDate": null,
      "parentBizEventID": 50003,
      "externalTransactionId": "CONV-001-TO"
    }
  ]
}
GET Get BizEvents POST Conversion PUT Cancel Event