PUT

/Investment

When to Use

Update investment configuration settings and allotment rules
Modify distribution frequency and reinvestment eligibility settings
Enable or disable investment trading by updating IsActive status
Update investment classifications and APIR codes
Adjust investment lifecycle dates and closure settings

Prerequisites

Investment record must exist

Considerations

PUT replaces entire investment record - include ALL fields to prevent data loss
ExternalInvestmentId cannot be modified after creation
Changes to IsActive status affect transaction processing immediately
NoOfDecimalPlaces changes affect existing pricing displays and calculations
Existing transactions may prevent certain modifications

Description

Updates an existing investment product with complete replacement of all fields. This endpoint performs comprehensive validation to ensure changes don't break existing transactions or violate business rules.

Update Process

System validates investment exists and is modifiable
Performs business rule validation for all changes
Checks impact on existing transactions and holdings
Applies changes atomically
Returns updated investment structure

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
`InvestmentID`	integer	Optional	Investment identifier for record identification (either InvestmentID or ExternalInvestmentId must be provided for PUT operations).
`externalInvestmentId`	string	Optional	External investment identifier for record identification (immutable field - cannot be changed during PUT operations).
`allowAllotment` >	boolean	> Required...	Controls whether new deposits are accepted via BizTransaction/Deposit (works with allotmentCutoffDate for lifecycle control).
`allotmentCutoffDate`	date	Optional	Hard deadline for accepting new investments (YYYY-MM-DD format, system rejects all deposits after this date regardless of allowAllotment status).
`allowDistribution` >	boolean	> Required...	Controls whether investment can process Distribution declarations, payments, and DRP operations.
`allotmentMinAmount`	decimal	Optional	Minimum deposit amount per transaction enforced during BizTransaction processing (e.g., $1,000-$5,000 retail, $250,000+ wholesale).
`allotmentMaxAmount`	decimal	Optional	Maximum single deposit amount per transaction (null allows unlimited deposits subject to maxCapital constraints).
`calcDividendIncludingFirstDay` >	boolean	> Required...	Controls whether Distribution accruals include first day of holding period (true includes purchase date, false excludes it).
`couponRate`	decimal	Optional	Fixed interest rate percentage for term deposits and bond investments (e.g., 5.25 = 5.25% annual interest).
`description`	string	Optional	Investment product narrative displayed in investor portals and statements (include strategy, risk profile, target market).
`distributionPeriodID`	integer	Optional	Distribution payment frequency reference via common/lookup. Affects Distribution/Declare timing.
`distributionTermID`	integer	Optional	Distribution calculation methodology via common/lookup (defines how distribution amounts are calculated for Distribution/Declare operations).
`endDate`	date	Optional	Investment maturity or planned closure date (YYYY-MM-DD format, does not automatically close investment - use with isActive flag).
`isActive` >	boolean	> Required...	Master control for all BizTransaction processing (false completely blocks all financial transactions regardless of other settings).
`isIncludedInAnnualReporting`	boolean	Optional	Controls whether investment appears on investor annual tax statements and EOFY summaries (default true for regulatory reporting).
`securityCode`	string	Optional	APIR code or international security identifier (ISIN, CUSIP, ticker symbol, required for Australian public offerings).
`maxCapital`	decimal	Optional	Maximum aggregate capital across all investors (system prevents new deposits exceeding this cap, null allows unlimited).
`name`	string	Optional	Investment display name shown in portals, statements, and transaction confirmations.
`noOfDecimalPlaces`	integer	Optional	Pricing precision (0-6 decimals) for calculations and InvestmentPrice records (CRITICAL: immutable after transactions exist).
`ordinal`	integer	Optional	Display sequence number for sorting investments in user interfaces (lower numbers appear first).
`ProductID`	integer	Optional	Parent product identifier linking investment to product hierarchy (product must exist before investment creation).
`externalProductId`	string	Optional	External product identifier for cross-system integration (alternative to ProductID, system resolves to native ProductID internally).
`roundingMethodID`	integer	Optional	Price rounding methodology reference via common/lookup. Applies after noOfDecimalPlaces precision.
`startDate`	date	Optional	Date when investment becomes available for deposits (YYYY-MM-DD format, use with isActive flag for precise availability control).
`termDays`	integer	Optional	Investment term length in days for short-term configurations (mutually exclusive with termMonths, use for money market instruments).
`termMonths`	integer	Optional	Investment term length in months for term deposits (common values: 3, 6, 12, 24, 36, null for ongoing managed funds).
`termTypeID`	integer	Optional	Term structure classification via common/lookup (defines investment duration methodology: fixed-term, open-ended, rolling).
`topUpMaxAmount`	decimal	Optional	Maximum amount for subsequent deposits to existing holdings (separate from allotmentMaxAmount, null allows unlimited top-ups).
`topUpMinAmount`	decimal	Optional	Minimum amount for subsequent deposits to existing holdings (typically lower than allotmentMinAmount).
`investmentTypeID` >	integer	> Required...	Investment type classification via common/lookup determining business rules and transaction processing logic.

