Investments

Returns the current investment holdings for the fund.

get/sites/{site-identifier}/funds/{fund-identifier}/investments

Request

  • Base URL: https://api-dev.superconcepts.com.au/api/v1
  • URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/funds/{fund-identifier}/investments
  • Auth: OAuth 2 (authorization code, authorization URL https://api.supermate.com.au/oauth/v1/authorize, token URL https://api.supermate.com.au/oauth/v1/token, scopes: default, fund_read, fund:investments_read)

Path parameters

site-identifierstring required

The GUID that identifies a site

fund-identifierstring required

The GUID that identifies a fund

Query parameters

effective-datestring date

The valuation date with format (yyyy-MM-dd). Default is the current date if not entered.

include-zero-balancesboolean
Example:true

Include all accounts that had transactions, a unit balance or value during the financial year prior to the effective date.

Response

Success

AccountNumberstring
AccountDescriptionstring
SecurityIDstring
GroupCodestring
Unitsnumber float
Pricenumber float
UnmatchedTransactionsboolean
MarketPriceDatestring date
Valuenumber float
ClosingBalancenumber float
Cashstring
NativePriceValuenumber float
CostBasenumber float
AdjustedCostBasenumber float
ExchangeRatenumber float
ExchangeRateSourcestring
AssetCategory'CASH' | 'CRYPTO' | 'DEBT_SEC' | 'DOM_COLLECT' | 'DOM_DERIV' | 'DOM_SHARES' | 'FIXED_INT' | 'FORGN_ASS' | 'INSURANCE' | 'LIABILITIES' | 'LOANS' | 'LRBA_OSPROPERTY' | 'LRBA_OSSHARES' | 'LRBA_OTHER' | 'LRBA_PROPERTY' | 'OS_MAN_INV' | 'OS_PROPERTY' | 'OS_SHARES' | 'OTHER_ASS' | 'OTHER_INVEST' | 'OTHER_TRUSTS' | 'PROPERTY' | 'PST' | 'UNIT_TRUST' | 'UNLISTED'

The asset category of the account. The predefined values are:

  • CASH: Cash
  • CRYPTO: Cryptocurrency
  • DEBT_SEC: Debt Securities
  • DOM_COLLECT: Australian Artwork, Collectables, Metal or Jewels
  • DOM_DERIV: LRBA Australian Shares
  • DOM_SHARES: Domestic Shares
  • FIXED_INT: Fixed Interest Securities
  • FORGN_ASS: Foreign Assets
  • INSURANCE: Insurance Policies
  • LIABILITIES: Financial Liabilities
  • LOANS: Loans
  • LRBA_OSPROPERTY: LRBA Overseas Property
  • LRBA_OSSHARES: LRBA Overseas Shares
  • LRBA_OTHER: LRBA Other
  • LRBA_PROPERTY: LRBA Property
  • OS_MAN_INV: Overseas Managed Investments
  • OS_PROPERTY: Overseas Real Property
  • OS_SHARES: Overseas Shares
  • OTHER_ASS: Other Assets
  • OTHER_INVEST: Other Investments
  • OTHER_TRUSTS: Non-Public & Non-PST Trusts
  • PROPERTY: Property
  • PST: Other Managed Investments
  • UNIT_TRUST: Unit Trusts
  • UNLISTED: Unlisted Shares & Equities

NOTE: There is a chance some sites have customised these values.

AssetStructure'ACCUMULATED-DEPRECIATION' | 'CASH' | 'DEPRECIATING-ASSET' | 'DIRECT-PROPERTY' | 'FMIS' | 'LISTED-EQUITY' | 'LISTED-TRUST' | 'OTHER' | 'OTHER-ASSET' | 'OTHER-PROPERTY' | 'PLATFORM' | 'STAPLED-SECURITY' | 'TERM-DEPOSIT' | 'TRADITIONAL-SECURITY' | 'UNLISTED-EQUITY' | 'UNLISTED-TRUST' | 'WARRANT'
  • ACCUMULATED-DEPRECIATION: Accumulated Depreciation - CASH: Cash - DEPRECIATING-ASSET: Depreciating Asset - DIRECT-PROPERTY: Property (Direct) - FMIS: Forestry Asset - LISTED-EQUITY: Equity (Listed) - LISTED-TRUST: Trust (Listed) - OTHER: Other - OTHER-ASSET: Other Investment Asset - OTHER-PROPERTY: Property (Other) - PLATFORM: Platform - STAPLED-SECURITY: Stapled Security - TERM-DEPOSIT: Term Deposit - TRADITIONAL-SECURITY: Traditional Security - UNLISTED-EQUITY: Equity (Unlisted) - UNLISTED-TRUST: Trust (Unlisted) - WARRANT: Warrant
InvestmentReportingCategorystring

The investment reporting category of the account. The predefined values are:

  • CASH: Cash
  • CRYPTO-CURRENCY: Cryptocurrency
  • DEBT_SEC: Debt Securities
  • DOM_COLLECT: Australian Artwork, Collectables, Metal or Jewels
  • DOM_DERIV: LRBA Australian Shares
  • DOM_SHARES: Domestic Shares
  • FIXED_INT: Fixed Interest Securities
  • FOREIGN_CASH: Foreign Cash
  • FORGN_ASS: Foreign Assets
  • INSURANCE: Insurance Policies
  • LIABILITIES: Financial Liabilities
  • LOANS: Loans
  • LRBA_OSPROPERTY: LRBA Overseas Property
  • LRBA_OSSHARES: LRBA Overseas Shares
  • LRBA_OTHER: LRBA Other
  • LRBA_PROPERTY: LRBA Property
  • MULTI-SECTOR: Multi Sector
  • OS_MAN_INV: Overseas Managed Investments
  • OS_PROPERTY: Overseas Real Property
  • OS_SHARES: Overseas Shares
  • OTHER_ASS: Other Assets
  • OTHER_INVEST: Other Investments
  • OTHER_TRUSTS: Non-Public & Non-PST Trusts
  • PLATFORMS-WRAPS: Platforms and Wraps
  • PROPERTY: Property
  • UNIT_TRUST: Unit Trusts
  • UNLISTED: Unlisted Shares & Equities

NOTE: These values can be customised by the individual site, and modifications won't be documented here.

LinkedLoanAccountNumberstring
LinkedPropertyAccountNumberstring
LinkedDepreciationAccountNumberstring
Currencystring
InvestmentTransactionsURLstring
RevenueTransactionsURLstring
RealisedTaxPacketsURLstring
UnrealisedTaxPacketsURLstring
TransactionsURLstring
BalanceURLstring
PlatformHoldingsURLstring
TermDepositHoldingsURLstring

Example response

[
  {
    "InvestorReference": {
      "InvestorReferenceGUID": "ca5e24ba-8e7c-aab4-7614-15048593f2e8",
      "InvestorReference": "X0012345678",
      "ProductName": "Macquarie Wrap"
    },
    "LinkedLoanAccountNumber": "4950002",
    "LinkedPropertyAccountNumber": "2100001",
    "LinkedDepreciationAccountNumber": "2390001",
    "Currency": "USD",
    "Balance": [
      {
        "FinYear": 2022,
        "Balance": 2216213.82
      }
    ],
    "Allocations": [
      {
        "CategoryName": "Australian Fixed Interest",
        "CategoryShortName": "AUFIXD",
        "Percentage": 100
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.