Pensions

<b>BETA:</b> Get pensions

get/sites/{site-identifier}/funds/{fund-identifier}/members/{member-identifier}/pensions

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}/pensions
  • 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

member-account-identifierstring

member account GUID or member extension.

effective-datestring date

effective date.

Response

Success

MemberAccountGUIDstring
DisplayNamestring
NicknameEnteredboolean
PensionType'ABP' | 'DBIS' | 'TRIS' | 'TRIS - RET' | 'MLP' | 'AP'
TermType'ACCOUNT' | 'ALLOCATED' | 'COMPLYING' | 'FTC' | 'LTC' | 'MARKET' | 'STGI'
Statusstring
AccountBalancenumber float
AnnualMinimumnumber float
AnnualMaximumnumber float
ScheduledPaymentboolean
NextPaymentDatestring date
PeriodicPaymentAmountnumber float
PensionPaymentsToDatenumber float
Reversionaryboolean
PAYGWboolean
CommencementDatestring date
PurchasePricenumber double
TaxFreeProportionnumber double
ReversionaryNamestring
ReversionaryMemberGUIDstring
PaymentFrequencystring
PaymentChoicestring
PAYGScalestring
TerminationDatestring date
ProRataMinimumnumber double
Selectednumber double
GrossPaymentsnumber double
Taxnumber double
Remainingnumber double
TransferBalanceAccount1July2017Amountnumber double
PensionPayment1July2017toLastYearAmountnumber double
ProRataMinimumPensionCurrentYearAmountnumber double
LTCBalanceAccountTypestring
ReserveBalanceAmountWithEarningsnumber double
ReserveBalanceAmountWithoutEarningsnumber double
TrusteeDeterminedAmountWithEarningsnumber double
TrusteeDeterminedAmountWithoutEarningsnumber double
NumberOfActiveLTCnumber

Example response

{
  "Actions": [
    [
      "cancel",
      "cancel_convert_accum"
    ]
  ],
  "PurchasePrice": 1000,
  "TaxFreeProportion": 1000,
  "PaymentFrequency": "MONTHLY",
  "PaymentChoice": "Mininum",
  "PAYGScale": "02",
  "Warnings": [
    [
      "Exceeds Maximum",
      "Estimate"
    ]
  ],
  "LTCBalanceAccountType": "Reserve Balance/Trustee Determined",
  "DBIS": {
    "AccountBalanceOnReversion": 1000
  },
  "TRIS": {
    "AccountBalanceOnConversion": 1000
  }
}

Changes

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