POST

/BizEvent/NoticeOfDeposit

Usage Notes

When

  • Record pending deposit before actual processing
  • Pre-register deposits for workflow tracking

Requirements

  • Account and Investment must exist
  • TransactionDate required

Notes

  • Creates single event record
  • ExternalBizEventId provides idempotency

Description

Creates a deposit event notice representing a pending deposit operation. Returns event record with system-assigned bizEventID.

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.
externalBizTransactionId
 string
Optional
External transaction identifier for system integration.
externalProductId >
string
External system identifier for the product (alternative to productID).
InvestmentID >
integer
Native 7G identifier for the investment.
externalInvestmentId >
string
External system identifier for the investment (alternative to investmentID).
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 deposit.
comment
 string
Optional
Additional notes or deposit reason.
transactionDate
 date
Optional
Effective date for the deposit (YYYY-MM-DD format).
paymentMethodID
 integer
Optional
Payment method identifier.
chequeBankName
 string
Optional
Bank name for cheque deposits. Required for cheque-based payments.
chequeBSB
 string
Optional
Bank State Branch code for cheque deposits. Required for cheque-based payments.
chequeAccountNumber
 string
Optional
Bank account number for cheque deposits. Required for cheque-based payments.
chequeChequeNo
 string
Optional
Cheque number for cheque deposits. Required for cheque-based payments.
chequeDrawer
 string
Optional
Name of person who wrote the cheque. Required for cheque-based payments.
entryFeeAmount
 decimal
Optional
Fixed entry fee amount in currency units.
entryFeeDiscountPercentage
 decimal
Optional
Entry fee discount percentage (0.0 to 100.0).
entryFeeOverridePercentage
 decimal
Optional
Entry fee override percentage (0.0 to 100.0).
entryFeePercentage
 decimal
Optional
Entry fee percentage (0.0 to 100.0).
ProductID
integer
Native 7G identifier for the product.
externalBizTransactionId
string
Optional
External transaction identifier for system integration.
externalProductId
string
External system identifier for the product (alternative to productID).
InvestmentID
integer
Native 7G identifier for the investment.
externalInvestmentId
string
External system identifier for the investment (alternative to investmentID).
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 deposit.
comment
string
Optional
Additional notes or deposit reason.
transactionDate
date
Optional
Effective date for the deposit (YYYY-MM-DD format).
paymentMethodID
integer
Optional
Payment method identifier.
chequeBankName
string
Optional
Bank name for cheque deposits. Required for cheque-based payments.
chequeBSB
string
Optional
Bank State Branch code for cheque deposits. Required for cheque-based payments.
chequeAccountNumber
string
Optional
Bank account number for cheque deposits. Required for cheque-based payments.
chequeChequeNo
string
Optional
Cheque number for cheque deposits. Required for cheque-based payments.
chequeDrawer
string
Optional
Name of person who wrote the cheque. Required for cheque-based payments.
entryFeeAmount
decimal
Optional
Fixed entry fee amount in currency units.
entryFeeDiscountPercentage
decimal
Optional
Entry fee discount percentage (0.0 to 100.0).
entryFeeOverridePercentage
decimal
Optional
Entry fee override percentage (0.0 to 100.0).
entryFeePercentage
decimal
Optional
Entry fee percentage (0.0 to 100.0).

Example Requests

bash
curl -X POST 'https://api.7g.com.au/BizEvent/NoticeOfDeposit' \
  -H 'Authorization: {accessToken}' \
  -H 'Version: 2.0' \
  -H 'Content-Type: application/json' \
  -d '{
    "productID": 100,
    "investmentID": 200,
    "accountID": 5678,
    "amount": 50000.00,
    "comment": "Initial investment deposit - bank transfer",
    "transactionDate": "2024-01-15",
    "paymentMethodID": 1
  }'

Response Examples

json
{
  "result": true,
  "message": "Deposit notice created successfully",
  "recordCount": 1,
  "data": [
    {
      "bizEventID": 50001,
      "bizEventTypeID": 51,
      "bizEventStatusID": 1,
      "productID": 100,
      "externalProductId": "PROD-001",
      "investmentID": 200,
      "externalInvestmentId": "INV-DEPOSIT-001",
      "accountID": 5678,
      "externalAccountId": "ACC-001",
      "accountNumber": "ACC123456",
      "bizEntityName": "Smith Family Trust",
      "bizEventDate": "2024-01-15",
      "amount": 50000.00,
      "quantity": null,
      "comment": "Initial investment deposit - bank transfer",
      "conversionMethodID": null,
      "conversionFactor": null,
      "createdDate": "2024-01-15T09:30:00Z",
      "updatedDate": null
    }
  ]
}
GET Get BizEvents POST Deposit PUT Cancel Event