Pensions

Update an Existing Pension

post/sites/{site-identifier}/funds/{fund-identifier}/members/{member-identifier}/pensions/{member-account-guid}/existing

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/{member-account-guid}/existing
  • 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)

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

member-account-guidstring required

The GUID that identifies a member account

Request body

Type'ABP' | 'DBIS' | 'TRIS' | 'TRIS - RET' | 'MLP' | 'AP'
DBISboolean
TaxFreeProportionnumber double
CommencementDatestring date

First day of the first open financial year if not entered

DisplayNamestring
PurchasePricenumber double

Last Year Balance if not entered

ReversionaryMemberGUIDstring
PaymentFrequency'Annual' | 'Biannual' | 'Fortnightly' | 'Monthly' | 'Quarterly' | 'Weekly'
PaymentChoicestring

'Minimum' by default if not entered.

SelectedAmountnumber double
PAYGScale'01' | '02' | '03' | '04NR' | '04R' | '05' | '06' | '08' | '09' | '10'
AvailableAmountnumber double
MemberSuspendedboolean

Example request

{
  "PensionBalance": [
    {
      "Year": 2020,
      "Balance": 6000
    }
  ],
  "Preservation": {
    "Unrestricted": 1000,
    "Restricted": 2000,
    "Preserved": 3000
  },
  "TaxFreeProportion": 25,
  "PurchasePrice": 2500,
  "ReversionaryMemberGUID": "d4c47341-a13b-bcb8-8c14-f13fc0ded109",
  "PaymentChoice": "Selected",
  "SelectedAmount": 1500
}

Response

Success

MemberAccountGUIDstring

Example response

{
  "MemberAccountGUID": "d4c47341-a13b-bcb8-8c14-f13fc0ded109"
}

Changes

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