Payment Summary

Return a record for each lodgement that is required for the fund.

get/sites/{site-identifier}/funds/{fund-identifier}/payment-summary

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}/payment-summary
  • 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

financial-yearstring

The financial year

statusstring
Example:NOT-APPLICABLE

The payment summary

payment-typestring
Example:PENSION

The payment summary type

Response

Success

CanViewReportsboolean
GrossAmountnumber float
LodgementStatus'CREATED' | 'LODGED' | 'NOT-APPLICABLE'
LodgementDatestring date
LodgementUserstring
MemberExtstring
MemberNamestring
MembershipTypestring
PaymentDatestring date-time
PaymentTypestring
PaymentSummaryGUIDstring guid
MemberAccountGUIDstring guid
AmendmentDatestring date
PaymentStatusstring
AmendmentIndicatorboolean
LodgementMedia'M' | 'E' | 'S'
BenefitType'DEATH' | 'COMPASSIONATE' | 'DISABILITY' | 'FIN-HARDSHIP' | 'OTHER' | 'PENSION' | 'RESIGNATION' | 'RETIREMENT' | 'RETRENCH-REDUN'
DBISboolean
CDBISboolean
TaxFreeProportionnumber float
AttachmentURLstring

Example response

[
  {
    "CanViewReports": true,
    "GrossAmount": 102,
    "LodgementDate": "2023-03-24",
    "LodgementUser": "UserCode",
    "MemberName": "Mccubbin, Antonetta (60)",
    "MembershipType": "ABP (00007) - 0.00%",
    "PaymentDate": "2023-03-24T16:55:52.679+07:00",
    "PaymentType": "Pension",
    "PaymentSummaryGUID": "b0c21331-6e4d-d18f-8a14-3a410c691230",
    "MemberAccountGUID": "b0c21331-6e4d-d18f-8a14-3a410c693640",
    "AmendmentDate": "2023-03-24",
    "PaymentStatus": "Cancelled",
    "AmendmentIndicator": true,
    "DBIS": true,
    "CDBIS": true,
    "TaxFreeProportion": 100,
    "AttachmentURL": "http://localhost:8080/api/v1/sites/local/funds/fundcode/members/b0c21331-6e4d-d18f-8a14-3a410c693640/payments/b0c21331-6e4d-d18f-8a14-3a410c691230/attachments/LumpSum?LodgeSBR=true"
  }
]

Changes

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