InvestmentID

integer

Optional

Investment identifier for record identification (either InvestmentID or ExternalInvestmentId must be provided for PUT operations).

externalInvestmentId

string

Optional

External investment identifier for record identification (immutable field - cannot be changed during PUT operations).

allowAllotment

boolean

> Required...

Controls whether new deposits are accepted via BizTransaction/Deposit (works with allotmentCutoffDate for lifecycle control).

allotmentCutoffDate

date

Optional

Hard deadline for accepting new investments (YYYY-MM-DD format, system rejects all deposits after this date regardless of allowAllotment status).

allowDistribution

boolean

> Required...

Controls whether investment can process Distribution declarations, payments, and DRP operations.

allotmentMinAmount

decimal

Optional

Minimum deposit amount per transaction enforced during BizTransaction processing (e.g., $1,000-$5,000 retail, $250,000+ wholesale).

allotmentMaxAmount

decimal

Optional

Maximum single deposit amount per transaction (null allows unlimited deposits subject to maxCapital constraints).

calcDividendIncludingFirstDay

boolean

> Required...

Controls whether Distribution accruals include first day of holding period (true includes purchase date, false excludes it).

couponRate

decimal

Optional

Fixed interest rate percentage for term deposits and bond investments (e.g., 5.25 = 5.25% annual interest).

description

string

Optional

Investment product narrative displayed in investor portals and statements (include strategy, risk profile, target market).

distributionPeriodID

integer

Optional

Distribution payment frequency reference via common/lookup. Affects Distribution/Declare timing.

distributionTermID

integer

Optional

Distribution calculation methodology via common/lookup (defines how distribution amounts are calculated for Distribution/Declare operations).

endDate

date

Optional

Investment maturity or planned closure date (YYYY-MM-DD format, does not automatically close investment - use with isActive flag).

isActive

boolean

> Required...

Master control for all BizTransaction processing (false completely blocks all financial transactions regardless of other settings).

isIncludedInAnnualReporting

boolean

Optional

Controls whether investment appears on investor annual tax statements and EOFY summaries (default true for regulatory reporting).

securityCode

string

Optional

APIR code or international security identifier (ISIN, CUSIP, ticker symbol, required for Australian public offerings).

maxCapital

decimal

Optional

Maximum aggregate capital across all investors (system prevents new deposits exceeding this cap, null allows unlimited).

name

string

Optional

Investment display name shown in portals, statements, and transaction confirmations.

noOfDecimalPlaces

integer

Optional

Pricing precision (0-6 decimals) for calculations and InvestmentPrice records (CRITICAL: immutable after transactions exist).

ordinal

integer

Optional

Display sequence number for sorting investments in user interfaces (lower numbers appear first).

ProductID

integer

Optional

Parent product identifier linking investment to product hierarchy (product must exist before investment creation).

externalProductId

string

Optional

External product identifier for cross-system integration (alternative to ProductID, system resolves to native ProductID internally).

