{ "paths": { "/api/esgcategories": { "get": { "responses": { "200": { "description": "ESG category IDs", "schema": { "type": "array", "items": { "type": "string" } } } }, "operationId": "GetAUAccountEsgCategories", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "accountId", "in": "query", "required": true, "description": "Account ID.", "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] }, "post": { "responses": { "204": { "description": "Success" } }, "operationId": "AddAUAccountEsgCategories", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "parameters": [ { "name": "body", "in": "body", "required": false, "schema": { "$ref": "#/definitions/PostEsgCategoryRequest" } }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] }, "put": { "responses": { "204": { "description": "Success" } }, "operationId": "ReplaceAUAccountEsgCategories", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "parameters": [ { "name": "body", "in": "body", "required": false, "schema": { "$ref": "#/definitions/PutEsgCategoryRequest" } }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] }, "delete": { "responses": { "204": { "description": "Success" } }, "operationId": "DeleteAUAccountEsgCategories", "parameters": [ { "name": "accountId", "in": "query", "required": true, "description": "Account ID.", "type": "string" }, { "name": "categoryId", "in": "query", "required": false, "description": "The category ID as returned by the all ESG categories endpoint.", "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/transactions": { "get": { "responses": { "200": { "description": "Transactions", "schema": { "$ref": "#/definitions/TransactionIEnumerablePagedResponse" } } }, "operationId": "GetAUTransactions", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" }, { "name": "AccountId", "in": "query", "required": true, "description": "Account ID.", "type": "string" }, { "name": "FromDate", "in": "query", "required": true, "description": "The from date used when calculating data for the request.", "format": "date-time", "type": "string" }, { "name": "ToDate", "in": "query", "required": true, "description": "The to date used when calculating data for the request.", "format": "date-time", "type": "string" }, { "name": "BuysAndSellsOnly", "in": "query", "required": false, "description": "Whether to includes only Buy, Close position, Sell, Short Sell, Write Opt. to Open, Write Opt. to Close, Buy Opt. to open, Buy Opt. to close. Default to false.", "type": "boolean" }, { "name": "ShowUnconfirmed", "in": "query", "required": false, "description": "Whether to show unconfirmed transactions. Default to false.", "type": "boolean" }, { "name": "Page", "in": "query", "required": false, "description": "Page number to return. Default to 1.", "format": "int32", "type": "integer" }, { "name": "Size", "in": "query", "required": false, "description": "Page size to return. Default to 100.", "format": "int32", "type": "integer" }, { "name": "OrderBy", "in": "query", "required": false, "description": "TransactionDate = 0, Security = 1. Default to 0.", "type": "enum" }, { "name": "Order", "in": "query", "required": false, "description": "Asc = 0, Desc = 1. Default to 1.", "type": "enum" } ] } }, "/api/cashtransactions": { "get": { "responses": { "200": { "description": "Cash transactions", "schema": { "$ref": "#/definitions/CashBookIEnumerablePagedResponse" } } }, "operationId": "GetAUCashTransactions", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "IncludePendingUnsettled", "in": "query", "required": false, "description": "Whether to include pending unsettled cash transactions. Default to false.", "type": "boolean" }, { "name": "Page", "in": "query", "required": false, "description": "Page number to return. Default to 1.", "format": "int32", "type": "integer" }, { "name": "Size", "in": "query", "required": false, "description": "Page size to return. Default to 100.", "format": "int32", "type": "integer" }, { "name": "AccountId", "in": "query", "required": true, "description": "Account ID.", "type": "string" }, { "name": "FromDate", "in": "query", "required": true, "description": "The from date used when calculating data for the request.", "format": "date-time", "type": "string" }, { "name": "ToDate", "in": "query", "required": true, "description": "The to date used when calculating data for the request.", "format": "date-time", "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/unsettledtransactions": { "get": { "responses": { "200": { "description": "Unsettled transactions", "schema": { "type": "array", "items": { "$ref": "#/definitions/UnsettledTransaction" } } } }, "operationId": "GetAUUnsettledTransactions", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "Page", "in": "query", "required": false, "description": "Page number to return. Default to 1.", "format": "int32", "type": "integer" }, { "name": "Size", "in": "query", "required": false, "description": "Page size to return. Default to 100.", "format": "int32", "type": "integer" }, { "name": "AccountId", "in": "query", "required": true, "description": "Account ID.", "type": "string" }, { "name": "FromDate", "in": "query", "required": true, "description": "The from date used when calculating data for the request.", "format": "date-time", "type": "string" }, { "name": "ToDate", "in": "query", "required": true, "description": "The to date used when calculating data for the request.", "format": "date-time", "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/dividendreinvestmentdetails": { "get": { "responses": { "200": { "description": "Dividend reinvestment details", "schema": { "type": "array", "items": { "$ref": "#/definitions/DividendReinvestmentDetail" } } } }, "operationId": "GetAUDividendReinvestmentDetails", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "accountId", "in": "query", "required": true, "description": "Account ID.", "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/users": { "get": { "responses": { "200": { "description": "User", "schema": { "$ref": "#/definitions/User" } } }, "operationId": "GetUser", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "User name.", "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/user": { "post": { "responses": { "200": { "description": "User", "schema": { "$ref": "#/definitions/UserCreationResponse" } } }, "operationId": "CreateUser", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "body", "in": "body", "required": false, "schema": { "$ref": "#/definitions/PostUserRequest" } }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/useraccounts": { "patch": { "responses": { "200": { "description": "Success" } }, "operationId": "LinkUserAccounts", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "parameters": [ { "name": "body", "in": "body", "required": false, "schema": { "$ref": "#/definitions/PatchUserAccountRequest" } }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/appform": { "get": { "responses": { "200": { "description": "Success" } }, "operationId": "GetAUAppForm", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" }, { "name": "AccountId", "in": "query", "required": true, "description": "Account ID.", "type": "string" }, { "name": "Recipient", "in": "query", "required": false, "description": "Adviser = 0, Investor = 1 (INTL only)", "type": "enum" }, { "name": "FormType", "in": "query", "required": false, "description": "Digital = 0, Paper = 1 (INTL only)", "type": "enum" } ] } }, "/api/accounts": { "get": { "responses": { "200": { "description": "Accounts", "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountIEnumerablePagedResponse" } } } }, "operationId": "GetAUAccounts", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": false, "description": "Account search string. This parameter accepts wildcards (*).", "type": "string" }, { "name": "accountIds", "in": "query", "required": false, "description": "An array of account IDs. If AccountIds are provided, all other parameters will be ignored.", "items": { "type": "string" }, "type": "array" }, { "name": "page", "in": "query", "required": false, "description": "Page number to return. Default to 1.", "format": "int32", "type": "integer" }, { "name": "size", "in": "query", "required": false, "description": "Page size to return. Default to 100.", "format": "int32", "type": "integer" }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/childaccounts": { "get": { "responses": { "200": { "description": "Child accounts", "schema": { "type": "array", "items": { "$ref": "#/definitions/ChildAccountAU" } } } }, "operationId": "GetAUChildAccounts", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "accountId", "in": "query", "required": true, "description": "Account ID.", "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/accountmodelweightings": { "get": { "responses": { "200": { "description": "Account model weightings", "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountModelWeighting" } } } }, "operationId": "GetAccountModelWeightings", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "accountId", "in": "query", "required": true, "description": "Account ID.", "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] }, "put": { "responses": { "204": { "description": "Success" } }, "operationId": "ReplaceAccountModelWeightings", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" }, { "name": "body", "in": "body", "required": false, "schema": { "$ref": "#/definitions/PutAccountModelWeightingRequest" } } ] } }, "/api/pds": { "get": { "responses": { "200": { "description": "PDS", "schema": { "type": "array", "items": { "$ref": "#/definitions/PdsDetail" } } } }, "operationId": "GetPDS", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/cedingparties": { "get": { "responses": { "200": { "description": "Ceding Parties", "schema": { "type": "array", "items": { "$ref": "#/definitions/CedingPartyResponse" } } } }, "operationId": "GetUKCedingParties", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" }, { "name": "accountType", "in": "query", "required": false, "description": "ISA = 15, GIA = 16.", "type": "enum" }, { "name": "search", "in": "query", "required": true, "description": "Search for Ceding party.", "type": "string" } ] } }, "/api/securities": { "get": { "responses": { "200": { "description": "Securities", "schema": { "type": "array", "items": { "$ref": "#/definitions/SecurityResponse" } } } }, "operationId": "FindAUSecurities", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" }, { "name": "search", "in": "query", "required": false, "description": "Search term based on security code or security description. If Search is provided, SecurityIds and SecurityCodes will be ignored.", "type": "string" }, { "name": "pdsId", "in": "query", "required": false, "description": "PDS ID. (AU only)", "type": "string" }, { "name": "securityIds", "in": "query", "required": false, "description": "A list of security IDs to search. If SecurityIds are provided, Search and SecurityCodes will be ignored.", "items": { "type": "string" }, "type": "array" }, { "name": "securityCodes", "in": "query", "required": false, "description": "A list of security codes to search. If SecurityCodes are provided, Search and SecurityIds will be ignored.", "items": { "type": "string" }, "type": "array" } ] } }, "/api/recalc/status": { "get": { "responses": { "200": { "description": "Service Recalc Status", "schema": { "$ref": "#/definitions/ServiceRecalcStatus" } } }, "operationId": "GetAURecalcStatus", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/application": { "post": { "responses": { "200": { "description": "Application upload result", "schema": { "$ref": "#/definitions/ApplicationUploadResult" } } }, "operationId": "CreateDraftApplication", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" }, { "name": "body", "in": "body", "required": false, "schema": { "$ref": "#/definitions/DraftApplication" } } ] } }, "/api/application/{ApplicationId}/status": { "get": { "responses": { "200": { "description": "Application status", "schema": { "$ref": "#/definitions/ApplicationStatus" } } }, "operationId": "GetDraftApplicationStatus", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "applicationId", "in": "path", "required": true, "description": "Unique application ID to be used as an application reference.", "format": "uuid", "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/expensedetail": { "get": { "responses": { "200": { "description": "Expense detail", "schema": { "type": "array", "items": { "$ref": "#/definitions/Expense" } } } }, "operationId": "GetAUExpenseDetail", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "AccountId", "in": "query", "required": true, "description": "Account ID.", "type": "string" }, { "name": "FromDate", "in": "query", "required": true, "description": "The from date used when calculating data for the request.", "format": "date-time", "type": "string" }, { "name": "ToDate", "in": "query", "required": true, "description": "The to date used when calculating data for the request.", "format": "date-time", "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/publisherevents": { "get": { "responses": { "200": { "description": "Publisher events", "schema": { "type": "array", "items": { "$ref": "#/definitions/PublisherEvent" } } } }, "operationId": "GetAUPublisherEvents", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/publishereventdetail": { "get": { "responses": { "200": { "description": "Publisher event detail", "schema": { "type": "array", "items": { "$ref": "#/definitions/PublisherEventDetail" } } } }, "operationId": "GetAUPublisherEventDetail", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "eventId", "in": "query", "required": true, "description": "EventId as returned by the report event endpoint.", "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/file": { "get": { "responses": { "200": { "description": "Success" } }, "operationId": "DownloadAUFile", "parameters": [ { "name": "fileId", "in": "query", "required": true, "description": "FileID as returned in the publisher event detail endpoint.", "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/assetclasssummary": { "get": { "responses": { "200": { "description": "Asset class summary", "schema": { "$ref": "#/definitions/AssetClassSummary" } } }, "operationId": "GetAUAssetClassSummary", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "AccountId", "in": "query", "required": true, "description": "Account ID.", "type": "string" }, { "name": "IncludeLoans", "in": "query", "required": false, "description": "Whether loans should be included. Default to false.", "type": "boolean" }, { "name": "ValuationDate", "in": "query", "required": true, "description": "Date used to display the data.", "format": "date-time", "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/holdingspermodel": { "get": { "responses": { "200": { "description": "Holdings per model", "schema": { "type": "array", "items": { "$ref": "#/definitions/HoldingsHistoryPerModel" } } } }, "operationId": "GetAUHoldingsPerModel", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "AccountId", "in": "query", "required": true, "description": "Account ID.", "type": "string" }, { "name": "FromDate", "in": "query", "required": true, "description": "The from date used when calculating data for the request.", "format": "date-time", "type": "string" }, { "name": "ToDate", "in": "query", "required": true, "description": "The to date used when calculating data for the request.", "format": "date-time", "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/holdings": { "get": { "responses": { "200": { "description": "Holdings", "schema": { "type": "array", "items": { "$ref": "#/definitions/HoldingData" } } } }, "operationId": "GetAUHoldings", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" }, { "name": "AccountIds", "in": "query", "required": true, "description": "An array of account IDs.", "items": { "type": "string" }, "type": "array" }, { "name": "ValuationDate", "in": "query", "required": true, "description": "Date used to display the data.", "format": "date-time", "type": "string" }, { "name": "ClassificationType", "in": "query", "required": true, "description": "AssetClassLookThrough = 1, AssetClassPrimaryClass = 2, MarketType = 3.", "type": "enum" } ] } }, "/api/incomedetail": { "get": { "responses": { "200": { "description": "Income detail", "schema": { "type": "array", "items": { "$ref": "#/definitions/IncomeDetail" } } } }, "operationId": "GetAUIncomeDetail", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "AccountId", "in": "query", "required": true, "description": "Account ID.", "type": "string" }, { "name": "FromDate", "in": "query", "required": true, "description": "The from date used when calculating data for the request.", "format": "date-time", "type": "string" }, { "name": "ToDate", "in": "query", "required": true, "description": "The to date used when calculating data for the request.", "format": "date-time", "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/incomeschedules": { "get": { "responses": { "200": { "description": "Income schedules", "schema": { "type": "array", "items": { "$ref": "#/definitions/IncomeSchedule" } } } }, "operationId": "GetAUIncomeSchedules", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "AccountId", "in": "query", "required": true, "description": "Account ID.", "type": "string" }, { "name": "FromDate", "in": "query", "required": true, "description": "The from date used when calculating data for the request.", "format": "date-time", "type": "string" }, { "name": "ToDate", "in": "query", "required": true, "description": "The to date used when calculating data for the request.", "format": "date-time", "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/incomeschedules/bulk": { "get": { "responses": { "200": { "description": "Income schedules bulk", "schema": { "type": "array", "items": { "$ref": "#/definitions/BulkIncomeScheduleData" } } } }, "operationId": "GetAUIncomeSchedulesBulk", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "AccountIds", "in": "query", "required": true, "description": "An array of account IDs.", "items": { "type": "string" }, "type": "array" }, { "name": "FromDate", "in": "query", "required": true, "description": "The from date used when calculating data for the request.", "format": "date-time", "type": "string" }, { "name": "ToDate", "in": "query", "required": true, "description": "The to date used when calculating data for the request.", "format": "date-time", "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/models": { "get": { "responses": { "200": { "description": "Models", "schema": { "type": "array", "items": { "$ref": "#/definitions/Model" } } } }, "operationId": "GetAUModels", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/modelapproximatefum": { "get": { "responses": { "200": { "description": "Model approximate FUM", "schema": { "$ref": "#/definitions/ModelApproximateFum" } } }, "operationId": "GetAUAproximateFum", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "modelId", "in": "query", "required": true, "description": "The model ID as returned by the model endpoint.", "type": "string" }, { "name": "valuationDate", "in": "query", "required": true, "description": "Date used to display the data.", "format": "date-time", "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/modelperformance": { "get": { "responses": { "200": { "description": "Model performance", "schema": { "$ref": "#/definitions/ModelPerformance" } } }, "operationId": "GetAUModelPerformance", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "ModelId", "in": "query", "required": true, "description": "The model ID as returned by the model endpoint.", "type": "string" }, { "name": "FromDate", "in": "query", "required": true, "description": "The from date used when calculating data for the request.", "format": "date-time", "type": "string" }, { "name": "ToDate", "in": "query", "required": true, "description": "The to date used when calculating data for the request.", "format": "date-time", "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/modelholdings": { "get": { "responses": { "200": { "description": "Model holdings", "schema": { "type": "array", "items": { "$ref": "#/definitions/ModelHolding" } } } }, "operationId": "GetAUModelHoldings", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "modelId", "in": "query", "required": true, "description": "The model ID as returned by the model endpoint.", "type": "string" }, { "name": "valuationDate", "in": "query", "required": true, "description": "Date used to display the data.", "format": "date-time", "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/modelweightadjustment": { "get": { "responses": { "200": { "description": "Model weight adjustment", "schema": { "type": "array", "items": { "$ref": "#/definitions/ModelWeightAdjustmentResponse" } } } }, "operationId": "GetAUModelWeightAdjustment", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "modelId", "in": "query", "required": true, "description": "The model ID as returned by the model endpoint.", "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] }, "put": { "responses": { "202": { "description": "Success" } }, "operationId": "ReplaceAUModelWeightAdjustment", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "parameters": [ { "name": "body", "in": "body", "required": false, "schema": { "$ref": "#/definitions/PutModelWeightAdjustmentRequest" } }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/bpay": { "get": { "responses": { "200": { "description": "BPAY", "schema": { "type": "array", "items": { "$ref": "#/definitions/BpayInfo" } } } }, "operationId": "GetAUBpay", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "accountIds", "in": "query", "required": true, "description": "An array of account IDs.", "items": { "type": "string" }, "type": "array" }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/cashflowinstructions": { "get": { "responses": { "200": { "description": "Cashflow instructions", "schema": { "type": "array", "items": { "$ref": "#/definitions/CashflowInstruction" } } } }, "operationId": "GetAUCashflowInstructions", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "accountId", "in": "query", "required": true, "description": "Account ID.", "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/cashflowinstructions/oneoff": { "post": { "responses": { "204": { "description": "Success" } }, "operationId": "AddAUOneOffCashflowInstructions", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "parameters": [ { "name": "body", "in": "body", "required": false, "schema": { "$ref": "#/definitions/PostOneOffCashflowInstructionRequest" } }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] }, "delete": { "responses": { "204": { "description": "Success" } }, "operationId": "DeleteAUOneOffCashflowInstructions", "parameters": [ { "name": "accountId", "in": "query", "required": true, "description": "Account ID.", "type": "string" }, { "name": "cashflowInstructionId", "in": "query", "required": true, "description": "Cashflow instruction ID returned by GET cashflow instructions endpoint", "type": "string" }, { "name": "cashflowInstructionType", "in": "query", "required": true, "description": "OneOffDirectDebit = 3." }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/cashflowinstructions/regular": { "put": { "responses": { "204": { "description": "Success" } }, "operationId": "UpdateAURegularCashflowInstructions", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "parameters": [ { "name": "body", "in": "body", "required": false, "schema": { "$ref": "#/definitions/PutRegularCashflowInstructionRequest" } }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] }, "delete": { "responses": { "204": { "description": "Success" } }, "operationId": "DeleteAURegularCashflowInstructions", "parameters": [ { "name": "accountId", "in": "query", "required": true, "description": "Account ID.", "type": "string" }, { "name": "cashflowInstructionType", "in": "query", "required": true, "description": "RegularContribution = 1, RegularWithdrawal = 2." }, { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" } ] } }, "/api/assetclassperformance": { "get": { "responses": { "200": { "description": "Asset class performance", "schema": { "type": "array", "items": { "$ref": "#/definitions/AssetClassInvestment" } } } }, "operationId": "GetAUAssetClassPerformance", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" }, { "name": "AccountId", "in": "query", "required": true, "description": "Account ID.", "type": "string" }, { "name": "FromDate", "in": "query", "required": true, "description": "The from date used when calculating data for the request.", "format": "date-time", "type": "string" }, { "name": "ToDate", "in": "query", "required": true, "description": "The to date used when calculating data for the request.", "format": "date-time", "type": "string" }, { "name": "IncludeCash", "in": "query", "required": false, "description": "Whether cash should be included. Default to false.", "type": "boolean" }, { "name": "IncludeLoans", "in": "query", "required": false, "description": "Whether loans should be included. Default to false.", "type": "boolean" }, { "name": "IncludeTaxCredits", "in": "query", "required": false, "description": "Whether or not to include tax credits. Default to false.", "type": "boolean" }, { "name": "IncludeForeignTaxPaid", "in": "query", "required": false, "description": "Whether or not to include foreign tax paid. Default to false.", "type": "boolean" }, { "name": "IncludeExcludedSecurities", "in": "query", "required": false, "description": "Whether or not to include any security that has been excluded from performance. Default to false.", "type": "boolean" }, { "name": "CalculationMethod", "in": "query", "required": false, "description": "ApproximateReturns = 0, TimeWeightedReturn = 1. Default to 1.", "type": "enum" } ] } }, "/api/performance": { "get": { "responses": { "200": { "description": "Performance", "schema": { "$ref": "#/definitions/Performance" } } }, "operationId": "GetAUPerformance", "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "Access token.", "type": "string" }, { "name": "x-pps-subscription-key", "in": "header", "required": true, "description": "Product subscription key.", "type": "string" }, { "name": "x-pps-api-version", "in": "header", "required": true, "description": "API version of the endpoint.", "type": "string" }, { "name": "AccountId", "in": "query", "required": true, "description": "Account ID.", "type": "string" }, { "name": "FromDate", "in": "query", "required": true, "description": "The from date used when calculating data for the request.", "format": "date-time", "type": "string" }, { "name": "ToDate", "in": "query", "required": true, "description": "The to date used when calculating data for the request.", "format": "date-time", "type": "string" }, { "name": "IncludeCash", "in": "query", "required": false, "description": "Whether cash should be included. Default to false.", "type": "boolean" }, { "name": "IncludeLoans", "in": "query", "required": false, "description": "Whether loans should be included. Default to false.", "type": "boolean" }, { "name": "IncludeExcludedSecurities", "in": "query", "required": false, "description": "Whether or not to include any security that has been excluded from performance. Default to false.", "type": "boolean" }, { "name": "IncludeTaxCredits", "in": "query", "required": false, "description": "Whether or not to include tax credits. Default to false.", "type": "boolean" }, { "name": "DisplayReturns", "in": "query", "required": false, "description": "BeforeExpenses = 0, AfterExpenses = 1, Both = 2. Default to 2.", "type": "enum" }, { "name": "MultiplePeriods", "in": "query", "required": false, "description": "The periods to return. Default to -1.