{
"paths": {
"/api/accounts/cashflowinstructions": {
"get": {
"responses": {
"200": {
"description": "Cash flow instructions",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.CashflowInstruction"
}
}
},
"401": {
"description": "Unauthorised to access the account",
"schema": {
"type": "string"
}
},
"404": {
"description": "Account does not exist.",
"schema": {
"type": "string"
}
}
},
"tags": [
"Accounts"
],
"operationId": "Accounts_GetCashflowInstructions",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request.accountId",
"in": "query",
"required": true,
"description": "AccountID of the SMA account. (prefixed with ‘AU’ for Australian accounts)",
"type": "string"
},
{
"name": "request.userId",
"in": "query",
"required": false,
"description": "Praemium user login to filter returned data based on the user’s Portfolio access.",
"type": "string"
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
}
},
"/api/accounts/cashflowinstructions/oneoff": {
"post": {
"responses": {
"204": {
"description": "NoContent"
},
"401": {
"description": "Unauthorised to access the account",
"schema": {
"type": "string"
}
},
"404": {
"description": "Account does not exist.",
"schema": {
"type": "string"
}
}
},
"tags": [
"Accounts"
],
"operationId": "Accounts_AddOneOffCashflowInstruction",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.PostOneOffCashflowInstructionRequest"
},
"description": ""
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
},
"delete": {
"responses": {
"204": {
"description": "NoContent"
},
"401": {
"description": "Unauthorised to access the account",
"schema": {
"type": "string"
}
},
"404": {
"description": "Account does not exist.",
"schema": {
"type": "string"
}
},
"422": {
"description": "Cashflow instruction {0} not found.",
"schema": {
"type": "string"
}
}
},
"tags": [
"Accounts"
],
"operationId": "Accounts_DeleteOneOffCashflowInstruction",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request.cashflowInstructionId",
"in": "query",
"required": true,
"description": "Cashflow instruction ID returned by GET cashflow instructions endpoint",
"format": "int32",
"type": "integer"
},
{
"name": "request.accountId",
"in": "query",
"required": true,
"description": "AccountID of the SMA account. (prefixed with ‘AU’ for Australian accounts)",
"type": "string"
},
{
"name": "request.userId",
"in": "query",
"required": false,
"description": "Praemium user login to filter returned data based on the user’s Portfolio access.",
"type": "string"
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
}
},
"/api/accounts/cashflowinstructions/regular": {
"put": {
"responses": {
"204": {
"description": "NoContent"
},
"401": {
"description": "Unauthorised to access the account",
"schema": {
"type": "string"
}
},
"404": {
"description": "Account does not exist.",
"schema": {
"type": "string"
}
}
},
"tags": [
"Accounts"
],
"operationId": "Accounts_UpdateRegularCashflowInstruction",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.PutRegularCashflowInstructionRequest"
},
"description": ""
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
},
"delete": {
"responses": {
"204": {
"description": "NoContent"
},
"401": {
"description": "Unauthorised to access the account",
"schema": {
"type": "string"
}
},
"404": {
"description": "Account does not exist.",
"schema": {
"type": "string"
}
}
},
"tags": [
"Accounts"
],
"operationId": "Accounts_DeleteRegularCashflowInstruction",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request.cashflowInstructionType",
"in": "query",
"required": true,
"description": "Regular contribution = 1, Regular withdrawal = 2",
"format": "int32",
"type": "integer",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
]
},
{
"name": "request.accountId",
"in": "query",
"required": true,
"description": "AccountID of the SMA account. (prefixed with ‘AU’ for Australian accounts)",
"type": "string"
},
{
"name": "request.userId",
"in": "query",
"required": false,
"description": "Praemium user login to filter returned data based on the user’s Portfolio access.",
"type": "string"
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
}
},
"/api/accounts": {
"post": {
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.AccountCreateResult"
}
}
},
"tags": [
"Accounts"
],
"operationId": "Accounts_Create",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "AccountCreate",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/AccountCreate"
}
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
},
"patch": {
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
}
},
"tags": [
"Accounts"
],
"operationId": "Accounts_LinkAccounts",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "link",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.LinkUserToAccounts"
},
"description": ""
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
}
},
"/api/accounts/{id}": {
"delete": {
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
}
},
"tags": [
"Accounts"
],
"operationId": "Accounts_DeleteAccount",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "",
"type": "string"
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
}
},
"/api/accounts/bpay": {
"get": {
"responses": {
"200": {
"description": "Account BPAY response list",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.AccountBpayResponse"
}
}
},
"401": {
"description": "Unauthorised to access the account",
"schema": {
"type": "string"
}
},
"404": {
"description": "Account does not exist.",
"schema": {
"type": "string"
}
}
},
"tags": [
"Accounts"
],
"operationId": "Accounts_GetAccountBpay",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "accountId",
"in": "query",
"required": false,
"description": "AccountID of the SMA account. (prefixed with ‘AU’ for Australian accounts) Omitting this field will retrieve items for all accounts.",
"type": "string"
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
}
},
"/api/accounts/{id}/appform": {
"get": {
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.SmaApplicationForm"
}
}
},
"tags": [
"Accounts"
],
"operationId": "Accounts_GetAppForm",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "AccountID of the SMA account. (prefixed with ‘AU’ for Australian accounts)",
"type": "string"
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
}
},
"/api/accounts/{id}/holdingsbymodel": {
"get": {
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.AccountHoldingsByModel"
}
}
},
"tags": [
"Accounts"
],
"operationId": "Accounts_GetAccountHoldingsByModel",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "AccountID of the SMA account. (prefixed with ‘AU’ for Australian accounts)",
"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": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
}
},
"/api/accounts/{accountId}/userlinks": {
"get": {
"responses": {
"200": {
"description": "User account links",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.UserAccountLink"
}
}
},
"401": {
"description": "Unauthorised to access the account",
"schema": {
"type": "string"
}
},
"404": {
"description": "Account does not exist.",
"schema": {
"type": "string"
}
}
},
"tags": [
"Accounts"
],
"operationId": "Accounts_GetUserAccountLinks",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "accountId",
"in": "path",
"required": true,
"description": "AccountID of the SMA account. (prefixed with ‘AU’ for Australian accounts)",
"type": "string"
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
}
},
"/api/accounts/{id}/signature": {
"post": {
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
}
},
"tags": [
"Accounts"
],
"operationId": "Accounts_InsertSignature",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "AccountID of the SMA account. (prefixed with ‘AU’ for Australian accounts)",
"type": "string"
},
{
"name": "signature",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.Signature"
},
"description": ""
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
}
},
"/api/accounts/{id}/status": {
"get": {
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.SmaAccountStatus"
}
}
},
"tags": [
"Accounts"
],
"operationId": "Accounts_GetAccountStatus",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "AccountID of the SMA account. (prefixed with ‘AU’ for Australian accounts)",
"type": "string"
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
}
},
"/api/accounts/customisations/exclusions": {
"get": {
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.SecurityExclusionResponse"
}
}
},
"401": {
"description": "Unauthorised to access the account",
"schema": {
"type": "string"
}
},
"404": {
"description": "Account does not exist.",
"schema": {
"type": "string"
}
}
},
"tags": [
"Accounts"
],
"operationId": "Accounts_GetSecurityExclusions",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "request.accountId",
"in": "query",
"required": true,
"description": "AccountID of the SMA account. (prefixed with ‘AU’ for Australian accounts)",
"type": "string"
},
{
"name": "request.userId",
"in": "query",
"required": false,
"description": "Praemium user login to filter returned data based on the user’s Portfolio access.",
"type": "string"
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
},
"put": {
"responses": {
"204": {
"description": "NoContent"
},
"401": {
"description": "This operation is not allowed for {0} token.",
"schema": {
"type": "string"
}
},
"422": {
"description": "Validation error",
"schema": {
"type": "string"
}
}
},
"tags": [
"Accounts"
],
"operationId": "Accounts_ReplaceSecurityExclusions",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.AddOrPutSecurityExclusionRequest"
},
"description": ""
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
},
"post": {
"responses": {
"204": {
"description": "NoContent"
},
"401": {
"description": "This operation is not allowed for {0} token.",
"schema": {
"type": "string"
}
},
"422": {
"description": "Validation error",
"schema": {
"type": "string"
}
}
},
"tags": [
"Accounts"
],
"operationId": "Accounts_AddSecurityExclusions",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.AddOrPutSecurityExclusionRequest"
},
"description": ""
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
},
"delete": {
"responses": {
"204": {
"description": "NoContent"
},
"401": {
"description": "This operation is not allowed for service provider token.",
"schema": {
"type": "string"
}
},
"422": {
"description": "Validation error",
"schema": {
"type": "string"
}
}
},
"tags": [
"Accounts"
],
"operationId": "Accounts_DeleteSecurityExclusions",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request.securityCode",
"in": "query",
"required": false,
"description": "The security code of the security.",
"type": "string"
},
{
"name": "request.exchangeCode",
"in": "query",
"required": false,
"description": "The exchange code of the security.",
"type": "string"
},
{
"name": "request.accountId",
"in": "query",
"required": true,
"description": "AccountID of the SMA account. (prefixed with ‘AU’ for Australian accounts)",
"type": "string"
},
{
"name": "request.userId",
"in": "query",
"required": false,
"description": "Praemium user login to filter returned data based on the user’s Portfolio access.",
"type": "string"
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
}
},
"/api/accounts/customisations": {
"get": {
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.SecurityCustomisationResponse"
}
},
"401": {
"description": "Unauthorised to access the account",
"schema": {
"type": "string"
}
},
"404": {
"description": "Account does not exist.",
"schema": {
"type": "string"
}
}
},
"tags": [
"Accounts"
],
"operationId": "Accounts_GetSecurityCustomisations",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "request.accountId",
"in": "query",
"required": true,
"description": "AccountID of the SMA account. (prefixed with ‘AU’ for Australian accounts)",
"type": "string"
},
{
"name": "request.userId",
"in": "query",
"required": false,
"description": "Praemium user login to filter returned data based on the user’s Portfolio access.",
"type": "string"
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
},
"put": {
"responses": {
"200": {
"description": "Security customisation response",
"schema": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.SecurityCustomisationResponse"
}
},
"401": {
"description": "This operation is not allowed for {0} token.",
"schema": {
"type": "string"
}
},
"422": {
"description": "Validation error",
"schema": {
"type": "string"
}
}
},
"tags": [
"Accounts"
],
"operationId": "Accounts_ReplaceSecurityCustomisations",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.PutCustomisationRequest"
},
"description": ""
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
}
},
"/api/accounts/customisations/substitutions": {
"get": {
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.SecuritySubstitutionResponse"
}
}
},
"401": {
"description": "Unauthorised to access the account",
"schema": {
"type": "string"
}
},
"404": {
"description": "Account does not exist.",
"schema": {
"type": "string"
}
}
},
"tags": [
"Accounts"
],
"operationId": "Accounts_GetSecuritySubstitutions",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "request.accountId",
"in": "query",
"required": true,
"description": "AccountID of the SMA account. (prefixed with ‘AU’ for Australian accounts)",
"type": "string"
},
{
"name": "request.userId",
"in": "query",
"required": false,
"description": "Praemium user login to filter returned data based on the user’s Portfolio access.",
"type": "string"
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
},
"put": {
"responses": {
"204": {
"description": "NoContent"
},
"401": {
"description": "This operation is not allowed for {0} token.",
"schema": {
"type": "string"
}
},
"422": {
"description": "Validation error",
"schema": {
"type": "string"
}
}
},
"tags": [
"Accounts"
],
"operationId": "Accounts_ReplaceSecuritySubstitutions",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.AddOrPutSecuritySubstitutionRequest"
},
"description": ""
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
},
"post": {
"responses": {
"204": {
"description": "NoContent"
},
"401": {
"description": "This operation is not allowed for {0} token.",
"schema": {
"type": "string"
}
},
"422": {
"description": "Validation error",
"schema": {
"type": "string"
}
}
},
"tags": [
"Accounts"
],
"operationId": "Accounts_AddSecuritySubstitutions",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.AddOrPutSecuritySubstitutionRequest"
},
"description": ""
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
},
"delete": {
"responses": {
"204": {
"description": "NoContent"
},
"401": {
"description": "This operation is not allowed for service provider token.",
"schema": {
"type": "string"
}
},
"422": {
"description": "Validation error",
"schema": {
"type": "string"
}
}
},
"tags": [
"Accounts"
],
"operationId": "Accounts_DeleteSecuritySubstitutions",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request.securityCodeFrom",
"in": "query",
"required": false,
"description": "The security code of the security.",
"type": "string"
},
{
"name": "request.exchangeCodeFrom",
"in": "query",
"required": false,
"description": "The exchange code of the security.",
"type": "string"
},
{
"name": "request.securityCodeTo",
"in": "query",
"required": false,
"description": "The security code of the security.",
"type": "string"
},
{
"name": "request.exchangeCodeTo",
"in": "query",
"required": false,
"description": "The exchange code of the security.",
"type": "string"
},
{
"name": "request.accountId",
"in": "query",
"required": true,
"description": "AccountID of the SMA account. (prefixed with ‘AU’ for Australian accounts)",
"type": "string"
},
{
"name": "request.userId",
"in": "query",
"required": false,
"description": "Praemium user login to filter returned data based on the user’s Portfolio access.",
"type": "string"
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
}
},
"/api/accounts/modelsubscriptions": {
"get": {
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.ModelSubscriptionResponse"
}
}
},
"401": {
"description": "Unauthorised to access the account",
"schema": {
"type": "string"
}
},
"404": {
"description": "Account does not exist.",
"schema": {
"type": "string"
}
}
},
"tags": [
"Accounts"
],
"operationId": "Accounts_GetModelSubscriptions",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "request.accountId",
"in": "query",
"required": true,
"description": "AccountID of the SMA account. (prefixed with ‘AU’ for Australian accounts)",
"type": "string"
},
{
"name": "request.userId",
"in": "query",
"required": false,
"description": "Praemium user login to filter returned data based on the user’s Portfolio access.",
"type": "string"
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
},
"put": {
"responses": {
"204": {
"description": "NoContent"
},
"401": {
"description": "Unauthorised to access the account",
"schema": {
"type": "string"
}
},
"404": {
"description": "Account does not exist.",
"schema": {
"type": "string"
}
},
"422": {
"description": "Validation error",
"schema": {
"type": "string"
}
}
},
"tags": [
"Accounts"
],
"operationId": "Accounts_ReplaceModelSubscriptions",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.PutModelSubscriptionRequest"
},
"description": ""
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
}
},
"/api/accounts/customisations/minimumtradesize": {
"get": {
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.MinimumTradeSizeResponse"
}
},
"401": {
"description": "Unauthorised to access the account",
"schema": {
"type": "string"
}
},
"404": {
"description": "Account does not exist.",
"schema": {
"type": "string"
}
}
},
"tags": [
"Accounts"
],
"operationId": "Accounts_GetMinimumTradeSize",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "request.accountId",
"in": "query",
"required": true,
"description": "AccountID of the SMA account. (prefixed with ‘AU’ for Australian accounts)",
"type": "string"
},
{
"name": "request.userId",
"in": "query",
"required": false,
"description": "Praemium user login to filter returned data based on the user’s Portfolio access.",
"type": "string"
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
},
"patch": {
"responses": {
"204": {
"description": "NoContent"
},
"401": {
"description": "Unauthorised to access the account",
"schema": {
"type": "string"
}
},
"404": {
"description": "Account does not exist.",
"schema": {
"type": "string"
}
},
"422": {
"description": "Validation error",
"schema": {
"type": "string"
}
}
},
"tags": [
"Accounts"
],
"operationId": "Accounts_UpdateMinimumTradeSize",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.PatchMinimumTradeSizeRequest"
},
"description": ""
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
}
},
"/api/applicants": {
"post": {
"responses": {
"200": {
"description": "Applicant creation result",
"schema": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.ApplicantCreateResult"
}
}
},
"tags": [
"Applicants"
],
"operationId": "Applicants_Post",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "ApplicantCreate",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ApplicantCreate"
}
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
}
},
"/api/applications/{applicationId}/status": {
"get": {
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.DraftApplication.ApplicationStatus"
}
}
},
"tags": [
"Application"
],
"operationId": "Application_GetApplicationStatus",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "applicationId",
"in": "path",
"required": true,
"description": "Unique ApplicationID to be used as an application reference.",
"format": "uuid",
"type": "string"
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
}
},
"/api/applications/draft": {
"post": {
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.ApplicationCreateResult"
}
}
},
"tags": [
"Application"
],
"operationId": "Application_CreateNewApplication",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.DraftApplication.Application"
},
"description": ""
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
}
},
"/api/beneficiarynominations": {
"post": {
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.BeneficiaryCreate"
}
}
},
"tags": [
"BeneficiaryNominations"
],
"operationId": "BeneficiaryNominations_CreateBeneficiaries",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "beneficiaryCreate",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.BeneficiaryCreate"
},
"description": ""
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
}
},
"/api/expenses": {
"get": {
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Expense"
}
}
}
},
"tags": [
"Expense"
],
"operationId": "Expense_GetExpenses",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "InternalID",
"in": "query",
"required": true,
"description": "The InternalID of the Portfolio as returned in the GET /api/portfolios endpoint.",
"format": "int32",
"type": "integer"
},
{
"name": "fromDate",
"in": "query",
"required": false,
"description": "The from date used when calculating data for the request.",
"format": "date-time",
"type": "string"
},
{
"name": "toDate",
"in": "query",
"required": false,
"description": "The to date used when calculating data for the request.",
"format": "date-time",
"type": "string"
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
}
},
"/api/income/schedules": {
"get": {
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.IncomeSchedule"
}
}
}
},
"tags": [
"Income"
],
"operationId": "Income_GetIncomeSchedules",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "InternalID",
"in": "query",
"required": true,
"description": "The InternalID of the Portfolio as returned in the GET /api/portfolios endpoint.",
"format": "int32",
"type": "integer"
},
{
"name": "fromDate",
"in": "query",
"required": false,
"description": "The from date used when calculating data for the request.",
"format": "date-time",
"type": "string"
},
{
"name": "toDate",
"in": "query",
"required": false,
"description": "The to date used when calculating data for the request.",
"format": "date-time",
"type": "string"
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
}
},
"/api/income/taxCredit": {
"get": {
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.IncomeAndTaxCredit"
}
}
}
},
"tags": [
"Income"
],
"operationId": "Income_GetIncomeAndTaxCredit",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "InternalID",
"in": "query",
"required": true,
"description": "The InternalID of the Portfolio as returned in the GET /api/portfolios endpoint.",
"format": "int32",
"type": "integer"
},
{
"name": "fromDate",
"in": "query",
"required": false,
"description": "The from date used when calculating data for the request.",
"format": "date-time",
"type": "string"
},
{
"name": "toDate",
"in": "query",
"required": false,
"description": "The to date used when calculating data for the request.",
"format": "date-time",
"type": "string"
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
}
},
"/api/income/schedules/bulk": {
"get": {
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.BulkIncomeScheduleData"
}
}
}
},
"tags": [
"Income"
],
"operationId": "Income_GetIncomeSchedulesBulk",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "internalIds",
"in": "query",
"required": false,
"collectionFormat": "multi",
"description": "Multiple InternalIds as string separated by comma.",
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
},
{
"name": "fromDate",
"in": "query",
"required": false,
"description": "The from date used when calculating data for the request.",
"format": "date-time",
"type": "string"
},
{
"name": "toDate",
"in": "query",
"required": false,
"description": "The to date used when calculating data for the request.",
"format": "date-time",
"type": "string"
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"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": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.ModelProvider.Model"
}
}
}
},
"tags": [
"Models"
],
"operationId": "Models_GetModels",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
}
},
"/api/models/{id}/holdings": {
"get": {
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.ModelProvider.ModelHoldingsSummary"
}
}
},
"tags": [
"Models"
],
"operationId": "Models_GetModelHoldings",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "ModelId as returned by the Models endpoint.",
"type": "string"
},
{
"name": "date",
"in": "query",
"required": false,
"description": "Date used to display the data.",
"format": "date-time",
"type": "string"
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
}
},
"/api/models/{id}/approximatefum": {
"get": {
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.ModelProvider.ModelApproximateFum"
}
}
},
"tags": [
"Models"
],
"operationId": "Models_GetApproximateFum",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "ModelID as returned by the /api/models/ endpoint.",
"type": "string"
},
{
"name": "date",
"in": "query",
"required": true,
"description": "The date to use when calculating data for the request.",
"format": "date-time",
"type": "string"
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
}
},
"/api/models/{id}/performance": {
"get": {
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.ModelProvider.ModelPerformance"
}
}
},
"tags": [
"Models"
],
"operationId": "Models_GetPerformance",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "ModelId as returned by the Models 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": "includeDailyReturns",
"in": "query",
"required": false,
"description": "If True, then the daily performance of the model is returned.",
"type": "boolean"
},
{
"name": "includeAnnulisedReturns",
"in": "query",
"required": false,
"description": "If True, then the annualised performance of the model is returned.",
"type": "boolean"
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
}
},
"/api/models/WeightAdjustments": {
"get": {
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.ModelWeightAdjustmentResponse"
}
}
},
"404": {
"description": "Models {0} are not found.",
"schema": {
"type": "string"
}
}
},
"tags": [
"Models"
],
"operationId": "Models_GetModelWeightAdjustments",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "modelCode",
"in": "query",
"required": false,
"description": "The Code as returned by the Models endpoint. Omitting this field will return weights for all models.",
"type": "string"
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
},
"put": {
"responses": {
"202": {
"description": ""
},
"422": {
"description": "Validation error",
"schema": {
"type": "string"
}
}
},
"tags": [
"Models"
],
"operationId": "Models_ReplaceModelWeightAdjustments",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.ModelWeightAdjustmentRequest"
},
"description": ""
},
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
}
},
"/api/pds": {
"get": {
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/PraemiumAPI.Public.Contract.Managed.PdsDetail"
}
}
}
},
"tags": [
"Pds"
],
"operationId": "Pds_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "x-pps-token",
"in": "header",
"required": true,
"description": "API token issued by Praemium.",
"type": "string"
},
{
"name": "x-pps-api-version",
"in": "header",
"required": true,
"description": "API version of the endpoint.",
"type": "string"
}
]
}
},
"/api/Performance": {
"get": {
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PraemiumAPI.Public.Implementation.ResponseGeneric[PraemiumAPI.Public.Contract.PortfolioPerformanceData]"
}
}
},
"tags": [
"Performance"
],
"operationId": "Performance_GetFromUri",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "request.internalID",
"in": "query",
"required": true,
"description": "The InternalID of the Portfolio as returned in the GET /api/portfolios endpoint.",
"format": "int32",
"type": "integer"
},
{
"name": "request.fromDate",
"in": "query",
"required": true,
"description": "The from date used when calculating data for the request.",
"format": "date-time",
"type": "string"
},
{
"name": "request.toDate",
"in": "query",
"required": true,
"description": "The to date used when calculating data for the request.",
"format": "date-time",
"type": "string"
},
{
"name": "request.perfCalcMethod",
"in": "query",
"required": true,
"description": "The method to calculate the percentage return. Currently always 0 for Time Weighted Return (TWR).",
"format": "int32",
"type": "integer"
},
{
"name": "request.cash",
"in": "query",
"required": false,
"description": "Whether or not to include cash in the performance calculations.",
"format": "int32",
"type": "integer"
},
{
"name": "request.excludedAssets",
"in": "query",
"required": false,
"description": "Whether or not to include any assets that have been excluded from performance.",
"format": "int32",
"type": "integer"
},
{
"name": "request.taxCredits",
"in": "query",
"required": false,
"description": "Whether or not to include tax credits in the dollar and percentage return calculations.",
"format": "int32",
"type": "integer"
},
{
"name": "request.percentReturns",
"in": "query",
"required": false,
"description": "Whether to calculate and return percentage returns.",
"format": "int32",
"type": "integer"
},
{
"name": "request.multiplePeriods",
"in": "query",
"required": false,
"description": "Whether to calculate percentage returns for the period requested or include other periods.