roundingMethodID

integer

Optional

Price rounding methodology reference via common/lookup. Applies after noOfDecimalPlaces precision.

startDate

date

Optional

Date when investment becomes available for deposits (YYYY-MM-DD format, use with isActive flag for precise availability control).

termDays

integer

Optional

Investment term length in days for short-term configurations (mutually exclusive with termMonths, use for money market instruments).

termMonths

integer

Optional

Investment term length in months for term deposits (common values: 3, 6, 12, 24, 36, null for ongoing managed funds).

termTypeID

integer

Optional

Term structure classification via common/lookup (defines investment duration methodology: fixed-term, open-ended, rolling).

topUpMaxAmount

decimal

Optional

Maximum amount for subsequent deposits to existing holdings (separate from allotmentMaxAmount, null allows unlimited top-ups).

topUpMinAmount

decimal

Optional

Minimum amount for subsequent deposits to existing holdings (typically lower than allotmentMinAmount).

investmentTypeID

integer

> Required...

Investment type classification via common/lookup determining business rules and transaction processing logic.

Complete Replacement

PUT operations require all fields to be provided:

investmentID: Must match the investment being updated
External IDs: Cannot be changed - must match current values
All other fields: Will be replaced with provided values

Important: Missing fields will be set to null/default values.

Example Requests

json

{
  "investmentID": 12345,
  "externalInvestmentId": "INV-001",
  "allowAllotment": true,
  "allotmentCutoffDate": "2025-08-16",
  "allowDistribution": true,
  "allotmentMinAmount": 1000.00,
  "allotmentMaxAmount": 1000000.00,
  "calcDividendIncludingFirstDay": false,
  "couponRate": 5.50,
  "description": "High Growth Equity Fund - Class A units with quarterly distributions - Updated",
  "distributionPeriodID": 2,
  "distributionTermID": 1,
  "endDate": "2030-12-31",
  "isActive": true,
  "isIncludedInAnnualReporting": true,
  "securityCode": "HGF001A",
  "maxCapital": 75000000.00,
  "name": "High Growth Equity Fund A",
  "noOfDecimalPlaces": 4,
  "ordinal": 1,
  "productID": 100,
  "externalProductId": "FUND-001",
  "roundingMethodID": 1,
  "startDate": "2025-01-01",
  "termDays": 0,
  "termMonths": 36,
  "termTypeID": 2,
  "topUpMaxAmount": 500000.00,
  "topUpMinAmount": 500.00,
  "investmentTypeID": 1
}

Response Examples

json

{
  "result": true,
  "message": "Investment updated successfully",
  "recordCount": 1,
  "data": {
    "investmentID": 12345,
    "externalInvestmentId": "INV-001",
    "allowAllotment": true,
    "allotmentCutoffDate": "2025-08-16",
    "allowDistribution": true,
    "allotmentMinAmount": 1000.00,
    "allotmentMaxAmount": 1000000.00,
    "calcDividendIncludingFirstDay": false,
    "couponRate": 5.50,
    "description": "High Growth Equity Fund - Class A units with quarterly distributions - Updated",
    "distributionPeriodID": 2,
    "distributionTermID": 1,
    "endDate": "2030-12-31",
    "isActive": true,
    "isIncludedInAnnualReporting": true,
    "securityCode": "HGF001A",
    "maxCapital": 75000000.00,
    "name": "High Growth Equity Fund A",
    "noOfDecimalPlaces": 4,
    "ordinal": 1,
    "productID": 100,
    "externalProductId": "FUND-001",
    "roundingMethodID": 1,
    "startDate": "2025-01-01",
    "termDays": 0,
    "termMonths": 36,
    "termTypeID": 2,
    "topUpMaxAmount": 500000.00,
    "topUpMinAmount": 500.00,
    "investmentTypeID": 1
  }
}

When to Use

Prerequisites

Considerations

Description

Update Process

Required Headers - See Authentication

Request Body

Complete Replacement

Example Requests

Response Examples

Related Endpoints

Connection Lost