Members

<b>BETA:</b> Returns a total super balance for the member

get/sites/{site-identifier}/funds/{fund-identifier}/members/{member-identifier}/total-super-balance

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}/members/{member-identifier}/total-super-balance
  • 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

member-identifierstring required

The GUID that identifies a member

Query parameters

FinancialYearstring

The financial year.

Response

Success

TotalSuperBalanceGUIDstring
Lockedboolean
FinYearnumber
FundDescriptionstring
AccumBalancenumber float
TRISNonRETBalancenumber float
PensionBalancenumber float
StructuredSettlementnumber float
Totalnumber float
ModifiedTransferBalancenumber float
TotalSuperBalancenumber float

Example response

[
  {
    "TotalSuperBalanceGUID": "9a6ce773-5011-308e-7914-73d18ced3493",
    "FinYear": 2018,
    "FundDescription": "Bagel SF",
    "AccumBalance": 10000,
    "TRISNonRETBalance": 2000,
    "PensionBalance": 360,
    "StructuredSettlement": 60,
    "Total": 12300,
    "TotalSuperBalance": 12300
  }
]

Changes

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