Funds

Returns the list of member balances.

get/sites/{site-identifier}/funds/{fund-identifier}/member-balances

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}/member-balances
  • 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: actuarial_write, audit_read, audit_write, client_access_grant, contactevents_read, contactevents_write, default, documents_read, documents_write, fund:investments_read, fund:members_read, fund:members_write, fund:transactions_read, fund:transactions_write, fund_read, fund_write, security:domains_write, security:policies_write, security:users_invite, site:accounting-notes_write, site:asset-categories_write, site:auditor_write, site:branding_write, site:datafeed-config_write, site:identity_write, site:letters_write, site:policies_write, site:reporting_write, sites_read, superstream:config_write)

Path parameters

site-identifierstring required

The GUID that identifies a site

fund-identifierstring required

The GUID that identifies a fund

Query parameters

effective-datestring

The effective date with format (yyyy-MM-dd)

include-terminatedboolean

Include terminated member or not.

calculation-methodstring

Calculation Method (StoredEarningRate, ShareOfNAV, ExcludeSharedEarnings).

Response

Success

MemExtstring
MembershipTypestring
Balancenumber float
Preservednumber float
Restrictednumber float
Unrestrictednumber float
Taxednumber float
TaxFreenumber float
TaxFreeProportionnumber float
PensionCommencementDatestring date
MinimumPensionAmountnumber float
MaximumPensionAmountnumber float
PensionDrawnYTDnumber float
TerminationDatestring date
SuspendedDatestring date
CalculationMethodstring
MemberTransactionsSinceEarningRateboolean

Example response

[
  {
    "CalculationMethod": "ShareOfNAV"
  }
]

Changes

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