Skip to content
Explore Class APIs/Member Reports/
Pension limit report

Pension limit report

Request

Provides details of the minimum, maximum and current payments for pension accounts.

Security
Class_oAuth(Required scopes: fund.read)
Path
businessCodestringrequired

Class business code

Example:demo-business
fundCodestringrequired

Class entity code

Example:demo-fund
Query
yearintegerrequired

The financial year to retrieve information

Example:year=2024
curl -i -X GET \
  'https://api.class-pie.com.au/api/1.0/f/demo-business/demo-fund/report-data/member-reports/pension-limit-report?year=2024' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success (Ok)

Bodyapplication/json
ErrorsArray of objectsrequired
Dataobjectrequired

Pension limit report showing drawdowns, balances and limits per pension account.

Response
{
  "Data": {
    "FinancialYear": "2023-07-01",
    "AsAtDate": "2024-07-01",
    "UnmatchedCashItems": {
      "TotalAmount": 5000,
      "AccountDetails": [
        {
          "AccountId": "acc001",
          "TotalAmount": 2500,
          "EarliestTransactionDate": "2024-01-01",
          "LatestTransactionDate": "2024-06-30"
        }
      ]
    },
    "Members": [
      {
        "Id": "bc6e82b3-1d04-477c-bd08-aa5235a36ac5",
        "MemberName": "John Smith",
        "MemberNumber": "1",
        "PensionDetails": [
          {
            "AccountId": "550e8400-e29b-41d4-a716-446655440000",
            "AccountName": "My Pension Account",
            "StartDateInPeriod": "2024-07-01",
            "PensionStartDate": "2007-07-01",
            "PensionEndDate": "2025-06-30",
            "Balances": {
              "YearToDate": 10000,
              "Minimum": 12000,
              "RequiredForMinimum": 2000,
              "Selected": 15000,
              "RequiredForSelected": 5000,
              "Maximum": 30000,
              "RemainingUntilMax": 15000,
              "OverMax": 0
            },
            "PensionDrawdowns": [
              {}
            ],
            "TotalDrawdowns": {
              "GrossAmount": 15000,
              "PaygAmount": 1500,
              "NetAmount": 13500
            },
            "BalanceState": "OverMax",
            "ReviewState": "Interim",
            "TaxFreePercentage": 27.326
          }
        ],
        "Totals": {
          "GrossDrawdowns": {
            "YearToDate": 10000,
            "Minimum": 12000,
            "RequiredForMinimum": 2000,
            "Selected": 15000,
            "RequiredForSelected": 5000,
            "Maximum": 30000,
            "RemainingUntilMax": 15000,
            "OverMax": 0
          },
          "Payg": {
            "YearToDate": 10000,
            "Minimum": 12000,
            "RequiredForMinimum": 2000,
            "Selected": 15000,
            "RequiredForSelected": 5000,
            "Maximum": 30000,
            "RemainingUntilMax": 15000,
            "OverMax": 0
          },
          "NetCash": {
            "YearToDate": 10000,
            "Minimum": 12000,
            "RequiredForMinimum": 2000,
            "Selected": 15000,
            "RequiredForSelected": 5000,
            "Maximum": 30000,
            "RemainingUntilMax": 15000,
            "OverMax": 0
          }
        }
      }
    ],
    "Totals": {
      "GrossDrawdowns": {
        "YearToDate": 10000,
        "Minimum": 12000,
        "RequiredForMinimum": 2000,
        "Selected": 15000,
        "RequiredForSelected": 5000,
        "Maximum": 30000,
        "RemainingUntilMax": 15000,
        "OverMax": 0
      },
      "Payg": {
        "YearToDate": 10000,
        "Minimum": 12000,
        "RequiredForMinimum": 2000,
        "Selected": 15000,
        "RequiredForSelected": 5000,
        "Maximum": 30000,
        "RemainingUntilMax": 15000,
        "OverMax": 0
      },
      "NetCash": {
        "YearToDate": 10000,
        "Minimum": 12000,
        "RequiredForMinimum": 2000,
        "Selected": 15000,
        "RequiredForSelected": 5000,
        "Maximum": 30000,
        "RemainingUntilMax": 15000,
        "OverMax": 0
      }
    },
    "FundCode": "demo-fund",
    "FundName": "Demo Superannuation Fund"
  },
  "Errors": [
    {
      "Code": "string",
      "Message": "string"
    }
  ]
}