POST
/BizEvent/NoticeOfDeposit
When to Use
- Create deposit event notice records for investor contributions
- Record deposit details including amount, payment method, and fee information
- Create event records with external identifiers for system integration
Prerequisites
- Valid account and investment identifiers (native or external)
- TransactionDate in YYYY-MM-DD format
Considerations
- Returns single event record upon successful creation
- Entry fee fields support percentage-based or fixed amount fee specifications
- Cheque-related fields optional (required only when payment method is cheque-based)
Description
Creates a deposit event notice record with specified amount, payment method, fee details, and account/investment references. Returns the created event record with assigned BizEventID for tracking purposes.
Deposit Event Records
Deposit notice records capture contribution details including payment method, entry fees, and cheque information when applicable for cheque-based payments.
Required Headers - See Authentication
| Header | Value | Description |
|---|---|---|
| Content-Type | application/json | Request content type |
| Authorization | {accessToken} | Bearer token for API access |
| Version | 2.0 | API 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
Native 7G identifier for the product.
externalBizTransactionId
External transaction identifier for system integration.
externalProductId
External system identifier for the product (alternative to productID).
InvestmentID
Native 7G identifier for the investment.
externalInvestmentId
External system identifier for the investment (alternative to investmentID).
AccountID
Native 7G identifier for the account.
externalAccountId
External system identifier for the account (alternative to accountID).
amount
Monetary value of the deposit.
comment
Additional notes or deposit reason.
transactionDate
Effective date for the deposit (YYYY-MM-DD format).
paymentMethodID
Payment method identifier.
chequeBankName
Bank name for cheque deposits. Required for cheque-based payments.
chequeBSB
Bank State Branch code for cheque deposits. Required for cheque-based payments.
chequeAccountNumber
Bank account number for cheque deposits. Required for cheque-based payments.
chequeChequeNo
Cheque number for cheque deposits. Required for cheque-based payments.
chequeDrawer
Name of person who wrote the cheque. Required for cheque-based payments.
entryFeeAmount
Fixed entry fee amount in currency units.
entryFeeDiscountPercentage
Entry fee discount percentage (0.0 to 100.0).
entryFeeOverridePercentage
Entry fee override percentage (0.0 to 100.0).
entryFeePercentage
Entry fee percentage (0.0 to 100.0).
Example Requests
json
{
"productID": 100,
"externalBizTransactionId": "DEPOSIT-001",
"externalProductId": "PROD-001",
"investmentID": 200,
"externalInvestmentId": "INV-DEPOSIT-001",
"accountID": 5678,
"externalAccountId": "ACC-001",
"amount": 50000.00,
"comment": "Initial investment deposit - bank transfer",
"transactionDate": "2024-01-15",
"paymentMethodID": 1,
"chequeBankName": "Commonwealth Bank",
"chequeBSB": "062-001",
"chequeAccountNumber": "12345678",
"chequeChequeNo": "000123",
"chequeDrawer": "John Smith",
"entryFeeAmount": 750.00,
"entryFeeDiscountPercentage": 0.0,
"entryFeeOverridePercentage": 0.0,
"entryFeePercentage": 1.5
}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
}
]
}