{ "openapi": "3.0.1", "info": { "x-metadata": { "tags": [ "Class Partner" ] }, "title": "Report Generator", "version": "1.0", "description": "\"It functions primarily to generate various\nreports for financial entities, including Self-Managed Superannuation Funds\n(SMSF) and Trusts. These reports can be generated in PDF, CSV, or RTF formats.\nTo specify the output format, the outputFormat parameter must be set in the\nquery string of the request. The Content-Type header should always be \"application/pdf\"\nregardless of the output format.\n\n\n
Servers
Partner Integration Environment (Sandbox)
https://apigateway.class-pie.com.au/api/1.0
Production Environment
https://apigateway.class.com.au/api/1.0
" }, "servers": [ { "url": "https://apigateway.class-pie.com.au/api/1.0", "description": "Partner Integration Environment (Sandbox)" }, { "url": "https://apigateway.class.com.au/api/1.0", "description": "Production Environment" } ], "paths": { "/f/{businessCode}/{fundCode}/report-data/report-generator/TaxAccountingReconciliation": { "post": { "operationId": "taxAccountingReconciliation", "summary": "Tax Accounting Reconciliation", "description": "Produces a Tax Accounting Reconciliation report for the specified fund, reconciling tax accounting entries to support compliance with Australian taxation obligations and annual tax return preparation.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "year", "description": "The financial year to retrieve information", "in": "query", "required": true, "schema": { "type": "integer", "example": 2024 } }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/UnrealisedCapitalGains": { "post": { "operationId": "runReportUnrealisedCapitalGains", "summary": "Unrealised Capital Gains", "description": "Produces an Unrealised Capital Gains report for the specified fund, providing a detailed view of open investment positions and their embedded gains or losses to support tax planning and portfolio valuation.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "startDate", "in": "query", "description": "The start date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2025-06-30" } }, { "$ref": "#/components/parameters/isSummaryParam" }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "includeAssetCodes", "in": "query", "description": "Indicates whether asset codes should be included in the report output.", "schema": { "type": "string", "example": "False", "enum": [ "True", "False" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/RealisedCapitalGains": { "post": { "operationId": "runReportRealisedCapitalGains", "summary": "Realised Capital Gains", "description": "Produces a Realised Capital Gains report for the specified fund, detailing gains and losses realised from asset disposals during the reporting period to support accurate tax assessment and ATO reporting obligations.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "startDate", "in": "query", "description": "The start date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2025-06-30" } }, { "$ref": "#/components/parameters/isSummaryParam" }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "groupBy", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "MarketType", "AssetPool", "GL", "Reference" ], "example": "MarketType" } }, { "name": "includeAssetCodes", "in": "query", "description": "Indicates whether asset codes should be included in the report output.", "schema": { "type": "string", "example": "True", "enum": [ "True", "False" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/FundDetails": { "post": { "operationId": "runReportFundDetails", "summary": "Fund Details", "description": "Produces a Fund Details report for the specified fund, presenting a comprehensive overview of the fund's registration attributes, member details, and structural information to support compliance and administrative requirements.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isPageFooterParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/ActivityStatementPreparation": { "post": { "operationId": "runReportActivityStatementPreparation", "summary": "Activity Statement Preparation", "description": "Produces an Activity Statement Preparation report for the specified fund, consolidating tax and superannuation reporting obligations to facilitate timely lodgement of the fund's Business Activity Statement or Instalment Activity Statement.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "startDate", "in": "query", "description": "The start date of the reporting period in YYYY-MM-DD format.", "required": true, "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period in YYYY-MM-DD format.", "required": true, "schema": { "type": "string", "example": "2025-06-30" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "$ref": "#/components/parameters/isSummaryParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/WorkTestDeclaration": { "post": { "operationId": "runReportWorkTestDeclaration", "summary": "Work Test Declaration", "description": "Produces a Work Test Declaration report for the specified fund, generating the formal document confirming that a member satisfies the ATO's work test requirements for making voluntary superannuation contributions after age 67.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "dateOfLetter", "in": "query", "schema": { "type": "string", "example": "2021-12-31" } }, { "name": "year", "description": "The financial year to retrieve information", "in": "query", "required": true, "schema": { "type": "integer", "example": 2024 } }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isPageFooterParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/TrialBalance": { "post": { "operationId": "runReportTrialBalance", "summary": "Trial Balance", "description": "Produces a Trial Balance report for the specified fund, listing all general ledger account balances to support period-end financial review and to verify accounting accuracy prior to financial statement preparation.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "atDate", "in": "query", "schema": { "type": "string", "example": "2024-07-01" } }, { "$ref": "#/components/parameters/isSummaryParam" }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isPageFooterParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/TransferBalanceAccountReportDeclaration": { "post": { "operationId": "runReportTransferBalanceAccountReportDeclaration", "summary": "Transfer Balance Account Report Declaration", "description": "Produces a Transfer Balance Account Report Declaration for the specified fund, supporting the trustee's obligation to report transfer balance account events to the ATO in compliance with the transfer balance cap regime.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "startDate", "in": "query", "description": "The start date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2025-06-30" } }, { "name": "tbarState", "in": "query", "schema": { "type": "string", "example": "All Transactions", "enum": [ "All Transactions", "Not Generated", "Generated" ] } }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "signature", "in": "query", "schema": { "type": "string", "example": "Chairperson", "enum": [ "Chairperson", "All Trustees" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/TaxStatement": { "post": { "operationId": "runReportTaxStatement", "summary": "Tax Statement", "description": "Produces a Tax Statement report for the specified fund, providing each member with a summary of taxable components and tax credits to assist in the preparation of their personal income tax return.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "year", "description": "The financial year to retrieve information", "in": "query", "required": true, "schema": { "type": "integer", "example": 2024 } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "artSnapshot", "in": "query", "schema": { "type": "string", "example": "True", "enum": [ "True", "False" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/SuperStreamESANotification": { "post": { "operationId": "runReportSuperStreamESANotification", "summary": "Super Stream ESA Notification", "description": "Produces a SuperStream Electronic Service Address (ESA) Notification report for the specified fund, generating the required communication for ESA updates to facilitate compliant rollovers and contributions under the SuperStream standard.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "dateOfLetter", "in": "query", "schema": { "type": "string", "example": "2024-12-31" } }, { "name": "noteHtml_Value", "in": "query", "description": "Provides short text description on the report", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isPageFooterParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/StatementOfDistribution": { "post": { "operationId": "runReportStatementOfDistribution", "summary": "Statement Of Distribution", "description": "Produces a Statement of Distribution report for the specified fund, detailing the allocation of net income or losses to beneficiaries or members for the reporting period to support tax distribution obligations.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "year", "description": "The financial year to retrieve information", "in": "query", "required": false, "schema": { "type": "integer", "example": 2025 } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/StatementOfFinancialPosition": { "post": { "operationId": "runReportStatementOfFinancialPosition", "summary": "Statement Of Financial Position", "description": "Produces a Statement of Financial Position report for the specified fund, presenting the fund's assets, liabilities, and net assets as at the reporting date in accordance with applicable accounting standards.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "atDate", "in": "query", "description": "Specify the date of the financial StatementOfFinancialPosition", "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "showComparatives", "in": "query", "schema": { "type": "string", "example": "Yes", "enum": [ "Yes", "No" ] } }, { "name": "comparisonDate", "in": "query", "description": "Specify the comparison date of the financial StatementOfFinancialPosition against the at date.", "schema": { "type": "string", "example": "2023-07-01" } }, { "name": "showNoteNumbers", "in": "query", "schema": { "type": "string", "example": "Yes", "enum": [ "Yes", "No" ] } }, { "name": "includeMembersAccounts", "in": "query", "schema": { "type": "string", "example": "Yes", "enum": [ "Yes", "No" ] } }, { "$ref": "#/components/parameters/isSummaryParam" }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "CompilationFootnoteText", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/RequestAdjustConcessional": { "post": { "operationId": "runReportRequestAdjustConcessional", "summary": "Request Adjust Concessional", "description": "Produces a Request to Adjust Concessional Contributions report for the specified fund, facilitating the formal submission to the ATO for adjusting a member's concessional contribution amounts within the applicable cap.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/yearParam" }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/RentalPropertySchedule": { "post": { "operationId": "runReportRentalPropertySchedule", "summary": "Rental Property Schedule", "description": "Produces a Rental Property Schedule report for the specified fund, detailing income, expenses, and depreciation for fund-owned rental properties to support accurate tax return lodgement.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/yearParam" }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "isSepPagePerAccount", "in": "query", "schema": { "type": "string", "example": "Yes", "enum": [ "Yes", "No" ] } }, { "name": "includeComparatives", "in": "query", "schema": { "type": "string", "example": "Yes", "enum": [ "Yes", "No" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/PensionLimit": { "post": { "operationId": "runReportPensionLimit", "summary": "Pension Limit", "description": "Produces a Pension Limit report for the specified fund, calculating the minimum and maximum pension payment obligations for each pension member to ensure compliance with superannuation drawdown requirements.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/yearParam" }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "$ref": "#/components/parameters/isSummaryParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/PAYGPaymentSummaryIncomeStream": { "post": { "operationId": "runReportPAYGPaymentSummaryIncomeStream", "summary": "PAYG Payment Summary Income Stream", "description": "Produces a PAYG Payment Summary for an Income Stream report for the specified fund, providing members with the required tax withholding and payment information needed to support their income tax return lodgement.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/yearParam" }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "isAmendedSummary", "in": "query", "schema": { "type": "string", "example": "Yes", "enum": [ "Yes", "No" ] } }, { "name": "printDate", "in": "query", "schema": { "type": "string", "example": "2021-12-01" } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/InvestmentMovementSummary": { "post": { "operationId": "runReportInvestmentMovementSummary", "summary": "Investment Movement Summary", "description": "Produces an Investment Movement Summary report for the specified fund, providing an aggregated view of purchases, sales, and transfers across the investment portfolio during the reporting period.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "groupBy", "in": "query", "schema": { "type": "string", "example": "MarketType", "enum": [ "MarketType", "AssetPool", "GL", "Reference" ] } }, { "name": "includeAssetCodes", "in": "query", "description": "Indicates whether asset codes should be included in the report output.", "schema": { "type": "string", "example": "True", "enum": [ "True", "False" ] } }, { "name": "startDate", "in": "query", "description": "The start date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2025-06-30" } }, { "name": "isSepPagePerPortfolio", "in": "query", "schema": { "type": "string", "example": "No", "enum": [ "Yes", "No" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/InvestmentMovementandReturns": { "post": { "operationId": "runReportInvestmentMovementandReturns", "summary": "Investment Movement And Returns", "description": "Produces an Investment Movement and Returns report for the specified fund, combining transaction history with income and capital return data to deliver a comprehensive performance overview of the portfolio.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2025-06-30" } }, { "name": "startDate", "in": "query", "description": "The start date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "includeIncomeDeclaredButNotPaid", "in": "query", "schema": { "type": "string", "example": "True", "enum": [ "True", "False" ] } }, { "name": "includeCumulativeNetInvestmentInGraph", "in": "query", "schema": { "type": "string", "example": "True", "enum": [ "True", "False" ] } }, { "name": "includeAfterExpensesInTwr", "in": "query", "schema": { "type": "string", "example": "True", "enum": [ "True", "False" ] } }, { "name": "ASXIndexId1", "in": "query", "schema": { "type": "string" } }, { "name": "ASXIndexId2", "in": "query", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/InvestmentPortfolio": { "post": { "operationId": "runReportInvestmentPortfolio", "summary": "Investment Portfolio", "description": "Produces an Investment Portfolio report for the specified fund, presenting a complete listing of current holdings with market valuations and allocation percentages to support investment strategy review and compliance reporting.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "includeAssetCodes", "in": "query", "description": "Indicates whether asset codes should be included in the report output.", "schema": { "type": "string", "example": "True", "enum": [ "True", "False" ] } }, { "name": "includeIncomeExpected", "in": "query", "schema": { "type": "string", "example": "True", "enum": [ "True", "False" ] } }, { "name": "atDate", "in": "query", "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "IsEstimatedIncomeandYield", "in": "query", "schema": { "type": "string", "example": "Yes", "enum": [ "Yes", "No" ] } }, { "name": "disclaimerText", "in": "query", "description": "Provide a short disclaimer text", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/InvestmentRevaluation": { "post": { "operationId": "runReportInvestmentRevaluation", "summary": "Investment Revaluation", "description": "Produces an Investment Revaluation report for the specified fund, capturing unrealised gains and losses arising from market value movements to support accurate net asset calculation and financial statement preparation.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "year", "description": "The financial year to retrieve information", "in": "query", "required": false, "schema": { "type": "integer", "example": 2025 } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "includeAssetCodes", "in": "query", "description": "Indicates whether asset codes should be included in the report output.", "schema": { "type": "string", "example": "True", "enum": [ "True", "False" ] } }, { "name": "groupBy", "in": "query", "schema": { "type": "string", "example": "MarketType", "enum": [ "MarketType", "AssetPool", "GL", "Reference" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/InvestmentTransactionConfirmationMinuteResolution": { "post": { "operationId": "runReportInvestmentTransactionConfirmationMinuteResolution", "summary": "Investment Transaction Confirmation Minute Resolution", "description": "Produces an Investment Transaction Confirmation Minute or Resolution report for the specified fund, providing formal trustee documentation confirming investment decisions in accordance with the fund's investment strategy obligations.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "minuteResolutionType", "in": "query", "required": true, "schema": { "type": "string", "example": "Minute", "enum": [ "Minute", "Resolution" ] } }, { "name": "noteHtml_Value", "in": "query", "required": true, "description": "Provides short text description on the report", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "description": "The start date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2025-06-30" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "meetingDate", "in": "query", "schema": { "type": "string", "example": "2023-07-01" } }, { "name": "meetingAddress", "in": "query", "schema": { "type": "string" } }, { "name": "signature", "in": "query", "schema": { "type": "string", "example": "Chairperson", "enum": [ "Chairperson", "All Trustees" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/InvestmentPerformance": { "post": { "operationId": "runReportInvestmentPerformance", "summary": "Investment Performance", "description": "Produces an Investment Performance report for the specified fund, measuring portfolio returns across asset classes and against relevant benchmarks to support investment strategy review and member reporting.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "includeReturnPercentage", "in": "query", "required": true, "schema": { "type": "string", "example": "Yes", "enum": [ "Yes", "No" ] } }, { "name": "calculationMethod", "in": "query", "required": true, "schema": { "type": "string", "example": "SimpleDietz", "enum": [ "SimpleDietz", "ModifiedDietz" ] } }, { "name": "startDate", "in": "query", "description": "The start date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2025-06-30" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "groupBy", "in": "query", "schema": { "type": "string", "example": "MarketType", "enum": [ "MarketType", "AssetPool", "GL", "Reference" ] } }, { "name": "isSeperatePagePerPortfolio", "in": "query", "schema": { "type": "string", "example": "Yes", "enum": [ "Yes", "No" ] } }, { "name": "isPrintInvestmentCodes", "in": "query", "schema": { "type": "string", "example": "Yes", "enum": [ "Yes", "No" ] } }, { "name": "includeIncomeExpected", "in": "query", "schema": { "type": "string", "example": "True", "enum": [ "True", "False" ] } }, { "name": "includeAssetCodes", "in": "query", "description": "Indicates whether asset codes should be included in the report output.", "schema": { "type": "string", "example": "True", "enum": [ "True", "False" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/GeneralLedgerAccountMovement": { "post": { "operationId": "runReportGeneralLedgerAccountMovement", "summary": "General Ledger Account Movement", "description": "Produces a General Ledger Account Movement report for the specified fund, listing all transactions recorded against each general ledger account during the reporting period to support reconciliation and audit review.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "startDate", "in": "query", "description": "The start date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2025-06-30" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "isSepPagePerAccount", "in": "query", "schema": { "type": "string", "example": "No", "enum": [ "Yes", "No" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/GeneralMinuteLetter": { "post": { "operationId": "runReportGeneralMinuteLetter", "summary": "General Minute Letter", "description": "Produces a General Minute or Letter report for the specified fund, providing a customisable trustee document for formal correspondence or meeting resolutions as required under fund governance obligations.", "security": [ { "Class_oAuth": [ "fund.read" ] } ], "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "addressTo", "in": "query", "schema": { "type": "string", "example": "Accountant", "enum": [ "None", "Accountant", "Administrator", "Advisor", "Auditor", "TaxAgent", "Trustees" ] } }, { "name": "signatures", "in": "query", "schema": { "type": "string", "example": "Accountant", "enum": [ "None", "Accountant", "Administrator", "AllTrustees", "ChairOnly", "TaxAgent" ] } }, { "name": "noteHtml_Value", "in": "query", "required": false, "description": "Provides short text description on the report", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "startDate", "in": "query", "description": "The start date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2025-06-30" } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } } } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/MarketPriceAuditReport": { "post": { "operationId": "runReportMarketPriceAuditReport", "summary": "Market Price Audit Report", "description": "Produces a Market Price Audit Report for the specified fund, validating the market prices applied to investment valuations to support the annual audit process and ensure compliance with fair value measurement requirements.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "atDate", "in": "query", "required": true, "schema": { "type": "string", "example": "2024-07-01" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "includeAssetCodes", "in": "query", "description": "Indicates whether asset codes should be included in the report output.", "schema": { "type": "string", "example": "True", "enum": [ "True", "False" ] } }, { "name": "groupBy", "in": "query", "schema": { "type": "string", "example": "MarketType", "enum": [ "MarketType", "AssetPool", "GL", "Reference" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/GeneralLedgerAuditTrail": { "post": { "operationId": "runReportGeneralLedgerAuditTrail", "summary": "General Ledger Audit Trail", "description": "Produces a General Ledger Audit Trail report for the specified fund, providing a complete chronological record of all ledger entries and adjustments to support audit review and financial accountability.", "security": [ { "Class_oAuth": [ "fund.read" ] } ], "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "startDate", "in": "query", "description": "The start date of the reporting period in YYYY-MM-DD format.", "required": true, "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period in YYYY-MM-DD format.", "required": true, "schema": { "type": "string", "example": "2025-06-30" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "includeDeleted", "in": "query", "schema": { "type": "string", "example": "No", "enum": [ "Yes", "No" ] } }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } } } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/MemberTransactionDetail": { "post": { "operationId": "runReportMemberTransactionDetail", "summary": "Member Transaction Detail", "description": "Produces a Member Transaction Detail report for the specified fund, listing all contributions, withdrawals, rollovers, and account transactions for each member to support member reporting and compliance obligations.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "startDate", "in": "query", "description": "The start date of the reporting period in YYYY-MM-DD format.", "required": true, "schema": { "type": "string", "example": "2023-07-01" } }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period in YYYY-MM-DD format.", "required": true, "schema": { "type": "string", "example": "2024-06-30" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/MemberTransactionSummary": { "post": { "operationId": "runReportMemberTransactionSummary", "summary": "Member Transaction Summary", "description": "Produces a Member Transaction Summary report for the specified fund, providing a consolidated view of member account movements during the reporting period to facilitate member communications and benefit calculations.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "startDate", "in": "query", "description": "The start date of the reporting period in YYYY-MM-DD format.", "required": true, "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period in YYYY-MM-DD format.", "required": true, "schema": { "type": "string", "example": "2025-06-30" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/StatementOfNetIncome": { "post": { "operationId": "runReportStatementOfNetIncome", "summary": "Statement Of Net Income", "description": "Produces a Statement of Net Income report for the specified fund, presenting the fund's income, expenses, and net income or loss for the reporting period in accordance with applicable accounting standards.", "security": [ { "Class_oAuth": [ "fund.read" ] } ], "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "year", "description": "The financial year to retrieve information", "in": "query", "required": false, "schema": { "type": "integer", "example": 2024 } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "$ref": "#/components/parameters/isSummaryParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } } } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/OperatingStatementProfitAndLoss": { "post": { "operationId": "runReportOperatingStatementProfitAndLoss", "summary": "Operating Statement Profit And Loss", "description": "Produces an Operating Statement (Profit and Loss) report for the specified fund, detailing revenues and expenditures for the reporting period to support financial reporting and compliance obligations.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "startDate", "in": "query", "description": "The start date of the reporting period in YYYY-MM-DD format.", "required": true, "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period in YYYY-MM-DD format.", "required": true, "schema": { "type": "string", "example": "2025-06-30" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "$ref": "#/components/parameters/isSummaryParam" }, { "name": "isSamePeriod", "in": "query", "schema": { "type": "string", "example": "No", "enum": [ "Yes", "No" ] } }, { "name": "comparisonStartDate", "in": "query", "schema": { "type": "string", "example": "2022-07-01" } }, { "name": "comparisonEndDate", "in": "query", "schema": { "type": "string", "example": "2023-06-30" } }, { "name": "showNoteNumbers", "in": "query", "schema": { "type": "string", "example": "Yes", "enum": [ "Yes", "No" ] } }, { "name": "CompilationFootnoteText", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/AssetStrategyComparison": { "post": { "operationId": "runReportAssetStrategyComparison", "summary": "Asset Strategy Comparison", "description": "Produces an Asset Strategy Comparison report for the specified fund, benchmarking the current investment allocation against the fund's documented investment strategy to support trustee review and regulatory compliance.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "atDate", "in": "query", "required": true, "schema": { "type": "string", "example": "2024-07-01" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isPageFooterParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/AssetStrategyMinuteResolution": { "post": { "operationId": "runReportAssetStrategyMinuteResolution", "summary": "Asset Strategy Minute Resolution", "description": "Produces an Asset Strategy Minute or Resolution report for the specified fund, providing formal trustee documentation of investment strategy decisions as required under superannuation trustee obligations.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "startDate", "in": "query", "description": "The start date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2025-06-30" } }, { "name": "minuteResolutionType", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "meetinDate", "in": "query", "required": false, "schema": { "type": "string", "example": "2023-12-31" } }, { "name": "meetingAddress", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "preStrategyNoteHtml_Value", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "postStrategyNoteHtml_Value", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "reservesNoteHtml_Value", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "signature", "in": "query", "schema": { "type": "string", "example": "All Trustees", "enum": [ "Chairperson", "All Trustees" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/BankAccountMovement": { "post": { "operationId": "runReportBankAccountMovement", "summary": "Bank Account Movement", "description": "Produces a Bank Account Movement report for the specified fund, listing all cash transactions across the fund's bank accounts during the reporting period to support cash flow analysis and reconciliation.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "isSepPagePerAccount", "in": "query", "schema": { "type": "string", "example": true, "enum": [ "Yes", "No" ] } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "startDate", "in": "query", "description": "The start date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2025-06-30" } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/CapitalAllowance": { "post": { "operationId": "runReportCapitalAllowance", "summary": "Capital Allowance", "description": "Produces a Capital Allowance report for the specified fund, calculating depreciation and capital allowance claims on eligible assets to support accurate tax deduction reporting and asset register maintenance.", "security": [ { "Class_oAuth": [ "fund.read" ] } ], "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/obscureSensitiveDataParam" }, { "$ref": "#/components/parameters/yearParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } } } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/CapitalGainsReliefAnalysisProportionate": { "post": { "operationId": "runReportCapitalGainsReliefAnalysisProportionate", "summary": "Capital Gains Relief Analysis Proportionate", "description": "Produces a Capital Gains Relief Analysis (Proportionate Method) report for the specified fund, analysing the proportionate CGT relief applicable to assets under the transitional capital gains tax relief provisions.", "security": [ { "Class_oAuth": [ "fund.read" ] } ], "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "groupBy", "in": "query", "schema": { "type": "string", "example": "MarketType", "enum": [ "MarketType", "AssetPool", "GL", "Reference" ] } }, { "name": "includeAssetCodes", "in": "query", "description": "Indicates whether asset codes should be included in the report output.", "required": false, "schema": { "type": "string", "example": "True", "enum": [ "True", "False" ] } }, { "name": "excludeLosses", "in": "query", "required": false, "schema": { "type": "string", "example": "True", "enum": [ "True", "False" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } } } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/CashReconciliation": { "post": { "operationId": "runReportCashReconciliation", "summary": "Cash Reconciliation", "description": "Produces a Cash Reconciliation report for the specified fund, reconciling opening and closing cash balances against recorded transactions to verify the accuracy of the fund's cash position.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "name": "startDate", "in": "query", "description": "The start date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string" }, "example": "2023-07-01" }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string" }, "example": "2024-06-30" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/AnnualReturnSMSF": { "post": { "operationId": "runReportAnnualReturnSMSF", "summary": "Annual Return SMSF", "description": "Produces an Annual Return report for the specified Self-Managed Superannuation Fund, compiling the financial and member data required for lodgement of the SMSF Annual Return with the Australian Taxation Office.", "security": [ { "Class_oAuth": [ "fund.read" ] } ], "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/yearParam" }, { "$ref": "#/components/parameters/obscureSensitiveDataParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } } } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/AnnualReturnLossesScheduleSMSF": { "post": { "operationId": "runReportAnnualReturnLossesScheduleSMSF", "summary": "Annual Return Losses Schedule SMSF", "description": "Produces an Annual Return Losses Schedule for the specified SMSF, detailing prior year tax losses and their application in accordance with ATO requirements for inclusion with the SMSF Annual Return lodgement.", "security": [ { "Class_oAuth": [ "fund.read" ] } ], "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/yearParam" }, { "$ref": "#/components/parameters/obscureSensitiveDataParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } } } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/AnnualReturnCGTScheduleSMSF": { "post": { "operationId": "runReportAnnualReturnCGTScheduleSMSF", "summary": "Annual Return CGT Schedule SMSF", "description": "Produces an Annual Return Capital Gains Tax Schedule for the specified SMSF, providing the CGT schedule required for inclusion with the SMSF Annual Return lodgement with the ATO.", "security": [ { "Class_oAuth": [ "fund.read" ] } ], "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/yearParam" }, { "$ref": "#/components/parameters/obscureSensitiveDataParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } } } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/AnnualReturnCGTScheduleTrust": { "post": { "operationId": "runReportAnnualReturnCGTScheduleTrust", "summary": "Annual Return CGT Schedule Trust", "description": "Produces an Annual Return Capital Gains Tax Schedule for the specified Trust, providing the CGT schedule required for inclusion with the Trust's annual tax return lodgement with the ATO.", "security": [ { "Class_oAuth": [ "fund.read" ] } ], "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/yearParam" }, { "$ref": "#/components/parameters/obscureSensitiveDataParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } } } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/AuditEngagementLetter": { "post": { "operationId": "runReportAuditEngagementLetter", "summary": "Audit Engagement Letter", "description": "Produces an Audit Engagement Letter for the specified fund, formalising the terms of the annual audit engagement between the trustee and the appointed SMSF auditor in accordance with applicable auditing standards.", "security": [ { "Class_oAuth": [ "fund.read" ] } ], "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/yearParam" }, { "name": "dateOfLetter", "in": "query", "required": false, "schema": { "type": "string", "example": "2024-07-01", "format": "yyyy-mm-dd" } }, { "name": "expectedAuditFee", "in": "query", "required": false, "description": "Provides a section on the report that includes a breakdown of the estimate of the costs associated with the scope of work with the auditor.", "schema": { "type": "number", "example": 1234.56 } }, { "name": "noteHtml_Value", "in": "query", "required": false, "description": "Provides short text description on the report", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isPageFooterParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } } } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/AuditPlanningMemo": { "post": { "operationId": "runReportAuditPlanningMemo", "summary": "Audit Planning Memo", "description": "Produces an Audit Planning Memorandum for the specified fund, documenting the auditor's planning procedures and risk assessment findings to support a structured and compliant SMSF audit engagement.", "security": [ { "Class_oAuth": [ "fund.read" ] } ], "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/yearParam" }, { "name": "currentYearMLUsed", "in": "query", "description": "Cash amount", "required": false, "schema": { "type": "number", "example": 1234.56 } }, { "name": "previousYearMLUsed", "in": "query", "description": "Cash amount", "required": false, "schema": { "type": "number", "example": 1234.56 } }, { "name": "noteHtml_Value", "in": "query", "required": false, "description": "Provides short text description on the report", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isPageFooterParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } } } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/AuditWorkpapers": { "post": { "operationId": "runReportAuditWorkpapers", "summary": "Audit Workpapers", "description": "Produces Audit Workpapers for the specified fund, generating the supporting documentation required by the appointed auditor to substantiate the findings and conclusions of the annual SMSF audit.", "security": [ { "Class_oAuth": [ "fund.read" ] } ], "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "atDate", "in": "query", "required": false, "schema": { "type": "string", "example": "2024-07-01", "format": "yyyy-mm-dd" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } } } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/InvestmentAllocation": { "post": { "operationId": "runReportInvestmentAllocation", "summary": "Investment Allocation", "description": "Produces an Investment Allocation report for the specified fund, presenting the distribution of assets across investment classes and sectors to support trustee review against the fund's investment strategy.", "security": [ { "Class_oAuth": [ "fund.read" ] } ], "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "atDate", "in": "query", "required": false, "schema": { "type": "string", "example": "2024-07-01" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "includeAssetCodes", "in": "query", "description": "Indicates whether asset codes should be included in the report output.", "required": false, "schema": { "type": "string", "example": "True", "enum": [ "True", "False" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } } } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/InvestmentIncomeComparisonReport": { "post": { "operationId": "runReportInvestmentIncomeComparisonReport", "summary": "Investment Income Comparison Report", "description": "Produces an Investment Income Comparison report for the specified fund, comparing income performance across asset holdings and reporting periods to support informed investment decision-making and trustee review.", "security": [ { "Class_oAuth": [ "fund.read" ] } ], "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "startDate", "in": "query", "description": "The start date of the reporting period in YYYY-MM-DD format.", "required": true, "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period in YYYY-MM-DD format.", "required": true, "schema": { "type": "string", "example": "2025-06-30" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "includeAssetCodes", "in": "query", "description": "Indicates whether asset codes should be included in the report output.", "required": false, "schema": { "type": "string", "example": "True", "enum": [ "True", "False" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } } } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/InvestmentIncomeDetails": { "post": { "operationId": "runReportInvestmentIncomeDetails", "summary": "Investment Income Details", "description": "Produces an Investment Income Details report for the specified fund, providing a granular breakdown of income received from each investment holding, including dividends, interest, and trust distributions.", "security": [ { "Class_oAuth": [ "fund.read" ] } ], "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "startDate", "in": "query", "required": false, "description": "Provides the information of a Fund's investment income starting date", "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "endDate", "in": "query", "required": false, "description": "Provides the information of a Fund's investment income ending date", "schema": { "type": "string", "example": "2025-06-30" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "includeAssetCodes", "in": "query", "description": "Indicates whether asset codes should be included in the report output.", "required": false, "schema": { "type": "string", "example": "True", "enum": [ "True", "False" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } } } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/InvestmentIncomeSummary": { "post": { "operationId": "runReportInvestmentIncomeSummary", "summary": "Investment Income Summary", "description": "Produces an Investment Income Summary report for the specified fund, consolidating investment income across all asset classes for the reporting period to support financial reporting and tax return preparation.", "security": [ { "Class_oAuth": [ "fund.read" ] } ], "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "startDate", "in": "query", "required": false, "description": "Provides the information of a Fund's investment income starting date", "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "endDate", "in": "query", "required": false, "description": "Provides the information of a Fund's investment income ending date", "schema": { "type": "string", "example": "2025-06-30" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "groupBy", "in": "query", "schema": { "type": "string", "example": "MarketType", "enum": [ "MarketType", "AssetPool", "GL", "Reference" ] } }, { "name": "includeAssetCodes", "in": "query", "description": "Indicates whether asset codes should be included in the report output.", "required": false, "schema": { "type": "string", "example": "True", "enum": [ "True", "False" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } } } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/InvestmentSummary": { "post": { "operationId": "runReportInvestmentSummary", "summary": "Investment Summary", "description": "Produces an Investment Summary report for the specified fund, providing a high-level overview of the portfolio's composition, market value, and performance to support member communications and trustee reporting.", "security": [ { "Class_oAuth": [ "fund.read" ] } ], "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "atDate", "in": "query", "required": true, "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "isEstimatedIncomeandYield", "in": "query", "required": false, "schema": { "type": "string", "example": "Yes", "enum": [ "Yes", "No" ] } }, { "name": "disclaimerText", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "groupBy", "in": "query", "schema": { "type": "string", "example": "MarketType", "enum": [ "MarketType", "AssetPool", "GL", "Reference" ] } }, { "name": "includeIncomeExpected", "in": "query", "required": false, "schema": { "type": "string", "example": "True", "enum": [ "True", "False" ] } }, { "name": "includeAssetCodes", "in": "query", "description": "Indicates whether asset codes should be included in the report output.", "required": false, "schema": { "type": "string", "example": "True", "enum": [ "True", "False" ] } }, { "name": "costbaseType", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "AccountingCostbase", "CGTCostbase" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } } } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/AnnualReturnLossesScheduleTrust": { "post": { "operationId": "runReportAnnualReturnLossesScheduleTrust", "summary": "Annual Return Losses Schedule Trust", "security": [ { "Class_oAuth": [ "fund.read" ] } ], "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/obscureSensitiveDataParam" }, { "$ref": "#/components/parameters/yearParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } } } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/AnnualReturnRentalScheduleTrust": { "post": { "operationId": "runReportAnnualReturnRentalScheduleTrust", "summary": "Annual Return Rental Schedule Trust", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/obscureSensitiveDataParam" }, { "$ref": "#/components/parameters/yearParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/AnnualTaxReturnTrust": { "post": { "operationId": "runReportAnnualTaxReturnTrust", "summary": "Annual Tax Return Trust", "description": "Produces an Annual Tax Return report for the specified Trust, compiling the financial and income distribution data required for lodgement of the Trust's annual tax return with the Australian Taxation Office.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/obscureSensitiveDataParam" }, { "$ref": "#/components/parameters/yearParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/AnnualTrusteeMinutesResolutions": { "post": { "operationId": "runReportAnnualTrusteeMinutesResolutions", "summary": "Annual Trustee Minutes Resolutions", "description": "Produces an Annual Trustee Minutes and Resolutions report for the specified fund, documenting the formal trustee decisions and resolutions required for annual fund governance compliance.", "security": [ { "Class_oAuth": [ "fund.read" ] } ], "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "minuteResolutionType", "in": "query", "required": true, "schema": { "type": "string", "example": "Minute", "enum": [ "Minute", "Resolution" ] } }, { "$ref": "#/components/parameters/yearParam" }, { "name": "meetingDate", "in": "query", "schema": { "type": "string", "example": "2023-07-01" } }, { "name": "meetingAddress", "in": "query", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "PreviousMinutesNoteHtml_Selected", "in": "query", "schema": { "type": "boolean", "example": false } }, { "name": "PreviousMinutesNoteHtml_Value", "in": "query", "schema": { "type": "string" } }, { "name": "ContributionsNoteHtml_Selected", "in": "query", "schema": { "type": "boolean", "example": false } }, { "name": "ContributionsNoteHtml_Value", "in": "query", "schema": { "type": "string" } }, { "name": "BenefitsNoteHtml_Selected", "in": "query", "schema": { "type": "boolean", "example": false } }, { "name": "BenefitsNoteHtml_Value", "in": "query", "schema": { "type": "string" } }, { "name": "RolloversNoteHtml_Selected", "in": "query", "schema": { "type": "boolean", "example": false } }, { "name": "RolloversNoteHtml_Value", "in": "query", "schema": { "type": "string" } }, { "name": "PurchasesNoteHtml_Selected", "in": "query", "schema": { "type": "boolean", "example": false } }, { "name": "PurchasesNoteHtml_Value", "in": "query", "schema": { "type": "string" } }, { "name": "PropertyValuationNoteHtml_Selected", "in": "query", "schema": { "type": "boolean", "example": false } }, { "name": "PropertyValuationNoteHtml_Value", "in": "query", "schema": { "type": "string" } }, { "name": "DisposalsNoteHtml_Selected", "in": "query", "schema": { "type": "boolean", "example": false } }, { "name": "DisposalsNoteHtml_Value", "in": "query", "schema": { "type": "string" } }, { "name": "IncomeAllocationNoteHtml_Selected", "in": "query", "schema": { "type": "boolean", "example": false } }, { "name": "IncomeAllocationNoteHtml_Value", "in": "query", "schema": { "type": "string" } }, { "name": "ReportingEntityNoteHtml_Selected", "in": "query", "schema": { "type": "boolean", "example": false } }, { "name": "ReportingEntityNoteHtml_Value", "in": "query", "schema": { "type": "string" } }, { "name": "ReportsAndStatementsNoteHtml_Selected", "in": "query", "schema": { "type": "boolean", "example": false } }, { "name": "ReportsAndStatementsNoteHtml_Value", "in": "query", "schema": { "type": "string" } }, { "name": "TaxReturnNoteHtml_Selected", "in": "query", "schema": { "type": "boolean", "example": false } }, { "name": "TaxReturnNoteHtml_Value", "in": "query", "schema": { "type": "string" } }, { "name": "InvestmentStrategyNoteHtml_Selected", "in": "query", "schema": { "type": "boolean", "example": false } }, { "name": "InvestmentStrategyNoteHtml_Value", "in": "query", "schema": { "type": "string" } }, { "name": "TrusteeStatusNoteHtml_Selected", "in": "query", "schema": { "type": "boolean", "example": false } }, { "name": "TrusteeStatusNoteHtml_Value", "in": "query", "schema": { "type": "string" } }, { "name": "showAuditor", "in": "query", "schema": { "type": "string", "example": "Show", "enum": [ "Show", "Hide" ] } }, { "name": "showTaxAgent", "in": "query", "schema": { "type": "string", "example": "Show", "enum": [ "Show", "Hide" ] } }, { "name": "signature", "in": "query", "schema": { "type": "string", "example": "All Trustees", "enum": [ "Chairperson", "All Trustees" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } } } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/AuditReportSAF": { "post": { "operationId": "runReportAuditReportSAF", "summary": "Audit Report SAF", "description": "Produces an Audit Report for the specified Small APRA Fund, providing the formal audit opinion and findings required to satisfy the fund's annual audit obligations under APRA-regulated superannuation legislation.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/yearParam" }, { "name": "partAInsert", "in": "query", "schema": { "type": "string" } }, { "name": "isPartAQual", "in": "query", "schema": { "type": "string", "example": "No", "enum": [ "Yes", "No" ] } }, { "name": "partAQualificationInsert", "in": "query", "schema": { "type": "string" } }, { "name": "partBInsert", "in": "query", "schema": { "type": "string" } }, { "name": "isPartBQual", "in": "query", "schema": { "type": "string", "example": "No", "enum": [ "Yes", "No" ] } }, { "name": "partBQualifiedOpText", "in": "query", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isPageFooterParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/AuditReportSMSF": { "post": { "operationId": "runReportAuditReportSMSF", "summary": "Audit Report SMSF", "description": "Produces an Audit Report for the specified SMSF, providing the formal audit opinion and findings required by the appointed auditor to satisfy the fund's annual audit obligations under the Superannuation Industry (Supervision) Act.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/yearParam" }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "reportNameHtml_Value", "in": "query", "schema": { "type": "string" } }, { "name": "auditorDetailsHtml_Value", "in": "query", "schema": { "type": "string" } }, { "name": "fundDetailsHtml_Value", "in": "query", "schema": { "type": "string" } }, { "name": "partAQualTextHtml_Value", "in": "query", "schema": { "type": "string" } }, { "name": "basisOfAccountingHtml_Value", "in": "query", "schema": { "type": "string" } }, { "name": "partBQualTextHtml_Value", "in": "query", "schema": { "type": "string" } }, { "name": "limitedLiabilityHtml_Value", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/AuditRepresentationLetter": { "post": { "operationId": "runReportAuditRepresentationLetter", "summary": "Audit Representation Letter", "description": "Produces an Audit Representation Letter for the specified fund, providing the trustee's formal written representations to the auditor regarding the completeness and accuracy of the fund's financial information.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/yearParam" }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "dateOfLetter", "in": "query", "schema": { "type": "string", "example": "2023-07-01" } }, { "name": "noteHtml_Value", "in": "query", "description": "Provides short text description on the report", "schema": { "type": "string", "example": "No" } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/BulkLumpSumPaymentMinutes": { "post": { "operationId": "runReportBulkLumpSumPaymentMinutes", "summary": "Bulk Lump Sum Payment Minutes", "description": "Produces a Bulk Lump Sum Payment Minutes report for the specified fund, generating formal trustee meeting minutes documenting the approval of multiple lump sum benefit payments to fund members.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "confirmationNoteHtml_Value", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "includeConfirmationLetter", "in": "query", "required": true, "schema": { "type": "string", "example": "No", "enum": [ "Yes", "No" ] } }, { "name": "minuteResolutionType", "in": "query", "required": true, "schema": { "type": "string", "example": "Resolution", "enum": [ "Minute", "Resolution" ] } }, { "name": "includeMinute", "in": "query", "required": true, "schema": { "type": "string", "example": "No", "enum": [ "Yes", "No" ] } }, { "name": "includeRequestLetter", "in": "query", "required": true, "schema": { "type": "string", "example": "No", "enum": [ "Yes", "No" ] } }, { "name": "letterNoteHtml_Value", "in": "query", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "startDate", "in": "query", "description": "The start date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2013-07-01" } }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2014-06-30" } }, { "name": "meetingAddress", "in": "query", "schema": { "type": "string" } }, { "name": "minuteNoteHtml_Value", "in": "query", "schema": { "type": "string" } }, { "name": "signature", "in": "query", "schema": { "type": "string", "example": "All Trustees", "enum": [ "Chairperson", "All Trustees" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/CentrelinkScheduleData": { "post": { "operationId": "runReportCentrelinkScheduleData", "summary": "Centrelink Schedule Data", "description": "Produces a Centrelink Schedule Data report for the specified fund, providing the income stream and asset data required by Services Australia to accurately assess members' social security entitlements.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "atDate", "in": "query", "required": true, "schema": { "type": "string", "example": "2024-07-01" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isRoundingParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/CompilationReportPersonal": { "post": { "operationId": "runReportCompilationReportPersonal", "summary": "Compilation Report Personal", "description": "Produces a Personal Compilation Report for the specified fund, presenting compiled financial information prepared in accordance with applicable professional standards for personal financial reporting purposes.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "year", "description": "The financial year to retrieve information", "in": "query", "required": false, "schema": { "type": "integer", "example": 2024 } }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "noteHtml_Value", "in": "query", "required": true, "description": "Provides short text description on the report", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "dateOfLetter", "in": "query", "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "signatures", "in": "query", "schema": { "type": "string", "example": "None", "enum": [ "None", "Accountant", "Director", "Partner" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/CompilationReportSMSF": { "post": { "operationId": "runReportCompilationReportSMSF", "summary": "Compilation Report SMSF", "description": "Produces a Compilation Report for the specified SMSF, presenting an independently compiled set of financial statements prepared in accordance with applicable professional standards to support the fund's annual reporting obligations.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "year", "description": "The financial year to retrieve information", "in": "query", "required": false, "schema": { "type": "integer", "example": 2024 } }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "noteHtml_Value", "in": "query", "required": true, "description": "Provides short text description on the report", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "dateOfLetter", "in": "query", "schema": { "type": "string", "example": "2025-07-01" } }, { "name": "signatures", "in": "query", "schema": { "type": "string", "example": "None", "enum": [ "None", "Accountant", "Director", "Partner" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/CompilationReportTrust": { "post": { "operationId": "runReportCompilationReportTrust", "summary": "Compilation Report Trust", "description": "Produces a Compilation Report for the specified Trust, presenting an independently compiled set of financial statements prepared in accordance with applicable professional standards to support the Trust's annual reporting obligations.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "year", "description": "The financial year to retrieve information", "in": "query", "required": false, "schema": { "type": "integer", "example": 2024 } }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "noteHtml_Value", "in": "query", "required": true, "description": "Provides short text description on the report", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "dateOfLetter", "in": "query", "schema": { "type": "string", "example": "2025-07-01" } }, { "name": "signatures", "in": "query", "schema": { "type": "string", "example": "None", "enum": [ "None", "Accountant", "Director", "Partner" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/CentrelinkReportTrust": { "post": { "operationId": "runReportCentrelinkReportTrust", "summary": "Centrelink Report Trust", "description": "Produces a Centrelink Report for the specified Trust, providing the income and asset data required by Services Australia to assess beneficiaries' social security entitlements.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "noteHtml_Value", "in": "query", "required": true, "description": "Provides short text description on the report", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "dateOfLetter", "in": "query", "schema": { "type": "string", "example": "2013-07-01" } }, { "$ref": "#/components/parameters/yearParam" }, { "name": "signatures", "in": "query", "schema": { "type": "string", "example": "None", "enum": [ "None", "Accountant", "Director", "Partner" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/ContributionCap": { "post": { "operationId": "runReportContributionCap", "summary": "Contribution Cap", "description": "Produces a Contribution Cap report for the specified fund, tracking each member's contributions against their concessional and non-concessional caps to ensure compliance with ATO contribution limits and prevent excess contributions.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/yearParam" }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isSummaryParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "name": "includeSmsfDataflow", "in": "query", "schema": { "type": "string", "example": "No", "enum": [ "Yes", "No" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/CoverLetter": { "post": { "operationId": "runReportCoverLetter", "summary": "Cover Letter", "description": "Produces a Cover Letter for the specified fund, providing a professional introductory document to accompany the fund's financial statements and annual report package for distribution to trustees and members.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "name": "dateOfLetter", "in": "query", "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "noteHtml_Value", "in": "query", "description": "Provides short text description on the report", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "description": "The start date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2025-06-30" } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/CoverPage": { "post": { "operationId": "runReportCoverPage", "summary": "Cover Page", "description": "Produces a Cover Page for the specified fund, providing a formatted title page for inclusion at the front of the fund's annual report or financial statements package.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "name": "noteHtml_Value", "in": "query", "description": "Provides short text description on the report", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "description": "The start date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2025-06-30" } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/DepreciationWorksheet": { "post": { "operationId": "runReportDepreciationWorksheet", "summary": "Depreciation Worksheet", "description": "Produces a Depreciation Worksheet for the specified fund, detailing depreciation calculations applied to depreciable assets to support accurate tax deduction claims and ongoing asset register maintenance.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/yearParam" }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/DetailedInvestmentTransactions": { "post": { "operationId": "runReportDetailedInvestmentTransactions", "summary": "Detailed Investment Transactions", "description": "Produces a Detailed Investment Transactions report for the specified fund, providing a comprehensive listing of all individual investment transactions during the reporting period to support audit review and portfolio reconciliation.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "isSepPagePerAccount", "in": "query", "schema": { "type": "string", "example": "Yes", "enum": [ "Yes", "No" ] } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "name": "startDate", "in": "query", "description": "The start date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2025-06-30" } }, { "name": "includeAssetCodes", "in": "query", "description": "Indicates whether asset codes should be included in the report output.", "schema": { "type": "string", "example": "False", "enum": [ "True", "False" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/DistributionReconciliation": { "post": { "operationId": "runReportDistributionReconciliation", "summary": "Distribution Reconciliation", "description": "Produces a Distribution Reconciliation report for the specified fund, reconciling distributions received from managed funds and trusts against tax statements to ensure accurate income recording and tax reporting.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/yearParam" }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "name": "includeAssetCodes", "in": "query", "description": "Indicates whether asset codes should be included in the report output.", "schema": { "type": "string", "example": "False", "enum": [ "True", "False" ] } }, { "name": "groupBy", "in": "query", "schema": { "type": "string", "example": "MarketType", "enum": [ "MarketType", "AssetPool", "GL", "Reference" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/EditableReport": { "post": { "operationId": "runReportEditableReport", "summary": "Editable Report", "description": "Produces an Editable Report for the specified fund, generating a customisable document template that trustees and administrators can tailor to meet specific fund communication or supplementary reporting requirements.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "name": "startDate", "in": "query", "description": "The start date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2025-06-30" } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/ELSDeclaration": { "post": { "operationId": "runReportELSDeclaration", "summary": "ELS Declaration", "description": "Produces an Electronic Lodgement System (ELS) Declaration for the specified fund, generating the formal declaration required for electronic lodgement of the fund's tax return via the ATO's lodgement infrastructure.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/yearParam" }, { "$ref": "#/components/parameters/obscureSensitiveDataParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/ELSTrustDeclaration": { "post": { "operationId": "runReportELSTrustDeclaration", "summary": "ELS Trust Declaration", "description": "Produces an Electronic Lodgement System (ELS) Trust Declaration for the specified Trust, generating the formal declaration required for electronic lodgement of the Trust's tax return via the ATO's lodgement infrastructure.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/yearParam" }, { "$ref": "#/components/parameters/obscureSensitiveDataParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/FinancialStatementTrusteeMinuteResolution": { "post": { "operationId": "runReportFinancialStatementTrusteeMinuteResolution", "summary": "Financial Statement Trustee Minute Resolution", "description": "Produces a Financial Statement Trustee Minute or Resolution for the specified fund, providing formal trustee documentation approving the fund's financial statements as required under superannuation governance obligations.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "year", "description": "The financial year to retrieve information", "in": "query", "required": true, "schema": { "type": "integer", "example": 2024 } }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "includeAssetCodes", "in": "query", "description": "Indicates whether asset codes should be included in the report output.", "schema": { "type": "string", "example": "False", "enum": [ "True", "False" ] } }, { "name": "groupBy", "in": "query", "schema": { "type": "string", "example": "MarketType", "enum": [ "MarketType", "AssetPool", "GL", "Reference" ] } }, { "name": "meetingDate", "in": "query", "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "minuteResolutionType", "in": "query", "required": true, "schema": { "type": "string", "example": "Minute" } }, { "name": "meetingAddress", "in": "query", "schema": { "type": "string" } }, { "name": "noteHtml_Value", "in": "query", "required": true, "description": "Provides short text description on the report", "schema": { "type": "string" } }, { "name": "Signature", "in": "query", "required": true, "schema": { "type": "string", "example": "All Trustees", "enum": [ "Chairperson", "All Trustees" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/ForeignAssetWorksheet": { "post": { "operationId": "runReportForeignAssetWorksheet", "summary": "Foreign Asset Worksheet", "description": "Produces a Foreign Asset Worksheet for the specified fund, detailing foreign currency translations and valuations for overseas investment holdings to support accurate financial reporting and tax compliance.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "startDate", "in": "query", "description": "The start date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2013-07-01" } }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2014-06-30" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "groupBy", "in": "query", "schema": { "type": "string", "example": "MarketType", "enum": [ "MarketType", "AssetPool", "GL", "Reference" ] } }, { "name": "includeAssetCodes", "in": "query", "description": "Indicates whether asset codes should be included in the report output.", "schema": { "type": "string", "example": "True", "enum": [ "True", "False" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/ForeignBankAccountMovements": { "post": { "operationId": "runReportForeignBankAccountMovements", "summary": "Foreign Bank Account Movements", "description": "Produces a Foreign Bank Account Movements report for the specified fund, listing transactions in foreign currency bank accounts with appropriate exchange rate conversions to support reconciliation and tax reporting.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "startDate", "in": "query", "description": "The start date of the reporting period in YYYY-MM-DD format.", "required": true, "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period in YYYY-MM-DD format.", "required": true, "schema": { "type": "string", "example": "2025-06-30" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "$ref": "#/components/parameters/isRoundingParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/ForeignCashReconciliation": { "post": { "operationId": "runReportForeignCashReconciliation", "summary": "Foreign Cash Reconciliation", "description": "Produces a Foreign Cash Reconciliation report for the specified fund, reconciling foreign currency cash balances against recorded transactions to ensure the accuracy of the fund's overseas cash positions.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "startDate", "in": "query", "description": "The start date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period in YYYY-MM-DD format.", "schema": { "type": "string", "example": "2025-06-30" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/ForeignIncomeAndExpensesWorksheet": { "post": { "operationId": "runReportForeignIncomeAndExpensesWorksheet", "summary": "Foreign Income And Expenses Worksheet", "description": "Produces a Foreign Income and Expenses Worksheet for the specified fund, detailing foreign-sourced income and related expenses with applicable currency conversions to support accurate tax calculation and ATO reporting.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "startDate", "in": "query", "description": "The start date of the reporting period in YYYY-MM-DD format.", "required": true, "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period in YYYY-MM-DD format.", "required": true, "schema": { "type": "string", "example": "2025-06-30" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "name": "groupBy", "in": "query", "schema": { "type": "string", "example": "MarketType", "enum": [ "MarketType", "AssetPool", "GL", "Reference" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/ForeignTaxElection": { "post": { "operationId": "runReportForeignTaxElection", "summary": "Foreign Tax Election", "description": "Produces a Foreign Tax Election report for the specified fund, documenting the trustee's election to apply foreign income tax offsets in accordance with ATO provisions for relief on foreign-sourced income.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "startDate", "in": "query", "description": "The start date of the reporting period in YYYY-MM-DD format.", "required": true, "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period in YYYY-MM-DD format.", "required": true, "schema": { "type": "string", "example": "2025-06-30" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "$ref": "#/components/parameters/isRoundingParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/MemberStatement": { "post": { "operationId": "runReportMemberStatement", "summary": "Member Statement", "description": "Produces a Member Statement for the specified fund, providing each member with a personalised summary of their account balance, contributions, earnings, and benefit entitlements for the reporting period.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "startDate", "in": "query", "description": "The start date of the reporting period in YYYY-MM-DD format.", "required": true, "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period in YYYY-MM-DD format.", "required": true, "schema": { "type": "string", "example": "2025-06-30" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "name": "isShortForm", "in": "query", "schema": { "type": "string", "example": "No", "enum": [ "Yes", "No" ] } }, { "name": "consolidatedMemberComponents", "in": "query", "schema": { "type": "string", "example": "Show", "enum": [ "Show", "Hide" ] } }, { "name": "signingPage", "in": "query", "schema": { "type": "string", "example": "Show", "enum": [ "Yes", "No" ] } }, { "name": "includeInvestmentReturn", "in": "query", "schema": { "type": "string", "example": "No", "enum": [ "Yes", "No" ] } }, { "name": "hideContactDetails", "in": "query", "schema": { "type": "string", "example": "No", "enum": [ "Yes", "No" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/NotesToTheFinancialStatements": { "post": { "operationId": "runReportNotesToTheFinancialStatements", "summary": "Notes To The Financial Statements", "description": "Produces Notes to the Financial Statements for the specified fund, providing the detailed disclosures and accounting policy explanations required to accompany the financial statements in accordance with applicable accounting standards.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "name": "atDate", "in": "query", "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "authorisationDate", "in": "query", "schema": { "type": "string", "example": "2023-07-01" } }, { "name": "note1TextHtml_Value", "in": "query", "schema": { "type": "string", "example": "No" } }, { "name": "subsequentEventsTextHtml_Value", "in": "query", "schema": { "type": "string", "example": "No" } }, { "name": "showComparatives", "in": "query", "schema": { "type": "string", "example": "No", "enum": [ "Yes", "No" ] } }, { "name": "liabilityNoteHtml_Value", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "vestedNoteHtml_Value", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "guaranteedNoteHtml_Value", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "fundingNoteHtml_Value", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "unallocatedContributionNoteHtml_Value", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "CompilationFootnoteText", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/NotesToTheFinancialStatementsTrust": { "post": { "operationId": "runReportNotesToTheFinancialStatementsTrust", "summary": "Notes To The Financial Statements Trust", "description": "Produces Notes to the Financial Statements for the specified Trust, providing the detailed disclosures and accounting policy explanations required to accompany the Trust's financial statements in accordance with applicable accounting standards.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "name": "atDate", "in": "query", "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "authorisationDate", "in": "query", "schema": { "type": "string", "example": "2024-07-01" } }, { "name": "note1TextHtml_Value", "in": "query", "schema": { "type": "string" } }, { "name": "CompilationFootnoteText", "in": "query", "schema": { "type": "string" } }, { "name": "showComparatives", "in": "query", "schema": { "type": "string", "example": "No", "enum": [ "Yes", "No" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/S290170AcceptanceMinuteResolution": { "post": { "operationId": "runReportS290170AcceptanceMinuteResolution", "summary": "S290170 Acceptance Minute Resolution", "description": "Produces an S290-170 Acceptance Minute or Resolution for the specified fund, documenting the trustee's formal acceptance of a member's Notice of Intent to Claim a deduction for personal superannuation contributions under Section 290-170 of the ITAA 1997.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "Signature", "in": "query", "schema": { "type": "string", "example": "All Trustees", "enum": [ "Chairperson", "All Trustees" ] } }, { "$ref": "#/components/parameters/yearParam" }, { "name": "minuteResolutionType", "in": "query", "required": true, "schema": { "type": "string", "example": "Minute", "enum": [ "Minute", "Resolution" ] } }, { "name": "meetingDate", "in": "query", "required": true, "schema": { "type": "string", "example": "2013-07-01" } }, { "name": "meetingAddress", "in": "query", "schema": { "type": "string" } }, { "name": "minuteNoteHtml_Value", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/S290170AcknowledgmentLetter": { "post": { "operationId": "runReportS290170AcknowledgmentLetter", "summary": "S290170 Acknowledgment Letter", "description": "Produces an S290-170 Acknowledgment Letter for the specified fund, providing the trustee's formal written acknowledgment of a member's Notice of Intent to Claim a tax deduction on personal superannuation contributions under Section 290-170 of the ITAA 1997.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "$ref": "#/components/parameters/yearParam" }, { "name": "dateOfLetter", "in": "query", "schema": { "type": "string", "example": "2023-07-01" } }, { "name": "dateOfNotice", "in": "query", "schema": { "type": "string", "example": "2024-12-31" } }, { "name": "letterNoteHtml_Value", "in": "query", "schema": { "type": "string", "example": "No" } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/S290170NoticeOfIntentToClaim": { "post": { "operationId": "runReportS290170NoticeOfIntentToClaim", "summary": "S290170 Notice Of Intent To Claim", "description": "Produces an S290-170 Notice of Intent to Claim report for the specified fund, generating the formal notice required for a member to claim a tax deduction on personal superannuation contributions under Section 290-170 of the ITAA 1997.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "$ref": "#/components/parameters/yearParam" }, { "name": "dateOfLetter", "in": "query", "schema": { "type": "string", "example": "2023-07-01" } }, { "name": "isSuppressTFNs", "in": "query", "schema": { "type": "string", "example": "No", "enum": [ "Yes", "No" ] } }, { "name": "isVariation", "in": "query", "required": true, "schema": { "type": "string", "example": "No", "enum": [ "Yes", "No" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/StatementOfTaxableIncome": { "post": { "operationId": "runReportStatementOfTaxableIncome", "summary": "Statement Of Taxable Income", "description": "Produces a Statement of Taxable Income report for the specified fund, detailing the components of the fund's taxable income to support the preparation and lodgement of the annual tax return with the ATO.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "Signature", "in": "query", "schema": { "type": "string", "example": "All Trustees" } }, { "name": "year", "description": "The financial year to retrieve information", "in": "query", "required": true, "schema": { "type": "integer", "example": 2024 } }, { "$ref": "#/components/parameters/isSummaryParam" }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/TaxAccountingReconciliationTrust": { "post": { "operationId": "runReportTaxAccountingReconciliationTrust", "summary": "Tax Accounting Reconciliation Trust", "description": "Produces a Tax Accounting Reconciliation report for the specified Trust, reconciling tax accounting entries to support compliance with Australian taxation obligations and annual trust tax return preparation.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isDollarSignParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "name": "year", "description": "The financial year to retrieve information", "in": "query", "required": true, "schema": { "type": "integer", "example": 2024 } }, { "$ref": "#/components/parameters/isRoundingParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/TrusteeDeclaration": { "post": { "operationId": "runReportTrusteeDeclaration", "summary": "Trustee Declaration", "description": "Produces a Trustee Declaration for the specified fund, providing the formal signed declaration required from the trustee as part of the fund's annual tax return lodgement obligations with the ATO.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "year", "description": "The financial year to retrieve information", "in": "query", "required": true, "schema": { "type": "integer", "example": 2024 } }, { "name": "noteHtml_Value", "in": "query", "description": "Provides short text description on the report", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/isPageFooterParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/TrusteeDeclarationTrust": { "post": { "operationId": "runReportTrusteeDeclarationTrust", "summary": "Trustee Declaration Trust", "description": "Produces a Trustee Declaration for the specified Trust, providing the formal signed declaration required from the trustee as part of the Trust's annual tax return lodgement obligations with the ATO.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "name": "year", "description": "The financial year to retrieve information", "in": "query", "required": true, "schema": { "type": "integer", "example": 2024 } }, { "name": "noteHtml_Value", "in": "query", "description": "Provides short text description on the report", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/isPageFooterParam" } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } }, "/f/{businessCode}/{fundCode}/report-data/report-generator/TrustIncomeScheduleReconciliation": { "post": { "operationId": "runReportTrustIncomeScheduleReconciliation", "summary": "Trust Income Schedule Reconciliation", "description": "Produces a Trust Income Schedule Reconciliation report for the specified fund, reconciling trust distribution income against trust tax statements to support accurate income allocation and tax reporting.", "parameters": [ { "$ref": "#/components/parameters/businessCodeParam" }, { "$ref": "#/components/parameters/fundCodeParam" }, { "name": "Content-Type", "in": "header", "description": "Specifies the media type expected in the response. Must always be set to application/pdf regardless of the desired output format.", "required": true, "schema": { "type": "string", "example": "application/pdf" } }, { "$ref": "#/components/parameters/outputFormatParam" }, { "$ref": "#/components/parameters/yearParam" }, { "$ref": "#/components/parameters/isReportHeaderParam" }, { "$ref": "#/components/parameters/isDraftWMParam" }, { "$ref": "#/components/parameters/isPageFooterParam" }, { "$ref": "#/components/parameters/isNegativeAmtParam" }, { "name": "includeAssetCodes", "in": "query", "description": "Indicates whether asset codes should be included in the report output.", "schema": { "type": "string", "example": "False", "enum": [ "True", "False" ] } }, { "name": "groupBy", "in": "query", "schema": { "type": "string", "example": "MarketType", "enum": [ "MarketType", "AssetPool", "GL", "Reference" ] } } ], "responses": { "200": { "description": "Success (Ok)" }, "400": { "description": "Error Message", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedErrorCommon" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenErrorCommon" } } } } } } }, "404": { "description": "Resource not available or user does not have access to the fund", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUnavailableErrorCommon" } } } } } } }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalErrorCommon" } } } } } } } }, "security": [ { "Class_oAuth": [ "fund.read" ] } ] } } }, "components": { "parameters": { "fundCodeParam": { "name": "fundCode", "description": "Class entity code", "in": "path", "required": true, "schema": { "type": "string", "example": "demo-fund" } }, "isDraftWMParam": { "name": "isDraftWM", "in": "query", "required": false, "description": "This will turn on a draft watermark on each page.", "schema": { "type": "string", "example": "No", "enum": [ "Yes", "No" ] } }, "isReportHeaderParam": { "name": "isReportHeader", "in": "query", "description": "This will turn on the report header logo.", "schema": { "type": "string", "example": "No", "enum": [ "Yes", "No" ] } }, "yearParam": { "name": "year", "description": "The financial year to retrieve information", "in": "query", "required": true, "schema": { "type": "integer", "example": 2024 } }, "isPageFooterParam": { "name": "isPageFooter", "in": "query", "description": "This will turn on the page footer.", "schema": { "type": "string", "example": "Yes", "enum": [ "Yes", "No", "Page Numbers Only" ] } }, "obscureSensitiveDataParam": { "name": "obscureSensitiveData", "in": "query", "description": "Indicates whether sensitive personal data, such as member names and tax file numbers, should be obscured in the generated report output.", "required": true, "schema": { "type": "string", "example": "Yes" } }, "isNegativeAmtParam": { "name": "isNegativeAmt", "in": "query", "description": "To display negative amounts with brackets or a minus sign.", "schema": { "type": "string", "example": "Brackets", "enum": [ "Brackets", "Minus Sign" ] } }, "isSummaryParam": { "name": "isSummary", "description": "This will provide a short version of this report.", "in": "query", "schema": { "type": "string", "example": "No", "enum": [ "Yes", "No" ] } }, "isDollarSignParam": { "name": "isDollarSign", "in": "query", "description": "This will display a '$' in the report.", "schema": { "type": "string", "example": "No", "enum": [ "Yes", "No" ] } }, "isRoundingParam": { "name": "isRounding", "in": "query", "description": "Indicates whether monetary amounts in the report should be rounded to the nearest whole dollar.", "schema": { "type": "string", "example": "No", "enum": [ "Yes", "No" ] } }, "outputFormatParam": { "name": "outputFormat", "in": "query", "description": "Specifies the desired output format for the generated report. Accepted values are pdf, csv, or rtf.", "required": true, "schema": { "type": "string", "example": "pdf", "enum": [ "pdf", "csv", "rtf" ] } }, "businessCodeParam": { "name": "businessCode", "in": "path", "description": "Class business code", "required": true, "schema": { "type": "string", "example": "demo-business" } } }, "schemas": { "UnauthorizedErrorCommon": { "type": "object", "properties": { "Code": { "type": "string", "example": "API_NOT_AUTHORISED" }, "Message": { "type": "string", "example": "Not authorised" } } }, "ErrorResponse": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ResourceUnavailableErrorCommon": { "type": "object", "properties": { "Code": { "type": "string", "example": "API_NOT_FOUND" }, "Message": { "type": "string", "example": "Resource not available or user does not have access to the fund." } } }, "ForbiddenErrorCommon": { "type": "object", "properties": { "Code": { "type": "string", "example": "FORBIDDEN" }, "Message": { "type": "string", "example": "You do not have permission to access this resource." } } }, "InternalErrorCommon": { "type": "object", "properties": { "Code": { "type": "string", "example": "API_INTERNAL_ERROR" }, "Message": { "type": "string", "example": "An unexpected error occurred on the server. Please try again later." } } } }, "securitySchemes": { "Class_oAuth": { "type": "oauth2", "description": "Class uses oAuth2 and OpenID for authentication and authorisation", "flows": { "authorizationCode": { "authorizationUrl": "https://apigateway.class-pie.com.au/connect/authorize", "tokenUrl": "https://apigateway.class-pie.com.au/connect/token", "scopes": { "business.fund.list": "List summarised data of funds in the business", "business.fund.create": "Create new funds in the business", "fund.details.read": "View basic fund details", "fund.details.maintain": "View and maintain basic fund details", "fund.member.read": "View member details", "fund.member.maintain": "View and maintain member details", "fund.read": "View all fund information", "fund.maintain": "View and maintain all fund information" } }, "clientCredentials": { "tokenUrl": "https://apigateway.class-pie.com.au/connect/token", "scopes": { "business.fund.list": "List summarised data of funds in the business", "business.fund.create": "Create new funds in the business", "fund.details.read": "View basic fund details", "fund.details.maintain": "View and maintain basic fund details", "fund.member.read": "View member details", "fund.member.maintain": "View and maintain member details", "fund.read": "View all fund information", "fund.maintain": "View and maintain all fund information" } } } } } } }