{"_id":"5d8b0b31c4b9960018c59a40","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","category":"5d8b0b31c4b9960018c599fb","user":"5c0db8c00fa7b60042af110d","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-04-12T02:15:33.510Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"The Praemium Application Programming Interface (API) enables your organisation to access information about your clients' portfolios from our system securely and on demand.\n\nThis site provides you with full details of each of the endpoints in the API, including the URL, parameters, validation tips, and what to expect in our response.\n\nIf you are interested in using our API please contact our product team at applyforapi@praemium.com.  They can answer any queries you may have and ensure all our compliance and contractual requirements are met.\n\nAfter the Product team has approved your use of our API, and you're ready to start developing, please contact our Client Services team at support@praemium.com.au to obtain a token is issued that allows access to our test environment. The test environment tokens are valid for 3* months and can be reissued upon request.\n\nOnce your application is fully developed, you can request a token for the Production environment.\nWe have a number of different endpoints available. To check what you have access to please consult the data feeds team at Praemium. Below is a summary of the endpoint availability for your token:\n\n|                            | Standard | SMA/Robo | Enterprise | Model Manager | SSO/User Management | Service Provider |\n|----------------------------|:--------:|:--------:|:---------:|:-------------:|:------------------------:|:------------------------:|\n| [Portfolio Account](doc:api-request)           |     ✔    |     ✔    |     ✔     |               |     ✔    |     ✔     |\n| [Performance](doc:performance)                 |     ✔    |     ✔    |     ✔     |               |               |               |\n| [Tax](doc:unrealisedcgt)                         |     ✔    |     ✔    |     ✔     |               |               |               |\n| [Trading Activity](doc:transactions)            |     ✔    |     ✔    |     ✔     |               |     ✔    |               |\n| [Income](doc:income-and-tax-credits)                      |     ✔    |     ✔    |     ✔     |               |               |               |\n| [Expenses](doc:expenses)                    |     ✔    |     ✔    |     ✔     |               |               |               |\n| [Reports and Files](doc:events)                    |     ✔    |     ✔    |     ✔     |               |               |               |\n| [Account Creation](doc:account)            |          |     ✔    |     ✔     |               |               |               |\n| [Applicant Creation](doc:applicants)          |          |     ✔    |     ✔     |               |               |               |\n| [PDS Get](doc:pds)                     |          |     ✔    |     ✔     |               |               |               |\n| [Linking Users](doc:link-a-user-to-an-account)               |          |     ✔    |     ✔     |               |               |               |\n| [Bulk](doc:recalc-asat)              |          |          |     ✔     |               |               |     ✔     |\n| [Create Applications via AP](doc:applications-draft)      |          |     ✔    |     ✔     |               |               |               |\n| [Models](doc:model-details)        |          |          |           |       ✔       |               |               |\n| [SSO and User Management](doc:sso-types)       |          |          |           |               |       ✔       |               |               |\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Some of our API endpoints content that we provide requires additional permissions.\\n\\nThis is granted on a case-by-case basis and at the sole discretion of Praemium\"\n}\n[/block]\nRefer to the [SSO into our Application](doc:sso-types) section for instructions on transitioning clients to our applications. If client authentication/authorisation is managed by your application, Praemium can assist in the security and design as it is in all our interests including clients to ensure security and appropriate levels of authorisation and access.\n\nIf there are any endpoints that you require and we have not listed, please contact for further information.","excerpt":"","slug":"introduction","type":"basic","title":"Introduction","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Introduction


The Praemium Application Programming Interface (API) enables your organisation to access information about your clients' portfolios from our system securely and on demand. This site provides you with full details of each of the endpoints in the API, including the URL, parameters, validation tips, and what to expect in our response. If you are interested in using our API please contact our product team at applyforapi@praemium.com. They can answer any queries you may have and ensure all our compliance and contractual requirements are met. After the Product team has approved your use of our API, and you're ready to start developing, please contact our Client Services team at support@praemium.com.au to obtain a token is issued that allows access to our test environment. The test environment tokens are valid for 3* months and can be reissued upon request. Once your application is fully developed, you can request a token for the Production environment. We have a number of different endpoints available. To check what you have access to please consult the data feeds team at Praemium. Below is a summary of the endpoint availability for your token: | | Standard | SMA/Robo | Enterprise | Model Manager | SSO/User Management | Service Provider | |----------------------------|:--------:|:--------:|:---------:|:-------------:|:------------------------:|:------------------------:| | [Portfolio Account](doc:api-request) | ✔ | ✔ | ✔ | | ✔ | ✔ | | [Performance](doc:performance) | ✔ | ✔ | ✔ | | | | | [Tax](doc:unrealisedcgt) | ✔ | ✔ | ✔ | | | | | [Trading Activity](doc:transactions) | ✔ | ✔ | ✔ | | ✔ | | | [Income](doc:income-and-tax-credits) | ✔ | ✔ | ✔ | | | | | [Expenses](doc:expenses) | ✔ | ✔ | ✔ | | | | | [Reports and Files](doc:events) | ✔ | ✔ | ✔ | | | | | [Account Creation](doc:account) | | ✔ | ✔ | | | | | [Applicant Creation](doc:applicants) | | ✔ | ✔ | | | | | [PDS Get](doc:pds) | | ✔ | ✔ | | | | | [Linking Users](doc:link-a-user-to-an-account) | | ✔ | ✔ | | | | | [Bulk](doc:recalc-asat) | | | ✔ | | | ✔ | | [Create Applications via AP](doc:applications-draft) | | ✔ | ✔ | | | | | [Models](doc:model-details) | | | | ✔ | | | | [SSO and User Management](doc:sso-types) | | | | | ✔ | | | [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Some of our API endpoints content that we provide requires additional permissions.\n\nThis is granted on a case-by-case basis and at the sole discretion of Praemium" } [/block] Refer to the [SSO into our Application](doc:sso-types) section for instructions on transitioning clients to our applications. If client authentication/authorisation is managed by your application, Praemium can assist in the security and design as it is in all our interests including clients to ensure security and appropriate levels of authorisation and access. If there are any endpoints that you require and we have not listed, please contact for further information.
View all 63 endpoints
The Praemium Application Programming Interface (API) enables your organisation to access information about your clients' portfolios from our system securely and on demand. This site provides you with full details of each of the endpoints in the API, including the URL, parameters, validation tips, and what to expect in our response. If you are interested in using our API please contact our product team at applyforapi@praemium.com. They can answer any queries you may have and ensure all our compliance and contractual requirements are met. After the Product team has approved your use of our API, and you're ready to start developing, please contact our Client Services team at support@praemium.com.au to obtain a token is issued that allows access to our test environment. The test environment tokens are valid for 3* months and can be reissued upon request. Once your application is fully developed, you can request a token for the Production environment. We have a number of different endpoints available. To check what you have access to please consult the data feeds team at Praemium. Below is a summary of the endpoint availability for your token: | | Standard | SMA/Robo | Enterprise | Model Manager | SSO/User Management | Service Provider | |----------------------------|:--------:|:--------:|:---------:|:-------------:|:------------------------:|:------------------------:| | [Portfolio Account](doc:api-request) | ✔ | ✔ | ✔ | | ✔ | ✔ | | [Performance](doc:performance) | ✔ | ✔ | ✔ | | | | | [Tax](doc:unrealisedcgt) | ✔ | ✔ | ✔ | | | | | [Trading Activity](doc:transactions) | ✔ | ✔ | ✔ | | ✔ | | | [Income](doc:income-and-tax-credits) | ✔ | ✔ | ✔ | | | | | [Expenses](doc:expenses) | ✔ | ✔ | ✔ | | | | | [Reports and Files](doc:events) | ✔ | ✔ | ✔ | | | | | [Account Creation](doc:account) | | ✔ | ✔ | | | | | [Applicant Creation](doc:applicants) | | ✔ | ✔ | | | | | [PDS Get](doc:pds) | | ✔ | ✔ | | | | | [Linking Users](doc:link-a-user-to-an-account) | | ✔ | ✔ | | | | | [Bulk](doc:recalc-asat) | | | ✔ | | | ✔ | | [Create Applications via AP](doc:applications-draft) | | ✔ | ✔ | | | | | [Models](doc:model-details) | | | | ✔ | | | | [SSO and User Management](doc:sso-types) | | | | | ✔ | | | [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Some of our API endpoints content that we provide requires additional permissions.\n\nThis is granted on a case-by-case basis and at the sole discretion of Praemium" } [/block] Refer to the [SSO into our Application](doc:sso-types) section for instructions on transitioning clients to our applications. If client authentication/authorisation is managed by your application, Praemium can assist in the security and design as it is in all our interests including clients to ensure security and appropriate levels of authorisation and access. If there are any endpoints that you require and we have not listed, please contact for further information.
{"_id":"5d8b0b31c4b9960018c59a36","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","category":"5d8b0b31c4b9960018c599fb","user":"598003249cea430015ae631d","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-04-22T23:01:02.161Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":"","examples":{"codes":[]},"method":"get"},"isReference":false,"order":1,"body":"Access to the API is protected by a security token.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Tokens\"\n}\n[/block]\nIn order to access the Premium API, you will need to be granted a token to authenticate and authorise your application.\n\nApplications that try to access the API without a valid token will receive a `403 (Forbidden)` response.\n\nTo make calls to the API, simply add the token as the `x-pps-token` header value in each HTTP request.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"x-pps-token: XXXX-XXXXXXXXXXXXXXXXXXXXXXX-XXXXXXXXXXXXX\",\n      \"language\": \"http\",\n      \"name\": \"HTTP Request Header\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Deprecated Header Name\",\n  \"body\": \"In previous versions of the API, the token was specified in the HTTP header `token`. In adopting better standards, this has been changed to by `x-pps-token`.\\n\\nThe header `token` is now deprecated and all applications should use `x-pps-token` to avoid possible service disruption.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Token Security\"\n}\n[/block]\nThe token allows access to the API, anyone with it will have access to your data. \n[block:callout]\n{\n  \"type\": \"danger\",\n  \"body\": \"**DO** treat the token as sensitive information and keep it secure.\\n\\n**DO** contact us immediately if you believe your token has been compromised. We will revoke it and re-issue a new one.\\n\\n**DO NOT** expose this token to your clients, but keep this token private within your secured self-hosted application only.\\n\\n** DO NOT** deploy software with this token outside of a trusted environment or pass it to a browser client-side script.\",\n  \"title\": \"Keep Your Token Secure\"\n}\n[/block]","excerpt":"","slug":"authentication","type":"basic","title":"Authentication","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Authentication


Access to the API is protected by a security token. [block:api-header] { "type": "basic", "title": "Tokens" } [/block] In order to access the Premium API, you will need to be granted a token to authenticate and authorise your application. Applications that try to access the API without a valid token will receive a `403 (Forbidden)` response. To make calls to the API, simply add the token as the `x-pps-token` header value in each HTTP request. [block:code] { "codes": [ { "code": "x-pps-token: XXXX-XXXXXXXXXXXXXXXXXXXXXXX-XXXXXXXXXXXXX", "language": "http", "name": "HTTP Request Header" } ] } [/block] [block:callout] { "type": "warning", "title": "Deprecated Header Name", "body": "In previous versions of the API, the token was specified in the HTTP header `token`. In adopting better standards, this has been changed to by `x-pps-token`.\n\nThe header `token` is now deprecated and all applications should use `x-pps-token` to avoid possible service disruption." } [/block] [block:api-header] { "title": "Token Security" } [/block] The token allows access to the API, anyone with it will have access to your data. [block:callout] { "type": "danger", "body": "**DO** treat the token as sensitive information and keep it secure.\n\n**DO** contact us immediately if you believe your token has been compromised. We will revoke it and re-issue a new one.\n\n**DO NOT** expose this token to your clients, but keep this token private within your secured self-hosted application only.\n\n** DO NOT** deploy software with this token outside of a trusted environment or pass it to a browser client-side script.", "title": "Keep Your Token Secure" } [/block]
Access to the API is protected by a security token. [block:api-header] { "type": "basic", "title": "Tokens" } [/block] In order to access the Premium API, you will need to be granted a token to authenticate and authorise your application. Applications that try to access the API without a valid token will receive a `403 (Forbidden)` response. To make calls to the API, simply add the token as the `x-pps-token` header value in each HTTP request. [block:code] { "codes": [ { "code": "x-pps-token: XXXX-XXXXXXXXXXXXXXXXXXXXXXX-XXXXXXXXXXXXX", "language": "http", "name": "HTTP Request Header" } ] } [/block] [block:callout] { "type": "warning", "title": "Deprecated Header Name", "body": "In previous versions of the API, the token was specified in the HTTP header `token`. In adopting better standards, this has been changed to by `x-pps-token`.\n\nThe header `token` is now deprecated and all applications should use `x-pps-token` to avoid possible service disruption." } [/block] [block:api-header] { "title": "Token Security" } [/block] The token allows access to the API, anyone with it will have access to your data. [block:callout] { "type": "danger", "body": "**DO** treat the token as sensitive information and keep it secure.\n\n**DO** contact us immediately if you believe your token has been compromised. We will revoke it and re-issue a new one.\n\n**DO NOT** expose this token to your clients, but keep this token private within your secured self-hosted application only.\n\n** DO NOT** deploy software with this token outside of a trusted environment or pass it to a browser client-side script.", "title": "Keep Your Token Secure" } [/block]
{"_id":"5d8b0b31c4b9960018c59a37","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","category":"5d8b0b31c4b9960018c599fb","user":"598003249cea430015ae631d","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-04-22T23:02:30.529Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"The API is versioned so that we can continually release new features and improvements without affecting existing implementations.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Specifying a Version\"\n}\n[/block]\nTo specify the API version, simply add the HTTP header `x-pps-api-version` header to each request.\n\nThe latest supported version is **2019.09.26** \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"x-pps-api-version: 2019.09.26\",\n      \"language\": \"text\",\n      \"name\": \"HTTP Request Header\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Currently, if an application does not explicitly specify an API version, a default legacy version is used.\\n\\nThis behaviour is deprecated and all applications will be phased in to explicitly specify an API version using the `x-pps-api-version` header.\\n\\nTo avoid service disruption, please ensure that your application supports the `x-pps-api-version` header.\",\n  \"title\": \"Deprecated Default Version\"\n}\n[/block]","excerpt":"","slug":"versioning","type":"basic","title":"Versioning","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Versioning


The API is versioned so that we can continually release new features and improvements without affecting existing implementations. [block:api-header] { "type": "basic", "title": "Specifying a Version" } [/block] To specify the API version, simply add the HTTP header `x-pps-api-version` header to each request. The latest supported version is **2019.09.26** [block:code] { "codes": [ { "code": "x-pps-api-version: 2019.09.26", "language": "text", "name": "HTTP Request Header" } ] } [/block] [block:callout] { "type": "warning", "body": "Currently, if an application does not explicitly specify an API version, a default legacy version is used.\n\nThis behaviour is deprecated and all applications will be phased in to explicitly specify an API version using the `x-pps-api-version` header.\n\nTo avoid service disruption, please ensure that your application supports the `x-pps-api-version` header.", "title": "Deprecated Default Version" } [/block]
The API is versioned so that we can continually release new features and improvements without affecting existing implementations. [block:api-header] { "type": "basic", "title": "Specifying a Version" } [/block] To specify the API version, simply add the HTTP header `x-pps-api-version` header to each request. The latest supported version is **2019.09.26** [block:code] { "codes": [ { "code": "x-pps-api-version: 2019.09.26", "language": "text", "name": "HTTP Request Header" } ] } [/block] [block:callout] { "type": "warning", "body": "Currently, if an application does not explicitly specify an API version, a default legacy version is used.\n\nThis behaviour is deprecated and all applications will be phased in to explicitly specify an API version using the `x-pps-api-version` header.\n\nTo avoid service disruption, please ensure that your application supports the `x-pps-api-version` header.", "title": "Deprecated Default Version" } [/block]
{"_id":"5d8b0b31c4b9960018c59a0a","category":"5d8b0b31c4b9960018c599fb","parentDoc":null,"project":"55ca8813e583751700f78a58","user":"55ca87c48705a70d00b8fc5c","version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-12-15T04:38:36.526Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"The Praemium API limits requests made to each Praemium service.  \n\nThe default is 5 requests per second, if you hit the limit the API will return HTTP code `429 (Too many requests)`.  If you genuinely need to make more requests, please speak to our support team.\n\nWe reserve the right to disable access to your application if this limit is abused.\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"body\": \"We reserve the right to disable your access to the API if this rate limit is abused.\"\n}\n[/block]","excerpt":"","slug":"api-requests","type":"basic","title":"Rate Limiting","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Rate Limiting


The Praemium API limits requests made to each Praemium service. The default is 5 requests per second, if you hit the limit the API will return HTTP code `429 (Too many requests)`. If you genuinely need to make more requests, please speak to our support team. We reserve the right to disable access to your application if this limit is abused. [block:callout] { "type": "danger", "body": "We reserve the right to disable your access to the API if this rate limit is abused." } [/block]
The Praemium API limits requests made to each Praemium service. The default is 5 requests per second, if you hit the limit the API will return HTTP code `429 (Too many requests)`. If you genuinely need to make more requests, please speak to our support team. We reserve the right to disable access to your application if this limit is abused. [block:callout] { "type": "danger", "body": "We reserve the right to disable your access to the API if this rate limit is abused." } [/block]
{"_id":"5d8b0b31c4b9960018c59a09","category":"5d8b0b31c4b9960018c599fb","project":"55ca8813e583751700f78a58","parentDoc":null,"user":"55ca87c48705a70d00b8fc5c","version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-19T07:05:42.238Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":4,"body":"The Praemium API communicates errors through standard HTTP status codes paired with our own error codes. Generally the following pattern will apply:\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"HTTP codes\"\n}\n[/block]\n2xx\n\nThe request was successfully received, understood, and accepted.\n\n3xx\n\nFurther action needs to be taken by the user agent in order to fulfill the request.\n\n4xx\n\nAn error in the request. Usually a bad parameter.\n\n5xx\n\nThe request is fine, but something is wrong on Praemium’s end.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"API error codes\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Code\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"99\",\n    \"1-0\": \"100\",\n    \"2-0\": \"101\",\n    \"3-0\": \"102\",\n    \"4-0\": \"103\",\n    \"5-0\": \"104\",\n    \"6-0\": \"105\",\n    \"7-0\": \"106\",\n    \"8-0\": \"107\",\n    \"9-0\": \"108\",\n    \"10-0\": \"109\",\n    \"11-0\": \"110\",\n    \"12-0\": \"111\",\n    \"13-0\": \"112\",\n    \"14-0\": \"113\",\n    \"15-0\": \"114\",\n    \"16-0\": \"115\",\n    \"17-0\": \"116\",\n    \"18-0\": \"117\",\n    \"0-1\": \"Unexpected system error.\",\n    \"1-1\": \"Authentication failed.\",\n    \"2-1\": \"User does not have access to the portfolio.\",\n    \"3-1\": \"Portfolio does not exist.\",\n    \"4-1\": \"Portfolio is closed.\",\n    \"5-1\": \"Portfolio not created until after valuation date.\",\n    \"6-1\": \"Valuation date cannot be greater than processed to date.\",\n    \"7-1\": \"Performance period from date cannot be earlier than the date of the first transaction for the portfolio.\",\n    \"8-1\": \"Performance period to date cannot be greater than the portfolio processed to date.\",\n    \"9-1\": \"Invalid performance calculation method.\",\n    \"10-1\": \"From date cannot be after to date.\",\n    \"11-1\": \"Portfolio is not a consolidated portfolio.\",\n    \"12-1\": \"Benchmark ID does not exist.\",\n    \"13-1\": \"Date range cannot be more than 31 days.\",\n    \"14-1\": \"\\nXML invalid.\",\n    \"15-1\": \"User ID must be supplied.\",\n    \"16-1\": \"Too many requests submitted.\",\n    \"17-1\": \"Page cannot be greater than the page count.\",\n    \"18-1\": \"Valuation date can only be the current processed to date.\"\n  },\n  \"cols\": 2,\n  \"rows\": 19\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example error response\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"ResponseStatus\\\": {\\n    \\\"Success\\\": false,\\n    \\\"Errors\\\": [\\n      {\\n        \\\"Code\\\": 113,\\n        \\\"Message\\\": \\\"Unexpected character encountered while parsing value: d. Path 'InternalID', line 2, position 23.\\\"\\n      }\\n    ]\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"response-codes","type":"basic","title":"Response Codes","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Response Codes


The Praemium API communicates errors through standard HTTP status codes paired with our own error codes. Generally the following pattern will apply: [block:api-header] { "type": "basic", "title": "HTTP codes" } [/block] 2xx The request was successfully received, understood, and accepted. 3xx Further action needs to be taken by the user agent in order to fulfill the request. 4xx An error in the request. Usually a bad parameter. 5xx The request is fine, but something is wrong on Praemium’s end. [block:api-header] { "type": "basic", "title": "API error codes" } [/block] [block:parameters] { "data": { "h-0": "Code", "h-1": "Description", "0-0": "99", "1-0": "100", "2-0": "101", "3-0": "102", "4-0": "103", "5-0": "104", "6-0": "105", "7-0": "106", "8-0": "107", "9-0": "108", "10-0": "109", "11-0": "110", "12-0": "111", "13-0": "112", "14-0": "113", "15-0": "114", "16-0": "115", "17-0": "116", "18-0": "117", "0-1": "Unexpected system error.", "1-1": "Authentication failed.", "2-1": "User does not have access to the portfolio.", "3-1": "Portfolio does not exist.", "4-1": "Portfolio is closed.", "5-1": "Portfolio not created until after valuation date.", "6-1": "Valuation date cannot be greater than processed to date.", "7-1": "Performance period from date cannot be earlier than the date of the first transaction for the portfolio.", "8-1": "Performance period to date cannot be greater than the portfolio processed to date.", "9-1": "Invalid performance calculation method.", "10-1": "From date cannot be after to date.", "11-1": "Portfolio is not a consolidated portfolio.", "12-1": "Benchmark ID does not exist.", "13-1": "Date range cannot be more than 31 days.", "14-1": "\nXML invalid.", "15-1": "User ID must be supplied.", "16-1": "Too many requests submitted.", "17-1": "Page cannot be greater than the page count.", "18-1": "Valuation date can only be the current processed to date." }, "cols": 2, "rows": 19 } [/block] [block:api-header] { "type": "basic", "title": "Example error response" } [/block] [block:code] { "codes": [ { "code": "{\n \"ResponseStatus\": {\n \"Success\": false,\n \"Errors\": [\n {\n \"Code\": 113,\n \"Message\": \"Unexpected character encountered while parsing value: d. Path 'InternalID', line 2, position 23.\"\n }\n ]\n }\n}", "language": "json", "name": "400 - Bad Request" } ] } [/block]
The Praemium API communicates errors through standard HTTP status codes paired with our own error codes. Generally the following pattern will apply: [block:api-header] { "type": "basic", "title": "HTTP codes" } [/block] 2xx The request was successfully received, understood, and accepted. 3xx Further action needs to be taken by the user agent in order to fulfill the request. 4xx An error in the request. Usually a bad parameter. 5xx The request is fine, but something is wrong on Praemium’s end. [block:api-header] { "type": "basic", "title": "API error codes" } [/block] [block:parameters] { "data": { "h-0": "Code", "h-1": "Description", "0-0": "99", "1-0": "100", "2-0": "101", "3-0": "102", "4-0": "103", "5-0": "104", "6-0": "105", "7-0": "106", "8-0": "107", "9-0": "108", "10-0": "109", "11-0": "110", "12-0": "111", "13-0": "112", "14-0": "113", "15-0": "114", "16-0": "115", "17-0": "116", "18-0": "117", "0-1": "Unexpected system error.", "1-1": "Authentication failed.", "2-1": "User does not have access to the portfolio.", "3-1": "Portfolio does not exist.", "4-1": "Portfolio is closed.", "5-1": "Portfolio not created until after valuation date.", "6-1": "Valuation date cannot be greater than processed to date.", "7-1": "Performance period from date cannot be earlier than the date of the first transaction for the portfolio.", "8-1": "Performance period to date cannot be greater than the portfolio processed to date.", "9-1": "Invalid performance calculation method.", "10-1": "From date cannot be after to date.", "11-1": "Portfolio is not a consolidated portfolio.", "12-1": "Benchmark ID does not exist.", "13-1": "Date range cannot be more than 31 days.", "14-1": "\nXML invalid.", "15-1": "User ID must be supplied.", "16-1": "Too many requests submitted.", "17-1": "Page cannot be greater than the page count.", "18-1": "Valuation date can only be the current processed to date." }, "cols": 2, "rows": 19 } [/block] [block:api-header] { "type": "basic", "title": "Example error response" } [/block] [block:code] { "codes": [ { "code": "{\n \"ResponseStatus\": {\n \"Success\": false,\n \"Errors\": [\n {\n \"Code\": 113,\n \"Message\": \"Unexpected character encountered while parsing value: d. Path 'InternalID', line 2, position 23.\"\n }\n ]\n }\n}", "language": "json", "name": "400 - Bad Request" } ] } [/block]
{"_id":"5d8b0b31c4b9960018c59a35","category":"5d8b0b31c4b9960018c59a03","project":"55ca8813e583751700f78a58","user":"55dd6ff10efd5821000d5471","parentDoc":null,"version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-12-07T02:37:12.355Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"\"Ok\"","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","examples":{"codes":[{"language":"json","code":"GET http://{URL as provided}/status HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION"}]},"method":"get","auth":"required","params":[{"_id":"5add713e5cd1890003da86ac","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5add713e5cd1890003da86ab","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Status"},"isReference":false,"order":0,"body":"The endpoint returns the status of API.\n\nThere are three possible values for status:\n- Ok - API is working fine.\n- Degraded - API is partially working or is taking longer to respond.\n- Errored - API is down.","excerpt":"This endpoint checks the status of the API","slug":"status","type":"get","title":"Status","__v":5,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getStatus

This endpoint checks the status of the API

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
The endpoint returns the status of API. There are three possible values for status: - Ok - API is working fine. - Degraded - API is partially working or is taking longer to respond. - Errored - API is down.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The endpoint returns the status of API. There are three possible values for status: - Ok - API is working fine. - Degraded - API is partially working or is taking longer to respond. - Errored - API is down.
{"_id":"5d8b0b31c4b9960018c59a1c","category":"5d8b0b31c4b9960018c599fc","project":"55ca8813e583751700f78a58","parentDoc":null,"user":"55ca87c48705a70d00b8fc5c","version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-11T23:58:24.633Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"GET http://{URL as provided}/Portfolios HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\n{\n  \"InternalID\": \"11*\",\n  \"UserID\": \"smithj\"\n}","name":null,"language":"json"}]},"method":"get","results":{"codes":[{"status":200,"name":"","code":"{\n    \"ResponseStatus\": {\n        \"Success\": true,\n        \"Errors\": []\n    },\n    \"ResponseData\": {\n        \"PortfolioCount\": {\n            \"RecordsFound\": 2,\n            \"RecordsReturned\": 2,\n            \"PageCount\": 1\n        },\n        \"Portfolios\": [\n            {\n                \"InternalID\": 111,\n                \"PortfolioID\": \"JSmithCon\",\n                \"PortfolioName\": \"Jane Smith\",\n                \"ConsolidatedPortfolioType\": \"None\",\n                \"Status\": \"Active\",\n                \"RecalcType\": \"Auto\",\n                \"RecalcStatus\": \"OK\",\n                \"ProcessedTo\": \"2019-08-16T00:00:00Z\",\n                \"ReportingFrequency\": \"Monthly\",\n                \"AdviserGUIDs\": [\n                    \"24bea05f-e469-4ea2-b7f7-52c0eddd3c03-817025133158184021\",\n                ]\n            },\n            {\n                \"InternalID\": 112,\n                \"PortfolioID\": \"JohnSmithCon\",\n                \"PortfolioName\": \"John Smith\",\n                \"ConsolidatedPortfolioType\": \"None\",\n                \"Status\": \"Active\",\n                \"RecalcType\": \"Auto\",\n                \"RecalcStatus\": \"OK\",\n                \"ProcessedTo\": \"2019-08-16T00:00:00Z\",\n                \"ReportingFrequency\": \"Monthly\",\n                \"AdviserGUIDs\": []\n            }\n        ]\n    }\n}","language":"json"}]},"settings":"","auth":"required","params":[{"_id":"55d183883ea9882100ec8695","ref":"","in":"query","required":true,"desc":"Portfolio search string","default":"*","type":"string","name":"Portfolio"},{"_id":"55d1862f945e481700afb9d9","ref":"","in":"query","required":false,"desc":"Praemium user account login ID to check has access to the portfolio before returning data.","default":"smithj","type":"string","name":"UserID"},{"_id":"55d277c43c74062300aee6be","ref":"","in":"query","required":false,"desc":"If you know the `InternalID` of the portfolio, you can specified it here.","default":"","type":"int","name":"InternalID"},{"_id":"55d277c43c74062300aee6bd","ref":"","in":"query","required":false,"desc":"Page count/number","default":"","type":"int","name":"Page"},{"_id":"5ada896e2c87d800035ebf7a","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8c4fa6bc980003475db3","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Portfolios"},"isReference":true,"order":0,"body":"Wildcards (*) can be used. Your system can then do further filtering on the results returned.\n\n*The AdviserGUIDs field will only return for Service Provider tokens.*\n\nThe list returned will only contain data for:\n  * Portfolios that your organisation or a specific user is allowed to view, including transaction and consolidated portfolios.\n  * A maximum number of portfolios according to the maximum records to be returned in a single page.\n \nClosed portfolios that match the search string are returned by this endpoint.\n\nThis endpoint returns the `InternalID` of the portfolio, if found.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**\"\n}\n[/block]","excerpt":"This endpoint returns a list of portfolios based on a string matching the portfolio ID and/or name.","slug":"api-request","type":"get","title":"Portfolios","__v":34,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getPortfolios

This endpoint returns a list of portfolios based on a string matching the portfolio ID and/or name.

Query Params

Portfolio:
required
string*
Portfolio search string
UserID:
stringsmithj
Praemium user account login ID to check has access to the portfolio before returning data.
InternalID:
integer
If you know the `InternalID` of the portfolio, you can specified it here.
Page:
integer
Page count/number

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
Wildcards (*) can be used. Your system can then do further filtering on the results returned. *The AdviserGUIDs field will only return for Service Provider tokens.* The list returned will only contain data for: * Portfolios that your organisation or a specific user is allowed to view, including transaction and consolidated portfolios. * A maximum number of portfolios according to the maximum records to be returned in a single page. Closed portfolios that match the search string are returned by this endpoint. This endpoint returns the `InternalID` of the portfolio, if found. [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Wildcards (*) can be used. Your system can then do further filtering on the results returned. *The AdviserGUIDs field will only return for Service Provider tokens.* The list returned will only contain data for: * Portfolios that your organisation or a specific user is allowed to view, including transaction and consolidated portfolios. * A maximum number of portfolios according to the maximum records to be returned in a single page. Closed portfolios that match the search string are returned by this endpoint. This endpoint returns the `InternalID` of the portfolio, if found. [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**" } [/block]
{"_id":"5d8b0b31c4b9960018c59a1d","category":"5d8b0b31c4b9960018c599fc","user":"55ca87c48705a70d00b8fc5c","parentDoc":null,"project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-19T01:40:09.770Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"language":"json","code":"{\n  \"ResponseStatus\": {\n    \"Success\": true,\n    \"Errors\": []\n  },\n  \"ResponseData\": {\n    \"InternalID\": 11111,\n    \"Portfolio\": {\n      \"PortfolioID\": \"E097\",\n      \"PortfolioName\": \"Jane Smith\",\n      \"ConsolidatedPortfolioType\": \"None\",\n      \"Status\": \"Active\",\n      \"RecalcType\": \"Auto\",\n      \"RecalcStatus\": \"OK\",\n      \"ProcessedTo\": \"2015-08-20T00:00:00Z\",\n      \"TaxEntityType\": \"I\",\n      \"TotalValue\": 2218221.69,\n      \"Owner\": \"Mr Advisor \",\n      \"DateCreated\": \"2007-12-18T10:04:24.68Z\",\n      \"RecalcRequired\": \"No\",\n      \"FirstTransactionDate\": \"2018-01-01T00:00:00Z\",\n      \"LastRecalcDate\": \"2018-12-13T19:30:37.033\",\n      \"AccountType\": 0,\n      \"Benchmark1ID\": 3,\n      \"Benchmark1\": \"ASX 200 Index\",\n      \"Benchmark2ID\": -1,\n      \"Benchmark2\": \"None\"\n    }\n  }\n}","name":"","status":200}]},"settings":"","examples":{"codes":[{"language":"json","name":"","code":"GET http://{URL as provided}/Portfolios/PortfolioDetail HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\n{\n  \"InternalID\": 11111,\n  \"UserID\": \"smithj\"\n}"}]},"method":"get","auth":"required","params":[{"_id":"55d2ed5f86807b2b0066b733","ref":"","in":"query","required":true,"desc":"The `InternalID` as returned by the Portfolios endpoint.","default":"11111","type":"int","name":"InternalID"},{"_id":"55d2edce2463351700f67e2b","ref":"","in":"query","required":false,"desc":"Praemium user account login ID to check has access to the portfolio before returning data.","default":"smithj","type":"string","name":"UserID"},{"_id":"5ada899a93588300034e6409","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8c6f2c87d800035ebf91","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Portfolios/PortfolioDetail"},"isReference":true,"order":1,"body":"The following is a list of the Account Types returned by endpoint:\n0- Standard VWrap Account\n1 - Super Fund\n2 - Super Fund Holding Account\n3 - Super Fund Segregated Account\n5 - Holdings Only Portfolio\n6 - SuperSMA (accumulation)\n7 - SuperSMA (pension)\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**\"\n}\n[/block]","excerpt":"This endpoint returns details for the specified portfolio.","slug":"portfoliodetail","type":"get","title":"Portfolio Detail","__v":26,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getPortfolio Detail

This endpoint returns details for the specified portfolio.

Query Params

InternalID:
required
integer11111
The `InternalID` as returned by the Portfolios endpoint.
UserID:
stringsmithj
Praemium user account login ID to check has access to the portfolio before returning data.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
The following is a list of the Account Types returned by endpoint: 0- Standard VWrap Account 1 - Super Fund 2 - Super Fund Holding Account 3 - Super Fund Segregated Account 5 - Holdings Only Portfolio 6 - SuperSMA (accumulation) 7 - SuperSMA (pension) [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The following is a list of the Account Types returned by endpoint: 0- Standard VWrap Account 1 - Super Fund 2 - Super Fund Holding Account 3 - Super Fund Segregated Account 5 - Holdings Only Portfolio 6 - SuperSMA (accumulation) 7 - SuperSMA (pension) [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**" } [/block]
{"_id":"5d8b0b31c4b9960018c59a1e","category":"5d8b0b31c4b9960018c599fc","parentDoc":null,"project":"55ca8813e583751700f78a58","user":"55d13d9d18e19f0d003e428b","version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-17T06:35:47.484Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"GET http://{URL as provided}/Portfolios/ChildPortfolios HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\n{\n  \"InternalID\": 111111,\n  \"UserID\": \"smithj\"\n}","name":""}]},"method":"get","results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n  \"ResponseStatus\": {\n    \"Success\": true,\n    \"Errors\": [\n      {\n        \"Code\": 1,\n        \"Message\": \"sample string 2\"\n      }\n    ]\n  },\n  \"ResponseData\": {\n    \"InternalID\": 1,\n    \"ChildPortfolios\": [\n      {\n        \"InternalID\": 1,\n        \"PortfolioID\": \"sample string 2\",\n        \"PortfolioName\": \"sample string 3\"\n      }\n    ]\n  }\n}"}]},"settings":"","auth":"required","params":[{"_id":"55d2ed5f86807b2b0066b733","ref":"","in":"query","required":true,"desc":"The `InternalID` as returned by the Portfolios endpoint.","default":"111111","type":"int","name":"InternalID"},{"_id":"55d2edce2463351700f67e2b","ref":"","in":"query","required":false,"desc":"Praemium user account login ID to check has access to the portfolio before returning data.","default":"smithj","type":"string","name":"UserID"},{"_id":"5ada89a893588300034e640a","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8c86c30da50003c501f0","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Portfolios/ChildPortfolios"},"isReference":true,"order":2,"body":"The specified portfolio must have a `ConsolidatedPortfolioType` value of `Transaction` or `Holding`.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**\",\n  \"title\": \"Endpoint Access\"\n}\n[/block]","excerpt":"This endpoint returns the child portfolios of a specified portfolio.","slug":"getchildportfolios","type":"get","title":"Child Portfolios","__v":15,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getChild Portfolios

This endpoint returns the child portfolios of a specified portfolio.

Query Params

InternalID:
required
integer111111
The `InternalID` as returned by the Portfolios endpoint.
UserID:
stringsmithj
Praemium user account login ID to check has access to the portfolio before returning data.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
The specified portfolio must have a `ConsolidatedPortfolioType` value of `Transaction` or `Holding`. [block:callout] { "type": "info", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**", "title": "Endpoint Access" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The specified portfolio must have a `ConsolidatedPortfolioType` value of `Transaction` or `Holding`. [block:callout] { "type": "info", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**", "title": "Endpoint Access" } [/block]
{"_id":"5d8b0b31c4b9960018c59a1f","category":"5d8b0b31c4b9960018c599fc","parentDoc":null,"project":"55ca8813e583751700f78a58","user":"55ca87c48705a70d00b8fc5c","version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-19T01:40:48.298Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"language":"json","code":"GET http://{URL as provided}/Portfolios/Valuation HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\n{\n  \"InternalID\": 11111,\n  \"ValuationDate\": \"2015-08-19\",\n  \"Loans\": 1,\n  \"UserID\": \"smithj\"\n}","name":""}]},"method":"get","results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n  \"ResponseStatus\": {\n    \"Success\": true,\n    \"Errors\": []\n  },\n  \"ResponseData\": {\n    \"InternalID\": 11111,\n    \"Valuation\": {\n      \"ValuationDate\": \"2015-08-19T00:00:00\",\n      \"TotalCost\": 1329302.67,\n      \"TotalValue\": 2220008.19,\n      \"NetValue\": 2238889.2,\n      \"TotalGainOrLoss\": 890705.52,\n      \"EstIncome\": 69280.3,\n      \"Yield\": 3.12\n    },\n    \"Holdings\": [\n      {\n        \"SecurityCode\": \"ARI\",\n        \"SecurityDescription\": \"ARRIUM LIMITED FPO\",\n        \"AssetClassDescription\": \"Domestic Shares\",\n        \"AssetClassCode\":\"DS\",\n        \"AssetClassCategory\":\"Growth\",\n        \"AssetType\":\"ASX Listed\",\n        \"GICSDescription\": \"Materials\",\n        \"Quantity\": 375,\n        \"UnitCost\": 2.64,\n        \"Cost\": 990,\n        \"UnitValue\": 0.12,\n        \"UnitPriceDate\": \"2015-08-19T00:00:00Z\",\n        \"Value\": 45,\n        \"PercentTotalValue\": 0,\n        \"GainOrLoss\": -945,\n        \"PercentTotalGainOrLoss\": -0.11,\n        \"EstIncome\": 11.25,\n        \"Yield\": 25,\n        \"AssetCurrency\": \"AUD\",\n        \"ValueAssetCurrency\": 45,\n        \"CostBaseUnknown\": 0,\n        \"TaxCredits\": 120\n      }\n    ],\n    \"ReceivablesAndPayables\": [\n      {\n        \"Code\": \"AUDDIVSNOTPAID\",\n        \"Description\": \"Income declared but not paid\",\n        \"Type\": \"\",\n        \"Amount\": 18881.01,\n        \"IncludedInNetValue\": 1\n      }\n    ]\n  }\n}"}]},"auth":"required","params":[{"_id":"55d2ed5f86807b2b0066b733","ref":"","in":"query","required":true,"desc":"The `InternalID` as returned by the Portfolios endpoint.","default":"11111","type":"string","name":"InternalID"},{"_id":"55d2edce2463351700f67e2b","ref":"","in":"query","required":false,"desc":"The date that the portfolio valuation is required as at.","default":"2015-08-19","type":"string","name":"ValuationDate"},{"_id":"55d688fbd2a8eb1900109eb4","ref":"","in":"query","required":false,"desc":"Whether or not to include loans in the net portfolio value.","default":"1","type":"int","name":"Loans"},{"_id":"55d688fbd2a8eb1900109eb3","ref":"","in":"query","required":false,"desc":"Praemium user account login ID to check has access to the portfolio before returning data.","default":"smithj","type":"string","name":"UserID"},{"_id":"5ada89c393588300034e640b","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8ca1a6bc980003475de9","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"},{"_id":"5c356a9ca7a4e7000ebf59cd","ref":"","in":"query","required":false,"desc":"This can take value of 1(look through managed fund), 2(primary class for managed fund), or 3 (market type).","default":"3","type":"int","name":"ClassificationType"}],"url":"/Portfolios/Valuation"},"isReference":true,"order":3,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**\"\n}\n[/block]","excerpt":"This endpoint returns the valuation data for the specified portfolio.","slug":"valuation","type":"get","title":"Valuation","__v":17,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getValuation

This endpoint returns the valuation data for the specified portfolio.

Query Params

InternalID:
required
string11111
The `InternalID` as returned by the Portfolios endpoint.
ValuationDate:
string2015-08-19
The date that the portfolio valuation is required as at.
Loans:
integer1
Whether or not to include loans in the net portfolio value.
UserID:
stringsmithj
Praemium user account login ID to check has access to the portfolio before returning data.
ClassificationType:
integer3
This can take value of 1(look through managed fund), 2(primary class for managed fund), or 3 (market type).

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
[block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**" } [/block]
{"_id":"5d8b0b31c4b9960018c59a20","category":"5d8b0b31c4b9960018c599fc","parentDoc":null,"user":"55ca87c48705a70d00b8fc5c","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-19T01:41:19.502Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"","language":"json","code":"GET http://{URL as provided}/Portfolios/AssetClassSummary HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\n{\n  \"InternalID\": 11111,\n  \"ValuationDate\": \"2015-08-19\",\n  \"Loans\": 1,\n  \"Targets\": 1,\n  \"UserID\": \"smithj\",\n}"}]},"method":"get","results":{"codes":[{"code":"{\n  \"ResponseStatus\": {\n    \"Success\": true,\n    \"Errors\": []\n  },\n  \"ResponseData\": {\n    \"InternalID\": 11111,\n    \"ValuationDate\": \"2015-08-19T00:00:00\",\n    \"Valuation\": {\n      \"ValuationDate\": \"2015-08-19T00:00:00\",\n      \"TotalCost\": 1329302.68,\n      \"TotalValue\": 2220008.19,\n      \"NetValue\": 2238889.2,\n      \"TotalGainOrLoss\": 890705.53\n    },\n    \"AssetClasses\": [\n      {\n        \"AssetClassDescription\": \"Domestic Shares\",\n        \"Value\": 716305.38,\n        \"PercentTotalValue\": 31.99,\n        \"PercentNetValue\": 31.99,\n        \"MinTargetAllocation\": 0.4,\n        \"MaxTargetAllocation\": 0.6,\n        \"MidPointTargetAllocation\": 0.5,\n        \"Variance\": -0.1801\n      }\n    ],\n    \"ReceivablesAndPayables\": [\n      {\n        \"Description\": \"Income declared but not paid\",\n        \"TotalAmount\": 18881.01,\n        \"IncludedInNetValue\": 1\n      }\n    ]\n  }\n}","language":"json","status":200,"name":""}]},"settings":"","auth":"required","params":[{"_id":"55d2ed5f86807b2b0066b733","ref":"","in":"query","required":true,"desc":"The `InternalID` as returned by the Portfolios endpoint.","default":"11111","type":"string","name":"InternalID"},{"_id":"55d2edce2463351700f67e2b","ref":"","in":"query","required":false,"desc":"The date that the asset class summary is required as at. If not supplied the valuation date will be as at the current processed to date of the portfolio.","default":"2015-08-19","type":"yyyy-mm-dd","name":"ValuationDate"},{"_id":"55d68371250d7d0d00427467","ref":"","in":"query","required":false,"desc":"Whether or not to include loans in the net portfolio value.","default":"1","type":"int","name":"Loans"},{"_id":"55d68371250d7d0d00427466","ref":"","in":"query","required":false,"desc":"Whether or not return asset allocation targets if applicable to the portfolio.","default":"1","type":"int","name":"Targets"},{"_id":"55d68371250d7d0d00427465","ref":"","in":"query","required":false,"desc":"Praemium user account login ID to verify access to portfolios before returning data.","default":"smithj","type":"string","name":"UserID"},{"_id":"5ada89d5e49a030003358fa3","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8cc82c87d800035ebf92","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Portfolios/AssetClassSummary"},"isReference":true,"order":4,"body":"It is also possible to retrieve asset class allocation targets if they have been entered for the portfolio, and the current variance between the portfolio’s current exposure and the midpoint of the targets.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"All currency values are in the portfolio's presentation currency.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**\",\n  \"title\": \"Endpoint Access\"\n}\n[/block]","excerpt":"This endpoint returns a summary of the portfolio’s exposure to each asset class.","slug":"assetclasssummary","type":"get","title":"Asset Class Summary","__v":13,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getAsset Class Summary

This endpoint returns a summary of the portfolio’s exposure to each asset class.

Query Params

InternalID:
required
string11111
The `InternalID` as returned by the Portfolios endpoint.
ValuationDate:
yyyy-mm-dd2015-08-19
The date that the asset class summary is required as at. If not supplied the valuation date will be as at the current processed to date of the portfolio.
Loans:
integer1
Whether or not to include loans in the net portfolio value.
Targets:
integer1
Whether or not return asset allocation targets if applicable to the portfolio.
UserID:
stringsmithj
Praemium user account login ID to verify access to portfolios before returning data.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
It is also possible to retrieve asset class allocation targets if they have been entered for the portfolio, and the current variance between the portfolio’s current exposure and the midpoint of the targets. [block:callout] { "type": "info", "body": "All currency values are in the portfolio's presentation currency." } [/block] [block:callout] { "type": "info", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**", "title": "Endpoint Access" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



It is also possible to retrieve asset class allocation targets if they have been entered for the portfolio, and the current variance between the portfolio’s current exposure and the midpoint of the targets. [block:callout] { "type": "info", "body": "All currency values are in the portfolio's presentation currency." } [/block] [block:callout] { "type": "info", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**", "title": "Endpoint Access" } [/block]
{"_id":"5d8b0b31c4b9960018c59a11","category":"5d8b0b31c4b9960018c599fd","user":"55ca87c48705a70d00b8fc5c","project":"55ca8813e583751700f78a58","parentDoc":null,"version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-19T01:43:44.198Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"GET http://{URL as provided}/Performance HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\n{\n  \"InternalID\": 11111,\n  \"FromDate\": \"2015-08-01\",\n  \"ToDate\": \"2015-08-19\",\n  \"PerfCalcMethod\": 1,\n  \"Cash\": 1,\n  \"ExcludedAssets\": 1,\n  \"TaxCredits\": 1,\n  \"PercentReturns\": 1,\n  \"MultiplePeriods\": 1,\n  \"UserID\": \"smithj\"\n}","name":""}]},"method":"get","results":{"codes":[{"name":"","code":"{\n  \"ResponseStatus\": {\n    \"Success\": true,\n    \"Errors\": []\n  },\n  \"ResponseData\": {\n    \"InternalID\": 11111,\n    \"Performance\": {\n      \"FromDate\": \"2015-08-01T00:00:00\",\n      \"ToDate\": \"2015-08-19T00:00:00\",\n      \"PerfInceptionDate\": \"2015-08-01T00:00:00\",\n      \"HoldingsExcluded\": 0,\n      \"PerfCalcMethod\": 1,\n      \"BMV\": 2299302.52,\n      \"EMV\": 2238889.2,\n      \"NetCapitalMovement\": 0,\n      \"NetInternalTransfers\": 0,\n      \"CashExpenses\": 0,\n      \"UnallocatedAmount\": 0,\n      \"DollarReturn\": {\n        \"CapitalAppreciation\": -79294.33,\n        \"TotalIncome\": 18881.01,\n        \"TaxCredits\": 8075.73,\n        \"ForexMovements\": 0,\n        \"GrossDollarReturn\": -52337.59,\n        \"TotalExpenses\": 0,\n        \"NetDollarReturn\": -52337.59\n      },\n      \"PercentReturns\": [\n        {\n          \"PeriodDescription\": \"1 month\",\n          \"GrossPercentReturn\": -2.28,\n          \"NetPercentReturn\": -2.28\n        }\n      ]\n    }\n  }\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"55d2ed5f86807b2b0066b733","ref":"","in":"query","required":true,"desc":"The `InternalID` as returned by the Portfolios endpoint.","default":"11111","type":"string","name":"InternalID"},{"_id":"55d2edce2463351700f67e2b","ref":"","in":"query","required":true,"desc":"The start of the period of interest.","default":"2015-08-19","type":"yyyy-mm-dd","name":"FromDate"},{"_id":"55d67eaa250d7d0d0042745b","ref":"","in":"query","required":true,"desc":"The end of the period of interest.","default":"2015-08-19","type":"yyyy-mm-dd","name":"ToDate"},{"_id":"55d67eaa250d7d0d0042745a","ref":"","in":"query","required":true,"desc":"The method to calculate the percentage return. Currently always 0 for Time Weighted Return (TWR).","default":"1","type":"int","name":"PerfCalcMethod"},{"_id":"55d67eaa250d7d0d00427459","ref":"","in":"query","required":false,"desc":"Whether or not to include cash in the performance calculations.","default":"1","type":"int","name":"Cash"},{"_id":"55d67eaa250d7d0d00427458","ref":"","in":"query","required":false,"desc":"Whether or not to include any assets that have been excluded from performance.","default":"1","type":"int","name":"ExcludedAssets"},{"_id":"55d67eaa250d7d0d00427457","ref":"","in":"query","required":false,"desc":"Whether or not to include tax credits in the dollar and percentage return calculations.","default":"1","type":"int","name":"TaxCredits"},{"_id":"55d67eaa250d7d0d00427456","ref":"","in":"query","required":false,"desc":"Whether to calculate percentage returns:","default":"1","type":"int","name":"PercentReturns"},{"_id":"55d67eaa250d7d0d00427455","ref":"","in":"query","required":false,"desc":"Whether to calculate percentage returns for the period requested or other periods:","default":"1","type":"int","name":"MultiplePeriods"},{"_id":"55d67eaa250d7d0d00427454","ref":"","in":"query","required":false,"desc":"Praemium user account login ID to verify access to portfolios before returning data.","default":"smithj","type":"string","name":"UserID"},{"_id":"5ada89e5342d70000384e0bd","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8ce2a6bc980003475dea","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Performance"},"isReference":true,"order":0,"body":"Default values for optional input parameters will match the defaults that you have set up for **Portfolio performance** in your Praemium Service.\n\nValid options for the MultiplePeriods paramater are as follows:\n\n\n|  Period |\t      Returns            |\n|------|\t:------------------------------------------------------------------------:|\n| -1   |\tPortfolio default                                                            |\n| 0    |\tFor the period only                                                       |\n| 1    |\t1 mth, 3 mths, 1 yr, the period                                           |\n| 2    |\t3 mths, 1 yr, 3 yrs, the period                                           |\n| 3    |\t1 yr, 3 yrs, 5 yrs, the period                                            |\n| 4    |\t1 mth, 3 mths, the period                                                 |\n| 5    |\tQtr to date, Fin yr to date, 3 yrs, 5 yrs                                 |\n| 6    |\tQtr to date, Fin yr to date, 3 yrs, Since inception                       |\n| 7    |\tQtr to date, Fin yr to date, 1 yr,  Since inception                       |\n| 8    |\t3 mths, 1 yr, 3 yrs, 5 yrs, Since inception                               |\n| 9    |\t1 mth, 3 mths, 6 mths, 1 yr, Since inception                              |\n| 10   |\t1 yr, 2 yrs, 3 yrs, 4 yrs, 5 yrs                                          |\n| 11   |\t1 mth, 3 mths, 6 mths, 1 yr, 2 yrs, 3 yrs, 4 yrs, 5 yrs, Since inception  |\n| 13   |\t3 mths, 1 yr, 2 yrs, 5 yrs, Since Inception                               |\n| 14   |\t3 mths, 6 mths, 1 yr, 2 yrs, Since inception                              |\n| 15   |\t3 mths, 6 mths, 1 yr, 2 yrs, 3 yrs                                        |\n| 16   |\t1 mth, 3 mths, 6 mths, 1 yr, 3 yrs, 5 yrs, 10 yrs, Since inception        |\n| 17   |\t3 mths, 6 mths, 1 yr, 3 yrs, 5 yrs                                        |\n| 18   |\t3 mths, 1 yr, 3 yrs, 5 yrs, 7 yrs                                         |\n| 19   |\t1 yr, 3 yrs, 5 yrs, 7 yrs, 10 yrs                                         |\n| 20   |\tThe period, Qtr to date, Fin yr to date, Since inception                  |\n| 21   |\t3 mths, 1 yr, 2 yrs, 3 yrs, Since inception                               |\n| 22   |\t3 mths, 1 yr, 2 yr, 3 yrs, 5 yrs                                          |\n| 23   |\t1 yr, 5 yrs, 10 yrs, Since inception                                      |\n| 24   |\t1 mths, 3 mths, 1 yr, 3 yrs, 5 yrs, the period                       |\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**\"\n}\n[/block]","excerpt":"This endpoint returns the performance data over a given period for the specified portfolio.","slug":"performance","type":"get","title":"Performance","__v":21,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getPerformance

This endpoint returns the performance data over a given period for the specified portfolio.

Query Params

InternalID:
required
string11111
The `InternalID` as returned by the Portfolios endpoint.
FromDate:
required
yyyy-mm-dd2015-08-19
The start of the period of interest.
ToDate:
required
yyyy-mm-dd2015-08-19
The end of the period of interest.
PerfCalcMethod:
required
integer1
The method to calculate the percentage return. Currently always 0 for Time Weighted Return (TWR).
Cash:
integer1
Whether or not to include cash in the performance calculations.
ExcludedAssets:
integer1
Whether or not to include any assets that have been excluded from performance.
TaxCredits:
integer1
Whether or not to include tax credits in the dollar and percentage return calculations.
PercentReturns:
integer1
Whether to calculate percentage returns:
MultiplePeriods:
integer1
Whether to calculate percentage returns for the period requested or other periods:
UserID:
stringsmithj
Praemium user account login ID to verify access to portfolios before returning data.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
Default values for optional input parameters will match the defaults that you have set up for **Portfolio performance** in your Praemium Service. Valid options for the MultiplePeriods paramater are as follows: | Period | Returns | |------| :------------------------------------------------------------------------:| | -1 | Portfolio default | | 0 | For the period only | | 1 | 1 mth, 3 mths, 1 yr, the period | | 2 | 3 mths, 1 yr, 3 yrs, the period | | 3 | 1 yr, 3 yrs, 5 yrs, the period | | 4 | 1 mth, 3 mths, the period | | 5 | Qtr to date, Fin yr to date, 3 yrs, 5 yrs | | 6 | Qtr to date, Fin yr to date, 3 yrs, Since inception | | 7 | Qtr to date, Fin yr to date, 1 yr, Since inception | | 8 | 3 mths, 1 yr, 3 yrs, 5 yrs, Since inception | | 9 | 1 mth, 3 mths, 6 mths, 1 yr, Since inception | | 10 | 1 yr, 2 yrs, 3 yrs, 4 yrs, 5 yrs | | 11 | 1 mth, 3 mths, 6 mths, 1 yr, 2 yrs, 3 yrs, 4 yrs, 5 yrs, Since inception | | 13 | 3 mths, 1 yr, 2 yrs, 5 yrs, Since Inception | | 14 | 3 mths, 6 mths, 1 yr, 2 yrs, Since inception | | 15 | 3 mths, 6 mths, 1 yr, 2 yrs, 3 yrs | | 16 | 1 mth, 3 mths, 6 mths, 1 yr, 3 yrs, 5 yrs, 10 yrs, Since inception | | 17 | 3 mths, 6 mths, 1 yr, 3 yrs, 5 yrs | | 18 | 3 mths, 1 yr, 3 yrs, 5 yrs, 7 yrs | | 19 | 1 yr, 3 yrs, 5 yrs, 7 yrs, 10 yrs | | 20 | The period, Qtr to date, Fin yr to date, Since inception | | 21 | 3 mths, 1 yr, 2 yrs, 3 yrs, Since inception | | 22 | 3 mths, 1 yr, 2 yr, 3 yrs, 5 yrs | | 23 | 1 yr, 5 yrs, 10 yrs, Since inception | | 24 | 1 mths, 3 mths, 1 yr, 3 yrs, 5 yrs, the period | [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Default values for optional input parameters will match the defaults that you have set up for **Portfolio performance** in your Praemium Service. Valid options for the MultiplePeriods paramater are as follows: | Period | Returns | |------| :------------------------------------------------------------------------:| | -1 | Portfolio default | | 0 | For the period only | | 1 | 1 mth, 3 mths, 1 yr, the period | | 2 | 3 mths, 1 yr, 3 yrs, the period | | 3 | 1 yr, 3 yrs, 5 yrs, the period | | 4 | 1 mth, 3 mths, the period | | 5 | Qtr to date, Fin yr to date, 3 yrs, 5 yrs | | 6 | Qtr to date, Fin yr to date, 3 yrs, Since inception | | 7 | Qtr to date, Fin yr to date, 1 yr, Since inception | | 8 | 3 mths, 1 yr, 3 yrs, 5 yrs, Since inception | | 9 | 1 mth, 3 mths, 6 mths, 1 yr, Since inception | | 10 | 1 yr, 2 yrs, 3 yrs, 4 yrs, 5 yrs | | 11 | 1 mth, 3 mths, 6 mths, 1 yr, 2 yrs, 3 yrs, 4 yrs, 5 yrs, Since inception | | 13 | 3 mths, 1 yr, 2 yrs, 5 yrs, Since Inception | | 14 | 3 mths, 6 mths, 1 yr, 2 yrs, Since inception | | 15 | 3 mths, 6 mths, 1 yr, 2 yrs, 3 yrs | | 16 | 1 mth, 3 mths, 6 mths, 1 yr, 3 yrs, 5 yrs, 10 yrs, Since inception | | 17 | 3 mths, 6 mths, 1 yr, 3 yrs, 5 yrs | | 18 | 3 mths, 1 yr, 3 yrs, 5 yrs, 7 yrs | | 19 | 1 yr, 3 yrs, 5 yrs, 7 yrs, 10 yrs | | 20 | The period, Qtr to date, Fin yr to date, Since inception | | 21 | 3 mths, 1 yr, 2 yrs, 3 yrs, Since inception | | 22 | 3 mths, 1 yr, 2 yr, 3 yrs, 5 yrs | | 23 | 1 yr, 5 yrs, 10 yrs, Since inception | | 24 | 1 mths, 3 mths, 1 yr, 3 yrs, 5 yrs, the period | [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**" } [/block]
{"_id":"5d8b0b31c4b9960018c59a12","category":"5d8b0b31c4b9960018c599fd","project":"55ca8813e583751700f78a58","parentDoc":null,"user":"55ca87c48705a70d00b8fc5c","version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-19T01:59:27.574Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"ResponseStatus\": {\n    \"Success\": true,\n    \"Errors\": []\n  },\n  \"ResponseData\": {\n    \"InternalID\": 11111,\n    \"FromDate\": \"2015-08-01T00:00:00\",\n    \"ToDate\": \"2015-08-19T00:00:00\",\n    \"Investments\": [\n      {\n        \"AssetType\": \"ASX Listed\",\n        \"SecurityCode\": \"CBAR\",\n        \"SecurityDescription\": \"COMMONWEALTH BANK OF AUSTRALIA RIGHTS - APPLICATIONS CLOSE 08-SEP-2015 US PROHIBITED DEFER\",\n        \"AssetCurrency\": \"AUD\",\n        \"IncludeInPerf\": 0,\n        \"StartMarketValue\": 0,\n        \"Purchases\": 0,\n        \"Sales\": 0,\n        \"NetAdjOther\": 0,\n        \"GainOrLoss\": 2460.5,\n        \"EndMarketValue\": 2460.5,\n        \"IncomeDRP\": 0,\n        \"IncomeCash\": 0,\n        \"IncomeNotYetPaid\": 0,\n        \"TotalIncome\": 0,\n        \"TaxCredits\": 0,\n        \"TotalReturn\": 2460.5,\n        \"PercentTotalReturn\": 0,\n        \"PercentCapitalReturn\": 0,\n        \"PercentIncomeReturn\": 0\n      }\n    ],\n    \"CashAndEquivalents\": [\n      {\n        \"SecurityCode\": \"DIVSNOTPAID\",\n        \"SecurityDescription\": \"Income receivable\",\n        \"AssetCurrency\": \"AUD\",\n        \"IncludeInPerf\": 1,\n        \"OpeningBalance\": 0,\n        \"Purchases\": 0,\n        \"Sales\": 0,\n        \"Other\": 0,\n        \"Income\": 0,\n        \"InterestReceipts\": 0,\n        \"InternalTransfers\": 0,\n        \"Expenses\": 0,\n        \"Deposits\": 0,\n        \"Withdrawals\": 0,\n        \"ForexMovements\": 0,\n        \"ClosingBalance\": 18881.01\n      }\n    ]\n  }\n}","name":""}]},"settings":"","examples":{"codes":[{"name":"","language":"json","code":"GET http://{URL as provided}/Performance/InvestmentMovements HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\n{\n  \"InternalID\": 11111,\n  \"FromDate\": \"2015-08-01\",\n  \"ToDate\": \"2015-08-19\"\n}"}]},"auth":"required","params":[{"_id":"55d2ed5f86807b2b0066b733","ref":"","in":"query","required":true,"desc":"The `InternalID` as returned by the Portfolios endpoint.","default":"11111","type":"string","name":"InternalID"},{"_id":"55d2edce2463351700f67e2b","ref":"","in":"query","required":true,"desc":"The start of the period of interest.","default":"2015-08-01","type":"yyyy-mm-dd","name":"FromDate"},{"_id":"55d6615aae529e0d00d34e85","ref":"","in":"query","required":true,"desc":"The end of the period of interest.","default":"2015-08-19","type":"yyyy-mm-dd","name":"ToDate"},{"_id":"58ec18d43d24c01900b7f8d5","ref":"","in":"query","required":false,"desc":"0 = Time Weighted Return (TWR), 1 = Approximate returns","default":"1","type":"int","name":"PercentReturnMethod"},{"_id":"5ada89f1342d70000384e0be","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8d07a6bc980003475deb","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Performance/InvestmentMovements"},"isReference":true,"order":1,"body":"The response also contains the total dollar returns and % total returns in the period for each investment, whether from income or capital appreciation or both. \n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"The percentage returns are approximate only and not time weighted.\"\n}\n[/block]\nDefault values for optional input parameters will match the defaults that you have set up for **Investment movements** in your Praemium Service.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**\",\n  \"title\": \"Endpoint Access\"\n}\n[/block]","excerpt":"This endpoint returns the movement in value over a given date period for the specified portfolio’s holdings, cash accounts and cash equivalents.","slug":"investmentmovements","type":"get","title":"Investment Movements","__v":14,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getInvestment Movements

This endpoint returns the movement in value over a given date period for the specified portfolio’s holdings, cash accounts and cash equivalents.

Query Params

InternalID:
required
string11111
The `InternalID` as returned by the Portfolios endpoint.
FromDate:
required
yyyy-mm-dd2015-08-01
The start of the period of interest.
ToDate:
required
yyyy-mm-dd2015-08-19
The end of the period of interest.
PercentReturnMethod:
integer1
0 = Time Weighted Return (TWR), 1 = Approximate returns

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
The response also contains the total dollar returns and % total returns in the period for each investment, whether from income or capital appreciation or both. [block:callout] { "type": "warning", "body": "The percentage returns are approximate only and not time weighted." } [/block] Default values for optional input parameters will match the defaults that you have set up for **Investment movements** in your Praemium Service. [block:callout] { "type": "info", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**", "title": "Endpoint Access" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The response also contains the total dollar returns and % total returns in the period for each investment, whether from income or capital appreciation or both. [block:callout] { "type": "warning", "body": "The percentage returns are approximate only and not time weighted." } [/block] Default values for optional input parameters will match the defaults that you have set up for **Investment movements** in your Praemium Service. [block:callout] { "type": "info", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**", "title": "Endpoint Access" } [/block]
{"_id":"5d8b0b31c4b9960018c59a13","category":"5d8b0b31c4b9960018c599fd","user":"55ca87c48705a70d00b8fc5c","parentDoc":null,"project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-19T01:44:33.704Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"GET http://{URL as provided}/Performance/DailyReturns HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\n{\n  \"InternalID\": 11111,\n  \"FromDate\": \"2015-08-19\",\n  \"ToDate\": \"2015-08-19\",\n  \"PerfCalcMethod\": 1,\n  \"Cash\": 1,\n  \"ExcludedAssets\": 1,\n  \"TaxCredits\": 1,\n  \"PercentReturns\": 1,\n  \"MultiplePeriods\": 1,\n  \"UserID\": \"smithj\"\n}","name":""}]},"method":"get","results":{"codes":[{"language":"json","code":"{\n  \"ResponseStatus\": {\n    \"Success\": true,\n    \"Errors\": []\n  },\n  \"ResponseData\": {\n    \"InternalID\": 11111,\n    \"FromDate\": \"2015-08-19T00:00:00\",\n    \"ToDate\": \"2015-08-19T00:00:00\",\n    \"PerfInceptionDate\": \"2015-08-19T00:00:00\",\n    \"DailyReturns\": [\n      {\n        \"Date\": \"2015-08-19T00:00:00\",\n        \"BMV\": 2226879.06,\n        \"EMV\": 2238876.14,\n        \"NetContribution\": 0,\n        \"NetInternalTransfers\": 0,\n        \"TotalExpenses\": 0,\n        \"TaxCredits\": 0,\n        \"PercentageReturn\": 0.01,\n        \"NetPercentReturn\": 0,\n        \"CumPercentageReturn\": 0.54,\n        \"CumNetPercentReturn\": 0.54\n      }\n    ]\n  }\n}","name":"","status":200}]},"settings":"","auth":"required","params":[{"_id":"55d2ed5f86807b2b0066b733","ref":"","in":"query","required":true,"desc":"The `InternalID` as returned by the Portfolios endpoint.","default":"11111","type":"string","name":"InternalID"},{"_id":"55d2edce2463351700f67e2b","ref":"","in":"query","required":true,"desc":"The start of the period of interest.","default":"2015-08-19","type":"yyyy-mm-dd","name":"FromDate"},{"_id":"55d65a43250d7d0d004273fb","ref":"","in":"query","required":true,"desc":"The end of the period of interest. Cannot be more than 31 days after `FromDate`.","default":"2015-08-19","type":"yyyy-mm-dd","name":"ToDate"},{"_id":"55d65a43250d7d0d004273fa","ref":"","in":"query","required":true,"desc":"0 = Time Weighted Return (TWR)","default":"1","type":"int","name":"PerfCalcMethod"},{"_id":"55d65a43250d7d0d004273f9","ref":"","in":"query","required":false,"desc":"Whether or not to include cash in the performance calculations. 0=Exclude, 1=Include","default":"1","type":"int","name":"Cash"},{"_id":"55d65a43250d7d0d004273f8","ref":"","in":"query","required":false,"desc":"Whether or not to include any assets that have been excluded from performance. 0=Exclude, 1=Include","default":"1","type":"int","name":"ExcludedAssets"},{"_id":"55d65a43250d7d0d004273f7","ref":"","in":"query","required":false,"desc":"Whether or not to include tax credits in the dollar and percentage return calculations. 0=Exclude, 1=Include","default":"1","type":"int","name":"TaxCredits"},{"_id":"55d65a43250d7d0d004273f6","ref":"","in":"query","required":false,"desc":"Whether to calculate percentage returns","default":"1","type":"int","name":"PercentReturns"},{"_id":"55d65a43250d7d0d004273f5","ref":"","in":"query","required":false,"desc":"Whether to calculate percentage returns for the period requested or other periods","default":"1","type":"int","name":"MultiplePeriods"},{"_id":"55d65a43250d7d0d004273f4","ref":"","in":"query","required":false,"desc":"Praemium user account login ID to verify access to portfolios before returning data.","default":"smithj","type":"string","name":"UserID"},{"_id":"5ada89fea6bc980003475da7","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8d37a6bc980003475dec","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Performance/DailyReturns"},"isReference":true,"order":2,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"This endpoint uses the Time-Weighted Return (TWR) method of calculation.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**\"\n}\n[/block]","excerpt":"This endpoint returns the daily percentage return of a portfolio over the specified period.","slug":"dailyreturns","type":"get","title":"Daily Returns","__v":19,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getDaily Returns

This endpoint returns the daily percentage return of a portfolio over the specified period.

Query Params

InternalID:
required
string11111
The `InternalID` as returned by the Portfolios endpoint.
FromDate:
required
yyyy-mm-dd2015-08-19
The start of the period of interest.
ToDate:
required
yyyy-mm-dd2015-08-19
The end of the period of interest. Cannot be more than 31 days after `FromDate`.
PerfCalcMethod:
required
integer1
0 = Time Weighted Return (TWR)
Cash:
integer1
Whether or not to include cash in the performance calculations. 0=Exclude, 1=Include
ExcludedAssets:
integer1
Whether or not to include any assets that have been excluded from performance. 0=Exclude, 1=Include
TaxCredits:
integer1
Whether or not to include tax credits in the dollar and percentage return calculations. 0=Exclude, 1=Include
PercentReturns:
integer1
Whether to calculate percentage returns
MultiplePeriods:
integer1
Whether to calculate percentage returns for the period requested or other periods
UserID:
stringsmithj
Praemium user account login ID to verify access to portfolios before returning data.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
[block:callout] { "type": "info", "body": "This endpoint uses the Time-Weighted Return (TWR) method of calculation." } [/block] [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "body": "This endpoint uses the Time-Weighted Return (TWR) method of calculation." } [/block] [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**" } [/block]
{"_id":"5d8b0b31c4b9960018c59a14","category":"5d8b0b31c4b9960018c599fd","parentDoc":null,"user":"55ca87c48705a70d00b8fc5c","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-19T01:45:01.048Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"name":"","code":"{\n  \"ResponseStatus\": {\n    \"Success\": true,\n    \"Errors\": []\n  },\n  \"ResponseData\": {\n    \"Benchmarks\": [\n      {\n        \"BenchmarkID\": 2,\n        \"BenchmarkCode\": \"XTL\",\n        \"BenchmarkDescription\": \"S&P/ASX 20\"\n      }\n    ]\n  }\n}","language":"json","status":200}]},"settings":"","examples":{"codes":[{"code":"GET http://{URL as provided}/Performance/Benchmarks HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n","name":"","language":"json"}]},"auth":"required","params":[{"_id":"5ada8a0ca6bc980003475da8","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8d5b93588300034e6456","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Performance/Benchmarks"},"isReference":true,"order":3,"body":"The purpose of this method is for your system to enable a user to select a benchmark\nindex and then request the [Benchmark Performance](doc:benchmarkperformance) data method.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**\",\n  \"title\": \"Endpoint Access\"\n}\n[/block]","excerpt":"This endpoint returns the full list of benchmark indices maintained by Praemium.","slug":"holdingsexcluded","type":"get","title":"Benchmarks","__v":5,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getBenchmarks

This endpoint returns the full list of benchmark indices maintained by Praemium.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
The purpose of this method is for your system to enable a user to select a benchmark index and then request the [Benchmark Performance](doc:benchmarkperformance) data method. [block:callout] { "type": "info", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**", "title": "Endpoint Access" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The purpose of this method is for your system to enable a user to select a benchmark index and then request the [Benchmark Performance](doc:benchmarkperformance) data method. [block:callout] { "type": "info", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**", "title": "Endpoint Access" } [/block]
{"_id":"5d8b0b31c4b9960018c59a15","category":"5d8b0b31c4b9960018c599fd","user":"55ca87c48705a70d00b8fc5c","parentDoc":null,"project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-19T01:58:40.862Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"ResponseStatus\": {\n    \"Success\": true,\n    \"Errors\": []\n  },\n  \"ResponseData\": {\n    \"BenchmarkID\": 2,\n    \"BenchmarkPerformance\": {\n      \"FromDate\": \"2015-08-19T00:00:00\",\n      \"ToDate\": \"2015-08-19T00:00:00\",\n      \"PercentReturns\": [\n        {\n          \"PeriodDescription\": \"1 month\",\n          \"PercentageReturn\": -6.3222\n        }\n      ]\n    }\n  }\n}","name":""}]},"settings":"","examples":{"codes":[{"language":"json","code":"GET http://{URL as provided}/Performance/BenchmarkPerformance HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\n{\n  \"BenchmarkID\": 2,\n  \"FromDate\": \"2015-08-19\",\n  \"ToDate\": \"2015-08-19\",\n  \"MultiplePeriods\": 1\n}","name":""}]},"auth":"required","params":[{"_id":"55d2ed5f86807b2b0066b733","ref":"","in":"query","required":true,"desc":"The `BenchmarkID` as returned by the Benchmarks endpoint.","default":"2","type":"int","name":"BenchmarkID"},{"_id":"55d2edce2463351700f67e2b","ref":"","in":"query","required":true,"desc":"The start of the period of interest.","default":"2015-08-19","type":"yyyy-mm-dd","name":"FromDate"},{"_id":"55d56924e60a2f0d00b88b4d","ref":"","in":"query","required":true,"desc":"The end of the period of interest.","default":"2015-08-19","type":"yyyy-mm-dd","name":"ToDate"},{"_id":"55d56924e60a2f0d00b88b4c","ref":"","in":"query","required":false,"desc":"Whether to calculate percentage returns for the period requested or other periods","default":"0","type":"int","name":"MultiplePeriods"},{"_id":"5ada8a17e49a030003358fa5","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8d752c87d800035ebf93","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Performance/BenchmarkPerformance"},"isReference":true,"order":4,"body":"When using this endpoint to compare with a portfolio’s performance, ensure that the date periods match.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**\",\n  \"title\": \"Endpoint Access\"\n}\n[/block]","excerpt":"This endpoint returns the percentage return of a benchmark for a given date period.","slug":"benchmarkperformance","type":"get","title":"Benchmark Performance","__v":13,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getBenchmark Performance

This endpoint returns the percentage return of a benchmark for a given date period.

Query Params

BenchmarkID:
required
integer2
The `BenchmarkID` as returned by the Benchmarks endpoint.
FromDate:
required
yyyy-mm-dd2015-08-19
The start of the period of interest.
ToDate:
required
yyyy-mm-dd2015-08-19
The end of the period of interest.
MultiplePeriods:
integer0
Whether to calculate percentage returns for the period requested or other periods

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
When using this endpoint to compare with a portfolio’s performance, ensure that the date periods match. [block:callout] { "type": "info", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**", "title": "Endpoint Access" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



When using this endpoint to compare with a portfolio’s performance, ensure that the date periods match. [block:callout] { "type": "info", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**", "title": "Endpoint Access" } [/block]
{"_id":"5d8b0b31c4b9960018c59a16","category":"5d8b0b31c4b9960018c599fd","project":"55ca8813e583751700f78a58","user":"55ca87c48705a70d00b8fc5c","parentDoc":null,"version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-19T02:07:47.357Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"GET http://{URL as provided}/Performance/HoldingsExcluded HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\n{\n  \"InternalID\": 11111,\n  \"FromDate\": \"2015-08-19\",\n  \"ToDate\": \"2015-08-19\",\n  \"UserID\": \"smithj\"\n}","name":""}]},"method":"get","results":{"codes":[{"name":"","code":"{\n  \"ResponseStatus\": {\n    \"Success\": true,\n    \"Errors\": [\n      {\n        \"Code\": 1,\n        \"Message\": \"sample string 2\"\n      }\n    ]\n  },\n  \"ResponseData\": {\n    \"InternalID\": 1,\n    \"Holdings\": [\n      {\n        \"SecurityCode\": \"sample string 1\",\n        \"SecurityDescription\": \"sample string 2\",\n        \"FromDate\": \"2015-08-19T12:09:47.3198598+10:00\",\n        \"ToDate\": \"2015-08-19T12:09:47.3198598+10:00\"\n      }\n    ]\n  }\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"55d2ed5f86807b2b0066b733","ref":"","in":"query","required":true,"desc":"The `InternalID` as returned by the Portfolios endpoint.","default":"11111","type":"string","name":"InternalID"},{"_id":"55d2edce2463351700f67e2b","ref":"","in":"query","required":false,"desc":"The start of the period of interest.","default":"2015-08-19","type":"string","name":"FromDate"},{"_id":"55d660bf250d7d0d00427417","ref":"","in":"query","required":false,"desc":"The end of the period of interest.","default":"2015-08-19","type":"string","name":"ToDate"},{"_id":"55d660bf250d7d0d00427416","ref":"","in":"query","required":false,"desc":"Praemium user account login ID to verify access to portfolios before returning data.","default":"smithj","type":"string","name":"UserID"},{"_id":"5ada8a23342d70000384e0c0","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8d928274b9000307922b","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Performance/HoldingsExcluded"},"isReference":true,"order":5,"body":"It is possible for holdings to be excluded for a set date range. This means that, depending on the performance period, a holding may not always be excluded.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**\"\n}\n[/block]","excerpt":"This endpoint returns the list of holdings that may be excluded from a portfolio's performance calculations.","slug":"holdingsexcluded-1","type":"get","title":"Holdings Excluded","__v":12,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getHoldings Excluded

This endpoint returns the list of holdings that may be excluded from a portfolio's performance calculations.

Query Params

InternalID:
required
string11111
The `InternalID` as returned by the Portfolios endpoint.
FromDate:
string2015-08-19
The start of the period of interest.
ToDate:
string2015-08-19
The end of the period of interest.
UserID:
stringsmithj
Praemium user account login ID to verify access to portfolios before returning data.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
It is possible for holdings to be excluded for a set date range. This means that, depending on the performance period, a holding may not always be excluded. [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



It is possible for holdings to be excluded for a set date range. This means that, depending on the performance period, a holding may not always be excluded. [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**" } [/block]
{"_id":"5d8b0b31c4b9960018c59a17","category":"5d8b0b31c4b9960018c599fd","project":"55ca8813e583751700f78a58","user":"55dd6ff10efd5821000d5471","parentDoc":null,"version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-06-23T07:19:19.654Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"GET https://{URL as provided}/Performance/AssetClassPerformance HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\n{\n  \"AccountId\": 123456,\n  \"FromDate\": \"2015-08-19\",\n  \"ToDate\": \"2016-08-18\"\n}","name":""}]},"settings":"","results":{"codes":[{"name":"","code":"{\n   \"AccountId\":123456,\n   \"FromDate\": \"2015-08-19\",\n   \"ToDate\": \"2016-08-18\",\n   \"Investments\":[\n      {\n         \"AssetClass\":\"Fixed Interest - Domestic\",\n         \"Benchmark\":\"\",\n         \"StartValue\":2165655.0,\n         \"EndValue\":3125110.0,\n         \"TotalReturn\":522632.0,\n         \"TotalReturnPercent\":8.12,\n         \"BenchmarkReturnPercent\":0.00\n      },\n      {\n         \"AssetClass\":\"Australian Equities\",\n         \"Benchmark\":\"S&P/ASX 200 ACCUMULATION INDEX\",\n         \"StartValue\":356305.0,\n         \"EndValue\":396508.0,\n         \"TotalReturn\":57888.0,\n         \"TotalReturnPercent\":10.12,\n         \"BenchmarkReturnPercent\":9.12\n      },\n      {\n         \"AssetClass\":\"International Equities\",\n         \"Benchmark\":\"MSCI INTERNATIONAL ACWI EX AUSTRALIA GROSS DIV AUD\",\n         \"StartValue\":0.0,\n         \"EndValue\":0.0,\n         \"TotalReturn\":0.0,\n         \"TotalReturnPercent\":0.00,\n         \"BenchmarkReturnPercent\":6.23\n      }\n   ]\n}","language":"json","status":200}]},"method":"get","auth":"required","params":[{"_id":"55d2ed5f86807b2b0066b733","ref":"","in":"query","required":true,"desc":"The `InternalID` as returned by the Portfolios endpoint.","default":"123456","type":"int","name":"AccountId"},{"_id":"55d2edce2463351700f67e2b","ref":"","in":"query","required":true,"desc":"The start of the period of interest.","default":"2015-08-19","type":"yyyy-mm-dd","name":"FromDate"},{"_id":"55d56924e60a2f0d00b88b4d","ref":"","in":"query","required":true,"desc":"The end of the period of interest.","default":"2016-08-18","type":"yyyy-mm-dd","name":"ToDate"},{"_id":"5ada8a2ee49a030003358fa6","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8dad93588300034e6458","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Performance/AssetClassPerformance"},"isReference":true,"order":6,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**\",\n  \"title\": \"Endpoint Access\"\n}\n[/block]","excerpt":"This endpoint returns the percentage returns for each asset class over a date period for the specified portfolio.","slug":"assetclassperformance","type":"get","title":"Asset Class Performance","__v":11,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getAsset Class Performance

This endpoint returns the percentage returns for each asset class over a date period for the specified portfolio.

Query Params

AccountId:
required
integer123456
The `InternalID` as returned by the Portfolios endpoint.
FromDate:
required
yyyy-mm-dd2015-08-19
The start of the period of interest.
ToDate:
required
yyyy-mm-dd2016-08-18
The end of the period of interest.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
[block:callout] { "type": "info", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**", "title": "Endpoint Access" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**", "title": "Endpoint Access" } [/block]
{"_id":"5d8b0b31c4b9960018c59a18","category":"5d8b0b31c4b9960018c599ff","project":"55ca8813e583751700f78a58","parentDoc":null,"user":"55ca87c48705a70d00b8fc5c","version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-19T02:04:00.287Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"GET http://{URL as provided}/Tax/UnrealisedCgt HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\n{\n  \"InternalID\": 11111,\n  \"UserID\": \"smithj\",\n  \"ValuationDate\": \"\",\n  \"Page\": \"\"\n}","name":""}]},"method":"get","results":{"codes":[{"name":"","code":"{\n  \"ResponseStatus\": {\n    \"Success\": true,\n    \"Errors\": []\n  },\n  \"ResponseData\": {\n    \"InternalID\": 11111,\n    \"ValuationDate\": \"2015-08-20T00:00:00Z\",\n    \"ParcelCount\": {\n      \"RecordsFound\": 55,\n      \"RecordsReturned\": 55,\n      \"PageCount\": 1\n    },\n    \"Parcels\": [\n      {\n        \"SecurityCode\": \"BHP\",\n        \"SecurityDescription\": \"BHP BILLITON LIMITED FPO\",\n        \"TaxDate\": \"1996-09-18T00:00:00Z\",\n        \"PurchaseDate\": \"2001-07-09T00:00:00Z\",\n        \"Quantity\": 1598,\n        \"CostBaseUnknown\": 0,\n        \"ActualCost\": 2188,\n        \"TaxDeferredAmount\": 0,\n        \"TaxFreeAmount\": 0,\n        \"AdjustedCost\": 2188,\n        \"IndexedCost\": 2247.08,\n        \"MarketValue\": 38959.24,\n        \"GrossGain\": 36771.24,\n        \"OptimalCGTCalculationMethod\": \"Discounted\",\n        \"DiscountedGain\": 18385.62,\n        \"IndexedGain\": 36712.16,\n        \"CGTGain\": 18385.62\n      }\n    ]\n  }\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"55d2ed5f86807b2b0066b733","ref":"","in":"query","required":true,"desc":"The `InternalID` as returned by the Portfolios endpoint.","default":"11111","type":"string","name":"InternalID"},{"_id":"55d68ae4d2a8eb1900109eb9","ref":"","in":"query","required":false,"desc":"Must always be the current processed to date of the portfolio. Optional. Only supply if you require a response error is required if the required date is not the current processed to date.","default":"","type":"yyyy-mm-dd","name":"ValuationDate"},{"_id":"55d68ae4d2a8eb1900109eb8","ref":"","in":"query","required":false,"desc":"The page index.","default":"1","type":"int","name":"Page"},{"_id":"55d2edce2463351700f67e2b","ref":"","in":"query","required":false,"desc":"Praemium user account login ID to check has access to the portfolio before returning data.","default":"smithj","type":"string","name":"UserID"},{"_id":"5ada8a3de49a030003358fa7","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8dcdc30da50003c501f5","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Tax/UnrealisedCgt"},"isReference":true,"order":0,"body":"If for example, a portfolio is currently recalculated to 24 March 2018, the unrealised CGT data can only be returned as at this date. It is currently not possible to request any other valuation date unless the portfolio is recalculated to the required date first.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**\",\n  \"title\": \"Endpoint Access\"\n}\n[/block]","excerpt":"This endpoint returns the cost bases, tax parcels and the unrealised CGT gain/loss for CGT assets.","slug":"unrealisedcgt","type":"get","title":"Unrealised CGT","__v":17,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getUnrealised CGT

This endpoint returns the cost bases, tax parcels and the unrealised CGT gain/loss for CGT assets.

Query Params

InternalID:
required
string11111
The `InternalID` as returned by the Portfolios endpoint.
ValuationDate:
yyyy-mm-dd
Must always be the current processed to date of the portfolio. Optional. Only supply if you require a response error is required if the required date is not the current processed to date.
Page:
integer1
The page index.
UserID:
stringsmithj
Praemium user account login ID to check has access to the portfolio before returning data.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
If for example, a portfolio is currently recalculated to 24 March 2018, the unrealised CGT data can only be returned as at this date. It is currently not possible to request any other valuation date unless the portfolio is recalculated to the required date first. [block:callout] { "type": "info", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**", "title": "Endpoint Access" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



If for example, a portfolio is currently recalculated to 24 March 2018, the unrealised CGT data can only be returned as at this date. It is currently not possible to request any other valuation date unless the portfolio is recalculated to the required date first. [block:callout] { "type": "info", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**", "title": "Endpoint Access" } [/block]
{"_id":"5d8b0b31c4b9960018c59a19","category":"5d8b0b31c4b9960018c599ff","parentDoc":null,"user":"55ca87c48705a70d00b8fc5c","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-19T02:03:41.168Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"code":"GET http://{URL as provided}/Tax/UnrealisedCgtSummary HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\n{\n  \"InternalID\": 11111,\n  \"UserID\": \"smithj\",\n  \"ValuationDate\": \"\"\n}","name":"","language":"json"}]},"method":"get","results":{"codes":[{"name":"","code":"{\n  \"ResponseStatus\": {\n    \"Success\": true,\n    \"Errors\": []\n  },\n  \"ResponseData\": {\n    \"InternalID\": 111111,\n    \"ValuationDate\": \"2015-08-20T00:00:00Z\",\n    \"UnrealisedCGT\": {\n      \"CostBaseUnknown\": 0,\n      \"ActualCost\": 1329302.67,\n      \"AdjustedCost\": 1328499.25,\n      \"MarketValue\": 2199340.68,\n      \"GrossGain\": 875494.38,\n      \"DiscountedGain\": 437698.71,\n      \"IndexedGain\": 0,\n      \"OtherGain\": 97.09,\n      \"CGTGain\": 437795.8,\n      \"CGTLoss\": -4652.95\n    }\n  }\n}","language":"json","status":200}]},"auth":"required","params":[{"_id":"55d2ed5f86807b2b0066b733","ref":"","in":"query","required":true,"desc":"The `InternalID` as returned by the Portfolios endpoint.","default":"11111","type":"string","name":"InternalID"},{"_id":"55d68a47250d7d0d00427473","ref":"","in":"query","required":false,"desc":"Must always be the current processed to date of the portfolio.","default":"","type":"yyyy-mm-dd","name":"ValuationDate"},{"_id":"55d2edce2463351700f67e2b","ref":"","in":"query","required":false,"desc":"Praemium user account login ID to check has access to the portfolio before returning data.","default":"smithj","type":"string","name":"UserID"},{"_id":"5ada8a4aa6bc980003475da9","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8de42c87d800035ebf96","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Tax/UnrealisedCgtSummary"},"isReference":true,"order":1,"body":"This API endpoint takes care of business logic for you to exclude from the portfolio totals any gains returned by the UnrealisedCGT endpoint that use a CGT calculation method that is not optimal, i.e. when there is more than one CGT calculation method available for an individual parcel.\n\nFor example, if the portfolio is currently recalculated to 24 March 2015, unrealised CGT data can only be returned as at this date. It is currently not possible to request any other valuation date unless the portfolio is recalculated to the required date first.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**\",\n  \"title\": \"Endpoint Access\"\n}\n[/block]","excerpt":"This endpoint returns the total cost base and total unrealised CGT gain/loss for the portfolio.","slug":"unrealisedcgtsummary","type":"get","title":"Unrealised CGT Summary","__v":16,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getUnrealised CGT Summary

This endpoint returns the total cost base and total unrealised CGT gain/loss for the portfolio.

Query Params

InternalID:
required
string11111
The `InternalID` as returned by the Portfolios endpoint.
ValuationDate:
yyyy-mm-dd
Must always be the current processed to date of the portfolio.
UserID:
stringsmithj
Praemium user account login ID to check has access to the portfolio before returning data.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
This API endpoint takes care of business logic for you to exclude from the portfolio totals any gains returned by the UnrealisedCGT endpoint that use a CGT calculation method that is not optimal, i.e. when there is more than one CGT calculation method available for an individual parcel. For example, if the portfolio is currently recalculated to 24 March 2015, unrealised CGT data can only be returned as at this date. It is currently not possible to request any other valuation date unless the portfolio is recalculated to the required date first. [block:callout] { "type": "info", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**", "title": "Endpoint Access" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This API endpoint takes care of business logic for you to exclude from the portfolio totals any gains returned by the UnrealisedCGT endpoint that use a CGT calculation method that is not optimal, i.e. when there is more than one CGT calculation method available for an individual parcel. For example, if the portfolio is currently recalculated to 24 March 2015, unrealised CGT data can only be returned as at this date. It is currently not possible to request any other valuation date unless the portfolio is recalculated to the required date first. [block:callout] { "type": "info", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**", "title": "Endpoint Access" } [/block]
{"_id":"5d8b0b31c4b9960018c59a1a","category":"5d8b0b31c4b9960018c599ff","project":"55ca8813e583751700f78a58","parentDoc":null,"user":"55dd6ff10efd5821000d5471","version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-01T01:41:10.024Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"GET http://{URL as provided}//Tax/RealisedCgt HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\n{\n  \"InternalID\": 11111\n}","name":"","language":"json"}]},"method":"get","results":{"codes":[{"name":"","code":"{\n  \"ResponseStatus\": {\n    \"Success\": true,\n    \"Errors\": []\n  },\n  \"ResponseData\": {\n    \"InternalID\": 11111,\n    \"ValuationDate\": \"2016-05-20T00:00:00Z\",\n    \"CGTAssetDisposals\": [\n      {\n        \"SecurityCode\": \"SDF\",\n        \"SecurityDescription\": \"STEADFAST GROUP LIMITED FPO\",\n        \"TaxDate\": \"2015-03-02T00:00:00Z\",\n        \"PurchaseDate\": \"2015-03-10T00:00:00Z\",\n        \"SaleDate\": \"2016-02-27T00:00:00Z\",\n        \"Quantity\": 2000,\n        \"ActualCost\": 2415.42,\n        \"AdjustedCost\": 2415.42,\n        \"TaxFreeAmount\": 0,\n        \"SaleProceeds\": 0,\n        \"GrossGain\": 823.01,\n        \"OptimalCGTCalculationMethod\": \"Other\",\n        \"OtherGain\": 823.01,\n        \"CGTGain\": 823.01\n      }\n    ],\n    \"TaxFreeAndTaxDeferredAmounts\": [\n      {\n        \"SecurityCode\": \"+QICAFIF\",\n        \"SecurityDescription\": \"QIC Australian Fixed Interest Fund\",\n        \"TaxDate\": \"2011-09-09T00:00:00Z\",\n        \"PurchaseDate\": \"2011-09-09T00:00:00Z\",\n        \"SaleDate\": \"2015-07-29T00:00:00Z\",\n        \"Quantity\": 6000.71,\n        \"ActualCost\": 79218.37,\n        \"TaxDeferred\": 3.61,\n        \"TaxFree\": 0,\n        \"AdjustedCost\": 69170.21\n      }\n\t],\n    \"TrustCGTDistributions\": [\n      {\n        \"SecurityCode\": \"MGR\",\n        \"SecurityDescription\": \"MIRVAC GROUP STAPLED SECURITIES\",\n        \"TaxDate\": \"2014-12-29T00:00:00Z\",\n        \"GrossGain\": 20.8,\n        \"DiscountedGain\": 17.2,\n        \"IndexedGain\": 0,\n        \"OtherGain\": 0,\n        \"CGTGainLoss\": 17.2,\n        \"PreCGTGainLoss\": 0\n      }\n    ]\n  }\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"55d2ed5f86807b2b0066b733","ref":"","in":"query","required":true,"desc":"The `InternalID` as returned by the Portfolios endpoint.","default":"11111","type":"string","name":"InternalID"},{"_id":"5ada8a552c87d800035ebf88","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8dfc325ad3000338d537","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Tax/RealisedCgt"},"isReference":true,"order":2,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**\",\n  \"title\": \"Endpoint Access\"\n}\n[/block]","excerpt":"This endpoint returns the cost bases, tax parcels and realised CGT gain/loss for the CGT assets of the specified portfolio.","slug":"realisedcgt","type":"get","title":"Realised CGT","__v":12,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getRealised CGT

This endpoint returns the cost bases, tax parcels and realised CGT gain/loss for the CGT assets of the specified portfolio.

Query Params

InternalID:
required
string11111
The `InternalID` as returned by the Portfolios endpoint.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
[block:callout] { "type": "info", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**", "title": "Endpoint Access" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**", "title": "Endpoint Access" } [/block]
{"_id":"5d8b0b31c4b9960018c59a1b","category":"5d8b0b31c4b9960018c599ff","parentDoc":null,"project":"55ca8813e583751700f78a58","user":"55dd6ff10efd5821000d5471","version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-24T00:52:52.366Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"code":"{  \n   \"ResponseStatus\":{  \n      \"Success\":true,\n      \"Errors\":[  \n\n      ]\n   },\n   \"ResponseData\":{  \n      \"InternalID\":11111,\n      \"ValuationDate\":\"2016-06-23T00:00:00Z\",\n      \"RealisedCGT\":{  \n         \"TaxEntityType\":\"Trust\",\n         \"LossesCarriedForward\":0.0,\n         \"LossesCurrentYear\":0.0,\n         \"CGTDisposalsDiscounted\":148.38,\n         \"CGTDisposalsIndexed\":0.0,\n         \"CGTDisposalsOther\":0.0,\n         \"CGTDistributionsDiscounted\":0.0,\n         \"CGTDistributionsIndexed\":0.0,\n         \"CGTDistributionsOther\":0.0,\n         \"LossesAppliedDiscounted\":0.0,\n         \"LossesAppliedIndexed\":0.0,\n         \"LossesAppliedOther\":0.0,\n         \"DiscountApplied\":-74.19,\n         \"NetCapitalGainLoss\":74.19,\n         \"NetCapitalGainLossDiscounted\":74.19,\n         \"NetCapitalGainLossIndexed\":0.0,\n         \"NetCapitalGainLossOther\":0.0\n      }\n   }\n}","language":"json","status":200,"name":""}]},"settings":"","examples":{"codes":[{"language":"json","code":"GET http://{URL as provided}/Tax/RealisedCgtSummary HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\n{\n  \"InternalID\": 11111\n}","name":""}]},"auth":"required","params":[{"_id":"55d2ed5f86807b2b0066b733","ref":"","in":"query","required":true,"desc":"The `InternalID` as returned by the Portfolios endpoint.","default":"11111","type":"string","name":"InternalID"},{"_id":"5ada8a612c87d800035ebf89","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8e19e80ca4000326d626","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Tax/RealisedCgtSummary"},"isReference":true,"order":3,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**\"\n}\n[/block]","excerpt":"This endpoint returns the cost bases, tax parcels and the realised CGT gain/loss for the CGT assets of the specified portfolio.","slug":"realisedcgtsummary","type":"get","title":"Realised CGT Summary","__v":11,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getRealised CGT Summary

This endpoint returns the cost bases, tax parcels and the realised CGT gain/loss for the CGT assets of the specified portfolio.

Query Params

InternalID:
required
string11111
The `InternalID` as returned by the Portfolios endpoint.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
[block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**" } [/block]
{"_id":"5d8b0b31c4b9960018c59a0b","category":"5d8b0b31c4b9960018c59a00","parentDoc":null,"user":"55ca87c48705a70d00b8fc5c","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-19T02:00:46.102Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n  \"ResponseStatus\": {\n    \"Success\": true,\n    \"Errors\": []\n  },\n  \"ResponseData\": {\n    \"InternalID\": 111111,\n    \"FromDate\": \"2015-08-01\",\n    \"ToDate\": \"2015-09-01\",\n    \"Transactions\": [\n      {\n        \"Asset\": \"VAS\",\n        \"AssetDescription\": \"VANGUARD AUSTRALIAN SHARES INDEX ETF UNITS FULLY PAID\",\n        \"ExchangeCode\": \"ASX\",\n        \"TransactionDate\": \"2015-08-19T00:00:00\",\n        \"SettlementDate\": \"2015-08-19T00:00:00\",\n        \"TransactionType\": \"Buy (DRP)\",\n        \"Quantity\": 7.0,\n        \"AveragePrice\": 8.0,\n        \"NetAmount\": 219.0,\n        \"Unconfirmed\": \"0\",\n        \"CostBaseUnknown\": \"0\",\n        \"DisposalMethod\": \"\",\n        \"Narration\": \"\",\n        \"BrokerageIncGST\": 0.0,\n        \"BrokerageGST\": 0.0,\n        \"GSTClaimable\": 0.0,\n        \"Broker\": \"\",\n        \"TradedCurrency\": \"AUD\",\n        \"TradedCurrencyAmount\": 219.0,\n        \"TradedCurrencyAveragePrice\": 8.0,\n        \"SettlementCurrency\": \"sample string 21\",\n        \"SettlementCurrencyAmount\": 219.0,\n        \"SettlementCurrencyAveragePrice\": 8.0,\n        \"BuyBack\": \"0\",\n        \"DeemedAmount\": 0.0\n      }\n    ]\n  }\n}"}]},"settings":"","examples":{"codes":[{"language":"json","code":"GET http://{URL as provided}/TradingActivity/Transactions HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\n{\n  \"InternalID\": 11111,\n  \"UserID\": \"smithj\",\n  \"FromDate\": \"2015-08-19\",\n  \"ToDate\": \"2015-08-19\",\n  \"BuysAndSellsOnly\": 1,\n  \"OrderBy\": TransactionDate,\n  \"Order\": asc\n}","name":""}]},"auth":"required","params":[{"_id":"55d2ed5f86807b2b0066b733","ref":"","in":"query","required":true,"desc":"The `InternalID` as returned by the Portfolios endpoint.","default":"11111","type":"string","name":"InternalID"},{"_id":"55d6b9fdae529e0d00d34f62","ref":"","in":"query","required":true,"desc":"The start of the period of interest.","default":"","type":"yyyy-mm-dd","name":"FromDate"},{"_id":"55d6b9fdae529e0d00d34f61","ref":"","in":"query","required":true,"desc":"The end of the period of interest.","default":"","type":"yyyy-mm-dd","name":"ToDate"},{"_id":"55d6b9fdae529e0d00d34f60","ref":"","in":"query","required":false,"desc":"Whether or not to include buys and sells only.","default":"1","type":"int","name":"BuysAndSellsOnly"},{"_id":"55d2edce2463351700f67e2b","ref":"","in":"query","required":false,"desc":"Praemium user account login ID to check has access to the portfolio before returning data.","default":"","type":"string","name":"UserID"},{"_id":"5ada8a6e93588300034e640c","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8e2a325ad3000338d539","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"},{"_id":"5d53b5ad8b722a0052d0fd42","ref":"","in":"query","required":false,"desc":"Field to order by. Accepted fields are 'Asset' and 'TransactionDate'","default":"","type":"string","name":"OrderBy"},{"_id":"5d53b5ad8b722a0052d0fd41","ref":"","in":"query","required":false,"desc":"Sort order. Accepted params are 'asc' and 'desc'","default":"","type":"string","name":"Order"}],"url":"/TradingActivity/Transactions"},"isReference":true,"order":0,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**\",\n  \"title\": \"Endpoint Access\"\n}\n[/block]","excerpt":"This endpoint returns the stock movements for the specified portfolio over the given date period.","slug":"transactions","type":"get","title":"Transactions","__v":14,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getTransactions

This endpoint returns the stock movements for the specified portfolio over the given date period.

Query Params

InternalID:
required
string11111
The `InternalID` as returned by the Portfolios endpoint.
FromDate:
required
yyyy-mm-dd
The start of the period of interest.
ToDate:
required
yyyy-mm-dd
The end of the period of interest.
BuysAndSellsOnly:
integer1
Whether or not to include buys and sells only.
UserID:
string
Praemium user account login ID to check has access to the portfolio before returning data.
OrderBy:
string
Field to order by. Accepted fields are 'Asset' and 'TransactionDate'
Order:
string
Sort order. Accepted params are 'asc' and 'desc'

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
[block:callout] { "type": "info", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**", "title": "Endpoint Access" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**", "title": "Endpoint Access" } [/block]
{"_id":"5d8b0b31c4b9960018c59a0c","category":"5d8b0b31c4b9960018c59a00","parentDoc":null,"user":"55ca87c48705a70d00b8fc5c","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-19T02:01:34.253Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"GET http://{URL as provided}/TradingActivity/CashTransactions HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\n{\n  \"InternalID\": 11111,\n  \"UserID\": \"smithj\",\n  \"FromDate\": \"2015-08-19\",\n  \"ToDate\": \"2015-08-19\",\n  \"Loans\": 1\n}","name":""}]},"method":"get","results":{"codes":[{"language":"json","code":"{\n  \"ResponseStatus\": {\n    \"Success\": true,\n    \"Errors\": []\n  },\n\"ResponseData\": {\n    \"InternalID\": 11111,\n    \"FromDate\": \"2015-08-19\",\n    \"ToDate\": \"2015-09-19\",\n    \"CashBooks\": [\n      {\n        \"Summary\": {\n          \"CashBookCode\": \"+ANZCASH\",\n          \"CashBookDescription\": \"ANZ CASH ACCOUNT\",\n          \"Currency\": \"USD\",\n          \"OpeningBalance\": 4100.0,\n          \"Deposits\": 235.0,\n          \"Withdrawals\": -16.0,\n          \"ClosingBalance\": 200001.0,\n          \"ClosingBalancePortfolioCurency\": 8.0,\n          \"ClosingForexRate\": 1.0\n        },\n        \"Transactions\": [\n          {\n            \"TransactionDate\": \"2015-08-19T12:09:47.2573598+10:00\",\n            \"Currency\": \"AUD\",\n            \"TransactionType\": \"Opening Balance\",\n            \"Narration\": \"\",\n            \"Deposit\": 0.0,\n            \"Withdrawal\": 0.0,\n            \"ValuePortfolioCurrency\": 7.0,\n            \"Balance\": 200001.0,\n            \"GLCode\": \"\"\n          }\n        ]\n      }\n    ]\n  }\n}","name":"","status":200}]},"settings":"","auth":"required","params":[{"_id":"55d2ed5f86807b2b0066b733","ref":"","in":"query","required":true,"desc":"The `InternalID` as returned by the Portfolios endpoint.","default":"11111","type":"int","name":"InternalID"},{"_id":"55d6b98860fc730d00fc268d","ref":"","in":"query","required":true,"desc":"The start of the period of interest.","default":"2015-08-01","type":"yyyy-mm-dd","name":"FromDate"},{"_id":"55d6b98860fc730d00fc268c","ref":"","in":"query","required":true,"desc":"The end of the period of interest.","default":"2015-09-01","type":"yyyy-mm-dd","name":"ToDate"},{"_id":"55d6b98860fc730d00fc268b","ref":"","in":"query","required":false,"desc":"Whether or not to include loans in the net portfolio value.","default":"1","type":"int","name":"Loans"},{"_id":"55d2edce2463351700f67e2b","ref":"","in":"query","required":false,"desc":"Praemium user account login ID to check has access to the portfolio before returning data.","default":"","type":"string","name":"UserID"},{"_id":"5ada8a83342d70000384e0c1","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8e3e93588300034e6459","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/TradingActivity/CashTransactions"},"isReference":true,"order":1,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**\",\n  \"title\": \"Endpoint Access\"\n}\n[/block]","excerpt":"This endpoint returns the cash movements of the specified portfolio over the given date period.","slug":"cashtransactions","type":"get","title":"Cash Transactions","__v":11,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getCash Transactions

This endpoint returns the cash movements of the specified portfolio over the given date period.

Query Params

InternalID:
required
integer11111
The `InternalID` as returned by the Portfolios endpoint.
FromDate:
required
yyyy-mm-dd2015-08-01
The start of the period of interest.
ToDate:
required
yyyy-mm-dd2015-09-01
The end of the period of interest.
Loans:
integer1
Whether or not to include loans in the net portfolio value.
UserID:
string
Praemium user account login ID to check has access to the portfolio before returning data.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
[block:callout] { "type": "info", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**", "title": "Endpoint Access" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**", "title": "Endpoint Access" } [/block]
{"_id":"5d8b0b31c4b9960018c59a38","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","category":"5d8b0b31c4b9960018c59a00","user":"598003249cea430015ae631d","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-04-27T00:33:03.548Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"GET http://{URL as provided}/TradingActivity/UnsettledTransactions HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\n{\n  \"InternalID\": 000000,\n  \"FromDate\": \"2015-08-10\",\n  \"ToDate\": \"2015-08-19\",\n}"}]},"results":{"codes":[{"name":"","code":"{\n    \"ResponseStatus\": {\n        \"Success\": true,\n        \"Errors\": []\n    },\n    \"ResponseData\": {\n        \"TransactionCount\": {\n            \"RecordsFound\": 2,\n            \"RecordsReturned\": 2,\n            \"PageCount\": 1\n        },\n        \"InternalID\": 000000,\n        \"FromDate\": \"2015-08-10T00:00:00Z\",\n        \"ToDate\": \"2015-08-19T00:00:00Z\",\n        \"Transactions\": [\n            {\n                \"Asset\": \"AAA\",\n                \"TransactionCode\": \"B\",\n                \"TransactionDescription\": \"Buy\",\n                \"TransactionDate\": \"2015-08-12T00:00:00\",\n                \"SettlementDate\": \"2015-08-25T00:00:00\",\n                \"Quantity\": 103,\n                \"NetAmount\": -3085.2521,\n                \"AveragePrice\": 29.9556,\n                \"DisposalMethod\": \"\",\n                \"Narration\": \"\",\n                \"ContractNoteRef\": \"\",\n                \"Brokerage\": 10,\n                \"GST\": 1,\n                \"OtherCharges\": 29.1289,\n                \"OtherChargesGST\": 1.2489\n            },\n            {\n                \"Asset\": \"AAA\",\n                \"TransactionCode\": \"S\",\n                \"TransactionDescription\": \"Sell\",\n                \"TransactionDate\": \"2015-08-13T00:00:00\",\n                \"SettlementDate\": \"2015-08-20T00:00:00\",\n                \"Quantity\": -15,\n                \"NetAmount\": 453.3442,\n                \"AveragePrice\": 30.2225,\n                \"DisposalMethod\": \"Minimise\",\n                \"Narration\": \"\",\n                \"ContractNoteRef\": \"\",\n                \"Brokerage\": 0,\n                \"GST\": 0,\n                \"OtherCharges\": 19.2193,\n                \"OtherChargesGST\": 1.214\n            }\n        ]\n    }\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[{"_id":"5ae270261d400700034f3c8d","ref":"","in":"query","required":true,"desc":"The `InternalID` as returned by the Portfolios endpoint.","default":"","type":"string","name":"InternalId"},{"_id":"5ae270261d400700034f3c8c","ref":"","in":"query","required":false,"desc":"The start of the period of interest.","default":"","type":"yyyy-mm-dd","name":"FromDate"},{"_id":"5ae270261d400700034f3c8b","ref":"","in":"query","required":false,"desc":"The end of the period of interest.","default":"","type":"yyyy-mm-dd","name":"ToDate"},{"_id":"5ae27036e35e360003571840","ref":"","in":"query","required":false,"desc":"Used to navigate paged results.","default":"","type":"int","name":"Page"},{"_id":"5ae27eea4adae4000365c1cf","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ae27eea4adae4000365c1ce","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/TradingActivity/UnsettledTransactions","method":"get"},"isReference":true,"order":2,"body":"Transactions that meet both conditions below are returned:\n- Transaction date less than or equal to the As At date.\n- Settlement date greater than the As At date.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**\"\n}\n[/block]","excerpt":"This endpoint provides a list of any unsettled transactions within the specified period.","slug":"unsettled-transactions","type":"get","title":"Unsettled Transactions","__v":11,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getUnsettled Transactions

This endpoint provides a list of any unsettled transactions within the specified period.

Query Params

InternalId:
required
string
The `InternalID` as returned by the Portfolios endpoint.
FromDate:
yyyy-mm-dd
The start of the period of interest.
ToDate:
yyyy-mm-dd
The end of the period of interest.
Page:
integer
Used to navigate paged results.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
Transactions that meet both conditions below are returned: - Transaction date less than or equal to the As At date. - Settlement date greater than the As At date. [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Transactions that meet both conditions below are returned: - Transaction date less than or equal to the As At date. - Settlement date greater than the As At date. [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**" } [/block]
{"_id":"5d8b0b31c4b9960018c59a45","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","category":"5d8b0b31c4b9960018c59a00","user":"5c0db8c00fa7b60042af110d","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-05-30T05:45:36.997Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"language":"json","code":"[\n    {\n        \"SecurityCode\": \"CBA\",\n        \"Exchange\": \"ASX\",\n        \"DRPType\": \"DRP\",\n        \"FromDate\": \"1900-01-01T00:00:00Z\",\n        \"ToDate\": \"2050-01-01T00:00:00Z\",\n        \"MaxSharesParticipating\": -1,\n        \"PercentSharesParticipating\": 0,\n        \"ExcludeFromDRP\": false,\n        \"CreatedDate\": \"2019-02-28T00:00:00\",\n        \"UpdatedDate\": \"2019-02-28T00:00:00\"\n    },\n    {\n        \"SecurityCode\": \"PER0011AU\",\n        \"Exchange\": \"FND\",\n        \"DRPType\": \"DRP\",\n        \"FromDate\": \"1900-01-01T00:00:00Z\",\n        \"ToDate\": \"2050-01-01T00:00:00Z\",\n        \"MaxSharesParticipating\": 500,\n        \"PercentSharesParticipating\": 0,\n        \"ExcludeFromDRP\": false,\n        \"CreatedDate\": \"2019-02-28T00:00:00\",\n        \"UpdatedDate\": \"2019-02-28T00:00:00\"\n    }\n]","name":"","status":200}]},"method":"get","examples":{"codes":[{"language":"http","code":"GET https://{URL as provided}/TradingActivity/DividendReinvestmentDetails?InternalID=11111 HTTP/1.1\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION","name":""}]},"auth":"required","params":[{"_id":"55d2ed5f86807b2b0066b733","ref":"","in":"query","required":true,"desc":"The `InternalID` as returned by the Portfolios endpoint.","default":"11111","type":"int","name":"InternalID"},{"_id":"5ada8a83342d70000384e0c1","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8e3e93588300034e6459","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/TradingActivity/DividendReinvestmentDetails"},"isReference":true,"order":3,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**\",\n  \"title\": \"Endpoint Access\"\n}\n[/block]","excerpt":"This endpoint returns the dividend reinvestment details of the specified portfolio.","slug":"dividend-reinvestment-details","type":"get","title":"Dividend Reinvestment Details","__v":1,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getDividend Reinvestment Details

This endpoint returns the dividend reinvestment details of the specified portfolio.

Query Params

InternalID:
required
integer11111
The `InternalID` as returned by the Portfolios endpoint.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
[block:callout] { "type": "info", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**", "title": "Endpoint Access" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**", "title": "Endpoint Access" } [/block]
{"_id":"5d8b0b31c4b9960018c59a39","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","category":"5d8b0b31c4b9960018c59a04","user":"598003249cea430015ae631d","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-04-27T00:38:54.579Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"[\n   {\n        \"IncomeSource\": \"Australian\",\n        \"IncomeType\": \"Interest from cash\",\n        \"Asset\": \"+AUD CURRENT ACCOUNT\",\n        \"AssetDescription\": \"Current Account\",\n        \"ExecutionDate\": \"2017-12-29T00:00:00Z\",\n        \"PaymentDate\": \"2017-12-29T00:00:00Z\",\n        \"IncomeTotal\": 126.23,\n        \"DRP\": 0,\n        \"CashAmount\": 126.23,\n        \"Receivable\": 0,\n        \"TaxWithheld\": 0,\n        \"ForeignTaxPay\": 0,\n        \"FrankingCredit\": 0\n    },\n    {\n        \"IncomeSource\": \"Australian\",\n        \"IncomeType\": \"Interest from cash\",\n        \"Asset\": \"AUD CURRENT ACCOUNT\",\n        \"AssetDescription\": \"AUD Current Account\",\n        \"ExecutionDate\": \"2017-11-30T00:00:00Z\",\n        \"PaymentDate\": \"2017-11-30T00:00:00Z\",\n        \"IncomeTotal\": 72.73,\n        \"DRP\": 0,\n        \"CashAmount\": 72.73,\n        \"Receivable\": 0,\n        \"TaxWithheld\": 0,\n        \"ForeignTaxPay\": 0,\n        \"FrankingCredit\": 0\n    },\n    {\n        \"IncomeSource\": \"Australian\",\n        \"IncomeType\": \"Interest from cash\",\n        \"Asset\": \"AUD CURRENT ACCOUNT\",\n        \"AssetDescription\": \"AUD Current Account\",\n        \"ExecutionDate\": \"2017-10-31T00:00:00Z\",\n        \"PaymentDate\": \"2017-10-31T00:00:00Z\",\n        \"IncomeTotal\": 80.12,\n        \"DRP\": 0,\n        \"CashAmount\": 80.12,\n        \"Receivable\": 0,\n        \"TaxWithheld\": 0,\n        \"ForeignTaxPay\": 0,\n        \"FrankingCredit\": 0\n    }\n]","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[{"_id":"5ae271a5ba91d70003876fdf","ref":"","in":"query","required":true,"desc":"The `InternalID` as returned by the Portfolios endpoint.","default":"","type":"string","name":"InternalId"},{"_id":"5ae271a5ba91d70003876fde","ref":"","in":"query","required":false,"desc":"The start of the period of interest.","default":"","type":"yyyy-mm-dd","name":"FromDate"},{"_id":"5ae271a5ba91d70003876fdd","ref":"","in":"query","required":false,"desc":"The end of the period of interest.","default":"","type":"yyyy-mm-dd","name":"ToDate"},{"_id":"5ae272ee4adae4000365c17c","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ae272ee4adae4000365c17b","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Income/TaxCredit","examples":{"codes":[{"language":"json","code":"GET http://{URL as provided}/Income/TaxCredit HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION"}]},"method":"get"},"isReference":false,"order":0,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**\"\n}\n[/block]","excerpt":"This endpoint returns the income and tax credit breakdown for the income entries accrued within the specified performance period.","slug":"income-and-tax-credits","type":"get","title":"Income and Tax Credits","__v":10,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getIncome and Tax Credits

This endpoint returns the income and tax credit breakdown for the income entries accrued within the specified performance period.

Query Params

InternalId:
required
string
The `InternalID` as returned by the Portfolios endpoint.
FromDate:
yyyy-mm-dd
The start of the period of interest.
ToDate:
yyyy-mm-dd
The end of the period of interest.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
[block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**" } [/block]
{"_id":"5d8b0b31c4b9960018c59a41","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","category":"5d8b0b31c4b9960018c59a04","user":"5c0db8c00fa7b60042af110d","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-05-23T06:10:55.482Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"code":"GET https://{URL as provided}/Income/Schedules?InternalId=11111&FromDate=2019-05-06&ToDate=2019-06-05 HTTP/1.1\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION","language":"http"}]},"settings":"","results":{"codes":[{"name":"","code":"[\n    {\n        \"IncomeId\": 1111,\n        \"IncomeTypeDescription\": \"Interest from cash\",\n        \"AssetDescription\": \"Current Account\",\n        \"TaxDate\": 2019-05-06,\n        \"Interest\": 1,\n        \"UnfrankedTotal\": 2,\n        \"FrankedTotal\": 3,\n        \"FrankingCreditsTotal\": 1,\n        \"TrustOtherAust\": 1,\n        \"ForeignIncomeTotal\": 1,\n        \"TrustCGTDistributionsTotal\": 1,\n        \"NonAssessableTotal\": 1,\n        \"IncomeTotal\": 1,\n        \"TaxWithheld\": 1,\n        \"ForeignIncomeTaxOffsetsTotal\": 1,\n        \"TrustOtherExpenses\": 1,\n        \"CashAmount\": 1,\n        \"DRP\": 1,\n        \"AccruedAmount\": 1\n    },\n    {\n        \"IncomeId\": 1112,\n        \"IncomeTypeDescription\": \"Interest from cash\",\n        \"AssetDescription\": \"Current Account\",\n        \"TaxDate\": 2019-05-06,\n        \"Interest\": 1,\n        \"UnfrankedTotal\": 1,\n        \"FrankedTotal\": 1,\n        \"FrankingCreditsTotal\": 1,\n        \"TrustOtherAust\": 1,\n        \"ForeignIncomeTotal\": 1,\n        \"TrustCGTDistributionsTotal\": 1,\n        \"NonAssessableTotal\": 1,\n        \"IncomeTotal\": 1,\n        \"TaxWithheld\": 1,\n        \"ForeignIncomeTaxOffsetsTotal\": 1,\n        \"TrustOtherExpenses\": 1,\n        \"CashAmount\": 1,\n        \"DRP\": 1,\n        \"AccruedAmount\": 1\n    },\n]","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"auth":"required","params":[{"_id":"5ae271a5ba91d70003876fdf","ref":"","in":"query","required":true,"desc":"The `InternalID` as returned by the Portfolios endpoint.","default":"","type":"string","name":"InternalId"},{"_id":"5ae271a5ba91d70003876fde","ref":"","in":"query","required":false,"desc":"The start of the period of interest.","default":"","type":"yyyy-mm-dd","name":"FromDate"},{"_id":"5ae271a5ba91d70003876fdd","ref":"","in":"query","required":false,"desc":"The end of the period of interest.","default":"","type":"yyyy-mm-dd","name":"ToDate"},{"_id":"5ae272ee4adae4000365c17c","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ae272ee4adae4000365c17b","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Income/Schedules"},"isReference":false,"order":1,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**\"\n}\n[/block]","excerpt":"This endpoint returns the income and schedules breakdown for the income entries accrued within the specified performance period.","slug":"income-schedules","type":"get","title":"Income Schedules","__v":4,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getIncome Schedules

This endpoint returns the income and schedules breakdown for the income entries accrued within the specified performance period.

Query Params

InternalId:
required
string
The `InternalID` as returned by the Portfolios endpoint.
FromDate:
yyyy-mm-dd
The start of the period of interest.
ToDate:
yyyy-mm-dd
The end of the period of interest.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
[block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**" } [/block]
{"_id":"5d8b0b31c4b9960018c59a3a","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","category":"5d8b0b31c4b9960018c59a05","user":"598003249cea430015ae631d","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-04-27T00:44:44.206Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"language":"json","code":"GET http://{URL as provided}/Expenses HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION"}]},"results":{"codes":[{"name":"","code":"[\n    {\n        \"ExpenseId\": 2133065,\n        \"EffectiveDate\": \"2004-09-30T00:00:00Z\",\n        \"TaxDate\": \"2004-09-30T00:00:00Z\",\n        \"PaymentDate\": \"2004-09-30T00:00:00Z\",\n        \"ExpenseInclGst\": 330,\n        \"ExpenseExclGst\": 300,\n        \"GstRefundableAmount\": 0,\n        \"DeductibleAmount\": 330,\n        \"NonDeductibleAmount\": 0,\n        \"ExpenseNarration\": \"\",\n        \"ExpenseTypeGroupId\": 2,\n        \"ExpenseTypeGroupDescription\": \"Investment expenses\",\n        \"ExpenseTypeId\": 55,\n        \"ExpenseTypeDescription\": \"Portfolio management fees\"\n    }\n]","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[{"_id":"5ae2727cba91d70003876fe3","ref":"","in":"query","required":true,"desc":"The `InternalID` as returned by the Portfolios endpoint.","default":"","type":"string","name":"InternalId"},{"_id":"5ae272a9e35e360003571868","ref":"","in":"query","required":false,"desc":"The start of the period of interest.","default":"","type":"yyyy-mm-dd","name":"FromDate"},{"_id":"5ae272a9e35e360003571867","ref":"","in":"query","required":false,"desc":"The end of the period of interest.","default":"","type":"yyyy-mm-dd","name":"ToDate"},{"_id":"5ae272cfba91d70003876fe5","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ae272cfba91d70003876fe4","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Expenses"},"isReference":false,"order":0,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**\",\n  \"title\": \"Endpoint Access\"\n}\n[/block]","excerpt":"This endpoint returns expenses for the specified portfolio.","slug":"expenses","type":"get","title":"Expenses","__v":12,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getExpenses

This endpoint returns expenses for the specified portfolio.

Query Params

InternalId:
required
string
The `InternalID` as returned by the Portfolios endpoint.
FromDate:
yyyy-mm-dd
The start of the period of interest.
ToDate:
yyyy-mm-dd
The end of the period of interest.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
[block:callout] { "type": "info", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**", "title": "Endpoint Access" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "body": "Access to this endpoint is available to **Standard, SMA/Robo, Enterprise**", "title": "Endpoint Access" } [/block]
{"_id":"5d8b0b31c4b9960018c59a46","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","category":"5d8b0b31c4b9960018c59a08","user":"5c0db8c00fa7b60042af110d","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-05-30T06:05:14.878Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"name":"","code":"[\n    {\n        \"Id\": 111,\n        \"EventName\": \"all list>today\",\n        \"CreatedDate\": \"2019-03-18T12:56:03.513\",\n        \"UpdatedDate\": \"2019-03-18T12:56:03.513\"\n    },\n    {\n        \"Id\": 1234,\n        \"EventName\": \"test\",\n        \"CreatedDate\": \"2017-10-26T02:47:13.68\",\n        \"UpdatedDate\": \"2018-01-29T04:42:43.053\"\n    }\n]","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"examples":{"codes":[{"code":"GET https://{URL as provided}/Reports/Events HTTP/1.1\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION","language":"http"}]},"method":"get","auth":"required","params":[{"_id":"5ae6b17aa3490f0003035dda","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ae6b17aa3490f0003035dd9","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Reports/Events"},"isReference":false,"order":0,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **Enterprise**\"\n}\n[/block]","excerpt":"This endpoint returns the report events.","slug":"events","type":"get","title":"Events","__v":3,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getEvents

This endpoint returns the report events.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
[block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **Enterprise**" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **Enterprise**" } [/block]
{"_id":"5d8b0b31c4b9960018c59a47","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","category":"5d8b0b31c4b9960018c59a08","user":"5c0db8c00fa7b60042af110d","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-05-30T06:11:55.128Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"code":"GET https://{URL as provided}/Reports/Events/1111/Published HTTP/1.1\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION","language":"http"}]},"results":{"codes":[{"name":"","code":"[\n    {\n        \"FileId\": \"0BF21F9ECF7D4031813A4825DB477432\",\n        \"PortfolioName\": \"Test Portfolio Name\",\n        \"PortfolioCode\": \"TESTCODE\",\n        \"FileName\": \"test.pdf\",\n        \"Extension\": \"pdf\",\n        \"GeneratedDate\": \"2019-03-18T18:42:46.667Z\",\n        \"PublishedDate\": \"2019-03-18T21:37:59.937Z\"\n    }\n]","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[{"_id":"5ae6b17aa3490f0003035dda","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ae6b17aa3490f0003035dd9","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"},{"_id":"5cef74b7c368e7005d914c72","ref":"","in":"path","required":false,"desc":"The `EventID` as returned by the Events response.","default":"","type":"int","name":"EventId"},{"_id":"5cef74b7c368e7005d914c71","ref":"","in":"query","required":false,"desc":"The portfolio code of the portfolio","default":"","type":"string","name":"PortfolioCode"},{"_id":"5cef74b7c368e7005d914c70","ref":"","in":"query","required":false,"desc":"The start of published date to be returned.","default":"","type":"yyyy-mm-dd","name":"FromPublishedDate"},{"_id":"5cef74b7c368e7005d914c6f","ref":"","in":"query","required":false,"desc":"The end of published date to be returned.","default":"","type":"string","name":"ToPublishedDate"}],"url":"/Reports/Events/{EventId}/Published"},"isReference":false,"order":1,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **Enterprise**\"\n}\n[/block]","excerpt":"This endpoint returns the published files for report events.","slug":"published-files-for-event","type":"get","title":"Published Files For Event","__v":2,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getPublished Files For Event

This endpoint returns the published files for report events.

Path Params

EventId:
integer
The `EventID` as returned by the Events response.

Query Params

PortfolioCode:
string
The portfolio code of the portfolio
FromPublishedDate:
yyyy-mm-dd
The start of published date to be returned.
ToPublishedDate:
string
The end of published date to be returned.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
[block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **Enterprise**" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **Enterprise**" } [/block]
{"_id":"5d8b0b31c4b9960018c59a48","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","category":"5d8b0b31c4b9960018c59a08","user":"5c0db8c00fa7b60042af110d","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-05-30T06:14:56.879Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"name":"","code":"Content of test.pdf","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"examples":{"codes":[{"code":"GET https://{URL as provided}/Reports/Files/0BF21F9ECF7D4031813A4825DB477432/Download HTTP/1.1\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION","language":"http"}]},"method":"get","auth":"required","params":[{"_id":"5ae6b17aa3490f0003035dda","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ae6b17aa3490f0003035dd9","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"},{"_id":"5cef74b7c368e7005d914c72","ref":"","in":"path","required":false,"desc":"The `EventID` as returned by the Events response.","default":"","type":"int","name":"EventId"}],"url":"/Reports/Files/{FileId}/Download"},"isReference":false,"order":2,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **Enterprise**\"\n}\n[/block]","excerpt":"This endpoint returns files for given file ID.","slug":"download-file","type":"get","title":"Download File","__v":4,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getDownload File

This endpoint returns files for given file ID.

Path Params

EventId:
integer
The `EventID` as returned by the Events response.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
[block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **Enterprise**" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **Enterprise**" } [/block]
{"_id":"5d8b0b31c4b9960018c59a21","category":"5d8b0b31c4b9960018c59a01","user":"55a49cd3e6c2470d002a648c","parentDoc":null,"project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-31T00:59:42.949Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":0,"body":"To set up an account on our award winning SMA platform, just follow these simple steps:\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"1. Get the PDS data\"\n}\n[/block]\nWe provide all the information you will need about the investment product your clients will be investing in, in the response from the PDS endpoint.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"2. Send us the account data\"\n}\n[/block]\nPost the account data to us using the Accounts endpoint. We will send you the account's ID in our response.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"3. Send us the applicant data\"\n}\n[/block]\nPost the applicant data to us using the Applicants endpoint, using the Account ID we provided in the Accounts response.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"4. If you need to add a user login for the applicant\"\n}\n[/block]\nCreate the user with the User endpoint, then link that login to the account using the User ID from the response, and the account ID from the Accounts response.","excerpt":"","slug":"setting-up-an-account-using-the-privileged-api","type":"basic","title":"Account Set Up","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Account Set Up


To set up an account on our award winning SMA platform, just follow these simple steps: [block:api-header] { "type": "basic", "title": "1. Get the PDS data" } [/block] We provide all the information you will need about the investment product your clients will be investing in, in the response from the PDS endpoint. [block:api-header] { "type": "basic", "title": "2. Send us the account data" } [/block] Post the account data to us using the Accounts endpoint. We will send you the account's ID in our response. [block:api-header] { "type": "basic", "title": "3. Send us the applicant data" } [/block] Post the applicant data to us using the Applicants endpoint, using the Account ID we provided in the Accounts response. [block:api-header] { "type": "basic", "title": "4. If you need to add a user login for the applicant" } [/block] Create the user with the User endpoint, then link that login to the account using the User ID from the response, and the account ID from the Accounts response.
To set up an account on our award winning SMA platform, just follow these simple steps: [block:api-header] { "type": "basic", "title": "1. Get the PDS data" } [/block] We provide all the information you will need about the investment product your clients will be investing in, in the response from the PDS endpoint. [block:api-header] { "type": "basic", "title": "2. Send us the account data" } [/block] Post the account data to us using the Accounts endpoint. We will send you the account's ID in our response. [block:api-header] { "type": "basic", "title": "3. Send us the applicant data" } [/block] Post the applicant data to us using the Applicants endpoint, using the Account ID we provided in the Accounts response. [block:api-header] { "type": "basic", "title": "4. If you need to add a user login for the applicant" } [/block] Create the user with the User endpoint, then link that login to the account using the User ID from the response, and the account ID from the Accounts response.
{"_id":"5d8b0b31c4b9960018c59a23","category":"5d8b0b31c4b9960018c59a01","user":"55ca87c48705a70d00b8fc5c","project":"55ca8813e583751700f78a58","parentDoc":null,"version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-19T02:02:45.820Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"language":"json","code":"POST http://{URL as provided}/Account HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\n{\n   \"Type\":1,\n   \"Account\":{\n      \"Name\":\"Miss Jane Smith\",\n      \"AdviserId\":\"jsmith\",\n      \"AdviserReference\":\"\",\n      \"PdsId\":\"AU123\",\n      \"ProductId\":\"\",\n      \"EntityType\":1,\n      \"ProviderReference\":\"\",\n      \"CurrencyCode\":\"AUD\",\n      \"BankAccounts\":[\n         {\n            \"Bsb\":\"012012\",\n            \"AccountNumber\":\"6555567\",\n            \"AccountName\":\"Miss Jane Smith\",\n            \"CashContributions\": true,\n            \"SmaWithdrawals\": true,\n\t    \t\t\t\"PayoutIncome\": false,\n\t    \t\t\t\"FeeOffset\": true,\n \t    \t\t\t\"RegularContributionPlan\": false\n         },\n         {\n            \"Bsb\":\"012012\",\n            \"AccountNumber\":\"8888888\",\n            \"AccountName\":\"Jane A Smith\",\n            \"CashContributions\": false,\n            \"SmaWithdrawals\": false,\n\t    \t\t\t\"PayoutIncome\": true,\n\t    \t\t\t\"FeeOffset\": false,\n \t    \t\t\t\"RegularContributionPlan\": true\n         }\n      ],\n      \"Models\":[\n          { \n          \"ModelCode\":\"AD0002\",\n          \"ModelPercent\":60.0\n        },\n          { \n          \"ModelCode\":\"AE0002\",\n          \"ModelPercent\":40.0\n        }\n      ],\n      \"Fees\":[\n         {\n            \"Id\":\"AU1234\",\n            \"FeeType\":0,\n            \"Value\":1.0,\n            \"IsPercent\":true,\n            \"IncludesTax\":true\n         }\n      ],\n      \"AccountSetup\":{\n         \"InitialInvestment\":10000.00,\n         \"InitialTransferValue\":1232.00,\n         \"CashInvestmentMethod\":1\n      },\n      \"RegularContributionAmount\":200.0\n   }\n}","name":"Individual"},{"language":"json","name":"Joint","code":"POST http://{URL as provided}/account HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\n\n"},{"code":"POST http://{URL as provided}/account HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\n\n{\n  \"Type\":5,\n  \"Account\":{\n    \"Name\":\"Miss Jane Smith\",\n    \"AdviserId\":\"admin@abcd.com.au\",\n    \"AdviserReference\":null,\n    \"EntityType\":0,\n    \"PdsId\":\"AU123\",\n    \"ProductId\":null,\n    \"ProviderReference\":null,\n    \"CurrencyCode\":\"AUD\",\n    \"Models\":[\n      {\n        \"ModelCode\":\"AD0002\",\n        \"ModelPercent\":50.0\n      }\n      {\n        \"ModelCode\":\"AE0005\",\n        \"ModelPercent\":50.0\n      }\n    ],\n    \"Fees\":[\n      {\n        \"Id\":\"AU1234\",\n        \"FeeType\":0,\n        \"Value\":1.0,\n        \"IsPercent\":true,\n        \"IncludesTax\":true\n      }\n    ],\n    \"PensionType\":2,\n    \"ContributionSources\":[\n      {\n        \"SourceOfContribution\":\"Australian Pension Fund - (123456789), Member 123456\",\n        \"EntireBalance\":true,\n        \"ExpectedAmount\":0.0\n      }\n    ],\n    \"Transfers\":[\n      {\n        \"TransferFromAccountId\":\"AU121212\",\n        \"TransferMethod\":0,\n        \"Amount\":0.0\n      }\n    ],\n    \"OtherContributions\":[\n      {\n        \"ContributionType\":31,\n        \"ExpectedAmount\":55555.0\n      }\n    ],\n    \"Consolidation\":{\n      \"UseExisting\":true,\n      \"AccountCode\":\"SMA00234540\",\n      \"CloseOnRollover\":true\n    },\n    \"ReversionaryBeneficiary\":null,\n    \"PaymentType\":1,\n    \"PaymentFrequency\":1,\n    \"PaymentAmount\":0.0,\n\t\t\"BankAccounts\":[\n         {\n            \"Bsb\":\"012012\",\n            \"AccountNumber\":\"6555567\",\n            \"AccountName\":\"Miss Jane Smith\",\n            \"PensionPayment\": true,\n         }\n      ]\n    \"IsTransitionToRetirement\":true,\n    \"CentrelinkSchedule\":false,\n    \"CommencementDate\":\"2015-10\",\n    \"FeeInstructions\":null,\n    \"IncomeInstructions\":[\n      {\n        \"Code\":\"AD0002\",\n        \"Percent\":60.0\n      },\n      {\n        \"Code\":\"AE0005\",\n        \"Percent\":40.0\n      }\n    ],\n    \"PensionPaymentInstructions\":null\n  }\n}\n\n\n\n\n","language":"json","name":"Pension (TTR)"}]},"method":"post","results":{"codes":[{"code":"{  \n   \"CreationStatus\":0,\n   \"Account\":{  \n      \"Code\":\"SMA00233601\",\n      \"Id\":\"AU233601\",\n      \"Name\":\"Miss Jane Smith\",\n      \"Status\":1,\n      \"Type\":1,\n      \"BpayReference\":\"2336018\"\n   }\n}","language":"json","status":201,"name":""},{"status":400,"language":"json","code":"{  \n    \"CreationStatus\":1,\n    \"ValidationMessage\":\"The fee specified '34001' is not valid for this account.\"\n}"}]},"auth":"required","params":[{"_id":"55dfe5693d8bfd0d00c65dca","ref":"","in":"body","required":true,"desc":"SMA = 1","default":"1","type":"int","name":"Type"},{"_id":"55f0c77078661c170035e149","ref":"","in":"body","required":false,"desc":"Contains the account data.","default":"","type":"object","name":"Account"},{"_id":"55dfe5693d8bfd0d00c65dc9","ref":"","in":"body","required":true,"desc":"The name of the account holder","default":"Miss Jane Smith","type":"string","name":"Account.Name"},{"_id":"55dfe5693d8bfd0d00c65dc8","ref":"","in":"body","required":true,"desc":"The `AdviserID`.","default":"admin@abcd.com.au","type":"string","name":"Account.AdviserId"},{"_id":"55dfe5693d8bfd0d00c65dc7","ref":"","in":"body","required":false,"desc":"Not required for our Australian product","default":"","type":"string","name":"Account.AdviserReference"},{"_id":"55dfe5693d8bfd0d00c65dc4","ref":"","in":"body","required":true,"desc":"The `PdsID` (from the PDS endpoint) of the product that the account will be invested in","default":"AU5","type":"string","name":"Account.PdsId"},{"_id":"55e64b5460a3390d00407a4b","ref":"","in":"body","required":false,"desc":"Not required for our Australian product","default":"","type":"string","name":"Account.ProductID"},{"_id":"55dfe5693d8bfd0d00c65dc5","ref":"","in":"body","required":true,"desc":"Our code for the tax entity type of the investor: 0 = Individual (use for SuperSMA), 1 = Trust, 2 = Company, 3 = Partnership, 4 = Super Fund (generally SMSFs), 5 = Joint","default":"0","type":"int","name":"Account.EntityType"},{"_id":"55dfe5693d8bfd0d00c65dc3","ref":"","in":"body","required":false,"desc":"Not required for our Australian product","default":"","type":"string","name":"Account.ProviderReference"},{"_id":"55dfe5693d8bfd0d00c65dc2","ref":"","in":"body","required":false,"desc":"The account's base currency. Must (currently) be AUD for our Australian product","default":"AUD","type":"string","name":"Account.CurrencyCode"},{"_id":"55dfe5693d8bfd0d00c65dbf","ref":"","in":"body","required":false,"desc":"Contains the details of the external bank account(s) that we will take funds from or pay funds to. SuperSMA accumulation accounts should not have linked bank accounts, otherwise an account must have at least one bank account, linked to the usages that are mandatory for the PDS.","default":"","type":"array_mixed","name":"Account.BankAccounts"},{"_id":"55dfe5693d8bfd0d00c65dbe","ref":"","in":"body","required":false,"desc":"A standard ABA Bank State Branch number","default":"062000","type":"string","name":"Account.BankAccounts.BSB"},{"_id":"55dfe5693d8bfd0d00c65dbd","ref":"","in":"body","required":false,"desc":"The bank account number","default":"13145715","type":"string","name":"Account.BankAccounts.AccountNumber"},{"_id":"55dfe5693d8bfd0d00c65dbc","ref":"","in":"body","required":false,"desc":"The name linked to the bank account","default":"Miss Jane Smith","type":"string","name":"Account.BankAccounts.AccountName"},{"_id":"55dfe5693d8bfd0d00c65dbb","ref":"","in":"body","required":false,"desc":"Whether this is the bank account that we should Direct Debit for cash contributions. If there is more than one bank account, only one of them can have this property set to true.","default":"True","type":"boolean","name":"Account.BankAccounts.CashContributions"},{"_id":"56160759c8c5e70d00a8a0dd","ref":"","in":"body","required":false,"desc":"Whether this is the bank account that we should Direct Credit for cash withdrawals. If there is more than one bank account, only one of them can have this property set to true.","default":"true","type":"boolean","name":"Account.BankAccounts.SmaWithdrawals"},{"_id":"56160759c8c5e70d00a8a0dc","ref":"","in":"body","required":false,"desc":"If PayoutIncome is false for all bank accounts, then income will be reinvested into the SMA account. Otherwise, the account with this property set to true will have income paid out. If there is more than one bank account, only one of them can have this property set to true.","default":"false","type":"boolean","name":"Account.BankAccounts.PayoutIncome"},{"_id":"56160759c8c5e70d00a8a0db","ref":"","in":"body","required":false,"desc":"Whether this is the bank account that we should Direct Debit to top the SMA account up for monthly fees. Whether this is the bank account that we should Direct Debit for the regular contribution plan. If there is more than one bank account, only one of them can have this property set to true.","default":"true","type":"boolean","name":"Account.BankAccounts.FeeOffset"},{"_id":"56160759c8c5e70d00a8a0da","ref":"","in":"body","required":false,"desc":"Whether this is the bank account that we should Direct Debit for the regular contribution plan. If there is more than one bank account, only one of them can have this property set to true.","default":"true","type":"boolean","name":"Account.BankAccounts.RegularContributionPlan"},{"_id":"583e250bd4d19c0f00654b4e","ref":"","in":"body","required":false,"desc":"Whether this is the bank account to use for regular withdrawals from the managed account.","default":"","type":"boolean","name":"Account.BankAccounts.RegularWithdrawal"},{"_id":"55dff54c34d6830d0091c597","ref":"","in":"body","required":false,"desc":"Contains the investment models linked to the account","default":"","type":"array_mixed","name":"Account.Models"},{"_id":"55dff54c34d6830d0091c596","ref":"","in":"body","required":false,"desc":"Our code for the investment model. Valid codes are in the PDS response","default":"SM0001","type":"string","name":"Account.Models.ModelCode"},{"_id":"55dff54c34d6830d0091c595","ref":"","in":"body","required":false,"desc":"The percentage allocated to the model, expressed as a decimal number. Note these must add to 100.","default":"100.0","type":"double","name":"Account.Models.ModelPercent"},{"_id":"55dff54c34d6830d0091c594","ref":"","in":"body","required":false,"desc":"Contains any fees that are overridden from their default values","default":"","type":"array_mixed","name":"Account.Fees"},{"_id":"55dff54c34d6830d0091c593","ref":"","in":"body","required":false,"desc":"The ID of the fee that has been overridden (valid IDs are in the PDS response).","default":"AU3400","type":"string","name":"Account.Fees.Id"},{"_id":"55dff54c34d6830d0091c592","ref":"","in":"body","required":false,"desc":"The Fee Type that has been overridden (as per the PDS response)","default":"0","type":"int","name":"Account.Fees.FeeType"},{"_id":"55dff54c34d6830d0091c591","ref":"","in":"body","required":false,"desc":"The dollar amount or percentage rate per year for the fee.","default":"2.0","type":"double","name":"Account.Fees.Value"},{"_id":"55dff54c34d6830d0091c590","ref":"","in":"body","required":false,"desc":"Whether Fees.Value is a dollar amount or a percentage","default":"true","type":"boolean","name":"Account.Fees.IsPercent"},{"_id":"55dff54c34d6830d0091c58f","ref":"","in":"body","required":false,"desc":"Whether Fees.Value includes taxes","default":"true","type":"boolean","name":"Account.Fees.IncludesTax"},{"_id":"55dff54c34d6830d0091c58e","ref":"","in":"body","required":false,"desc":"","default":"","type":"object","name":"Account.AccountSetup"},{"_id":"55dff54c34d6830d0091c58d","ref":"","in":"body","required":false,"desc":"The amount of cash that will be invested in the account","default":"10000.00","type":"double","name":"Account.AccountSetup.InitialInvestment"},{"_id":"55dff54c34d6830d0091c58c","ref":"","in":"body","required":false,"desc":"The estimated value of shares that will be transferred in specie into the account","default":"12357.56","type":"double","name":"Account.AccountSetup.InitialTransferValue"},{"_id":"55dff54c34d6830d0091c58b","ref":"","in":"body","required":false,"desc":"How the cash investment will be submitted to the account. Bpay = 1, Direct Debit = 2","default":"1","type":"int","name":"Account.AccountSetup.CashInvestmentMethod"},{"_id":"55e64b5460a3390d00407a4a","ref":"","in":"body","required":false,"desc":"If a bank account has been supplied with the RCP usage, the amount of the regular contributions must be specified","default":"200.00","type":"double","name":"Account.RegularContributionAmount"},{"_id":"583e250bd4d19c0f00654b4d","ref":"","in":"body","required":false,"desc":"If a bank account has been flagged for Regular Withdrawals, the amount of the regular withdrawal","default":"","type":"double","name":"Account.RegularWithdrawalAmount"},{"_id":"583e250bd4d19c0f00654b4c","ref":"","in":"body","required":false,"desc":"If a bank account has been flagged for Regular Withdrawals, the frequency: Monthly = 1, Quarterly = 2, SixMonthly = 3, Annually = 4","default":"","type":"int","name":"Account.RegularWithdrawalFrequency"},{"_id":"5ada8aa2a6bc980003475daa","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8e6ec30da50003c501f6","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Accounts"},"isReference":true,"order":1,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **SMA/Robo, Enterprise**\"\n}\n[/block]","excerpt":"This endpoint creates a new account in the system.","slug":"account","type":"post","title":"Accounts","__v":22,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postAccounts

This endpoint creates a new account in the system.

Body Params

Type:
required
integer1
SMA = 1
Account:
object
Contains the account data.
Account.Name:
required
stringMiss Jane Smith
The name of the account holder
Account.AdviserId:
required
stringadmin@abcd.com.au
The `AdviserID`.
Account.AdviserReference:
string
Not required for our Australian product
Account.PdsId:
required
stringAU5
The `PdsID` (from the PDS endpoint) of the product that the account will be invested in
Account.ProductID:
string
Not required for our Australian product
Account.EntityType:
required
integer0
Our code for the tax entity type of the investor: 0 = Individual (use for SuperSMA), 1 = Trust, 2 = Company, 3 = Partnership, 4 = Super Fund (generally SMSFs), 5 = Joint
Account.ProviderReference:
string
Not required for our Australian product
Account.CurrencyCode:
stringAUD
The account's base currency. Must (currently) be AUD for our Australian product
Account.BankAccounts:
array of mixed
Contains the details of the external bank account(s) that we will take funds from or pay funds to. SuperSMA accumulation accounts should not have linked bank accounts, otherwise an account must have at least one bank account, linked to the usages that are mandatory for the PDS.
Account.BankAccounts.BSB:
string062000
A standard ABA Bank State Branch number
Account.BankAccounts.AccountNumber:
string13145715
The bank account number
Account.BankAccounts.AccountName:
stringMiss Jane Smith
The name linked to the bank account
Account.BankAccounts.CashContributions:
booleanTrue
Whether this is the bank account that we should Direct Debit for cash contributions. If there is more than one bank account, only one of them can have this property set to true.
Account.BankAccounts.SmaWithdrawals:
booleantrue
Whether this is the bank account that we should Direct Credit for cash withdrawals. If there is more than one bank account, only one of them can have this property set to true.
Account.BankAccounts.PayoutIncome:
booleanfalse
If PayoutIncome is false for all bank accounts, then income will be reinvested into the SMA account. Otherwise, the account with this property set to true will have income paid out. If there is more than one bank account, only one of them can have this property set to true.
Account.BankAccounts.FeeOffset:
booleantrue
Whether this is the bank account that we should Direct Debit to top the SMA account up for monthly fees. Whether this is the bank account that we should Direct Debit for the regular contribution plan. If there is more than one bank account, only one of them can have this property set to true.
Account.BankAccounts.RegularContributionPlan:
booleantrue
Whether this is the bank account that we should Direct Debit for the regular contribution plan. If there is more than one bank account, only one of them can have this property set to true.
Account.BankAccounts.RegularWithdrawal:
boolean
Whether this is the bank account to use for regular withdrawals from the managed account.
Account.Models:
array of mixed
Contains the investment models linked to the account
Account.Models.ModelCode:
stringSM0001
Our code for the investment model. Valid codes are in the PDS response
Account.Models.ModelPercent:
double100.0
The percentage allocated to the model, expressed as a decimal number. Note these must add to 100.
Account.Fees:
array of mixed
Contains any fees that are overridden from their default values
Account.Fees.Id:
stringAU3400
The ID of the fee that has been overridden (valid IDs are in the PDS response).
Account.Fees.FeeType:
integer0
The Fee Type that has been overridden (as per the PDS response)
Account.Fees.Value:
double2.0
The dollar amount or percentage rate per year for the fee.
Account.Fees.IsPercent:
booleantrue
Whether Fees.Value is a dollar amount or a percentage
Account.Fees.IncludesTax:
booleantrue
Whether Fees.Value includes taxes
Account.AccountSetup:
object
Account.AccountSetup.InitialInvestment:
double10000.00
The amount of cash that will be invested in the account
Account.AccountSetup.InitialTransferValue:
double12357.56
The estimated value of shares that will be transferred in specie into the account
Account.AccountSetup.CashInvestmentMethod:
integer1
How the cash investment will be submitted to the account. Bpay = 1, Direct Debit = 2
Account.RegularContributionAmount:
double200.00
If a bank account has been supplied with the RCP usage, the amount of the regular contributions must be specified
Account.RegularWithdrawalAmount:
double
If a bank account has been flagged for Regular Withdrawals, the amount of the regular withdrawal
Account.RegularWithdrawalFrequency:
integer
If a bank account has been flagged for Regular Withdrawals, the frequency: Monthly = 1, Quarterly = 2, SixMonthly = 3, Annually = 4

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
[block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block]
{"_id":"5d8b0b31c4b9960018c59a42","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","category":"5d8b0b31c4b9960018c59a01","user":"5b6a77482abf4e0003e8eb5d","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-05-23T06:35:40.395Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"code":"[  \n   {  \n      \"Index\":1,\n      \"CreationStatus\":0,\n      \"Account\":{  \n         \"Code\":\"SMA00233603\",\n         \"Id\":\"AU233603\",\n         \"Name\":\"Miss Jane Smith\",\n         \"Status\":1,\n         \"Type\":1\n      }\n   },\n   {  \n      \"Index\":2,\n      \"CreationStatus\":0,\n      \"Account\":{  \n         \"Code\":\"SMA00233604\",\n         \"Id\":\"AU233604\",\n         \"Name\":\"Mr Mike Smith\",\n         \"Status\":1,\n         \"Type\":4\n      }\n   }\n]","language":"json","status":201,"name":""},{"name":"207 Multi Status","status":null,"language":"json","code":"[  \n   {  \n      \"Index\":1,\n      \"CreationStatus\":1,\n      \"ValidationMessage\":\"The fee specified '34001' is not valid for this account.\"\n   },\n   {  \n      \"Index\":2,\n      \"CreationStatus\":0,\n      \"Account\":{  \n         \"Code\":\"SMA00233602\",\n         \"Id\":\"AU233602\",\n         \"Name\":\"Miss Jane Smith\",\n         \"Status\":1,\n         \"Type\":1\n      }\n   }\n]"},{"status":400,"name":null,"language":"json","code":"[  \n   {  \n      \"Index\":1,\n      \"CreationStatus\":1,\n      \"ValidationMessage\":\"The fee specified '34001' is not valid for this account.\"\n   },\n   {  \n      \"Index\":2,\n      \"CreationStatus\":1,\n      \"ValidationMessage\":\"The fee specified '34001' is not valid for this account.\"\n   }\n]"}]},"method":"post","examples":{"codes":[{"language":"json","code":"POST http://{URL as provided}/Accounts HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\n[\n  {\n     \"Type\":1,\n     \"Account\":{\n        \"Name\":\"Miss Jane Smith\",\n        \"AdviserId\":\"jsmith\",\n        \"AdviserReference\":\"\",\n        \"PdsId\":\"AU123\",\n        \"ProductId\":\"\",\n        \"EntityType\":1,\n        \"ProviderReference\":\"\",\n        \"CurrencyCode\":\"AUD\",\n        \"BankAccounts\":[\n           {\n              \"Bsb\":\"012012\",\n              \"AccountNumber\":\"6555567\",\n              \"AccountName\":\"Miss Jane Smith\",\n              \"CashContributions\": true,\n              \"SmaWithdrawals\": true,\n              \"PayoutIncome\": false,\n              \"FeeOffset\": true,\n              \"RegularContributionPlan\": false\n           },\n           {\n              \"Bsb\":\"012012\",\n              \"AccountNumber\":\"8888888\",\n              \"AccountName\":\"Jane A Smith\",\n              \"CashContributions\": false,\n              \"SmaWithdrawals\": false,\n              \"PayoutIncome\": true,\n              \"FeeOffset\": false,\n              \"RegularContributionPlan\": true\n           }\n        ],\n        \"Models\":[\n            { \n            \"ModelCode\":\"AD0002\",\n            \"ModelPercent\":60.0\n          },\n            { \n            \"ModelCode\":\"AE0002\",\n            \"ModelPercent\":40.0\n          }\n        ],\n        \"Fees\":[\n           {\n              \"Id\":\"AU1234\",\n              \"FeeType\":0,\n              \"Value\":1.0,\n              \"IsPercent\":true,\n              \"IncludesTax\":true\n           }\n        ],\n        \"AccountSetup\":{\n           \"InitialInvestment\":10000.00,\n           \"InitialTransferValue\":1232.00,\n           \"CashInvestmentMethod\":1\n        },\n        \"RegularContributionAmount\":200.0\n     }\n  },\n  {\n    \"Type\":1,\n    \"Account\":{\n      \"Name\":\"Miss Mike Smith\",\n      \"AdviserId\":\"admin@abcd.com.au\",\n      \"AdviserReference\":\"\",\n      \"PdsId\":\"AU100\",\n      \"ProductId\":\"\",\n      \"EntityType\":0,\n      \"ProviderReference\":\"\",\n      \"CurrencyCode\":\"AUD\",\n      \"BankAccounts\":[\n        {\n          \"Bsb\":\"062000\",\n          \"AccountNumber\":\"13145716\",\n          \"AccountName\":\"Miss Mike Smith\",\n          \"Usages\":[\n            \"CASHCON\",\n            \"SMAWDWL\",\n            \"RCP\"\n          ]\n        }\n      ],\n      \"Models\":[\n        {\n          \"ModelCode\":\"100% Cash Model\",\n          \"ModelPercent\":100.0\n        }\n      ],\n      \"Fees\":[\n        {\n          \"Id\":\"AU3400\",\n          \"FeeType\":0,\n          \"Value\":2.0,\n          \"IsPercent\":true,\n          \"IncludesTax\":true\n        }\n      ],\n      \"AccountSetup\":{\n        \"InitialInvestment\":1.0,\n        \"InitialTransferValue\":2.0,\n        \"CashInvestmentMethod\":1\n      },\n      \"RegularContributionAmount\":200.00\n    }\n  }\n]","name":"Individual"},{"language":"json","name":"Joint","code":"POST http://{URL as provided}/account HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\n\n\n[\n  { \n     \"Type\":1,\n     \"Account\":{ \n        \"Name\":\"Miss Jane Smith and Mr Bob Smith\",\n        \"AdviserId\":\"admin@abcd.com.au\",\n        \"AdviserReference\":\"\",\n        \"PdsId\":\"AU100\",\n        \"ProductId\":\"\",\n        \"EntityType\":1,\n        \"ProviderReference\":\"\",\n        \"CurrencyCode\":\"AUD\",\n        \"BankAccounts\":[\n           {\n              \"Bsb\":\"012012\",\n              \"AccountNumber\":\"6555567\",\n              \"AccountName\":\"Jane and Bob Smith\",\n              \"CashContributions\": true,\n              \"SmaWithdrawals\": true,\n              \"PayoutIncome\": false,\n              \"FeeOffset\": true,\n              \"RegularContributionPlan\": false\n           }\n        ],\n           }\n        ],\n        \"Models\":[ \n           { \n              \"ModelCode\":\"100% Cash Model\",\n              \"ModelPercent\":100.0\n           }\n        ],\n        \"Fees\":[ \n           { \n              \"Id\":\"AU3400\",\n              \"FeeType\":0,\n              \"Value\":2.0,\n              \"IsPercent\":true,\n              \"IncludesTax\":true\n           }\n        ],\n        \"AccountSetup\":{ \n           \"InitialInvestment\":1.0,\n           \"InitialTransferValue\":2.0,\n           \"CashInvestmentMethod\":1\n        },\n        \"RegularContributionAmount\":200.00\n\t\t}\n\t}\n  {\n    \"Type\":1,\n     \"Account\":{ \n        \"Name\":\"Mr Mike Smith & Jim Jones\",\n        \"AdviserId\":\"admin@abcd.com.au\",\n        \"AdviserReference\":\"\",\n        \"PdsId\":\"AU100\",\n        \"ProductId\":\"\",\n        \"EntityType\":1,\n        \"ProviderReference\":\"\",\n        \"CurrencyCode\":\"AUD\",\n        \"BankAccounts\":[ \n           { \n              \"Bsb\":\"062000\",\n              \"AccountNumber\":\"13145725\",\n              \"AccountName\":\"Mr Mike Smith\",\n              \"Usages\":[ \n                 \"CASHCON\",\n                 \"SMAWDWL\",\n                 \"RCP\"\n              ]\n           }\n        ],\n        \"Models\":[ \n           { \n              \"ModelCode\":\"100% Cash Model\",\n              \"ModelPercent\":100.0\n           }\n        ],\n        \"Fees\":[ \n           { \n              \"Id\":\"AU3400\",\n              \"FeeType\":0,\n              \"Value\":2.0,\n              \"IsPercent\":true,\n              \"IncludesTax\":true\n           }\n        ],\n        \"AccountSetup\":{ \n           \"InitialInvestment\":1.0,\n           \"InitialTransferValue\":2.0,\n           \"CashInvestmentMethod\":1\n        },\n        \"RegularContributionAmount\":200.00\n     }\n  }\n]"},{"code":"POST http://{URL as provided}/account HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\n\n[\n  { \n     \"Type\":1,\n     \"Account\":{ \n        \"Name\":\"Miss Jane Smith\",\n        \"AdviserId\":\"admin@abcd.com.au\",\n        \"AdviserReference\":\"\",\n        \"PdsId\":\"AU100\",\n        \"ProductId\":\"\",\n        \"EntityType\":1,\n        \"ProviderReference\":\"\",\n        \"CurrencyCode\":\"AUD\",\n        \"Models\":[ \n           { \n              \"ModelCode\":\"100% Cash Model\",\n              \"ModelPercent\":100.0\n           }\n        ],\n        \"Fees\":[ \n           { \n              \"Id\":\"AU3400\",\n              \"FeeType\":0,\n              \"Value\":2.0,\n              \"IsPercent\":true,\n              \"IncludesTax\":true\n           }\n        ],\n        \"AccountSetup\":{ \n           \"InitialInvestment\":1.0,\n           \"InitialTransferValue\":0.0,\n           \"CashInvestmentMethod\":1\n        },\n      \"EmployerContributions\": true\n    }\n  }\n  {\n     \"Type\":1,\n     \"Account\":{ \n        \"Name\":\"Miss Jane Smith\",\n        \"AdviserId\":\"admin@abcd.com.au\",\n        \"AdviserReference\":\"\",\n        \"PdsId\":\"AU100\",\n        \"ProductId\":\"\",\n        \"EntityType\":1,\n        \"ProviderReference\":\"\",\n        \"CurrencyCode\":\"AUD\",\n        \"Models\":[ \n           { \n              \"ModelCode\":\"100% Cash Model\",\n              \"ModelPercent\":100.0\n           }\n        ],\n        \"Fees\":[ \n           { \n              \"Id\":\"AU3400\",\n              \"FeeType\":0,\n              \"Value\":2.0,\n              \"IsPercent\":true,\n              \"IncludesTax\":true\n           }\n        ],\n        \"AccountSetup\":{ \n           \"InitialInvestment\":1.0,\n           \"InitialTransferValue\":0.0,\n           \"CashInvestmentMethod\":1\n        },\n      \"EmployerContributions\": true\n     }\n  }\n]","language":"json","name":"Accumulation"},{"name":"Pension","language":"text","code":"For pension accounts the below JSON changes must be made:\n\n\nCOMING SOON\n\n\n\n\n"}]},"settings":"","auth":"required","params":[{"_id":"5ce63f3cb69ac9000e511f4d","ref":"","in":"body","required":false,"desc":"","default":"","type":"array_object","name":"Array of {Type, Account}"},{"_id":"55dfe5693d8bfd0d00c65dca","ref":"","in":"body","required":true,"desc":"SMA = 1","default":"1","type":"int","name":"Type"},{"_id":"55f0c77078661c170035e149","ref":"","in":"body","required":false,"desc":"Contains the account data.","default":"","type":"object","name":"Account"},{"_id":"55dfe5693d8bfd0d00c65dc9","ref":"","in":"body","required":true,"desc":"The name of the account holder","default":"Miss Jane Smith","type":"string","name":"Account.Name"},{"_id":"55dfe5693d8bfd0d00c65dc8","ref":"","in":"body","required":true,"desc":"The `AdviserID`.","default":"admin@abcd.com.au","type":"string","name":"Account.AdviserId"},{"_id":"55dfe5693d8bfd0d00c65dc7","ref":"","in":"body","required":false,"desc":"Not required for our Australian product","default":"","type":"string","name":"Account.AdviserReference"},{"_id":"55dfe5693d8bfd0d00c65dc4","ref":"","in":"body","required":true,"desc":"The `PdsID` (from the PDS endpoint) of the product that the account will be invested in","default":"AU5","type":"string","name":"Account.PdsId"},{"_id":"55e64b5460a3390d00407a4b","ref":"","in":"body","required":false,"desc":"Not required for our Australian product","default":"","type":"string","name":"Account.ProductID"},{"_id":"55dfe5693d8bfd0d00c65dc5","ref":"","in":"body","required":true,"desc":"Our code for the tax entity type of the investor: 0 = Individual (use for SuperSMA), 1 = Trust, 2 = Company, 3 = Partnership, 4 = Super Fund (generally SMSFs), 5 = Joint","default":"0","type":"int","name":"Account.EntityType"},{"_id":"55dfe5693d8bfd0d00c65dc3","ref":"","in":"body","required":false,"desc":"Not required for our Australian product","default":"","type":"string","name":"Account.ProviderReference"},{"_id":"55dfe5693d8bfd0d00c65dc2","ref":"","in":"body","required":false,"desc":"The account's base currency. Must (currently) be AUD for our Australian product","default":"AUD","type":"string","name":"Account.CurrencyCode"},{"_id":"55dfe5693d8bfd0d00c65dbf","ref":"","in":"body","required":false,"desc":"Contains the details of the external bank account(s) that we will take funds from or pay funds to. SuperSMA accumulation accounts should not have linked bank accounts, otherwise an account must have at least one bank account, linked to the usages that are mandatory for the PDS.","default":"","type":"array_mixed","name":"Account.BankAccounts"},{"_id":"55dfe5693d8bfd0d00c65dbe","ref":"","in":"body","required":false,"desc":"A standard ABA Bank State Branch number","default":"062000","type":"string","name":"Account.BankAccounts.BSB"},{"_id":"55dfe5693d8bfd0d00c65dbd","ref":"","in":"body","required":false,"desc":"The bank account number","default":"13145715","type":"string","name":"Account.BankAccounts.AccountNumber"},{"_id":"55dfe5693d8bfd0d00c65dbc","ref":"","in":"body","required":false,"desc":"The name linked to the bank account","default":"Miss Jane Smith","type":"string","name":"Account.BankAccounts.AccountName"},{"_id":"55dfe5693d8bfd0d00c65dbb","ref":"","in":"body","required":false,"desc":"Whether this is the bank account that we should Direct Debit for cash contributions. If there is more than one bank account, only one of them can have this property set to true.","default":"True","type":"boolean","name":"Account.BankAccounts.CashContributions"},{"_id":"56160759c8c5e70d00a8a0dd","ref":"","in":"body","required":false,"desc":"Whether this is the bank account that we should Direct Credit for cash withdrawals. If there is more than one bank account, only one of them can have this property set to true.","default":"true","type":"boolean","name":"Account.BankAccounts.SmaWithdrawals"},{"_id":"56160759c8c5e70d00a8a0dc","ref":"","in":"body","required":false,"desc":"If PayoutIncome is false for all bank accounts, then income will be reinvested into the SMA account. Otherwise, the account with this property set to true will have income paid out. If there is more than one bank account, only one of them can have this property set to true.","default":"false","type":"boolean","name":"Account.BankAccounts.PayoutIncome"},{"_id":"56160759c8c5e70d00a8a0db","ref":"","in":"body","required":false,"desc":"Whether this is the bank account that we should Direct Debit to top the SMA account up for monthly fees. Whether this is the bank account that we should Direct Debit for the regular contribution plan. If there is more than one bank account, only one of them can have this property set to true.","default":"true","type":"boolean","name":"Account.BankAccounts.FeeOffset"},{"_id":"56160759c8c5e70d00a8a0da","ref":"","in":"body","required":false,"desc":"Whether this is the bank account that we should Direct Debit for the regular contribution plan. If there is more than one bank account, only one of them can have this property set to true.","default":"true","type":"boolean","name":"Account.BankAccounts.RegularContributionPlan"},{"_id":"583e250bd4d19c0f00654b4e","ref":"","in":"body","required":false,"desc":"Whether this is the bank account to use for regular withdrawals from the managed account.","default":"","type":"boolean","name":"Account.BankAccounts.RegularWithdrawal"},{"_id":"55dff54c34d6830d0091c597","ref":"","in":"body","required":false,"desc":"Contains the investment models linked to the account","default":"","type":"array_mixed","name":"Account.Models"},{"_id":"55dff54c34d6830d0091c596","ref":"","in":"body","required":false,"desc":"Our code for the investment model. Valid codes are in the PDS response","default":"SM0001","type":"string","name":"Account.Models.ModelCode"},{"_id":"55dff54c34d6830d0091c595","ref":"","in":"body","required":false,"desc":"The percentage allocated to the model, expressed as a decimal number. Note these must add to 100.","default":"100.0","type":"double","name":"Account.Models.ModelPercent"},{"_id":"55dff54c34d6830d0091c594","ref":"","in":"body","required":false,"desc":"Contains any fees that are overridden from their default values","default":"","type":"array_mixed","name":"Account.Fees"},{"_id":"55dff54c34d6830d0091c593","ref":"","in":"body","required":false,"desc":"The ID of the fee that has been overridden (valid IDs are in the PDS response).","default":"AU3400","type":"string","name":"Account.Fees.Id"},{"_id":"55dff54c34d6830d0091c592","ref":"","in":"body","required":false,"desc":"The Fee Type that has been overridden (as per the PDS response)","default":"0","type":"int","name":"Account.Fees.FeeType"},{"_id":"55dff54c34d6830d0091c591","ref":"","in":"body","required":false,"desc":"The dollar amount or percentage rate per year for the fee.","default":"2.0","type":"double","name":"Account.Fees.Value"},{"_id":"55dff54c34d6830d0091c590","ref":"","in":"body","required":false,"desc":"Whether Fees.Value is a dollar amount or a percentage","default":"true","type":"boolean","name":"Account.Fees.IsPercent"},{"_id":"55dff54c34d6830d0091c58f","ref":"","in":"body","required":false,"desc":"Whether Fees.Value includes taxes","default":"true","type":"boolean","name":"Account.Fees.IncludesTax"},{"_id":"55dff54c34d6830d0091c58e","ref":"","in":"body","required":false,"desc":"","default":"","type":"object","name":"Account.AccountSetup"},{"_id":"55dff54c34d6830d0091c58d","ref":"","in":"body","required":false,"desc":"The amount of cash that will be invested in the account","default":"10000.00","type":"double","name":"Account.AccountSetup.InitialInvestment"},{"_id":"55dff54c34d6830d0091c58c","ref":"","in":"body","required":false,"desc":"The estimated value of shares that will be transferred in specie into the account","default":"12357.56","type":"double","name":"Account.AccountSetup.InitialTransferValue"},{"_id":"55dff54c34d6830d0091c58b","ref":"","in":"body","required":false,"desc":"How the cash investment will be submitted to the account. Bpay = 1, Direct Debit = 2","default":"1","type":"int","name":"Account.AccountSetup.CashInvestmentMethod"},{"_id":"55e64b5460a3390d00407a4a","ref":"","in":"body","required":false,"desc":"If a bank account has been supplied with the RCP usage, the amount of the regular contributions must be specified","default":"200.00","type":"double","name":"Account.RegularContributionAmount"},{"_id":"583e250bd4d19c0f00654b4d","ref":"","in":"body","required":false,"desc":"If a bank account has been flagged for Regular Withdrawals, the amount of the regular withdrawal","default":"","type":"double","name":"Account.RegularWithdrawalAmount"},{"_id":"583e250bd4d19c0f00654b4c","ref":"","in":"body","required":false,"desc":"If a bank account has been flagged for Regular Withdrawals, the frequency: Monthly = 1, Quarterly = 2, SixMonthly = 3, Annually = 4","default":"","type":"int","name":"Account.RegularWithdrawalFrequency"},{"_id":"5ada8aa2a6bc980003475daa","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8e6ec30da50003c501f6","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Accounts"},"isReference":true,"order":2,"body":"You can use the Accounts endpoint to set up more than one account in a single request, for example if you are migrating a number of accounts from your legacy system. We return the IDs we have allocated to the accounts in our response, so that you can pass us the applicant details.\nPlease refer to the documentation on the Accounts endpoint for information on the parameters.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **SMA/Robo, Enterprise**\"\n}\n[/block]","excerpt":"This endpoint creates multiple accounts in the system.","slug":"bulk-accounts-1","type":"post","title":"Bulk Accounts","__v":3,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postBulk Accounts

This endpoint creates multiple accounts in the system.

Body Params

Array:
array of objects
Type:
required
integer1
SMA = 1
Account:
object
Contains the account data.
Account.Name:
required
stringMiss Jane Smith
The name of the account holder
Account.AdviserId:
required
stringadmin@abcd.com.au
The `AdviserID`.
Account.AdviserReference:
string
Not required for our Australian product
Account.PdsId:
required
stringAU5
The `PdsID` (from the PDS endpoint) of the product that the account will be invested in
Account.ProductID:
string
Not required for our Australian product
Account.EntityType:
required
integer0
Our code for the tax entity type of the investor: 0 = Individual (use for SuperSMA), 1 = Trust, 2 = Company, 3 = Partnership, 4 = Super Fund (generally SMSFs), 5 = Joint
Account.ProviderReference:
string
Not required for our Australian product
Account.CurrencyCode:
stringAUD
The account's base currency. Must (currently) be AUD for our Australian product
Account.BankAccounts:
array of mixed
Contains the details of the external bank account(s) that we will take funds from or pay funds to. SuperSMA accumulation accounts should not have linked bank accounts, otherwise an account must have at least one bank account, linked to the usages that are mandatory for the PDS.
Account.BankAccounts.BSB:
string062000
A standard ABA Bank State Branch number
Account.BankAccounts.AccountNumber:
string13145715
The bank account number
Account.BankAccounts.AccountName:
stringMiss Jane Smith
The name linked to the bank account
Account.BankAccounts.CashContributions:
booleanTrue
Whether this is the bank account that we should Direct Debit for cash contributions. If there is more than one bank account, only one of them can have this property set to true.
Account.BankAccounts.SmaWithdrawals:
booleantrue
Whether this is the bank account that we should Direct Credit for cash withdrawals. If there is more than one bank account, only one of them can have this property set to true.
Account.BankAccounts.PayoutIncome:
booleanfalse
If PayoutIncome is false for all bank accounts, then income will be reinvested into the SMA account. Otherwise, the account with this property set to true will have income paid out. If there is more than one bank account, only one of them can have this property set to true.
Account.BankAccounts.FeeOffset:
booleantrue
Whether this is the bank account that we should Direct Debit to top the SMA account up for monthly fees. Whether this is the bank account that we should Direct Debit for the regular contribution plan. If there is more than one bank account, only one of them can have this property set to true.
Account.BankAccounts.RegularContributionPlan:
booleantrue
Whether this is the bank account that we should Direct Debit for the regular contribution plan. If there is more than one bank account, only one of them can have this property set to true.
Account.BankAccounts.RegularWithdrawal:
boolean
Whether this is the bank account to use for regular withdrawals from the managed account.
Account.Models:
array of mixed
Contains the investment models linked to the account
Account.Models.ModelCode:
stringSM0001
Our code for the investment model. Valid codes are in the PDS response
Account.Models.ModelPercent:
double100.0
The percentage allocated to the model, expressed as a decimal number. Note these must add to 100.
Account.Fees:
array of mixed
Contains any fees that are overridden from their default values
Account.Fees.Id:
stringAU3400
The ID of the fee that has been overridden (valid IDs are in the PDS response).
Account.Fees.FeeType:
integer0
The Fee Type that has been overridden (as per the PDS response)
Account.Fees.Value:
double2.0
The dollar amount or percentage rate per year for the fee.
Account.Fees.IsPercent:
booleantrue
Whether Fees.Value is a dollar amount or a percentage
Account.Fees.IncludesTax:
booleantrue
Whether Fees.Value includes taxes
Account.AccountSetup:
object
Account.AccountSetup.InitialInvestment:
double10000.00
The amount of cash that will be invested in the account
Account.AccountSetup.InitialTransferValue:
double12357.56
The estimated value of shares that will be transferred in specie into the account
Account.AccountSetup.CashInvestmentMethod:
integer1
How the cash investment will be submitted to the account. Bpay = 1, Direct Debit = 2
Account.RegularContributionAmount:
double200.00
If a bank account has been supplied with the RCP usage, the amount of the regular contributions must be specified
Account.RegularWithdrawalAmount:
double
If a bank account has been flagged for Regular Withdrawals, the amount of the regular withdrawal
Account.RegularWithdrawalFrequency:
integer
If a bank account has been flagged for Regular Withdrawals, the frequency: Monthly = 1, Quarterly = 2, SixMonthly = 3, Annually = 4

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
You can use the Accounts endpoint to set up more than one account in a single request, for example if you are migrating a number of accounts from your legacy system. We return the IDs we have allocated to the accounts in our response, so that you can pass us the applicant details. Please refer to the documentation on the Accounts endpoint for information on the parameters. [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



You can use the Accounts endpoint to set up more than one account in a single request, for example if you are migrating a number of accounts from your legacy system. We return the IDs we have allocated to the accounts in our response, so that you can pass us the applicant details. Please refer to the documentation on the Accounts endpoint for information on the parameters. [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block]
{"_id":"5d8b0b31c4b9960018c59a24","category":"5d8b0b31c4b9960018c59a01","project":"55ca8813e583751700f78a58","user":"55a49cd3e6c2470d002a648c","parentDoc":null,"version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-31T04:03:01.743Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":201,"name":"","code":"{  \n   \"CreationStatus\":0,\n   \"Account\":{  \n      \"Code\":\"SMA00233601\",\n      \"Id\":\"AU233601\",\n      \"Name\":\"Accum Account 1\",\n      \"Status\":1,\n      \"Type\":4\n   }\n}","language":"json"},{"language":"json","code":"{  \n    \"CreationStatus\":1,\n    \"ValidationMessage\":\"The fee specified '34001' is not valid for this account.\"\n}","status":400}]},"settings":"","examples":{"codes":[{"name":"Accumulation","language":"json","code":"POST http://{URL as provided}/Account HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-token: THE-API-VERSION\n\nAccum account creation:\n{\n  \"Type\": 4,\n  \"Account\":{\n      \"AdviserId\": \"jjones@jones.com\",\n      \"Name\": \"Accum Account 1\",\n      \"AdviserReference\": null,\n      \"EntityType\": 0,\n      \"PdsId\": \"AU85\",\n      \"ProductId\": null,\n      \"ProviderReference\": null,\n      \"CurrencyCode\": \"AUD\",\n      \"AccountSetup\":{\n         \"InitialInvestment\":10000.00,\n         \"InitialTransferValue\":1232.00,\n         \"CashInvestmentMethod\":1\n      },\n      \"BankAccounts\":[\n         {\n            \"Bsb\":\"012012\",\n            \"AccountNumber\":\"6555567\",\n            \"AccountName\":\"Miss Jane Smith\",\n            \"CashContributions\": true,\n            \"SmaWithdrawals\": true,\n\t    \t\t\t\"PayoutIncome\": false,\n\t    \t\t\t\"FeeOffset\": true,\n \t    \t\t\t\"RegularContributionPlan\": false\n         },\n         {\n            \"Bsb\":\"012012\",\n            \"AccountNumber\":\"8888888\",\n            \"AccountName\":\"Jane A Smith\",\n            \"CashContributions\": false,\n            \"SmaWithdrawals\": false,\n\t    \t\t\t\"PayoutIncome\": true,\n\t    \t\t\t\"FeeOffset\": false,\n \t    \t\t\t\"RegularContributionPlan\": true\n         }\n      ],\n      \"Models\": [\n        {\n          \"ModelCode\": \"EA0001\",\n          \"ModelPercent\": 100.0\n        }\n      ],\n      \"Fees\": [\n        {\n          \"Id\": \"AU5328\",\n          \"FeeType\": 0,\n          \"Value\": 1.0,\n          \"IsPercent\": true,\n          \"IncludesTax\": true\n        }\n      ],\n      \"EmployerContributions\": true,\n      \"FeeInstructions\": null,\n      \"IncomeInstructions\": null,\n      \"ContributionSources\": [\n        {\n          \"SourceOfContribution\": \"Bendigo SmartStart Super (STL0050AU), Member 1\",\n          \"EntireBalance\": true,\n          \"ExpectedAmount\": 0.0\n        }\n      ],\n      \"Transfers\": [\n        {\n          \"TransferFromAccountId\": \"AU111222\",\n          \"TransferMethod\": \"WholeAmountKeepOpen\",\n          \"Amount\": 10000.00\n        } \n      ],\n      \"OtherContributions\": [\n        {\n          \"ContributionType\": 11,\n          \"ExpectedAmount\": 250.00\n        }\n      ]\n  }\n}\n"}]},"method":"post","auth":"required","params":[{"_id":"55dfe5693d8bfd0d00c65dca","ref":"","in":"body","required":true,"desc":"SuperSMAAccumulation = 4","default":"1","type":"int","name":"Type"},{"_id":"55f0c77078661c170035e149","ref":"","in":"body","required":false,"desc":"Contains the account data.","default":"","type":"object","name":"Account"},{"_id":"55dfe5693d8bfd0d00c65dc9","ref":"","in":"body","required":true,"desc":"The name of the account holder","default":"Miss Jane Smith","type":"string","name":"Account.Name"},{"_id":"55dfe5693d8bfd0d00c65dc8","ref":"","in":"body","required":false,"desc":"The user ID that you have been provided with","default":"admin@abcd.com.au","type":"string","name":"Account.AdviserId"},{"_id":"55dfe5693d8bfd0d00c65dc7","ref":"","in":"body","required":false,"desc":"Not required for our Australian product","default":"","type":"string","name":"Account.AdviserReference"},{"_id":"55dfe5693d8bfd0d00c65dc4","ref":"","in":"body","required":true,"desc":"The `PdsID` (from the PDS endpoint) of the product that the account will be invested in","default":"AU5","type":"string","name":"Account.PdsId"},{"_id":"55e64b5460a3390d00407a4b","ref":"","in":"body","required":false,"desc":"Not required for our Australian product","default":"","type":"string","name":"Account.ProductID"},{"_id":"55dfe5693d8bfd0d00c65dc5","ref":"","in":"body","required":true,"desc":"Our code for the tax entity type for the account. In the API we currently handle 0 = Individual (use for SuperSMA)","default":"0","type":"int","name":"Account.EntityType"},{"_id":"55dfe5693d8bfd0d00c65dc3","ref":"","in":"body","required":false,"desc":"Not required for our Australian product","default":"","type":"string","name":"Account.ProviderReference"},{"_id":"55dfe5693d8bfd0d00c65dc2","ref":"","in":"body","required":false,"desc":"The account's base currency. Must (currently) be AUD for our Australian product","default":"AUD","type":"string","name":"Account.CurrencyCode"},{"_id":"5b8cdf85bb36ba0003ffd4de","ref":"","in":"body","required":false,"desc":"Contains the details of the external bank account(s) that we will take funds from or pay funds to. SuperSMA accumulation accounts should not have linked bank accounts, otherwise an account must have at least one bank account, linked to the usages that are mandatory for the PDS.","default":"","type":"array_mixed","name":"Account.BankAccounts"},{"_id":"5b8cdf85bb36ba0003ffd4dd","ref":"","in":"body","required":false,"desc":"A standard ABA Bank State Branch number","default":"062000","type":"string","name":"Account.BankAccounts.BSB"},{"_id":"5b8cdf85bb36ba0003ffd4dc","ref":"","in":"body","required":false,"desc":"The bank account number","default":"13145715","type":"string","name":"Account.BankAccounts.AccountNumber"},{"_id":"5b8cdf85bb36ba0003ffd4db","ref":"","in":"body","required":false,"desc":"The name linked to the bank account","default":"Miss Jane Smith","type":"string","name":"Account.BankAccounts.AccountName"},{"_id":"5b8cdf85bb36ba0003ffd4da","ref":"","in":"body","required":false,"desc":"Whether this is the bank account that we should Direct Debit for cash contributions. If there is more than one bank account, only one of them can have this property set to true.","default":"True","type":"boolean","name":"Account.BankAccounts.CashContributions"},{"_id":"5b8cdf85bb36ba0003ffd4d9","ref":"","in":"body","required":false,"desc":"Whether this is the bank account that we should Direct Credit for cash withdrawals. If there is more than one bank account, only one of them can have this property set to true.","default":"True","type":"boolean","name":"Account.BankAccounts.SmaWithdrawals"},{"_id":"5b8cdf85bb36ba0003ffd4d8","ref":"","in":"body","required":false,"desc":"If PayoutIncome is false for all bank accounts, then income will be reinvested into the SMA account. Otherwise, the account with this property set to true will have income paid out. If there is more than one bank account, only one of them can have this property set to true.","default":"False","type":"boolean","name":"Account.BankAccounts.PayoutIncome"},{"_id":"5b8cdf85bb36ba0003ffd4d7","ref":"","in":"body","required":false,"desc":"Whether this is the bank account that we should Direct Debit to top the SMA account up for monthly fees. Whether this is the bank account that we should Direct Debit for the regular contribution plan. If there is more than one bank account, only one of them can have this property set to true.","default":"True","type":"boolean","name":"Account.BankAccounts.FeeOffset"},{"_id":"5b8cdf85bb36ba0003ffd4d6","ref":"","in":"body","required":false,"desc":"Whether this is the bank account that we should Direct Debit for the regular contribution plan. If there is more than one bank account, only one of them can have this property set to true.","default":"True","type":"boolean","name":"Account.BankAccounts.RegularContributionPlan"},{"_id":"5b8cdf85bb36ba0003ffd4d5","ref":"","in":"body","required":false,"desc":"Whether this is the bank account to use for regular withdrawals from the managed account.","default":"False","type":"boolean","name":"Account.BankAccounts.RegularWithdrawal"},{"_id":"55dff54c34d6830d0091c597","ref":"","in":"body","required":false,"desc":"Contains the investment models linked to the account","default":"","type":"array_mixed","name":"Account.Models"},{"_id":"55dff54c34d6830d0091c596","ref":"","in":"body","required":false,"desc":"Our code for the investment model. Valid codes are in the PDS response","default":"SM0001","type":"string","name":"Account.Models.ModelCode"},{"_id":"55dff54c34d6830d0091c595","ref":"","in":"body","required":false,"desc":"The percentage allocated to the model, expressed as a decimal number. Note these must add to 100.","default":"100.0","type":"double","name":"Account.Models.ModelPercent"},{"_id":"55dff54c34d6830d0091c594","ref":"","in":"body","required":false,"desc":"Contains any fees that are overridden from their default values","default":"","type":"array_mixed","name":"Account.Fees"},{"_id":"55dff54c34d6830d0091c593","ref":"","in":"body","required":false,"desc":"The ID of the fee that has been overridden (valid IDs are in the PDS response).","default":"AU3400","type":"string","name":"Account.Fees.Id"},{"_id":"55dff54c34d6830d0091c592","ref":"","in":"body","required":false,"desc":"The Fee Type that has been overridden (as per the PDS response)","default":"0","type":"int","name":"Account.Fees.FeeType"},{"_id":"55dff54c34d6830d0091c591","ref":"","in":"body","required":false,"desc":"The dollar amount or percentage rate per year for the fee.","default":"2.0","type":"double","name":"Account.Fees.Value"},{"_id":"55dff54c34d6830d0091c590","ref":"","in":"body","required":false,"desc":"Whether Fees.Value is a dollar amount or a percentage","default":"true","type":"boolean","name":"Account.Fees.IsPercent"},{"_id":"55dff54c34d6830d0091c58f","ref":"","in":"body","required":false,"desc":"Whether Fees.Value includes taxes","default":"true","type":"boolean","name":"Account.Fees.IncludesTax"},{"_id":"55f0d228e27bf00d00618100","ref":"","in":"body","required":false,"desc":"For SuperSMA (Accumulation accounts) whether the member's (the investor for SuperSMA accounts) employer will be making contributions.","default":"false","type":"boolean","name":"Account.EmployerContributions"},{"_id":"56fcb50fcaad892200847ab2","ref":"","in":"body","required":false,"desc":"Contains the instructions (see below) on the model(s) to sell down to fund fees","default":"","type":"array_mixed","name":"Account.FeeInstructions"},{"_id":"56fcb50fcaad892200847ab1","ref":"","in":"body","required":false,"desc":"Contains the instructions (see below) on the model(s) to reinvest any income that the account receives into","default":"","type":"array_mixed","name":"Account.IncomeInstructions"},{"_id":"56fcb50fcaad892200847ab0","ref":"","in":"body","required":false,"desc":"Contains details on the investors' accounts in external super funds that will be used to fund this account.","default":"","type":"array_mixed","name":"Account.ContributionSources"},{"_id":"56fcb50fcaad892200847aaf","ref":"","in":"body","required":false,"desc":"Details of the external account","default":"Bendigo SmartStart Super (STL0050AU), Member 1","type":"string","name":"Account.ContributionSources.SourceOfContribution"},{"_id":"56fcb50fcaad892200847aae","ref":"","in":"body","required":false,"desc":"Whether the entire balance of the external fund account will be transferred","default":"true","type":"boolean","name":"Account.ContributionSources.EntireBalance"},{"_id":"56fcb50fcaad892200847aad","ref":"","in":"body","required":false,"desc":"If Account.ContributionSources.EntireBalance is FALSE, the amount to be transferred","default":"10000","type":"double","name":"Account.ContributionSources.ExpectedAmount"},{"_id":"56fcb50fcaad892200847aac","ref":"","in":"body","required":false,"desc":"Contains details on the investors' other SuperSMA account(s) that will be used to fund this account.","default":"","type":"array_mixed","name":"Account.Transfers"},{"_id":"5714851a4007610e00c80393","ref":"","in":"body","required":false,"desc":"The ID of the other SuperSMA account that will be the source of funds","default":"","type":"string","name":"Account.Transfers.TransferFromAccountID"},{"_id":"5714851a4007610e00c80392","ref":"","in":"body","required":false,"desc":"WholeAmountWithClose or WholeAmountKeepOpen or SpecifiedAmount - whether the source account will be kept open","default":"","type":"string","name":"Account.Transfers.TransferMethod"},{"_id":"5714851a4007610e00c80391","ref":"","in":"body","required":false,"desc":"If Account.Transfers.TransferMethod is WholeAmountKeepOpenSpecifiedAmount, the amount to be transferred across","default":"","type":"string","name":"Account.Transfers.Amount"},{"_id":"56fcb50fcaad892200847aab","ref":"","in":"body","required":false,"desc":"Contains details of other assets that will be used to fund this account.","default":"","type":"array_mixed","name":"Account.OtherContributions"},{"_id":"5714851a4007610e00c80390","ref":"","in":"body","required":false,"desc":"The source of the funds: Unknown = 0, ConcessionalEmployee = 11, ConcessionalPersonal = 12, ConcessionalOtherFriendsAndFamily = 13, NonConcessionalPersonal = 21, NonConcessionalSpouseAndChild = 22, NonConcessionalFirstHomeSaverAccount = 23, ExemptCgt15Year = 31, ExemptCgtRetirement = 32, ExemptPersonalInjuryElection = 33, OtherGovernmentCoContribution = 41, OtherLowIncomeSuperContribution = 42","default":"","type":"string","name":"Account.OtherContributions.ContributionType"},{"_id":"5b90a395b437ba0003a3b66d","ref":"","in":"body","required":false,"desc":"If a bank account has been supplied with the RCP usage, the amount of the regular contributions must be specified","default":"200.00","type":"double","name":"Account.RegularContributionAmount"},{"_id":"5b90a395b437ba0003a3b66c","ref":"","in":"body","required":false,"desc":"The source of the funds for regular contributions: NonConcessionalPersonal = 21, NonConcessionalSpouseAndChild = 22","default":"21","type":"int","name":"Account.ContributionType"},{"_id":"5b90a395b437ba0003a3b66b","ref":"","in":"body","required":false,"desc":"The amount of cash that will be invested in the account","default":"200.0","type":"double","name":"Account.InitialInvestmentAmount"},{"_id":"5b90a395b437ba0003a3b66a","ref":"","in":"body","required":false,"desc":"The source of the funds for initial investment: NonConcessionalPersonal = 21, NonConcessionalSpouseAndChild = 22","default":"21","type":"int","name":"Account.InitialInvestmentType"},{"_id":"5ada8ac2a6bc980003475dab","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8ed993588300034e645a","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Accounts"},"isReference":true,"order":3,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"What are \\\"instructions\\\"?\",\n  \"body\": \"Investors can choose to have certain cash flows into or out of an account, funded by or invested into, one or more of the models they are invested in, rather than being pro-rated between their models. We call these choices 'cashflow instructions. The instructions arrays include the details of these.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **SMA/Robo, Enterprise**\"\n}\n[/block]","excerpt":"This endpoint creates an Retail Super - Accumulation accounts in the system.","slug":"accounts-super-accumulation","type":"post","title":"Retail Super-Accumulation","__v":27,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postRetail Super-Accumulation

This endpoint creates an Retail Super - Accumulation accounts in the system.

Body Params

Type:
required
integer1
SuperSMAAccumulation = 4
Account:
object
Contains the account data.
Account.Name:
required
stringMiss Jane Smith
The name of the account holder
Account.AdviserId:
stringadmin@abcd.com.au
The user ID that you have been provided with
Account.AdviserReference:
string
Not required for our Australian product
Account.PdsId:
required
stringAU5
The `PdsID` (from the PDS endpoint) of the product that the account will be invested in
Account.ProductID:
string
Not required for our Australian product
Account.EntityType:
required
integer0
Our code for the tax entity type for the account. In the API we currently handle 0 = Individual (use for SuperSMA)
Account.ProviderReference:
string
Not required for our Australian product
Account.CurrencyCode:
stringAUD
The account's base currency. Must (currently) be AUD for our Australian product
Account.BankAccounts:
array of mixed
Contains the details of the external bank account(s) that we will take funds from or pay funds to. SuperSMA accumulation accounts should not have linked bank accounts, otherwise an account must have at least one bank account, linked to the usages that are mandatory for the PDS.
Account.BankAccounts.BSB:
string062000
A standard ABA Bank State Branch number
Account.BankAccounts.AccountNumber:
string13145715
The bank account number
Account.BankAccounts.AccountName:
stringMiss Jane Smith
The name linked to the bank account
Account.BankAccounts.CashContributions:
booleanTrue
Whether this is the bank account that we should Direct Debit for cash contributions. If there is more than one bank account, only one of them can have this property set to true.
Account.BankAccounts.SmaWithdrawals:
booleanTrue
Whether this is the bank account that we should Direct Credit for cash withdrawals. If there is more than one bank account, only one of them can have this property set to true.
Account.BankAccounts.PayoutIncome:
booleanFalse
If PayoutIncome is false for all bank accounts, then income will be reinvested into the SMA account. Otherwise, the account with this property set to true will have income paid out. If there is more than one bank account, only one of them can have this property set to true.
Account.BankAccounts.FeeOffset:
booleanTrue
Whether this is the bank account that we should Direct Debit to top the SMA account up for monthly fees. Whether this is the bank account that we should Direct Debit for the regular contribution plan. If there is more than one bank account, only one of them can have this property set to true.
Account.BankAccounts.RegularContributionPlan:
booleanTrue
Whether this is the bank account that we should Direct Debit for the regular contribution plan. If there is more than one bank account, only one of them can have this property set to true.
Account.BankAccounts.RegularWithdrawal:
booleanFalse
Whether this is the bank account to use for regular withdrawals from the managed account.
Account.Models:
array of mixed
Contains the investment models linked to the account
Account.Models.ModelCode:
stringSM0001
Our code for the investment model. Valid codes are in the PDS response
Account.Models.ModelPercent:
double100.0
The percentage allocated to the model, expressed as a decimal number. Note these must add to 100.
Account.Fees:
array of mixed
Contains any fees that are overridden from their default values
Account.Fees.Id:
stringAU3400
The ID of the fee that has been overridden (valid IDs are in the PDS response).
Account.Fees.FeeType:
integer0
The Fee Type that has been overridden (as per the PDS response)
Account.Fees.Value:
double2.0
The dollar amount or percentage rate per year for the fee.
Account.Fees.IsPercent:
booleantrue
Whether Fees.Value is a dollar amount or a percentage
Account.Fees.IncludesTax:
booleantrue
Whether Fees.Value includes taxes
Account.EmployerContributions:
booleanfalse
For SuperSMA (Accumulation accounts) whether the member's (the investor for SuperSMA accounts) employer will be making contributions.
Account.FeeInstructions:
array of mixed
Contains the instructions (see below) on the model(s) to sell down to fund fees
Account.IncomeInstructions:
array of mixed
Contains the instructions (see below) on the model(s) to reinvest any income that the account receives into
Account.ContributionSources:
array of mixed
Contains details on the investors' accounts in external super funds that will be used to fund this account.
Account.ContributionSources.SourceOfContribution:
stringBendigo SmartStart Super (STL0050AU), Member 1
Details of the external account
Account.ContributionSources.EntireBalance:
booleantrue
Whether the entire balance of the external fund account will be transferred
Account.ContributionSources.ExpectedAmount:
double10000
If Account.ContributionSources.EntireBalance is FALSE, the amount to be transferred
Account.Transfers:
array of mixed
Contains details on the investors' other SuperSMA account(s) that will be used to fund this account.
Account.Transfers.TransferFromAccountID:
string
The ID of the other SuperSMA account that will be the source of funds
Account.Transfers.TransferMethod:
string
WholeAmountWithClose or WholeAmountKeepOpen or SpecifiedAmount - whether the source account will be kept open
Account.Transfers.Amount:
string
If Account.Transfers.TransferMethod is WholeAmountKeepOpenSpecifiedAmount, the amount to be transferred across
Account.OtherContributions:
array of mixed
Contains details of other assets that will be used to fund this account.
Account.OtherContributions.ContributionType:
string
The source of the funds: Unknown = 0, ConcessionalEmployee = 11, ConcessionalPersonal = 12, ConcessionalOtherFriendsAndFamily = 13, NonConcessionalPersonal = 21, NonConcessionalSpouseAndChild = 22, NonConcessionalFirstHomeSaverAccount = 23, ExemptCgt15Year = 31, ExemptCgtRetirement = 32, ExemptPersonalInjuryElection = 33, OtherGovernmentCoContribution = 41, OtherLowIncomeSuperContribution = 42
Account.RegularContributionAmount:
double200.00
If a bank account has been supplied with the RCP usage, the amount of the regular contributions must be specified
Account.ContributionType:
integer21
The source of the funds for regular contributions: NonConcessionalPersonal = 21, NonConcessionalSpouseAndChild = 22
Account.InitialInvestmentAmount:
double200.0
The amount of cash that will be invested in the account
Account.InitialInvestmentType:
integer21
The source of the funds for initial investment: NonConcessionalPersonal = 21, NonConcessionalSpouseAndChild = 22

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
[block:callout] { "type": "info", "title": "What are \"instructions\"?", "body": "Investors can choose to have certain cash flows into or out of an account, funded by or invested into, one or more of the models they are invested in, rather than being pro-rated between their models. We call these choices 'cashflow instructions. The instructions arrays include the details of these." } [/block] [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "title": "What are \"instructions\"?", "body": "Investors can choose to have certain cash flows into or out of an account, funded by or invested into, one or more of the models they are invested in, rather than being pro-rated between their models. We call these choices 'cashflow instructions. The instructions arrays include the details of these." } [/block] [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block]
{"_id":"5d8b0b31c4b9960018c59a25","category":"5d8b0b31c4b9960018c59a01","user":"55a49cd3e6c2470d002a648c","project":"55ca8813e583751700f78a58","parentDoc":null,"version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-21T07:00:30.678Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"Pension","code":"POST http://{URL as provided}/Account HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\nPension account creation:\n{\n  \"Type\": 5,\n  \"Account\":{\n      \"AdviserId\": \"jjones@jones.com\",\n      \"Name\": \"Pension Account 1\",\n      \"AdviserReference\": null,\n      \"EntityType\": 0,\n      \"PdsId\": \"AU85\",\n      \"ProductId\": null,\n      \"ProviderReference\": null,\n      \"CurrencyCode\": \"AUD\",\n      \"BankAccounts\":[\n         {\n            \"Bsb\":\"062000\",\n            \"AccountNumber\":\"13145716\",\n            \"AccountName\":\"Miss Jane Smith\"\n         }],\n        \"Models\": [\n          {\n            \"ModelCode\": \"EA0001\",\n            \"ModelPercent\": 100.0\n          }\n        ],\n        \"Fees\": [\n          {\n            \"Id\": \"AU5328\",\n            \"FeeType\": 0,\n            \"Value\": 1.0,\n            \"IsPercent\": true,\n            \"IncludesTax\": true\n          }\n        ],\n        \"FeeInstructions\": null,\n        \"IncomeInstructions\": null,\n        \"ContributionSources\": [\n          {\n            \"SourceOfContribution\": \"Bendigo SmartStart Super (STL0050AU), Member 1\",\n            \"EntireBalance\": true,\n            \"ExpectedAmount\": 0.0\n          }\n        ],\n        \"Transfers\": [\n          {\n            \"TransferFromAccountId\": \"AU111222\",\n            \"TransferMethod\": \"WholeAmountKeepOpenSpecifiedAmount\",\n            \"Amount\": 10000.00\n          } \n        ],\n        \"OtherContributions\": [\n          {\n            \"ContributionType\": 11,\n            \"ExpectedAmount\": 250.00\n          }\n        ],\n      \"PaymentType\": 0,\n      \"PaymentAmount\": 1000,\n      \"PaymentFrequency\": 1\n  }\n}\n","language":"json"}]},"method":"post","results":{"codes":[{"code":"{  \n   \"CreationStatus\":0,\n   \"Account\":{  \n      \"Code\":\"SMA00233601\",\n      \"Id\":\"AU233601\",\n      \"Name\":\"Pension Account 1\",\n      \"Status\":1,\n      \"Type\":5\n   }\n}","language":"json","status":201,"name":""},{"code":"{  \n    \"CreationStatus\":1,\n    \"ValidationMessage\":\"The fee specified '34001' is not valid for this account.\"\n}","status":400,"language":"json"}]},"settings":"","auth":"required","params":[{"_id":"55dfe5693d8bfd0d00c65dca","ref":"","in":"body","required":true,"desc":"SuperSMA Pension (TTR - Transition to retirement) = 5 SuperSMA Pension (ABP - Account based pension) = 6","default":"1","type":"int","name":"Type"},{"_id":"55f0c77078661c170035e149","ref":"","in":"body","required":false,"desc":"Contains the account data.","default":"","type":"object","name":"Account"},{"_id":"55dfe5693d8bfd0d00c65dc9","ref":"","in":"body","required":true,"desc":"The name of the account holder","default":"Miss Jane Smith","type":"string","name":"Account.Name"},{"_id":"55dfe5693d8bfd0d00c65dc8","ref":"","in":"body","required":false,"desc":"The user ID that you have been provided with","default":"admin@abcd.com.au","type":"string","name":"Account.AdviserId"},{"_id":"55dfe5693d8bfd0d00c65dc7","ref":"","in":"body","required":false,"desc":"Not required for our Australian product","default":"","type":"string","name":"Account.AdviserReference"},{"_id":"55dfe5693d8bfd0d00c65dc4","ref":"","in":"body","required":true,"desc":"The `PdsID` (from the PDS endpoint) of the product that the account will be invested in","default":"AU5","type":"string","name":"Account.PdsId"},{"_id":"55e64b5460a3390d00407a4b","ref":"","in":"body","required":false,"desc":"Not required for our Australian product","default":"","type":"string","name":"Account.ProductID"},{"_id":"55dfe5693d8bfd0d00c65dc5","ref":"","in":"body","required":true,"desc":"Our code for the tax entity type for the account. In the API we currently handle 0 = Individual (use for SuperSMA)","default":"0","type":"int","name":"Account.EntityType"},{"_id":"55dfe5693d8bfd0d00c65dc3","ref":"","in":"body","required":false,"desc":"Not required for our Australian product","default":"","type":"string","name":"Account.ProviderReference"},{"_id":"55dfe5693d8bfd0d00c65dc2","ref":"","in":"body","required":false,"desc":"The account's base currency. Must (currently) be AUD for our Australian product","default":"AUD","type":"string","name":"Account.CurrencyCode"},{"_id":"55dff54c34d6830d0091c597","ref":"","in":"body","required":false,"desc":"Contains the investment models linked to the account","default":"","type":"array_mixed","name":"Account.Models"},{"_id":"55dff54c34d6830d0091c596","ref":"","in":"body","required":false,"desc":"Our code for the investment model. Valid codes are in the PDS response","default":"SM0001","type":"string","name":"Account.Models.ModelCode"},{"_id":"55dff54c34d6830d0091c595","ref":"","in":"body","required":false,"desc":"The percentage allocated to the model, expressed as a decimal number. Note these must add to 100.","default":"100.0","type":"double","name":"Account.Models.ModelPercent"},{"_id":"55dff54c34d6830d0091c594","ref":"","in":"body","required":false,"desc":"Contains any fees that are overridden from their default values","default":"","type":"array_mixed","name":"Account.Fees"},{"_id":"55dff54c34d6830d0091c593","ref":"","in":"body","required":false,"desc":"The ID of the fee that has been overridden (valid IDs are in the PDS response).","default":"AU3400","type":"string","name":"Account.Fees.Id"},{"_id":"55dff54c34d6830d0091c592","ref":"","in":"body","required":false,"desc":"The Fee Type that has been overridden (as per the PDS response)","default":"0","type":"int","name":"Account.Fees.FeeType"},{"_id":"55dff54c34d6830d0091c591","ref":"","in":"body","required":false,"desc":"The dollar amount or percentage rate per year for the fee.","default":"2.0","type":"double","name":"Account.Fees.Value"},{"_id":"55dff54c34d6830d0091c590","ref":"","in":"body","required":false,"desc":"Whether Fees.Value is a dollar amount or a percentage","default":"true","type":"boolean","name":"Account.Fees.IsPercent"},{"_id":"55dff54c34d6830d0091c58f","ref":"","in":"body","required":false,"desc":"Whether Fees.Value includes taxes","default":"true","type":"boolean","name":"Account.Fees.IncludesTax"},{"_id":"56fcb50fcaad892200847ab2","ref":"","in":"body","required":false,"desc":"Contains the instructions (see below) on the model(s) to sell down to fund fees","default":"","type":"array_mixed","name":"Account.FeeInstructions"},{"_id":"56fcb50fcaad892200847ab1","ref":"","in":"body","required":false,"desc":"Contains the instructions (see below) on the model(s) to reinvest any income that the account receives into","default":"","type":"array_mixed","name":"Account.IncomeInstructions"},{"_id":"56fcb50fcaad892200847ab0","ref":"","in":"body","required":false,"desc":"Contains details on the investors' accounts in external super funds that will be used to fund this account.","default":"","type":"array_mixed","name":"Account.ContributionSources"},{"_id":"56fcb50fcaad892200847aaf","ref":"","in":"body","required":false,"desc":"Details of the external account","default":"Bendigo SmartStart Super (STL0050AU), Member 1","type":"string","name":"Account.ContributionSources.SourceOfContribution"},{"_id":"56fcb50fcaad892200847aae","ref":"","in":"body","required":false,"desc":"Whether the entire balance of the external fund account will be transferred","default":"true","type":"boolean","name":"Account.ContributionSources.EntireBalance"},{"_id":"56fcb50fcaad892200847aad","ref":"","in":"body","required":false,"desc":"If Account.ContributionSources.EntireBalance is FALSE, the amount to be transferred","default":"10000","type":"double","name":"Account.ContributionSources.ExpectedAmount"},{"_id":"56fcb50fcaad892200847aac","ref":"","in":"body","required":false,"desc":"Contains details on the investors' other SuperSMA account(s) that will be used to fund this account.","default":"","type":"array_mixed","name":"Account.Transfers"},{"_id":"5714851a4007610e00c80393","ref":"","in":"body","required":false,"desc":"The ID of the other SuperSMA account that will be the source of funds","default":"","type":"string","name":"Account.Transfers.TransferFromAccountID"},{"_id":"5714851a4007610e00c80392","ref":"","in":"body","required":false,"desc":"WholeAmountWithClose or WholeAmountKeepOpenSpecifiedAmount - whether the source account will be kept open","default":"","type":"string","name":"Account.Transfers.TransferMethod"},{"_id":"5714851a4007610e00c80391","ref":"","in":"body","required":false,"desc":"If Account.Transfers.TransferMethod is WholeAmountKeepOpenSpecifiedAmount, the amount to be transferred across","default":"","type":"string","name":"Account.Transfers.Amount"},{"_id":"56fcb50fcaad892200847aab","ref":"","in":"body","required":false,"desc":"Contains details of other assets that will be used to fund this account.","default":"","type":"array_mixed","name":"Account.OtherContributions"},{"_id":"5714851a4007610e00c80390","ref":"","in":"body","required":false,"desc":"The source of the funds: Unknown = 0, ConcessionalEmployee = 11, ConcessionalPersonal = 12, ConcessionalOtherFriendsAndFamily = 13, NonConcessionalPersonal = 21, NonConcessionalSpouseAndChild = 22, NonConcessionalFirstHomeSaverAccount = 23, ExemptCgt15Year = 31, ExemptCgtRetirement = 32, ExemptPersonalInjuryElection = 33, OtherGovernmentCoContribution = 41, OtherLowIncomeSuperContribution = 42","default":"","type":"string","name":"Account.OtherContributions.ContributionType"},{"_id":"57187a8e459f6f0e007504ef","ref":"","in":"body","required":false,"desc":"Contains the details of the external bank account(s) that we will take funds from or pay funds to. For a pension account, this is the bank account that the pension will be paid out to,","default":"","type":"array_mixed","name":"BankAccounts"},{"_id":"57187a8e459f6f0e007504ee","ref":"","in":"body","required":false,"desc":"A standard ABA Bank State Branch number","default":"062000","type":"string","name":"Account.BankAccounts.BSB"},{"_id":"57187a8e459f6f0e007504ed","ref":"","in":"body","required":false,"desc":"The bank account number","default":"13145715","type":"string","name":"Account.BankAccounts.AccountNumber"},{"_id":"57187a8e459f6f0e007504ec","ref":"","in":"body","required":false,"desc":"The name linked to the bank account","default":"Miss Jane Smith","type":"string","name":"Account.BankAccounts.AccountName"},{"_id":"57187a8e459f6f0e007504eb","ref":"","in":"body","required":false,"desc":"Whether the pension payment will be (0) a specified amount; (1) the minimum amount; or (2) the maximum amount","default":"0","type":"string","name":"Account.PaymentType"},{"_id":"571f0a01c10a771700e93ce4","ref":"","in":"body","required":false,"desc":"Monthly = 1, ThreeMonthly = 3, SixMonthly= 6, Annually = 12","default":"1","type":"string","name":"Account.PaymentFrequency"},{"_id":"571f0a01c10a771700e93ce3","ref":"","in":"body","required":false,"desc":"The payment amount to/from the account","default":"1000","type":"string","name":"Account.PaymentAmount"},{"_id":"571f0abed8667f0e00a3c3fa","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"Consolidation"},{"_id":"5ada8ad12c87d800035ebf8a","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8ef0325ad3000338d588","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Accounts"},"isReference":true,"order":4,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"What are \\\"instructions\\\"?\",\n  \"body\": \"Investors can choose to have certain cash flows into or out of an account funded by or invested into one or more of the models they are invested in, rather than being pro-rated between their models. We call these choices 'cashflow instructions. The instructions arrays include the details of these.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **SMA/Robo, Enterprise**\"\n}\n[/block]","excerpt":"This endpoint creates an Retail Super - Pension account in the system.","slug":"accounts-pension","type":"post","title":"Retail Super-Pension","__v":16,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postRetail Super-Pension

This endpoint creates an Retail Super - Pension account in the system.

Body Params

Type:
required
integer1
SuperSMA Pension (TTR - Transition to retirement) = 5 SuperSMA Pension (ABP - Account based pension) = 6
Account:
object
Contains the account data.
Account.Name:
required
stringMiss Jane Smith
The name of the account holder
Account.AdviserId:
stringadmin@abcd.com.au
The user ID that you have been provided with
Account.AdviserReference:
string
Not required for our Australian product
Account.PdsId:
required
stringAU5
The `PdsID` (from the PDS endpoint) of the product that the account will be invested in
Account.ProductID:
string
Not required for our Australian product
Account.EntityType:
required
integer0
Our code for the tax entity type for the account. In the API we currently handle 0 = Individual (use for SuperSMA)
Account.ProviderReference:
string
Not required for our Australian product
Account.CurrencyCode:
stringAUD
The account's base currency. Must (currently) be AUD for our Australian product
Account.Models:
array of mixed
Contains the investment models linked to the account
Account.Models.ModelCode:
stringSM0001
Our code for the investment model. Valid codes are in the PDS response
Account.Models.ModelPercent:
double100.0
The percentage allocated to the model, expressed as a decimal number. Note these must add to 100.
Account.Fees:
array of mixed
Contains any fees that are overridden from their default values
Account.Fees.Id:
stringAU3400
The ID of the fee that has been overridden (valid IDs are in the PDS response).
Account.Fees.FeeType:
integer0
The Fee Type that has been overridden (as per the PDS response)
Account.Fees.Value:
double2.0
The dollar amount or percentage rate per year for the fee.
Account.Fees.IsPercent:
booleantrue
Whether Fees.Value is a dollar amount or a percentage
Account.Fees.IncludesTax:
booleantrue
Whether Fees.Value includes taxes
Account.FeeInstructions:
array of mixed
Contains the instructions (see below) on the model(s) to sell down to fund fees
Account.IncomeInstructions:
array of mixed
Contains the instructions (see below) on the model(s) to reinvest any income that the account receives into
Account.ContributionSources:
array of mixed
Contains details on the investors' accounts in external super funds that will be used to fund this account.
Account.ContributionSources.SourceOfContribution:
stringBendigo SmartStart Super (STL0050AU), Member 1
Details of the external account
Account.ContributionSources.EntireBalance:
booleantrue
Whether the entire balance of the external fund account will be transferred
Account.ContributionSources.ExpectedAmount:
double10000
If Account.ContributionSources.EntireBalance is FALSE, the amount to be transferred
Account.Transfers:
array of mixed
Contains details on the investors' other SuperSMA account(s) that will be used to fund this account.
Account.Transfers.TransferFromAccountID:
string
The ID of the other SuperSMA account that will be the source of funds
Account.Transfers.TransferMethod:
string
WholeAmountWithClose or WholeAmountKeepOpenSpecifiedAmount - whether the source account will be kept open
Account.Transfers.Amount:
string
If Account.Transfers.TransferMethod is WholeAmountKeepOpenSpecifiedAmount, the amount to be transferred across
Account.OtherContributions:
array of mixed
Contains details of other assets that will be used to fund this account.
Account.OtherContributions.ContributionType:
string
The source of the funds: Unknown = 0, ConcessionalEmployee = 11, ConcessionalPersonal = 12, ConcessionalOtherFriendsAndFamily = 13, NonConcessionalPersonal = 21, NonConcessionalSpouseAndChild = 22, NonConcessionalFirstHomeSaverAccount = 23, ExemptCgt15Year = 31, ExemptCgtRetirement = 32, ExemptPersonalInjuryElection = 33, OtherGovernmentCoContribution = 41, OtherLowIncomeSuperContribution = 42
BankAccounts:
array of mixed
Contains the details of the external bank account(s) that we will take funds from or pay funds to. For a pension account, this is the bank account that the pension will be paid out to,
Account.BankAccounts.BSB:
string062000
A standard ABA Bank State Branch number
Account.BankAccounts.AccountNumber:
string13145715
The bank account number
Account.BankAccounts.AccountName:
stringMiss Jane Smith
The name linked to the bank account
Account.PaymentType:
string0
Whether the pension payment will be (0) a specified amount; (1) the minimum amount; or (2) the maximum amount
Account.PaymentFrequency:
string1
Monthly = 1, ThreeMonthly = 3, SixMonthly= 6, Annually = 12
Account.PaymentAmount:
string1000
The payment amount to/from the account
Consolidation:
string

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
[block:callout] { "type": "info", "title": "What are \"instructions\"?", "body": "Investors can choose to have certain cash flows into or out of an account funded by or invested into one or more of the models they are invested in, rather than being pro-rated between their models. We call these choices 'cashflow instructions. The instructions arrays include the details of these." } [/block] [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "title": "What are \"instructions\"?", "body": "Investors can choose to have certain cash flows into or out of an account funded by or invested into one or more of the models they are invested in, rather than being pro-rated between their models. We call these choices 'cashflow instructions. The instructions arrays include the details of these." } [/block] [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block]
{"_id":"5d8b0b31c4b9960018c59a26","category":"5d8b0b31c4b9960018c59a01","user":"55ca87c48705a70d00b8fc5c","parentDoc":null,"project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-25T06:38:51.260Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"POST http://{URL as provided}/Applicants HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\n{  \n  \"Type\":1,\n  \"Applicant\":{  \n    \"AccountId\":\"AU233692\",\n    \"AdviserId\":\"admin@abcd.com.au\",\n    \"TaxDomiclieCountryCode\":\"AUD\",\n    \"Profession\":\"\",\n    \"SourceOfFunds\":\"\",\n    \"IsPolitcallyExposedPerson\":true,\n    \"SourceofWealth\":\"\",\n    \"TaxRateElection\":\"RABN\",\n    \"TaxDomicileCountryCode\":\"AUS\",\n    \"Name\":{  \n      \"Title\":\"Mr\",\n      \"First\":\"John\",\n      \"Last\":\"Smith\"\n    },\n    \"DateOfBirth\":\"1987-09-20\",\n    \"Email\":\"johnsmith@smith.com\",\n    \"BirthCountryCode\":\"AUS\",\n    \"CitizenshipCountryCode\":\"AUS\",\n    \"Addresses\":[  \n      {  \n        \"Type\":0,\n        \"Line1\":\"50 Queen Street\",\n        \"Line2\":\"Melbourne\",\n        \"SuburbCounty\":\"Melbourne\",\n        \"TownCityState\":\"Vic\",\n        \"Postcode\":3000,\n        \"CountryCode\":\"AUS\"\n      }\n    ],\n    \"Phone\":\"+61 (3) 1111 2222\",\n    \"PhoneOther\":\"\",\n    \"IsSignatory\":true,\n    \"SignatureImage\":null,\n    \"IsPoliticallyExposedPerson\":false,\n    \"Identification\":[  \n      {  \n        \"IdNumber\":\"123456782\",\n        \"Type\":5\n      }\n    ]\n  }\n}","language":"json","name":""}]},"method":"post","results":{"codes":[{"name":"","code":"[  \n  {  \n    \"CreationStatus\":0,\n    \"Applicant\":{  \n      \"Id\":\"AU21996\"\n    }\n  },\n]","language":"json","status":201}]},"settings":"","auth":"required","params":[{"_id":"55f0bb2278661c170035e12a","ref":"","in":"body","required":true,"desc":"1=Individual","default":"1","type":"int","name":"Type"},{"_id":"55f0c5cf78661c170035e146","ref":"","in":"body","required":false,"desc":"Contains the applicant data. When we have more types, the contents will be customisable based on Applicant.Type","default":"","type":"object","name":"Applicant"},{"_id":"5615f5121651730d005048e6","ref":"","in":"body","required":false,"desc":"The user ID that you have been provided with","default":"admin@abcd.com.au","type":"string","name":"Applicant.AdviserId"},{"_id":"55de478d9db51a0d006494e4","ref":"","in":"body","required":true,"desc":"The `AccountID` as returned by the Accounts endpoint.","default":"AU228403","type":"string","name":"Applicant.AccountId"},{"_id":"55de478d9db51a0d006494de","ref":"","in":"body","required":true,"desc":"","default":"","type":"array_mixed","name":"Applicant.Name"},{"_id":"55de478d9db51a0d006494dc","ref":"","in":"body","required":true,"desc":"The applicant's first name","default":"John","type":"string","name":"Applicant.Name.First"},{"_id":"55de478d9db51a0d006494db","ref":"","in":"body","required":true,"desc":"The applicant's last name","default":"Smith","type":"string","name":"Applicant.Name.Last"},{"_id":"55de478d9db51a0d006494dd","ref":"","in":"body","required":true,"desc":"The applicant's title. Valid values are: Mr, Mrs, Ms, Miss, Doctor, Lady, Prof and Sir","default":"Mr","type":"string","name":"Applicant.Name.Title"},{"_id":"55de478d9db51a0d006494da","ref":"","in":"body","required":true,"desc":"The applicant's date of birth","default":"1987-09-20","type":"yyyy-mm-dd","name":"Applicant.DateOfBirth"},{"_id":"55de478d9db51a0d006494d9","ref":"","in":"body","required":true,"desc":"The applicant's email","default":"johnsmith@smith.com","type":"string","name":"Applicant.Email"},{"_id":"55de67219db51a0d0064950d","ref":"","in":"body","required":true,"desc":"The primary contact number for the applicant","default":"+61 (3) 1111 2222","type":"string","name":"Applicant.Phone"},{"_id":"55de67219db51a0d0064950c","ref":"","in":"body","required":false,"desc":"A secondary contact number for the applicant","default":"True","type":"string","name":"Applicant.PhoneOther"},{"_id":"55de478d9db51a0d006494d6","ref":"","in":"body","required":true,"desc":"","default":"","type":"array_string","name":"Applicant.Addresses"},{"_id":"55de478d9db51a0d006494d5","ref":"","in":"body","required":true,"desc":"Home = 0, Office = 1, Mailing = 2, PrincipalPlaceOfBusiness = 3. We only need 0, and 2 if it is different.","default":"0","type":"int","name":"Applicant.Addresses.Type"},{"_id":"55de478d9db51a0d006494d4","ref":"","in":"body","required":true,"desc":"","default":"50 Queen Street","type":"string","name":"Applicant.Addresses.Line1"},{"_id":"55de478d9db51a0d006494d3","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"Applicant.Addresses.Line2"},{"_id":"55de478d9db51a0d006494d2","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"Applicant.Addresses.Line3"},{"_id":"55de478d9db51a0d006494d1","ref":"","in":"body","required":true,"desc":"For Australian addresses, this must be one of the locations associated with the postcode by Australia Post.","default":"Melbourne","type":"string","name":"Applicant.Addresses.SuburbCounty"},{"_id":"55de478d9db51a0d006494d0","ref":"","in":"body","required":false,"desc":"","default":"VIC","type":"string","name":"Applicant.Addresses.TownCityState"},{"_id":"55de478d9db51a0d006494cf","ref":"","in":"body","required":true,"desc":"For Australian addresses, this must be the postcode that corresponds to what you have passed in SuburbCountry.","default":"3000","type":"string","name":"Applicant.Addresses.PostCode"},{"_id":"55de478d9db51a0d006494ce","ref":"","in":"body","required":false,"desc":"The ISO alpha-3 code for the country the address is in","default":"AUS","type":"string","name":"Addresses.CountryCode"},{"_id":"55de67219db51a0d0064950b","ref":"","in":"body","required":true,"desc":"Whether the applicant is a signatory on the account. We require one signatory for individual and SuperSMA accounts, and all joint account holders must be signatories","default":"","type":"boolean","name":"Applicant.IsSignatory"},{"_id":"569593ebcaa32519009c423e","ref":"","in":"body","required":false,"desc":"A base64 string representing an image of the applicant's signature. To prevent distortion of the image when it is printed, please ensure the width of the image is five times the height.","default":"","type":"string","name":"Applicant.SignatureImage"},{"_id":"55de478d9db51a0d006494df","ref":"","in":"body","required":true,"desc":"Our code for the applicant's tax status - RTFN = Resident with TFN, RABN = Resident with ABN, NRWT = Non resident of Australia, NTFN = Resident of Australia without a TFN","default":"RTFN","type":"string","name":"Applicant.TaxRateElection"},{"_id":"55de478d9db51a0d006494e3","ref":"","in":"body","required":true,"desc":"The ISO alpha-3 code for the country where the applicant is resident for tax purposes","default":"AUD","type":"string","name":"Applicant.TaxDomicileCountryCode"},{"_id":"55de478d9db51a0d006494e2","ref":"","in":"body","required":false,"desc":"For Anti Money Laundering (AML) checks. Not required for our Australian SMA offering","default":"","type":"string","name":"Applicant.Profession"},{"_id":"55de478d9db51a0d006494e1","ref":"","in":"body","required":false,"desc":"For Anti Money Laundering (AML) checks. Not required for our Australian SMA offering","default":"","type":"string","name":"Applicant.SourceOfFunds"},{"_id":"55e653e627a31d0d00901beb","ref":"","in":"body","required":false,"desc":"For Anti Money Laundering (AML) checks. Not required for our Australian SMA offering","default":"","type":"string","name":"Applicant.SourceOfWealth"},{"_id":"55de478d9db51a0d006494e0","ref":"","in":"body","required":false,"desc":"For Anti Money Laundering (AML) checks. Not required for our Australian SMA offering","default":"","type":"string","name":"Applicant.IsPoliticallyExposedPerson"},{"_id":"55de478d9db51a0d006494d8","ref":"","in":"body","required":false,"desc":"The ISO alpha-3 code for the applicant's country of birth. For Anti Money Laundering (AML) checks. Not required for our Australian SMA offering","default":"AUS","type":"string","name":"Applicant.BirthCountryCode"},{"_id":"55de478d9db51a0d006494d7","ref":"","in":"body","required":true,"desc":"The ISO alpha-3 code for the applicant's country of citizenship","default":"AUS","type":"string","name":"Applicant.CitzenshipCountryCode"},{"_id":"55de67219db51a0d0064950a","ref":"","in":"body","required":false,"desc":"In Australia, this object contains the applicant's TFN or ABN","default":"","type":"array_string","name":"Applicant.Identification"},{"_id":"55de67219db51a0d00649509","ref":"","in":"body","required":false,"desc":"The TFN or ABN. For SuperSMA accounts we require a TFN.","default":"123456782","type":"string","name":"Applicant.Identification.IdNumber"},{"_id":"55de67219db51a0d00649508","ref":"","in":"body","required":false,"desc":"The type of identification. 0=US TIN, 4= ABN, 5=TFN","default":"5","type":"int","name":"Applicant.Identification.Type"},{"_id":"55de67219db51a0d00649507","ref":"","in":"body","required":false,"desc":"For Anti Money Laundering (AML) checks. Not required for our Australian SMA offering.","default":"","type":"string","name":"Applicant.Identification.BirthTown"},{"_id":"5acacb008bdbeb0003ac3675","ref":"","in":"body","required":false,"desc":"Required for SuperSma applicants. M or F.","default":"","type":"string","name":"Applicant.Sex"},{"_id":"5ad97bbfa5f7bd0003cc6435","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8f02325ad3000338d589","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Applicants"},"isReference":true,"order":5,"body":"These may be, for example, individual investors, SuperSMA fund members, directors or trustees.\n\nFor digital signatures, which appear on any resulting app forms should you need those printed/produced, see `Applicant.SignatureImage` and other components as above \n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **SMA/Robo, Enterprise**\"\n}\n[/block]","excerpt":"This endpoint is used to send details of the entity or entities associated with an account.","slug":"applicants","type":"post","title":"Applicants","__v":19,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postApplicants

This endpoint is used to send details of the entity or entities associated with an account.

Body Params

Type:
required
integer1
1=Individual
Applicant:
object
Contains the applicant data. When we have more types, the contents will be customisable based on Applicant.Type
Applicant.AdviserId:
stringadmin@abcd.com.au
The user ID that you have been provided with
Applicant.AccountId:
required
stringAU228403
The `AccountID` as returned by the Accounts endpoint.
Applicant.Name:
required
array of mixed
Applicant.Name.First:
required
stringJohn
The applicant's first name
Applicant.Name.Last:
required
stringSmith
The applicant's last name
Applicant.Name.Title:
required
stringMr
The applicant's title. Valid values are: Mr, Mrs, Ms, Miss, Doctor, Lady, Prof and Sir
Applicant.DateOfBirth:
required
yyyy-mm-dd1987-09-20
The applicant's date of birth
Applicant.Email:
required
stringjohnsmith@smith.com
The applicant's email
Applicant.Phone:
required
string+61 (3) 1111 2222
The primary contact number for the applicant
Applicant.PhoneOther:
stringTrue
A secondary contact number for the applicant
Applicant.Addresses:
required
array of strings
Applicant.Addresses.Type:
required
integer0
Home = 0, Office = 1, Mailing = 2, PrincipalPlaceOfBusiness = 3. We only need 0, and 2 if it is different.
Applicant.Addresses.Line1:
required
string50 Queen Street
Applicant.Addresses.Line2:
string
Applicant.Addresses.Line3:
string
Applicant.Addresses.SuburbCounty:
required
stringMelbourne
For Australian addresses, this must be one of the locations associated with the postcode by Australia Post.
Applicant.Addresses.TownCityState:
stringVIC
Applicant.Addresses.PostCode:
required
string3000
For Australian addresses, this must be the postcode that corresponds to what you have passed in SuburbCountry.
Addresses.CountryCode:
stringAUS
The ISO alpha-3 code for the country the address is in
Applicant.IsSignatory:
required
boolean
Whether the applicant is a signatory on the account. We require one signatory for individual and SuperSMA accounts, and all joint account holders must be signatories
Applicant.SignatureImage:
string
A base64 string representing an image of the applicant's signature. To prevent distortion of the image when it is printed, please ensure the width of the image is five times the height.
Applicant.TaxRateElection:
required
stringRTFN
Our code for the applicant's tax status - RTFN = Resident with TFN, RABN = Resident with ABN, NRWT = Non resident of Australia, NTFN = Resident of Australia without a TFN
Applicant.TaxDomicileCountryCode:
required
stringAUD
The ISO alpha-3 code for the country where the applicant is resident for tax purposes
Applicant.Profession:
string
For Anti Money Laundering (AML) checks. Not required for our Australian SMA offering
Applicant.SourceOfFunds:
string
For Anti Money Laundering (AML) checks. Not required for our Australian SMA offering
Applicant.SourceOfWealth:
string
For Anti Money Laundering (AML) checks. Not required for our Australian SMA offering
Applicant.IsPoliticallyExposedPerson:
string
For Anti Money Laundering (AML) checks. Not required for our Australian SMA offering
Applicant.BirthCountryCode:
stringAUS
The ISO alpha-3 code for the applicant's country of birth. For Anti Money Laundering (AML) checks. Not required for our Australian SMA offering
Applicant.CitzenshipCountryCode:
required
stringAUS
The ISO alpha-3 code for the applicant's country of citizenship
Applicant.Identification:
array of strings
In Australia, this object contains the applicant's TFN or ABN
Applicant.Identification.IdNumber:
string123456782
The TFN or ABN. For SuperSMA accounts we require a TFN.
Applicant.Identification.Type:
integer5
The type of identification. 0=US TIN, 4= ABN, 5=TFN
Applicant.Identification.BirthTown:
string
For Anti Money Laundering (AML) checks. Not required for our Australian SMA offering.
Applicant.Sex:
string
Required for SuperSma applicants. M or F.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
These may be, for example, individual investors, SuperSMA fund members, directors or trustees. For digital signatures, which appear on any resulting app forms should you need those printed/produced, see `Applicant.SignatureImage` and other components as above [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



These may be, for example, individual investors, SuperSMA fund members, directors or trustees. For digital signatures, which appear on any resulting app forms should you need those printed/produced, see `Applicant.SignatureImage` and other components as above [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block]
{"_id":"5d8b0b31c4b9960018c59a43","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","category":"5d8b0b31c4b9960018c59a01","user":"5b6a77482abf4e0003e8eb5d","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-05-23T06:37:55.975Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"name":"","code":"[  \n  {  \n    \"Index\":1,\n    \"CreationStatus\":0,\n    \"Applicant\":{  \n      \"Id\":\"AU21996\"\n    }\n  },\n  {  \n    \"Index\":2,\n    \"CreationStatus\":0,\n    \"Applicant\":{  \n      \"Id\":\"AU21997\"\n    }\n  }\n]","language":"json","status":201},{"code":"[  \n  {  \n    \"Index\":1,\n    \"CreationStatus\":0,\n    \"Applicant\":{  \n      \"Id\":\"AU21996\"\n    }\n  },\n  {  \n    \"Index\":2,\n    \"CreationStatus\":1,\n    \"ValidationMessage\":\"This account is individual and already has 1 investors associated with it, no more can be added.\"\n  }\n]","language":"json","name":"207 Multi Status"},{"code":"[  \n  {  \n    \"Index\":1,\n    \"CreationStatus\":1,\n    \"ValidationMessage\":\"This account is individual and already has 1 investors associated with it, no more can be added.\"\n  },\n  {  \n    \"Index\":2,\n    \"CreationStatus\":1,\n    \"ValidationMessage\":\"This account is individual and already has 1 investors associated with it, no more can be added.\"\n  }\n]","language":"json","status":400}]},"method":"post","examples":{"codes":[{"code":"POST http://{URL as provided}/Applicants HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\n[  \n  {  \n    \"Type\":1,\n    \"Applicant\":{  \n      \"AccountId\":\"AU233690\",\n      \"AdviserId\":\"admin@abcd.com.au\",\n      \"TaxDomiclieCountryCode\":\"AUD\",\n      \"Profession\":\"\",\n      \"SourceOfFunds\":\"\",\n      \"IsPolitcallyExposedPerson\":true,\n      \"SourceofWealth\":\"\",\n      \"TaxRateElection\":\"RABN\",\n      \"TaxDomicileCountryCode\":\"AUD\",\n      \"Name\":{  \n        \"Title\":\"Mr\",\n        \"First\":\"John\",\n        \"Last\":\"Smith\"\n      },\n      \"DateOfBirth\":\"1987-09-20\",\n      \"Email\":\"johnsmith@smith.com\",\n      \"BirthCountryCode\":\"AUS\",\n      \"BirthTown\": \"Melbourne\",\n      \"CitizenshipCountryCode\":\"AUS\",\n      \"Addresses\":[  \n        {  \n          \"Type\":\"Home\",\n          \"Line1\":\"367 Collins Street\",\n          \"Line2\":\"Melbourne\",\n          \"SuburbCounty\":\"Melbourne\",\n          \"TownCityState\":\"Vic\",\n          \"Postcode\":3000,\n          \"CountryCode\":\"AUS\"\n        }\n      ],\n      \"Phone\":\"+61 (3) 1111 2222\",\n      \"PhoneOther\":\"\",\n      \"IsSignatory\":true,\n      \"Signature_image\":\"\",\n      \"IsPoliticallyExposedPerson\":false,\n      \"Identification\":[  \n        {  \n          \"IdNumber\":\"123456782\",\n          \"Type\":5\n        }\n      ]\n    }\n  },\n  {  \n    \"Type\":1,\n    \"Applicant\":{  \n      \"AccountId\":\"AU233691\",\n      \"AdviserId\":\"admin@abcd.com.au\",\n      \"TaxDomiclieCountryCode\":\"AUD\",\n      \"Profession\":\"\",\n      \"SourceOfFunds\":\"\",\n      \"IsPolitcallyExposedPerson\":true,\n      \"SourceofWealth\":\"\",\n      \"TaxRateElection\":\"RABN\",\n      \"TaxDomicileCountryCode\":\"AUD\",\n      \"Name\":{  \n        \"Title\":\"Miss\",\n        \"First\":\"Jane\",\n        \"Last\":\"Smith\"\n      },\n      \"DateOfBirth\":\"1987-09-20\",\n      \"Email\":\"janesmith@smith.com\",\n      \"BirthCountryCode\":\"AUS\",\n      \"BirthTown\": \"Melbourne\",\n      \"CitizenshipCountryCode\":\"AUS\",\n      \"Addresses\":[  \n        {  \n          \"Type\":\"Home\",\n          \"Line1\":\"367 Collins Street\",\n          \"Line2\":\"Melbourne\",\n          \"SuburbCounty\":\"Melbourne\",\n          \"TownCityState\":\"Vic\",\n          \"Postcode\":3000,\n          \"CountryCode\":\"AUS\"\n        }\n      ],\n      \"Phone\":\"+61 (3) 1111 2222\",\n      \"PhoneOther\":\"\",\n      \"IsSignatory\":true,\n      \"Signature_image\":\"\",\n      \"IsPoliticallyExposedPerson\":false,\n      \"Identification\":[  \n        {  \n          \"IdNumber\":\"123456782\",\n          \"Type\":5\n        }\n      ]\n    }\n  }\n]","language":"json","name":""}]},"auth":"required","params":[{"_id":"5ce63fc35ca585003f57de7c","ref":"","in":"body","required":false,"desc":"","default":"","type":"array_object","name":"Array of {Type, Applicant}"},{"_id":"55f0bb2278661c170035e12a","ref":"","in":"body","required":true,"desc":"1=Individual","default":"1","type":"int","name":"Type"},{"_id":"55f0c5cf78661c170035e146","ref":"","in":"body","required":false,"desc":"Contains the applicant data. When we have more types, the contents will be customisable based on Applicant.Type","default":"","type":"object","name":"Applicant"},{"_id":"5615f5121651730d005048e6","ref":"","in":"body","required":false,"desc":"The user ID that you have been provided with","default":"admin@abcd.com.au","type":"string","name":"Applicant.AdviserId"},{"_id":"55de478d9db51a0d006494e4","ref":"","in":"body","required":true,"desc":"The `AccountID` as returned by the Accounts endpoint.","default":"AU228403","type":"string","name":"Applicant.AccountId"},{"_id":"55de478d9db51a0d006494de","ref":"","in":"body","required":true,"desc":"","default":"","type":"array_mixed","name":"Applicant.Name"},{"_id":"55de478d9db51a0d006494dc","ref":"","in":"body","required":true,"desc":"The applicant's first name","default":"John","type":"string","name":"Applicant.Name.First"},{"_id":"55de478d9db51a0d006494db","ref":"","in":"body","required":true,"desc":"The applicant's last name","default":"Smith","type":"string","name":"Applicant.Name.Last"},{"_id":"55de478d9db51a0d006494dd","ref":"","in":"body","required":true,"desc":"The applicant's title. Valid values are: Mr, Mrs, Ms, Miss, Doctor, Lady, Prof and Sir","default":"Mr","type":"string","name":"Applicant.Name.Title"},{"_id":"55de478d9db51a0d006494da","ref":"","in":"body","required":true,"desc":"The applicant's date of birth","default":"1987-09-20","type":"yyyy-mm-dd","name":"Applicant.DateOfBirth"},{"_id":"55de478d9db51a0d006494d9","ref":"","in":"body","required":true,"desc":"The applicant's email","default":"johnsmith@smith.com","type":"string","name":"Applicant.Email"},{"_id":"55de67219db51a0d0064950d","ref":"","in":"body","required":true,"desc":"The primary contact number for the applicant","default":"+61 (3) 1111 2222","type":"string","name":"Applicant.Phone"},{"_id":"55de67219db51a0d0064950c","ref":"","in":"body","required":false,"desc":"A secondary contact number for the applicant","default":"True","type":"string","name":"Applicant.PhoneOther"},{"_id":"55de478d9db51a0d006494d6","ref":"","in":"body","required":true,"desc":"","default":"","type":"array_string","name":"Applicant.Addresses"},{"_id":"55de478d9db51a0d006494d5","ref":"","in":"body","required":true,"desc":"Home = 0, Office = 1, Mailing = 2, PrincipalPlaceOfBusiness = 3. We only need 0, and 2 if it is different.","default":"0","type":"int","name":"Applicant.Addresses.Type"},{"_id":"55de478d9db51a0d006494d4","ref":"","in":"body","required":true,"desc":"","default":"50 Queen Street\"","type":"string","name":"Applicant.Addresses.Line1"},{"_id":"55de478d9db51a0d006494d3","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"Applicant.Addresses.Line2"},{"_id":"55de478d9db51a0d006494d2","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"Applicant.Addresses.Line3"},{"_id":"55de478d9db51a0d006494d1","ref":"","in":"body","required":true,"desc":"For Australian addresses, this must be one of the locations associated with the postcode by Australia Post.","default":"Melbourne","type":"string","name":"Applicant.Addresses.SuburbCounty"},{"_id":"55de478d9db51a0d006494d0","ref":"","in":"body","required":false,"desc":"","default":"VIC","type":"string","name":"Applicant.Addresses.TownCityState"},{"_id":"55de478d9db51a0d006494cf","ref":"","in":"body","required":true,"desc":"For Australian addresses, this must be the postcode that corresponds to what you have passed in SuburbCountry.","default":"3000","type":"string","name":"Applicant.Addresses.PostCode"},{"_id":"55de478d9db51a0d006494ce","ref":"","in":"body","required":false,"desc":"The ISO alpha-3 code for the country the address is in","default":"AUS","type":"string","name":"Addresses.CountryCode"},{"_id":"55de67219db51a0d0064950b","ref":"","in":"body","required":true,"desc":"Whether the applicant is a signatory on the account. We require one signatory for individual and SuperSMA accounts, and all joint account holders must be signatories","default":"","type":"boolean","name":"Applicant.IsSignatory"},{"_id":"569593ebcaa32519009c423e","ref":"","in":"body","required":false,"desc":"A base64 string representing an image of the applicant's signature. To prevent distortion of the image when it is printed, please ensure the width of the image is five times the height.","default":"","type":"string","name":"Applicant.SignatureImage"},{"_id":"55de478d9db51a0d006494df","ref":"","in":"body","required":true,"desc":"Our code for the applicant's tax status - RTFN = Resident with TFN, RABN = Resident with ABN, NRWT = Non resident of Australia, NTFN = Resident of Australia without a TFN","default":"RTFN","type":"string","name":"Applicant.TaxRateElection"},{"_id":"55de478d9db51a0d006494e3","ref":"","in":"body","required":true,"desc":"The ISO alpha-3 code for the country where the applicant is resident for tax purposes","default":"AUD","type":"string","name":"Applicant.TaxDomicileCountryCode"},{"_id":"55de478d9db51a0d006494e2","ref":"","in":"body","required":false,"desc":"For Anti Money Laundering (AML) checks. Not required for our Australian SMA offering","default":"","type":"string","name":"Applicant.Profession"},{"_id":"55de478d9db51a0d006494e1","ref":"","in":"body","required":false,"desc":"For Anti Money Laundering (AML) checks. Not required for our Australian SMA offering","default":"","type":"string","name":"Applicant.SourceOfFunds"},{"_id":"55e653e627a31d0d00901beb","ref":"","in":"body","required":false,"desc":"For Anti Money Laundering (AML) checks. Not required for our Australian SMA offering","default":"","type":"string","name":"Applicant.SourceOfWealth"},{"_id":"55de478d9db51a0d006494e0","ref":"","in":"body","required":false,"desc":"For Anti Money Laundering (AML) checks. Not required for our Australian SMA offering","default":"","type":"string","name":"Applicant.IsPoliticallyExposedPerson"},{"_id":"55de478d9db51a0d006494d8","ref":"","in":"body","required":false,"desc":"The ISO alpha-3 code for the applicant's country of birth. For Anti Money Laundering (AML) checks. Not required for our Australian SMA offering","default":"AUS","type":"string","name":"Applicant.BirthCountryCode"},{"_id":"55de478d9db51a0d006494d7","ref":"","in":"body","required":true,"desc":"The ISO alpha-3 code for the applicant's country of citizenship","default":"AUS","type":"string","name":"Applicant.CitzenshipCountryCode"},{"_id":"55de67219db51a0d0064950a","ref":"","in":"body","required":false,"desc":"In Australia, this object contains the applicant's TFN or ABN","default":"","type":"array_string","name":"Applicant.Identification"},{"_id":"55de67219db51a0d00649509","ref":"","in":"body","required":false,"desc":"The TFN or ABN. For SuperSMA accounts we require a TFN.","default":"123456782","type":"string","name":"Applicant.Identification.IdNumber"},{"_id":"55de67219db51a0d00649508","ref":"","in":"body","required":false,"desc":"The type of identification. 0=US TIN, 4= ABN, 5=TFN","default":"5","type":"int","name":"Applicant.Identification.Type"},{"_id":"55de67219db51a0d00649507","ref":"","in":"body","required":false,"desc":"For Anti Money Laundering (AML) checks. Not required for our Australian SMA offering.","default":"","type":"string","name":"Applicant.Identification.BirthTown"},{"_id":"5acacb008bdbeb0003ac3675","ref":"","in":"body","required":false,"desc":"Required for SuperSma applicants. M or F.","default":"","type":"string","name":"Applicant.Sex"},{"_id":"5ad97bbfa5f7bd0003cc6435","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8f02325ad3000338d589","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Applicants"},"isReference":true,"order":6,"body":"The body of the request should contain an array of objects, each specifying an applicant.\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **SMA/Robo, Enterprise**\"\n}\n[/block]","excerpt":"This endpoint is functionally identical to the [Applicants](doc:applicants) endpoint except that it allows more than one applicant to be associated with an account.","slug":"bulk-applicants-1","type":"post","title":"Bulk Applicants","__v":5,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postBulk Applicants

This endpoint is functionally identical to the [Applicants](doc:applicants) endpoint except that it allows more than one applicant to be associated with an account.

Body Params

Array:
array of objects
Type:
required
integer1
1=Individual
Applicant:
object
Contains the applicant data. When we have more types, the contents will be customisable based on Applicant.Type
Applicant.AdviserId:
stringadmin@abcd.com.au
The user ID that you have been provided with
Applicant.AccountId:
required
stringAU228403
The `AccountID` as returned by the Accounts endpoint.
Applicant.Name:
required
array of mixed
Applicant.Name.First:
required
stringJohn
The applicant's first name
Applicant.Name.Last:
required
stringSmith
The applicant's last name
Applicant.Name.Title:
required
stringMr
The applicant's title. Valid values are: Mr, Mrs, Ms, Miss, Doctor, Lady, Prof and Sir
Applicant.DateOfBirth:
required
yyyy-mm-dd1987-09-20
The applicant's date of birth
Applicant.Email:
required
stringjohnsmith@smith.com
The applicant's email
Applicant.Phone:
required
string+61 (3) 1111 2222
The primary contact number for the applicant
Applicant.PhoneOther:
stringTrue
A secondary contact number for the applicant
Applicant.Addresses:
required
array of strings
Applicant.Addresses.Type:
required
integer0
Home = 0, Office = 1, Mailing = 2, PrincipalPlaceOfBusiness = 3. We only need 0, and 2 if it is different.
Applicant.Addresses.Line1:
required
string50 Queen Street"
Applicant.Addresses.Line2:
string
Applicant.Addresses.Line3:
string
Applicant.Addresses.SuburbCounty:
required
stringMelbourne
For Australian addresses, this must be one of the locations associated with the postcode by Australia Post.
Applicant.Addresses.TownCityState:
stringVIC
Applicant.Addresses.PostCode:
required
string3000
For Australian addresses, this must be the postcode that corresponds to what you have passed in SuburbCountry.
Addresses.CountryCode:
stringAUS
The ISO alpha-3 code for the country the address is in
Applicant.IsSignatory:
required
boolean
Whether the applicant is a signatory on the account. We require one signatory for individual and SuperSMA accounts, and all joint account holders must be signatories
Applicant.SignatureImage:
string
A base64 string representing an image of the applicant's signature. To prevent distortion of the image when it is printed, please ensure the width of the image is five times the height.
Applicant.TaxRateElection:
required
stringRTFN
Our code for the applicant's tax status - RTFN = Resident with TFN, RABN = Resident with ABN, NRWT = Non resident of Australia, NTFN = Resident of Australia without a TFN
Applicant.TaxDomicileCountryCode:
required
stringAUD
The ISO alpha-3 code for the country where the applicant is resident for tax purposes
Applicant.Profession:
string
For Anti Money Laundering (AML) checks. Not required for our Australian SMA offering
Applicant.SourceOfFunds:
string
For Anti Money Laundering (AML) checks. Not required for our Australian SMA offering
Applicant.SourceOfWealth:
string
For Anti Money Laundering (AML) checks. Not required for our Australian SMA offering
Applicant.IsPoliticallyExposedPerson:
string
For Anti Money Laundering (AML) checks. Not required for our Australian SMA offering
Applicant.BirthCountryCode:
stringAUS
The ISO alpha-3 code for the applicant's country of birth. For Anti Money Laundering (AML) checks. Not required for our Australian SMA offering
Applicant.CitzenshipCountryCode:
required
stringAUS
The ISO alpha-3 code for the applicant's country of citizenship
Applicant.Identification:
array of strings
In Australia, this object contains the applicant's TFN or ABN
Applicant.Identification.IdNumber:
string123456782
The TFN or ABN. For SuperSMA accounts we require a TFN.
Applicant.Identification.Type:
integer5
The type of identification. 0=US TIN, 4= ABN, 5=TFN
Applicant.Identification.BirthTown:
string
For Anti Money Laundering (AML) checks. Not required for our Australian SMA offering.
Applicant.Sex:
string
Required for SuperSma applicants. M or F.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
The body of the request should contain an array of objects, each specifying an applicant. [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The body of the request should contain an array of objects, each specifying an applicant. [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block]
{"_id":"5d8b0b31c4b9960018c59a27","category":"5d8b0b31c4b9960018c59a01","parentDoc":null,"user":"55a49cd3e6c2470d002a648c","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-21T04:29:50.515Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"POST http://{URL as provided}/TrusteeApplicants HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\n{\n\t  \"AdviserId\": \"Adviser\",\n    \"AccountId\": \"AU254022\",\n    \"Name\": \"FTW Super Fund\",\n    \"TrusteeName\": \"Acme Ltd\",\n    \"RegisteredNumber\": \"51824753556\",\n\t  \"ContactName\": \"Smith\",\n    \"ContactEmail\": \"test@test.com\",\n    \"ContactPhone\": \"0410336121\",\n    \"Addresses\": [\n    {\n                    \"Type\": 3,\n                    \"Line1\": \"367 Collins Street\",\n                    \"Line2\": \" \",\n                    \"Line3\": \"\",\n                    \"SuburbCounty\": \"Melbourne\",\n                    \"TownCityState\": \"VIC\",\n                    \"PostCode\": 3000,\n                    \"CountryCode\": \"AUS\"\n    }],\n\t  \"Signatories\":\n\t  [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"Capacity\": 1,\n\t\t\t\t\t\t\t\"Name\": {\n\t\t\t\t\t\t\t\t\t\t\t\"First\": \"Test 1\",\n\t\t\t\t\t\t\t\t\t\t\t\"Last\": \"Test\",\n\t\t\t\t\t\t\t\t\t\t\t\"Title\": \"Mrs\"\n\t\t\t\t\t\t\t}\n\t\t  },\n\t\t  {\n\t\t\t\t\t\t\t\"Capacity\": 3,\n\t\t\t\t\t\t\t\"Name\": {\n\t\t\t\t\t\t\t\t\t\t\t\"First\": \"Test 2\",\n\t\t\t\t\t\t\t\t\t\t\t\"Last\": \"Test\",\n\t\t\t\t\t\t\t\t\t\t\t\"Title\": \"Mrs\"\n\t\t\t\t\t\t\t}\n\t\t  }\t\n\t\t]\t\t\t\t\n}","name":""}]},"method":"post","results":{"codes":[{"status":200,"language":"json","code":"{  \n   \"CreationStatus\":0,\n   \"Signatories\":[  \n      {  \n         \"Id\":\"AU26533\"\n      },\n      {  \n         \"Id\":\"AU26534\"\n      }\n   ]\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"55f0c5cf78661c170035e146","ref":"","in":"body","required":false,"desc":"Contains the applicant data. When we have more than one type, the content will be customisable based on the Applicant Type","default":"","type":"object","name":"TrusteeApplicants"},{"_id":"5615f5121651730d005048e6","ref":"","in":"body","required":true,"desc":"The user ID that you have been provided with","default":"admin@abcd.com.au","type":"string","name":"TrusteeApplicants.AdviserId"},{"_id":"55de478d9db51a0d006494e4","ref":"","in":"body","required":true,"desc":"The `AccountID` as returned by the Accounts endpoint.","default":"AU228403","type":"string","name":"TrusteeApplicants.AccountId"},{"_id":"55de478d9db51a0d006494de","ref":"","in":"body","required":true,"desc":"The name of the super fund","default":"","type":"array_mixed","name":"TrusteeApplicants.Name"},{"_id":"5768de5547693a0e0000299c","ref":"","in":"body","required":true,"desc":"The name of the corporate trustee: required if this is a trust or SMSF with a corporate trustee","default":"","type":"string","name":"TrusteeApplicants.TrusteeName"},{"_id":"5768de5547693a0e0000299d","ref":"","in":"body","required":false,"desc":"The ABN of the Super Fund itself rather than the corporate trustee.","default":"","type":"string","name":"TrusteeApplicants.RegisteredNumber"},{"_id":"5768c2bef480fb0e004dbddf","ref":"","in":"body","required":false,"desc":"The name of the primary contact person for the account","default":"","type":"string","name":"TrusteeApplicants.ContactName"},{"_id":"5768de5547693a0e000029a7","ref":"","in":"body","required":false,"desc":"The name of the primary contact person for the account","default":"","type":"string","name":"TrusteeApplicants.ContactEmail"},{"_id":"5768c2bef480fb0e004dbdde","ref":"","in":"body","required":false,"desc":"The contact telephone number of the primary contact person for the account","default":"","type":"string","name":"TrusteeApplicants.ContactPhone"},{"_id":"5760ccbff0bc821700ab4910","ref":"","in":"body","required":false,"desc":"The email address of the primary contact person for the Account.","default":"a@a.co","type":"string","name":"TrusteeApplicants.Email"},{"_id":"5768de5547693a0e000029a6","ref":"","in":"body","required":false,"desc":"","default":"","type":"array_mixed","name":"TrusteeApplicants.Addresses"},{"_id":"5768de5547693a0e000029a5","ref":"","in":"body","required":false,"desc":"Home = 0, Office = 1, Mailing = 2, PrincipalPlaceOfBusiness = 3. We only need 0, and 2 if it is different.","default":"0","type":"int","name":"TrusteeApplicants.Addresses.Type"},{"_id":"5768de5547693a0e000029a4","ref":"","in":"body","required":false,"desc":"50 Queen Street","default":"","type":"string","name":"TrusteeApplicants.Addresses.Line1"},{"_id":"5768de5547693a0e000029a3","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"TrusteeApplicants.Addresses.Line2"},{"_id":"5768de5547693a0e000029a2","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"TrusteeApplicants.Addresses.Line3"},{"_id":"5768de5547693a0e000029a1","ref":"","in":"body","required":false,"desc":"For Australian addresses, this must be one of the locations associated with the postcode by Australia Post.","default":"Melbourne","type":"string","name":"TrusteeApplicants.Addresses.SuburbCounty"},{"_id":"5768de5547693a0e000029a0","ref":"","in":"body","required":false,"desc":"","default":"VIC","type":"string","name":"TrusteeApplicants.Addresses.TownCityState"},{"_id":"5768de5547693a0e0000299f","ref":"","in":"body","required":false,"desc":"For Australian addresses, this must be the postcode that corresponds to what you have passed in SuburbCountry.","default":"3000","type":"string","name":"TrusteeApplicants.Addresses.PostCode"},{"_id":"5768de5547693a0e0000299e","ref":"","in":"body","required":false,"desc":"The ISO alpha-3 code for the country the address is in","default":"AUS","type":"string","name":"TrusteeApplicants.Addresses.CountryCode"},{"_id":"5768de5547693a0e0000299b","ref":"","in":"body","required":false,"desc":"","default":"","type":"array_string","name":"TrusteeApplicants.Signatories"},{"_id":"5768de5547693a0e0000299a","ref":"","in":"body","required":false,"desc":"director = 1, company secretary = 3, sole director = 4, signed under seal = 7","default":"","type":"string","name":"TrusteeApplicants.Signatories.Capacity"},{"_id":"55de478d9db51a0d006494dc","ref":"","in":"body","required":false,"desc":"The signatory's first name","default":"John","type":"string","name":"TrusteeApplicants.Signatories.Name.First"},{"_id":"55de478d9db51a0d006494db","ref":"","in":"body","required":false,"desc":"The signatory's last name","default":"Smith","type":"string","name":"TrusteeApplicants.Signatories.Name.Last"},{"_id":"55de478d9db51a0d006494dd","ref":"","in":"body","required":false,"desc":"The signatory's title. Valid values are: Mr, Mrs, Ms, Miss, Doctor, Lady, Prof and Sir","default":"Mr","type":"string","name":"TrusteeApplicants.Signatories.Name.Title"},{"_id":"5ada8b0393588300034e640d","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8f2ae80ca4000326d629","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/TrusteeApplicants"},"isReference":true,"order":7,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **SMA/Robo, Enterprise**\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"If you need to produce or print any digital/electronic signatures on any of the resulting app forms, see Applicant.SignatureImage and other components as above.\",\n  \"title\": \"Digital Signatures\"\n}\n[/block]","excerpt":"This endpoint is used to create an application with corporate trustees associated with an SMSF account.","slug":"applicants-smsf-with-corporate-trustee","type":"post","title":"SMSF - Corporate Trustees","__v":17,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postSMSF - Corporate Trustees

This endpoint is used to create an application with corporate trustees associated with an SMSF account.

Body Params

TrusteeApplicants:
object
Contains the applicant data. When we have more than one type, the content will be customisable based on the Applicant Type
TrusteeApplicants.AdviserId:
required
stringadmin@abcd.com.au
The user ID that you have been provided with
TrusteeApplicants.AccountId:
required
stringAU228403
The `AccountID` as returned by the Accounts endpoint.
TrusteeApplicants.Name:
required
array of mixed
The name of the super fund
TrusteeApplicants.TrusteeName:
required
string
The name of the corporate trustee: required if this is a trust or SMSF with a corporate trustee
TrusteeApplicants.RegisteredNumber:
string
The ABN of the Super Fund itself rather than the corporate trustee.
TrusteeApplicants.ContactName:
string
The name of the primary contact person for the account
TrusteeApplicants.ContactEmail:
string
The name of the primary contact person for the account
TrusteeApplicants.ContactPhone:
string
The contact telephone number of the primary contact person for the account
TrusteeApplicants.Email:
stringa@a.co
The email address of the primary contact person for the Account.
TrusteeApplicants.Addresses:
array of mixed
TrusteeApplicants.Addresses.Type:
integer0
Home = 0, Office = 1, Mailing = 2, PrincipalPlaceOfBusiness = 3. We only need 0, and 2 if it is different.
TrusteeApplicants.Addresses.Line1:
string
50 Queen Street
TrusteeApplicants.Addresses.Line2:
string
TrusteeApplicants.Addresses.Line3:
string
TrusteeApplicants.Addresses.SuburbCounty:
stringMelbourne
For Australian addresses, this must be one of the locations associated with the postcode by Australia Post.
TrusteeApplicants.Addresses.TownCityState:
stringVIC
TrusteeApplicants.Addresses.PostCode:
string3000
For Australian addresses, this must be the postcode that corresponds to what you have passed in SuburbCountry.
TrusteeApplicants.Addresses.CountryCode:
stringAUS
The ISO alpha-3 code for the country the address is in
TrusteeApplicants.Signatories:
array of strings
TrusteeApplicants.Signatories.Capacity:
string
director = 1, company secretary = 3, sole director = 4, signed under seal = 7
TrusteeApplicants.Signatories.Name.First:
stringJohn
The signatory's first name
TrusteeApplicants.Signatories.Name.Last:
stringSmith
The signatory's last name
TrusteeApplicants.Signatories.Name.Title:
stringMr
The signatory's title. Valid values are: Mr, Mrs, Ms, Miss, Doctor, Lady, Prof and Sir

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
[block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block] [block:callout] { "type": "info", "body": "If you need to produce or print any digital/electronic signatures on any of the resulting app forms, see Applicant.SignatureImage and other components as above.", "title": "Digital Signatures" } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block] [block:callout] { "type": "info", "body": "If you need to produce or print any digital/electronic signatures on any of the resulting app forms, see Applicant.SignatureImage and other components as above.", "title": "Digital Signatures" } [/block]
{"_id":"5d8b0b31c4b9960018c59a28","category":"5d8b0b31c4b9960018c59a01","parentDoc":null,"user":"55a49cd3e6c2470d002a648c","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-23T01:28:16.432Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"code":"{  \n   \"CreationStatus\":0,\n   \"Signatories\":[  \n      {  \n         \"Id\":\"AU26531\"\n      },\n      {  \n         \"Id\":\"AU26532\"\n      }\n   ]\n}","name":"","status":200,"language":"json"}]},"settings":"","examples":{"codes":[{"language":"json","code":"POST http://{URL as provided}/TrusteeApplicants HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\n{  \n   \"AdviserId\":\"Adviser\",\n   \"AccountId\":\"AU254022\",\n   \"Name\":\"FTW Super Fund\",\n   \"RegisteredNumber\":\"51824753556\",\n   \"Addresses\":[  \n      {  \n         \"Type\":0,\n         \"Line1\":\"367 Collins Street\",\n         \"Line2\":\"\",\n         \"Line3\":\"\",\n         \"SuburbCounty\":\"Melbourne\",\n         \"TownCityState\":\"VIC\",\n         \"PostCode\":3000,\n         \"CountryCode\":\"AUS\"\n      }\n   ],\n   \"Signatories\":[  \n      {  \n         \"Capacity\":6,\n         \"Name\":{  \n            \"First\":\"Test 1\",\n            \"Last\":\"Test\",\n            \"Title\":\"Mrs\"\n         }\n      },\n      {  \n         \"Capacity\":6,\n         \"Name\":{  \n            \"First\":\"Test 2\",\n            \"Last\":\"Test\",\n            \"Title\":\"Mrs\"\n         }\n      }\n   ]\n}","name":""}]},"auth":"required","params":[{"_id":"55f0c5cf78661c170035e146","ref":"","in":"body","required":false,"desc":"Contains the applicant data. When we have more types, the contents will be customisable based on Applicant.Type","default":"","type":"object","name":"TrusteeApplicants"},{"_id":"5615f5121651730d005048e6","ref":"","in":"body","required":true,"desc":"The user ID that you have been provided with","default":"admin@abcd.com.au","type":"string","name":"TrusteeApplicants.AdviserId"},{"_id":"55de478d9db51a0d006494e4","ref":"","in":"body","required":true,"desc":"The `AccountID` as returned by the Accounts endpoint.","default":"AU228403","type":"string","name":"TrusteeApplicants.AccountId"},{"_id":"55de478d9db51a0d006494de","ref":"","in":"body","required":true,"desc":"The name of the super fund","default":"","type":"array_mixed","name":"TrusteeApplicants.Name"},{"_id":"5768de5547693a0e0000299d","ref":"","in":"body","required":false,"desc":"The ABN of the investor, so eg the super fund's ABN","default":"","type":"string","name":"TrusteeApplicants.RegisteredNumber"},{"_id":"5760ccbff0bc821700ab4910","ref":"","in":"body","required":false,"desc":"The primary contact's email address","default":"a@a.co","type":"string","name":"TrusteeApplicants.Email"},{"_id":"5768de5547693a0e000029a6","ref":"","in":"body","required":false,"desc":"","default":"","type":"array_mixed","name":"TrusteeApplicants.Addresses"},{"_id":"5768de5547693a0e000029a5","ref":"","in":"body","required":false,"desc":"Home = 0, Office = 1, Mailing = 2, PrincipalPlaceOfBusiness = 3. We only need 0, and 2 if it is different.","default":"0","type":"int","name":"TrusteeApplicants.Addresses.Type"},{"_id":"5768de5547693a0e000029a4","ref":"","in":"body","required":false,"desc":"50 Queen Street","default":"","type":"string","name":"TrusteeApplicants.Addresses.Line1"},{"_id":"5768de5547693a0e000029a3","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"TrusteeApplicants.Addresses.Line2"},{"_id":"5768de5547693a0e000029a2","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"TrusteeApplicants.Addresses.Line3"},{"_id":"5768de5547693a0e000029a1","ref":"","in":"body","required":false,"desc":"For Australian addresses, this must be one of the locations associated with the postcode by Australia Post.","default":"Melbourne","type":"string","name":"TrusteeApplicants.Addresses.SuburbCounty"},{"_id":"5768de5547693a0e000029a0","ref":"","in":"body","required":false,"desc":"","default":"VIC","type":"string","name":"TrusteeApplicants.Addresses.TownCityState"},{"_id":"5768de5547693a0e0000299f","ref":"","in":"body","required":false,"desc":"For Australian addresses, this must be the postcode that corresponds to what you have passed in SuburbCountry.","default":"3000","type":"string","name":"TrusteeApplicants.Addresses.PostCode"},{"_id":"5768de5547693a0e0000299e","ref":"","in":"body","required":false,"desc":"The ISO alpha-3 code for the country the address is in","default":"AUS","type":"string","name":"TrusteeApplicants.Addresses.CountryCode"},{"_id":"5768de5547693a0e0000299b","ref":"","in":"body","required":false,"desc":"","default":"","type":"array_string","name":"TrusteeApplicants.Signatories"},{"_id":"5768de5547693a0e0000299a","ref":"","in":"body","required":true,"desc":"Trustee = 6","default":"","type":"string","name":"TrusteeApplicants.Signatories.Capacity"},{"_id":"55de478d9db51a0d006494dc","ref":"","in":"body","required":true,"desc":"The signatory's first name","default":"John","type":"string","name":"TrusteeApplicants.Signatories.Name.First"},{"_id":"55de478d9db51a0d006494db","ref":"","in":"body","required":true,"desc":"The signatory's last name","default":"Smith","type":"string","name":"TrusteeApplicants.Signatories.Name.Last"},{"_id":"55de478d9db51a0d006494dd","ref":"","in":"body","required":true,"desc":"The signatory's title. Valid values are: Mr, Mrs, Ms, Miss, Doctor, Lady, Prof and Sir","default":"Mr","type":"string","name":"TrusteeApplicants.Signatories.Name.Title"},{"_id":"5ada8b1293588300034e641a","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8f3e325ad3000338d58b","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/TrusteeApplicants"},"isReference":true,"order":8,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"If you need to produce or print any digital/electronic signatures on any of the resulting app forms, see Applicant.SignatureImage and other components as above.\",\n  \"title\": \"Digital Signatures\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **SMA/Robo, Enterprise**\"\n}\n[/block]","excerpt":"This endpoint is used to create an application with individual trustees associated with an SMSF account.","slug":"applicants-smsf-with-individual-trustees","type":"post","title":"SMSF - Individual Trustees","__v":17,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postSMSF - Individual Trustees

This endpoint is used to create an application with individual trustees associated with an SMSF account.

Body Params

TrusteeApplicants:
object
Contains the applicant data. When we have more types, the contents will be customisable based on Applicant.Type
TrusteeApplicants.AdviserId:
required
stringadmin@abcd.com.au
The user ID that you have been provided with
TrusteeApplicants.AccountId:
required
stringAU228403
The `AccountID` as returned by the Accounts endpoint.
TrusteeApplicants.Name:
required
array of mixed
The name of the super fund
TrusteeApplicants.RegisteredNumber:
string
The ABN of the investor, so eg the super fund's ABN
TrusteeApplicants.Email:
stringa@a.co
The primary contact's email address
TrusteeApplicants.Addresses:
array of mixed
TrusteeApplicants.Addresses.Type:
integer0
Home = 0, Office = 1, Mailing = 2, PrincipalPlaceOfBusiness = 3. We only need 0, and 2 if it is different.
TrusteeApplicants.Addresses.Line1:
string
50 Queen Street
TrusteeApplicants.Addresses.Line2:
string
TrusteeApplicants.Addresses.Line3:
string
TrusteeApplicants.Addresses.SuburbCounty:
stringMelbourne
For Australian addresses, this must be one of the locations associated with the postcode by Australia Post.
TrusteeApplicants.Addresses.TownCityState:
stringVIC
TrusteeApplicants.Addresses.PostCode:
string3000
For Australian addresses, this must be the postcode that corresponds to what you have passed in SuburbCountry.
TrusteeApplicants.Addresses.CountryCode:
stringAUS
The ISO alpha-3 code for the country the address is in
TrusteeApplicants.Signatories:
array of strings
TrusteeApplicants.Signatories.Capacity:
required
string
Trustee = 6
TrusteeApplicants.Signatories.Name.First:
required
stringJohn
The signatory's first name
TrusteeApplicants.Signatories.Name.Last:
required
stringSmith
The signatory's last name
TrusteeApplicants.Signatories.Name.Title:
required
stringMr
The signatory's title. Valid values are: Mr, Mrs, Ms, Miss, Doctor, Lady, Prof and Sir

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
[block:callout] { "type": "info", "body": "If you need to produce or print any digital/electronic signatures on any of the resulting app forms, see Applicant.SignatureImage and other components as above.", "title": "Digital Signatures" } [/block] [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "body": "If you need to produce or print any digital/electronic signatures on any of the resulting app forms, see Applicant.SignatureImage and other components as above.", "title": "Digital Signatures" } [/block] [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block]
{"_id":"5d8b0b31c4b9960018c59a29","category":"5d8b0b31c4b9960018c59a01","project":"55ca8813e583751700f78a58","user":"55dd6ff10efd5821000d5471","parentDoc":null,"version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-16T01:06:29.625Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"true","language":"json","status":200}]},"settings":"","examples":{"codes":[{"name":"","code":"POST http://{URL as provided}/Accounts/AU32112/Signature HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\n{\n  \t\"ApplicantID\": \"AU12345\",\n\t\t\"IPAddress\": \"10.0.0.1\",\n\t\t\"UserAgent\": \"Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36\",\n\t\t\"SignatureDate\": \"2016-06-12 05:00:10\",\n\t\t\"AmlReferenceNumber\": \"123456789\",\n\t\t\"Location\": null,\n\t\t\"SignatureBlob\": null,\n\t\t\"PdsRevision\": \"2016-06-02\",\n\t\t\"PdsNumber\": \"123456\",\n\t\t\"IsPdsSent\": true,\n    \"AdditionalData\": \n    {\n     \t\t\"Item1\": \"Value\"\n  \t}\n}","language":"json"}]},"method":"post","auth":"required","params":[{"_id":"55f0c5cf78661c170035e146","ref":"","in":"body","required":true,"desc":"The `ApplicantID` as returned by the Applicants endpoint.","default":"","type":"string","name":"ApplicantID"},{"_id":"55de67219db51a0d00649507","ref":"","in":"body","required":true,"desc":"IP address of the computer that applicant submitted signature","default":"","type":"string","name":"IPAddress"},{"_id":"5739217c4dea9d0e000519c9","ref":"","in":"body","required":true,"desc":"User agent of the browser","default":"","type":"string","name":"UserAgent"},{"_id":"5739217c4dea9d0e000519c8","ref":"","in":"body","required":true,"desc":"Datetime in AEST that the signature was captured by your systems","default":"","type":"datetime","name":"SignatureDate"},{"_id":"5739217c4dea9d0e000519c7","ref":"","in":"body","required":false,"desc":"Anti Money Laundering (AML) reference number","default":"","type":"string","name":"AmlReferenceNumber"},{"_id":"574fe3ebd1d5a20e00658d8a","ref":"","in":"body","required":false,"desc":"Date or revision of PDS","default":"","type":"string","name":"PdsRevision"},{"_id":"574fe3ebd1d5a20e00658d89","ref":"","in":"body","required":false,"desc":"PDS number or name","default":"","type":"string","name":"PdsNumber"},{"_id":"574fe3ebd1d5a20e00658d88","ref":"","in":"body","required":false,"desc":"A flag indicates whether PDS has been sent","default":"","type":"boolean","name":"IsPdsSent"},{"_id":"5739217c4dea9d0e000519c6","ref":"","in":"body","required":false,"desc":"Location of the applicant (GPS coordinates)","default":"","type":"string","name":"Location"},{"_id":"5739217c4dea9d0e000519c4","ref":"","in":"body","required":false,"desc":"Additional information about the signature","default":"","type":"array_mixed","name":"AdditionalData"},{"_id":"5ada8b1fa6bc980003475dad","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8f56e80ca4000326d62a","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Accounts/{Id}/Signature"},"isReference":true,"order":9,"body":"The signatures may be click-wrapped acceptance data or graphical images of signatures. The electronic signature may have attached metadata such as GPS coordinates or AML references numbers to ensure surety of digital acceptance.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **SMA/Robo, Enterprise**\"\n}\n[/block]","excerpt":"This endpoint is used to let your application send us digital signatures for an applicant.","slug":"signature","type":"post","title":"Electronic Signatures","__v":13,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postElectronic Signatures

This endpoint is used to let your application send us digital signatures for an applicant.

Body Params

ApplicantID:
required
string
The `ApplicantID` as returned by the Applicants endpoint.
IPAddress:
required
string
IP address of the computer that applicant submitted signature
UserAgent:
required
string
User agent of the browser
SignatureDate:
required
datetime
Datetime in AEST that the signature was captured by your systems
AmlReferenceNumber:
string
Anti Money Laundering (AML) reference number
PdsRevision:
string
Date or revision of PDS
PdsNumber:
string
PDS number or name
IsPdsSent:
boolean
A flag indicates whether PDS has been sent
Location:
string
Location of the applicant (GPS coordinates)
AdditionalData:
array of mixed
Additional information about the signature

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
The signatures may be click-wrapped acceptance data or graphical images of signatures. The electronic signature may have attached metadata such as GPS coordinates or AML references numbers to ensure surety of digital acceptance. [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The signatures may be click-wrapped acceptance data or graphical images of signatures. The electronic signature may have attached metadata such as GPS coordinates or AML references numbers to ensure surety of digital acceptance. [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block]
{"_id":"5d8b0b31c4b9960018c59a2a","category":"5d8b0b31c4b9960018c59a01","parentDoc":null,"project":"55ca8813e583751700f78a58","user":"55dd6ff10efd5821000d5471","version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-28T06:29:27.069Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"GET http://{URL as provided}/Accounts/AU32112/Appform HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n","name":""}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n  \t\"FormContent\": \"BASE64 STRING HERE\"\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"56a9b5472d8fd90d0036eeff","ref":"","in":"path","required":true,"desc":"The `AccountID` as returned by the Accounts response.","default":"AU123456","type":"string","name":"Id"},{"_id":"5ada8b2ca6bc980003475dae","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8f6c2c87d800035ebfa2","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Accounts/{Id}/Appform"},"isReference":true,"order":10,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"What's an App Form?\",\n  \"body\": \"An application form is a confirmation to the client of the details of their account. It includes a signoff from them that they agree to our terms and conditions.\"\n}\n[/block]\nThe PDF is returned as a base64 encoded string.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **SMA/Robo, Enterprise**\"\n}\n[/block]","excerpt":"This endpoint is used to request a PDF application form for the specified account.","slug":"appform","type":"get","title":"App Form","__v":11,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getApp Form

This endpoint is used to request a PDF application form for the specified account.

Path Params

Id:
required
stringAU123456
The `AccountID` as returned by the Accounts response.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
[block:callout] { "type": "info", "title": "What's an App Form?", "body": "An application form is a confirmation to the client of the details of their account. It includes a signoff from them that they agree to our terms and conditions." } [/block] The PDF is returned as a base64 encoded string. [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "title": "What's an App Form?", "body": "An application form is a confirmation to the client of the details of their account. It includes a signoff from them that they agree to our terms and conditions." } [/block] The PDF is returned as a base64 encoded string. [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block]
{"_id":"5d8b0b31c4b9960018c59a2b","category":"5d8b0b31c4b9960018c59a01","user":"55dd6ff10efd5821000d5471","project":"55ca8813e583751700f78a58","parentDoc":null,"version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-26T06:22:31.515Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"GET http://{URL as provided}/Accounts/AU32112/Status HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n","name":""}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"Detail\": \"Traded\"\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"56a9b5472d8fd90d0036eeff","ref":"","in":"path","required":true,"desc":"The `Id` as returned by the Accounts response.","default":"AU123456","type":"string","name":"Id"},{"_id":"5ada8b3993588300034e641b","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8f802c87d800035ebfa3","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Accounts/{Id}/Status"},"isReference":true,"order":11,"body":"Possible return/status values:\n  * 1 - Traded\n  * 2 - In the market\n  * 3 - Completely funded\n  * 4 - Partially funded\n  * 5 - Awaiting funds\n  * 6 - Awaiting approval\n  * 7 - Closure requested\n  * 8 - Disposing of assets\n  * 9 - Awaiting settlement\n  * 10 - Awaiting income\n  * 11 - Ready for payment\n  * 12 - Pending payment\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **SMA/Robo, Enterprise**\"\n}\n[/block]","excerpt":"This endpoint is used to check the trading status of an Account.","slug":"account-status","type":"get","title":"Account Status","__v":16,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getAccount Status

This endpoint is used to check the trading status of an Account.

Path Params

Id:
required
stringAU123456
The `Id` as returned by the Accounts response.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
Possible return/status values: * 1 - Traded * 2 - In the market * 3 - Completely funded * 4 - Partially funded * 5 - Awaiting funds * 6 - Awaiting approval * 7 - Closure requested * 8 - Disposing of assets * 9 - Awaiting settlement * 10 - Awaiting income * 11 - Ready for payment * 12 - Pending payment [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Possible return/status values: * 1 - Traded * 2 - In the market * 3 - Completely funded * 4 - Partially funded * 5 - Awaiting funds * 6 - Awaiting approval * 7 - Closure requested * 8 - Disposing of assets * 9 - Awaiting settlement * 10 - Awaiting income * 11 - Ready for payment * 12 - Pending payment [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block]
{"_id":"5d8b0b31c4b9960018c59a2c","category":"5d8b0b31c4b9960018c59a01","parentDoc":null,"project":"55ca8813e583751700f78a58","user":"55a49cd3e6c2470d002a648c","version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-27T03:29:05.051Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"57216f77e1805f0e00422005","examples":{"codes":[{"language":"json","code":"GET http://userapi.onpraemium.com/Users\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\n{  \n   \"Id\":1,\n   \"Name\":{  \n      \"Title\":\"sample string 1\",\n      \"First\":\"sample string 2\",\n      \"Last\":\"sample string 3\"\n   },\n   \"Gender\":Null,\n   \"Type\":1,\n   \"UserLevel\":1,\n   \"Email\":\"a@a.co\",\n   \"DateOfBirth\":\"2016-04-24T00:00:00+00:00\",\n   \"MothersMaidenName\":\"sample string 5\",\n   \"Addresses\":[  \n      {  \n         \"Type\":0,\n         \"AddressLine1\":\"sample string 1\",\n         \"AddressLine2\":\"sample string 2\",\n         \"AddressLine3\":\"sample string 3\",\n         \"SuburbCounty\":\"sample string 4\",\n         \"TownCityState\":\"sample string 5\",\n         \"Postcode\":\"sample string 6\",\n         \"Country\":\"sample string 7\"\n      },\n      {  \n         \"Type\":0,\n         \"AddressLine1\":\"sample string 1\",\n         \"AddressLine2\":\"sample string 2\",\n         \"AddressLine3\":\"sample string 3\",\n         \"SuburbCounty\":\"sample string 4\",\n         \"TownCityState\":\"sample string 5\",\n         \"Postcode\":\"sample string 6\",\n         \"Country\":\"sample string 7\"\n      },\n      {  \n         \"Type\":0,\n         \"AddressLine1\":\"sample string 1\",\n         \"AddressLine2\":\"sample string 2\",\n         \"AddressLine3\":\"sample string 3\",\n         \"SuburbCounty\":\"sample string 4\",\n         \"TownCityState\":\"sample string 5\",\n         \"Postcode\":\"sample string 6\",\n         \"Country\":\"sample string 7\"\n      }\n   ],\n   \"Phone\":\"sample string 6\",\n   \"PhoneAlt\":\"sample string 7\",\n   \"ServiceId\":\"sample string 8\",\n   \"Location\":\"sample string 9\",\n   \"Team\":\"sample string 10\",\n   \"JobTitle\":\"sample string 11\",\n   \"AdviserId\":1,\n   \"GenerateGetStartedToken\":false,\n   \"GetStartedToken\":\"sample string 12\"\n}\n"}]},"method":"post","auth":"required","params":[{"_id":"5720459e5be73c17009601c7","ref":"","in":"body","required":true,"desc":"The ID that the user will type when logging in","default":"","type":"string","name":"User.ID"},{"_id":"57203201a0acd42000af967e","ref":"","in":"body","required":false,"desc":"Contains the name of the person we are creating a user for.","default":"","type":"object","name":"User.Name"},{"_id":"57203201a0acd42000af967d","ref":"","in":"body","required":false,"desc":"Title of the User","default":"","type":"string","name":"User.Name.Title"},{"_id":"5720459e5be73c17009601c6","ref":"","in":"body","required":true,"desc":"The User's First Name","default":"","type":"string","name":"User.Name.First"},{"_id":"5720459e5be73c17009601c5","ref":"","in":"body","required":true,"desc":"The User's Last Name","default":"","type":"string","name":"User.Name.Last"},{"_id":"5720459e5be73c17009601c4","ref":"","in":"body","required":false,"desc":"Male, Female, or Null","default":"","type":"string","name":"User.Gender"},{"_id":"5720459e5be73c17009601c3","ref":"","in":"body","required":false,"desc":"1 = investor","default":"","type":"int","name":"User.Type"},{"_id":"5720459e5be73c17009601c2","ref":"","in":"body","required":false,"desc":"1 = standard investor user","default":"","type":"int","name":"User.UserLevel"},{"_id":"5720459e5be73c17009601c1","ref":"","in":"body","required":true,"desc":"The User's Email Address","default":"","type":"string","name":"User.Email"},{"_id":"5720459e5be73c17009601c0","ref":"","in":"body","required":false,"desc":"For security purposes if we need to identify the user over the phone","default":"","type":"yyyy-mm-dd","name":"User.DateOfBirth"},{"_id":"5720459e5be73c17009601bf","ref":"","in":"body","required":false,"desc":"For security purposes if we need to identify the user over the phone","default":"","type":"string","name":"User.MothersMaidenName"},{"_id":"5720459e5be73c17009601be","ref":"","in":"body","required":false,"desc":"Contains details of the user's address","default":"","type":"array_mixed","name":"User.Addresses"},{"_id":"5720459e5be73c17009601bd","ref":"","in":"body","required":false,"desc":"0 = street address","default":"0","type":"int","name":"User.Addresses.Type"},{"_id":"5720459e5be73c17009601bc","ref":"","in":"body","required":true,"desc":"Address details - Line 1","default":"","type":"string","name":"User.Addresses.AddressLine1"},{"_id":"5720459e5be73c17009601bb","ref":"","in":"body","required":false,"desc":"Address details - Line 2 (if applicable)","default":"","type":"string","name":"User.Addresses.AddressLine2"},{"_id":"5720459e5be73c17009601ba","ref":"","in":"body","required":false,"desc":"Address details - Line 3 (if applicable)","default":"","type":"string","name":"User.Addresses.AddressLine3"},{"_id":"5720459e5be73c17009601b9","ref":"","in":"body","required":true,"desc":"Suburb or County details","default":"","type":"string","name":"User.Addresses.SuburbCounty"},{"_id":"5720459e5be73c17009601b8","ref":"","in":"body","required":false,"desc":"State or Town or City details","default":"","type":"string","name":"User.Addresses.TownCityState"},{"_id":"5720459e5be73c17009601b7","ref":"","in":"body","required":true,"desc":"Postcode","default":"","type":"string","name":"User.Addresses.Postcode"},{"_id":"5720459e5be73c17009601b6","ref":"","in":"body","required":true,"desc":"AUS = Australia","default":"","type":"string","name":"User.Addresses.Country"},{"_id":"5720459e5be73c17009601b5","ref":"","in":"body","required":true,"desc":"The User's Phone Number","default":"","type":"string","name":"User.Phone"},{"_id":"5720459e5be73c17009601b4","ref":"","in":"body","required":false,"desc":"An alternative phone number for the investor","default":"","type":"string","name":"User.PhoneAlt"},{"_id":"5720459e5be73c17009601b3","ref":"","in":"body","required":false,"desc":"The ID for the service that the user will log in to.","default":"","type":"string","name":"User.ServiceID"},{"_id":"5720459e5be73c17009601b2","ref":"","in":"body","required":false,"desc":"Location of the User","default":"","type":"string","name":"User.Location"},{"_id":"5720459e5be73c17009601b1","ref":"","in":"body","required":false,"desc":"Team that User is part of","default":"","type":"string","name":"User.Team"},{"_id":"5720459e5be73c17009601b0","ref":"","in":"body","required":false,"desc":"The Users Job Title","default":"","type":"string","name":"User.JobTitle"},{"_id":"5720459e5be73c17009601af","ref":"","in":"body","required":false,"desc":"The adviser ID for this user's adviser","default":"","type":"int","name":"User.AdviserID"},{"_id":"57a27d3cb7d9350e00a451d7","ref":"","in":"query","required":false,"desc":"The integer ID of user that is being used to create new user","default":"","type":"int","name":"ModifiedUserId"},{"_id":"5ada8b472c87d800035ebf8b","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8f9a325ad3000338d58d","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Users"},"isReference":true,"order":12,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **SSO/User Management**\"\n}\n[/block]","excerpt":"This endpoint creates a new user in the system.","slug":"user","type":"post","title":"Users","__v":16,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postUsers

This endpoint creates a new user in the system.

Query Params

ModifiedUserId:
integer
The integer ID of user that is being used to create new user

Body Params

User.ID:
required
string
The ID that the user will type when logging in
User.Name:
object
Contains the name of the person we are creating a user for.
User.Name.Title:
string
Title of the User
User.Name.First:
required
string
The User's First Name
User.Name.Last:
required
string
The User's Last Name
User.Gender:
string
Male, Female, or Null
User.Type:
integer
1 = investor
User.UserLevel:
integer
1 = standard investor user
User.Email:
required
string
The User's Email Address
User.DateOfBirth:
yyyy-mm-dd
For security purposes if we need to identify the user over the phone
User.MothersMaidenName:
string
For security purposes if we need to identify the user over the phone
User.Addresses:
array of mixed
Contains details of the user's address
User.Addresses.Type:
integer0
0 = street address
User.Addresses.AddressLine1:
required
string
Address details - Line 1
User.Addresses.AddressLine2:
string
Address details - Line 2 (if applicable)
User.Addresses.AddressLine3:
string
Address details - Line 3 (if applicable)
User.Addresses.SuburbCounty:
required
string
Suburb or County details
User.Addresses.TownCityState:
string
State or Town or City details
User.Addresses.Postcode:
required
string
Postcode
User.Addresses.Country:
required
string
AUS = Australia
User.Phone:
required
string
The User's Phone Number
User.PhoneAlt:
string
An alternative phone number for the investor
User.ServiceID:
string
The ID for the service that the user will log in to.
User.Location:
string
Location of the User
User.Team:
string
Team that User is part of
User.JobTitle:
string
The Users Job Title
User.AdviserID:
integer
The adviser ID for this user's adviser

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
[block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SSO/User Management**" } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SSO/User Management**" } [/block]
{"_id":"5d8b0b31c4b9960018c59a22","category":"5d8b0b31c4b9960018c59a01","user":"55ca87c48705a70d00b8fc5c","project":"55ca8813e583751700f78a58","parentDoc":null,"version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-25T06:12:01.218Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"","code":"GET http://{URL as provided}/Pds HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n","language":"json"}]},"method":"get","results":{"codes":[{"language":"json","code":"[\n\t{\n\t\t\"Id\":\"AU49\",\n\t\t\"Name\":\"Praemium Diversified Portfolios\",\n\t\t\"IsSuperSma\":false,\n    \"BpayBillerCode\":\"347112\",\n\t\t\"AccountTypes\":[\n\t\t\t1\n\t\t],\n\t\t\"Fees\":[\n\t\t{\n\t\t\t\"Id\":\"AU9029\",\n\t\t\t\"Type\":0,\n\t\t\t\"Name\":\"Administration Fee\",\n\t\t\t\"Tiers\":[\n\t\t\t{\n\t\t\t\t\"ValueAppliedFrom\":0.0,\n\t\t\t\t\"FeePercent\":0.336,\n\t\t\t\t\"FeePercentWithTax\":0.3696\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"ValueAppliedFrom\":250001.0,\n\t\t\t\t\"FeePercent\":0.264,\n\t\t\t\t\"FeePercentWithTax\":0.2904\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"ValueAppliedFrom\":500001.0,\n\t\t\t\t\"FeePercent\":0.218,\n\t\t\t\t\"FeePercentWithTax\":0.2398\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"ValueAppliedFrom\":1000001.0,\n\t\t\t\t\"FeePercent\":0.173,\n\t\t\t\t\"FeePercentWithTax\":0.1903\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"ValueAppliedFrom\":2000001.0,\n\t\t\t\t\"FeePercent\":0.064,\n\t\t\t\t\"FeePercentWithTax\":0.0704\n\t\t\t}\n\t\t\t],\n\t\t\t\t\"DefaultValue\":0.336,\n\t\t\t\t\"DefaultValueWithTax\":0.3696,\n\t\t\t\t\"DefaultType\":2\n\t\t\t}\n\t\t\t],\n\t\t\"Models\":[\n\t\t\t{\n\t\t\t\t\"Code\":\"SM0001\",\n\t\t\t\t\"Name\":\"Smart Investment ASX Top20\",\n\t\t\t\t\"Style\":\"Australian Shares\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"Code\":\"XX9999\",\n\t\t\t\t\"Name\":\"Cash Model\",\n\t\t\t\t\"Style\":\"100% Cash\"\n\t\t\t}\n\t\t\t],\n\t\t\"BankAccountUsages\":[\n\t\t\t{\n\t\t\t\t\"Usage\":\"SMAFEE\",\n\t\t\t\t\"Description\":\"Fee offset\",\n\t\t\t\t\"IsMandatory\":false,\n\t\t\t\t\"Notes\":\"If no bank account is selected, fees will be deducted from your SMA cash account.\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"Usage\":\"INCOME\",\n\t\t\t\t\"Description\":\"Income payment\",\n\t\t\t\t\"IsMandatory\":false,\n\t\t\t\t\"Notes\":\"If no bank account is selected, income or dividends received will form part of your cash holding.\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"Usage\":\"RCP\",\n\t\t\t\t\"Description\":\"Regular Contribution Plan\",\n\t\t\t\t\"IsMandatory\":false,\n\t\t\t\t\"Notes\":\"Regular Contribution Plan\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"Usage\":\"CASHCON\",\n\t\t\t\t\"Description\":\"Cash contributions\",\n\t\t\t\t\"IsMandatory\":true,\n\t\t\t\t\"Notes\":\"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"Usage\":\"SMAWDWL\",\n\t\t\t\t\"Description\":\"Withdrawals from the SMA\",\n\t\t\t\t\"IsMandatory\":true,\n\t\t\t\t\"Notes\":\"\"\n\t\t\t}\n\t\t\t],\n\t\t\"TaxOptions\":[\n\t\t\t{\n\t\t\t\t\"Code\":\"WTFN\",\n\t\t\t\t\"Description\":\"Resident with TFN\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"Code\":\"RABN\",\n\t\t\t\t\"Description\":\"Resident with ABN\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"Code\":\"ALPH\",\n\t\t\t\t\"Description\":\"Alphabetic Tax No quoted\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"Code\":\"NTFN\",\n\t\t\t\t\"Description\":\"Resident without TFN or ABN\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"Code\":\"BUS\",\n\t\t\t\t\"Description\":\"Financial Services\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"Code\":\"AGED\",\n\t\t\t\t\"Description\":\"Aged Pension Exemption\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"Code\":\"CARE\",\n\t\t\t\t\"Description\":\"Carer's Pension Exemption\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"Code\":\"INVD\",\n\t\t\t\t\"Description\":\"Invalid Pension Exemption\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"Code\":\"NONP\",\n\t\t\t\t\"Description\":\"Non-Profit Organisation Exemption\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"Code\":\"RHAB\",\n\t\t\t\t\"Description\":\"Rehabilitaton Allowance Exemption\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"Code\":\"SERV\",\n\t\t\t\t\"Description\":\"Service/Veteran's Pension Exemption\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"Code\":\"SOLE\",\n\t\t\t\t\"Description\":\"Sole Parent's Pension Exemption\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"Code\":\"SPEC\",\n\t\t\t\t\"Description\":\"Special Benefit Exemption\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"Code\":\"WIDW\",\n\t\t\t\t\"Description\":\"Widow's Pension Exemption\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"Code\":\"WIFE\",\n\t\t\t\t\"Description\":\"Wife's Pension Exemption\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"Code\":\"EXMT\",\n\t\t\t\t\"Description\":\"Resident with Exemption\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"Code\":\"TERR\",\n\t\t\t\t\"Description\":\"Norfolk Island residents\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"Code\":\"NRWT\",\n\t\t\t\t\"Description\":\"Non-resident of Australia\"\n\t\t\t}\n\t\t\t]\n\t},\n]","name":"","status":200}]},"settings":"","auth":"required","params":[{"_id":"5ada8a92342d70000384e0c2","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8e56325ad3000338d56e","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Pds"},"isReference":true,"order":13,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"What's a PDS?\",\n  \"body\": \"The Product Disclosure Statement (PDS) explains all of the details of an investment product to an investor. We provide all those details in the PDS endpoint so that the accounts you create are in line with what your investor has been shown.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **SMA/Robo, Enterprise**\"\n}\n[/block]\nWhat the PDS endpoint contains\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"ID\",\n    \"0-1\": \"The `PdsID`.\",\n    \"1-0\": \"Name\",\n    \"1-1\": \"The official name of the investment product\",\n    \"h-1\": \"Description\",\n    \"2-0\": \"IsSuperSMA\",\n    \"2-1\": \"Whether this PDS is part of our SuperSMA product.\",\n    \"4-0\": \"AccountTypes\",\n    \"4-1\": \"The different types of account that can be set up against the PDS\",\n    \"7-0\": \"Fees.Name\",\n    \"7-1\": \"How to describe the fee\",\n    \"8-0\": \"Fees.DollarOverride.MinValue\",\n    \"8-1\": \"If the default fee can be overridden with a dollar amount, the minimum fee (excluding taxes)\",\n    \"9-0\": \"Fees.DollarOverride.MaxValue\",\n    \"9-1\": \"If the default fee can be overridden with a dollar amount, the maximum fee (excluding taxes)\",\n    \"10-0\": \"Fees.DollarOverride.MinValueWithTax\",\n    \"10-1\": \"If the default fee can be overridden with a dollar amount, the minimum fee (including taxes)\",\n    \"11-1\": \"If the default fee can be overridden with a dollar amount, the maximum fee (including taxes)\",\n    \"11-0\": \"Fees.DollarOverride.MaxValueWithTax\",\n    \"h-0\": \"Property\",\n    \"12-0\": \"Fees.PercentOverride.MinValue\",\n    \"12-1\": \"If the default fee can be overridden with a percentage rate, the minimum fee (excluding taxes)\",\n    \"13-0\": \"Fees.PercentOverride.MaxValue\",\n    \"13-1\": \"If the default fee can be overridden with a percentage rate, the maximum fee (excluding taxes)\",\n    \"14-0\": \"Fees.PercentOverride.MinValueWithTax\",\n    \"14-1\": \"If the default fee can be overridden with a percentage rate, the minimum fee (including taxes)\",\n    \"15-0\": \"Fees.PercentOverride.MaxValueWithTax\",\n    \"15-1\": \"If the default fee can be overridden with a percentage rate, the maximum fee (including taxes)\",\n    \"16-0\": \"Fees.Tiers.ValueAppliedFrom\",\n    \"16-1\": \"For a tiered fee, the lower limit of the account value that this rate applies to\",\n    \"17-0\": \"Fees.Tiers.FeePercent\",\n    \"17-1\": \"The percentage fee rate that applies to this tier (excluding taxes)\",\n    \"18-1\": \"The percentage fee rate that applies to this tier (including taxes)\",\n    \"18-0\": \"Fees.Tiers.FeePercentWithTax\",\n    \"20-0\": \"Models.Code\",\n    \"20-1\": \"Our identifier for the model\",\n    \"21-0\": \"Models.Name\",\n    \"21-1\": \"The name for the model\",\n    \"22-0\": \"Models.Style\",\n    \"22-1\": \"A brief description of the model's investments\",\n    \"6-0\": \"Fees.ID\",\n    \"5-0\": \"Fees\",\n    \"5-1\": \"Contains details of the fees charged to accounts in the PDS\",\n    \"6-1\": \"Our internal ID for each fee that is chargeable to an account within the PDS\",\n    \"19-0\": \"Models\",\n    \"19-1\": \"The investment models available in the PDS\",\n    \"23-0\": \"BankAccountUsages\",\n    \"23-1\": \"Contains the different ways that accounts can interact with external bank accounts\",\n    \"24-0\": \"BankAccountUsages.Usage\",\n    \"24-1\": \"Our code for the bank account usage\",\n    \"25-0\": \"BankAccountUsages.Description\",\n    \"25-1\": \"Our description for the bank account usage\",\n    \"26-0\": \"BankAccountUsages.IsMandatory\",\n    \"26-1\": \"If this is True, a bank account with this usage must be supplied\",\n    \"27-0\": \"BankAccountUsages.Notes\",\n    \"27-1\": \"Explanatory notes on the usage to provide to your users\",\n    \"28-0\": \"TaxOptions\",\n    \"28-1\": \"Contains the different tax statuses (tax rate elections) an investor in the product may have.\",\n    \"29-0\": \"TaxOptions.Code\",\n    \"29-1\": \"Our code for the tax rate election\",\n    \"30-0\": \"TaxOptions.Description\",\n    \"30-1\": \"A description of the status\",\n    \"3-0\": \"BpayBillerCode\",\n    \"3-1\": \"BPay biller code\"\n  },\n  \"cols\": 2,\n  \"rows\": 31\n}\n[/block]","excerpt":"This endpoint returns details of all the Product Disclosure Statements (PDS).","slug":"pds","type":"get","title":"PDS","__v":12,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getPDS

This endpoint returns details of all the Product Disclosure Statements (PDS).

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
[block:callout] { "type": "info", "title": "What's a PDS?", "body": "The Product Disclosure Statement (PDS) explains all of the details of an investment product to an investor. We provide all those details in the PDS endpoint so that the accounts you create are in line with what your investor has been shown." } [/block] [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block] What the PDS endpoint contains [block:parameters] { "data": { "0-0": "ID", "0-1": "The `PdsID`.", "1-0": "Name", "1-1": "The official name of the investment product", "h-1": "Description", "2-0": "IsSuperSMA", "2-1": "Whether this PDS is part of our SuperSMA product.", "4-0": "AccountTypes", "4-1": "The different types of account that can be set up against the PDS", "7-0": "Fees.Name", "7-1": "How to describe the fee", "8-0": "Fees.DollarOverride.MinValue", "8-1": "If the default fee can be overridden with a dollar amount, the minimum fee (excluding taxes)", "9-0": "Fees.DollarOverride.MaxValue", "9-1": "If the default fee can be overridden with a dollar amount, the maximum fee (excluding taxes)", "10-0": "Fees.DollarOverride.MinValueWithTax", "10-1": "If the default fee can be overridden with a dollar amount, the minimum fee (including taxes)", "11-1": "If the default fee can be overridden with a dollar amount, the maximum fee (including taxes)", "11-0": "Fees.DollarOverride.MaxValueWithTax", "h-0": "Property", "12-0": "Fees.PercentOverride.MinValue", "12-1": "If the default fee can be overridden with a percentage rate, the minimum fee (excluding taxes)", "13-0": "Fees.PercentOverride.MaxValue", "13-1": "If the default fee can be overridden with a percentage rate, the maximum fee (excluding taxes)", "14-0": "Fees.PercentOverride.MinValueWithTax", "14-1": "If the default fee can be overridden with a percentage rate, the minimum fee (including taxes)", "15-0": "Fees.PercentOverride.MaxValueWithTax", "15-1": "If the default fee can be overridden with a percentage rate, the maximum fee (including taxes)", "16-0": "Fees.Tiers.ValueAppliedFrom", "16-1": "For a tiered fee, the lower limit of the account value that this rate applies to", "17-0": "Fees.Tiers.FeePercent", "17-1": "The percentage fee rate that applies to this tier (excluding taxes)", "18-1": "The percentage fee rate that applies to this tier (including taxes)", "18-0": "Fees.Tiers.FeePercentWithTax", "20-0": "Models.Code", "20-1": "Our identifier for the model", "21-0": "Models.Name", "21-1": "The name for the model", "22-0": "Models.Style", "22-1": "A brief description of the model's investments", "6-0": "Fees.ID", "5-0": "Fees", "5-1": "Contains details of the fees charged to accounts in the PDS", "6-1": "Our internal ID for each fee that is chargeable to an account within the PDS", "19-0": "Models", "19-1": "The investment models available in the PDS", "23-0": "BankAccountUsages", "23-1": "Contains the different ways that accounts can interact with external bank accounts", "24-0": "BankAccountUsages.Usage", "24-1": "Our code for the bank account usage", "25-0": "BankAccountUsages.Description", "25-1": "Our description for the bank account usage", "26-0": "BankAccountUsages.IsMandatory", "26-1": "If this is True, a bank account with this usage must be supplied", "27-0": "BankAccountUsages.Notes", "27-1": "Explanatory notes on the usage to provide to your users", "28-0": "TaxOptions", "28-1": "Contains the different tax statuses (tax rate elections) an investor in the product may have.", "29-0": "TaxOptions.Code", "29-1": "Our code for the tax rate election", "30-0": "TaxOptions.Description", "30-1": "A description of the status", "3-0": "BpayBillerCode", "3-1": "BPay biller code" }, "cols": 2, "rows": 31 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "title": "What's a PDS?", "body": "The Product Disclosure Statement (PDS) explains all of the details of an investment product to an investor. We provide all those details in the PDS endpoint so that the accounts you create are in line with what your investor has been shown." } [/block] [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block] What the PDS endpoint contains [block:parameters] { "data": { "0-0": "ID", "0-1": "The `PdsID`.", "1-0": "Name", "1-1": "The official name of the investment product", "h-1": "Description", "2-0": "IsSuperSMA", "2-1": "Whether this PDS is part of our SuperSMA product.", "4-0": "AccountTypes", "4-1": "The different types of account that can be set up against the PDS", "7-0": "Fees.Name", "7-1": "How to describe the fee", "8-0": "Fees.DollarOverride.MinValue", "8-1": "If the default fee can be overridden with a dollar amount, the minimum fee (excluding taxes)", "9-0": "Fees.DollarOverride.MaxValue", "9-1": "If the default fee can be overridden with a dollar amount, the maximum fee (excluding taxes)", "10-0": "Fees.DollarOverride.MinValueWithTax", "10-1": "If the default fee can be overridden with a dollar amount, the minimum fee (including taxes)", "11-1": "If the default fee can be overridden with a dollar amount, the maximum fee (including taxes)", "11-0": "Fees.DollarOverride.MaxValueWithTax", "h-0": "Property", "12-0": "Fees.PercentOverride.MinValue", "12-1": "If the default fee can be overridden with a percentage rate, the minimum fee (excluding taxes)", "13-0": "Fees.PercentOverride.MaxValue", "13-1": "If the default fee can be overridden with a percentage rate, the maximum fee (excluding taxes)", "14-0": "Fees.PercentOverride.MinValueWithTax", "14-1": "If the default fee can be overridden with a percentage rate, the minimum fee (including taxes)", "15-0": "Fees.PercentOverride.MaxValueWithTax", "15-1": "If the default fee can be overridden with a percentage rate, the maximum fee (including taxes)", "16-0": "Fees.Tiers.ValueAppliedFrom", "16-1": "For a tiered fee, the lower limit of the account value that this rate applies to", "17-0": "Fees.Tiers.FeePercent", "17-1": "The percentage fee rate that applies to this tier (excluding taxes)", "18-1": "The percentage fee rate that applies to this tier (including taxes)", "18-0": "Fees.Tiers.FeePercentWithTax", "20-0": "Models.Code", "20-1": "Our identifier for the model", "21-0": "Models.Name", "21-1": "The name for the model", "22-0": "Models.Style", "22-1": "A brief description of the model's investments", "6-0": "Fees.ID", "5-0": "Fees", "5-1": "Contains details of the fees charged to accounts in the PDS", "6-1": "Our internal ID for each fee that is chargeable to an account within the PDS", "19-0": "Models", "19-1": "The investment models available in the PDS", "23-0": "BankAccountUsages", "23-1": "Contains the different ways that accounts can interact with external bank accounts", "24-0": "BankAccountUsages.Usage", "24-1": "Our code for the bank account usage", "25-0": "BankAccountUsages.Description", "25-1": "Our description for the bank account usage", "26-0": "BankAccountUsages.IsMandatory", "26-1": "If this is True, a bank account with this usage must be supplied", "27-0": "BankAccountUsages.Notes", "27-1": "Explanatory notes on the usage to provide to your users", "28-0": "TaxOptions", "28-1": "Contains the different tax statuses (tax rate elections) an investor in the product may have.", "29-0": "TaxOptions.Code", "29-1": "Our code for the tax rate election", "30-0": "TaxOptions.Description", "30-1": "A description of the status", "3-0": "BpayBillerCode", "3-1": "BPay biller code" }, "cols": 2, "rows": 31 } [/block]
{"_id":"5d8b0b31c4b9960018c59a2d","category":"5d8b0b31c4b9960018c59a01","parentDoc":null,"project":"55ca8813e583751700f78a58","user":"55a49cd3e6c2470d002a648c","version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-27T07:01:40.557Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"language":"json","code":"GET http://{URL as provided}/Accounts HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\n{\n       \"ModifiedUserId\": 15642,\n  \t\t \"UserId\": 12345,\n       \"AccountIds\": [“AU1234”, “AU1235”]\n}\n\n"}]},"method":"patch","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"auth":"required","params":[{"_id":"5720459e5be73c17009601c7","ref":"","in":"body","required":true,"desc":"The ID that is being used to modify the link","default":"","type":"int","name":"ModifiedUserID"},{"_id":"5720459e5be73c17009601ae","ref":"","in":"body","required":true,"desc":"The user who will have access to the account","default":"","type":"int","name":"UserID"},{"_id":"572063d4c669e80e00c34f9f","ref":"","in":"body","required":true,"desc":"contains the accounts that the user will be able to view","default":"","type":"array_string","name":"AccountIDs"},{"_id":"572063d4c669e80e00c34f9e","ref":"","in":"body","required":false,"desc":"The `AccountID` as returned by the Accounts request","default":"","type":"string","name":"AccountID"},{"_id":"5ada8b528274b90003079218","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8fc593588300034e645b","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Accounts"},"isReference":true,"order":14,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **SMA/Robo, Enterprise**\"\n}\n[/block]","excerpt":"This endpoint is used to associate an investor with an account.","slug":"link-a-user-to-an-account","type":"patch","title":"Link a User to an Account","__v":10,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

patchLink a User to an Account

This endpoint is used to associate an investor with an account.

Body Params

ModifiedUserID:
required
integer
The ID that is being used to modify the link
UserID:
required
integer
The user who will have access to the account
AccountIDs:
required
array of strings
contains the accounts that the user will be able to view
AccountID:
string
The `AccountID` as returned by the Accounts request

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
[block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block]

User Information

Try It Out

patch
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block]
{"_id":"5d8b0b31c4b9960018c59a2e","category":"5d8b0b31c4b9960018c59a01","user":"55dd6ff10efd5821000d5471","project":"55ca8813e583751700f78a58","parentDoc":null,"version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-23T00:34:34.728Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"GET http://{URL as provided}/SuperFunds HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n","name":""}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"[  \n   {  \n      \"Usi\":\"40339821422001\",\n      \"FundName\":\"1611 Superannuation Fund\",\n      \"ProductName\":\"1611 Superannuation Fund\"\n   },\n   {  \n      \"Usi\":\"83490759952001\",\n      \"FundName\":\"55/63 Private Superannuation Fund\",\n      \"ProductName\":\"55/63 Private Superannuation Fund\"\n   },\n   {  \n      \"Usi\":\"56434745609001\",\n      \"FundName\":\"A & B Sutherland Super Fund\",\n      \"ProductName\":\"A & B Sutherland Super Fund\"\n   },\n   {  \n      \"Usi\":\"42093108789001\",\n      \"FundName\":\"A & C Ward Superannuation Fund\",\n      \"ProductName\":\"A & C Ward Superannuation Fund\"\n   },\n   {  \n      \"Usi\":\"97673231129001\",\n      \"FundName\":\"A & L Peterson Private Superannuation Fund\",\n      \"ProductName\":\"A & L Peterson Private Superannuation Fund\"\n   },\n   {  \n      \"Usi\":\"84437140301001\",\n      \"FundName\":\"A & L Thomas Private Superannuation Fund\",\n      \"ProductName\":\"A & L Thomas Private Superannuation Fund\"\n   },\n   {  \n      \"Usi\":\"WAL0001AU\",\n      \"Spin\": \"WAL0001AU\",\n      \"FundName\":\"WA Local Government Superannuation Plan\",\n      \"ProductName\":\"WA Super Super Solutions\"\n   },\n   {  \n      \"Usi\":\"33632838393987\",\n      \"Spin\": \"ZUR0473AU\",\n      \"FundName\":\"Zurich Master Superannuation Fund\",\n      \"ProductName\":\"Zurich Master Superannuation Fund\"\n   }\n]","name":""}]},"settings":"","auth":"required","params":[{"_id":"5ada8b6b8274b90003079219","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8fd793588300034e645c","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/SuperFunds"},"isReference":true,"order":15,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"What's an App Form?\",\n  \"body\": \"An application form is a confirmation to the client of the details of their account. It includes a signoff from them that they agree to our terms and conditions.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **SMA/Robo, Enterprise**\"\n}\n[/block]","excerpt":"Use this endpoint to request a PDF application form for an account.","slug":"super-funds","type":"get","title":"Super Funds","__v":6,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getSuper Funds

Use this endpoint to request a PDF application form for an account.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
[block:callout] { "type": "info", "title": "What's an App Form?", "body": "An application form is a confirmation to the client of the details of their account. It includes a signoff from them that they agree to our terms and conditions." } [/block] [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "title": "What's an App Form?", "body": "An application form is a confirmation to the client of the details of their account. It includes a signoff from them that they agree to our terms and conditions." } [/block] [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block]
{"_id":"5d8b0b31c4b9960018c59a2f","category":"5d8b0b31c4b9960018c59a01","parentDoc":null,"user":"55dd6ff10efd5821000d5471","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-08-09T00:58:58.214Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"GET http://{URL as provided}/BeneficiaryNominations HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\n{\n  \"AccountId\": \"AU200123\",\n  \"IsBinding\": false,\n  \"ModifiedUserId\": 123456,\n  \"Beneficiaries\": [\n    {\n      \"Type\": 1,\n      \"FullName\": \"Ms Mary Smith\",\n      \"RelationshipToMember\": 1,\n      \"Proportion\": 100,\n      \"DateOfBirth\": \"1990-01-01\"\n    }\n  ]\n}\n\n","language":"json","name":"Standard beneficiary nomination"},{"name":"Reversionary beneficiary nomination","code":"GET http://{URL as provided}/accounts HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\n\n{\n  \"AccountId\": \"AU200123\",\n  \"IsBinding\": false,\n  \"ModifiedUserId\": 123456,\n  \"Beneficiaries\": [\n    {\n      \"Type\": 0,\n      \"FullName\": \"Ms Mary Smith\",\n      \"RelationshipToMember\": 1,\n      \"Proportion\": 50,\n      \"DateOfBirth\": \"1990-01-01\"\n    },\n    {\n      \"Type\": 0,\n      \"FullName\": \"Ms James Smith\",\n      \"RelationshipToMember\": 1,\n      \"Proportion\": 50,\n      \"DateOfBirth\": \"1990-01-01\"\n    }\n  ]\n}","language":"json"}]},"method":"post","results":{"codes":[{"language":"json","status":201,"name":"","code":"{}"},{"code":"{}","language":"json","status":400,"name":""}]},"settings":"","auth":"required","params":[{"_id":"57a92dc27cb8f80e0031390b","ref":"","in":"body","required":true,"desc":"The user ID we have allocated for your API","default":"","type":"int","name":"ModifiedUserId"},{"_id":"57a92d09bf6e210e00b1a389","ref":"","in":"body","required":false,"desc":"The `AccountID` as returned by the Accounts endpoint.","default":"","type":"string","name":"AccountId"},{"_id":"57a92d179d46870e006e982c","ref":"","in":"body","required":false,"desc":"Whether or not the nomination is binding","default":"","type":"boolean","name":"IsBinding"},{"_id":"57a92dc27cb8f80e0031390a","ref":"","in":"body","required":false,"desc":"","default":"","type":"array_object","name":"Beneficiaries"},{"_id":"57a92dc27cb8f80e00313909","ref":"","in":"body","required":false,"desc":"Standard = 0, reversionary pensioner = 1","default":"","type":"string","name":"Beneficiaries.Type"},{"_id":"57a92dc27cb8f80e00313908","ref":"","in":"body","required":false,"desc":"The full legal name of the beneficiary","default":"","type":"string","name":"Beneficiaries.FullName"},{"_id":"57a92dc27cb8f80e00313907","ref":"","in":"body","required":false,"desc":"Spouse = 1, child = 2, other = 3","default":"","type":"int","name":"Beneficiaries.RelationshipToMember"},{"_id":"57a92dc27cb8f80e00313906","ref":"","in":"body","required":false,"desc":"The portion of the benefit that should be paid to the beneficiary. These must add up to 100%.","default":"","type":"double","name":"Beneficiaries.Proportion"},{"_id":"57a92dc27cb8f80e00313905","ref":"","in":"body","required":false,"desc":"The beneficiary's date of birth","default":"","type":"yyyy-mm-dd","name":"Beneficiaries.DateOfBirth"},{"_id":"5ada8b8193588300034e641c","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada8fece80ca4000326d62b","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/BeneficiaryNominations"},"isReference":true,"order":16,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **SMA/Robo, Enterprise**\"\n}\n[/block]","excerpt":"This endpoint is used to associate an investor with an account.","slug":"beneficiary-nominations","type":"post","title":"Beneficiary Nominations","__v":12,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postBeneficiary Nominations

This endpoint is used to associate an investor with an account.

Body Params

ModifiedUserId:
required
integer
The user ID we have allocated for your API
AccountId:
string
The `AccountID` as returned by the Accounts endpoint.
IsBinding:
boolean
Whether or not the nomination is binding
Beneficiaries:
array of objects
Beneficiaries.Type:
string
Standard = 0, reversionary pensioner = 1
Beneficiaries.FullName:
string
The full legal name of the beneficiary
Beneficiaries.RelationshipToMember:
integer
Spouse = 1, child = 2, other = 3
Beneficiaries.Proportion:
double
The portion of the benefit that should be paid to the beneficiary. These must add up to 100%.
Beneficiaries.DateOfBirth:
yyyy-mm-dd
The beneficiary's date of birth

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
[block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block]
{"_id":"5d8b0b31c4b9960018c59a30","category":"5d8b0b31c4b9960018c59a01","parentDoc":null,"user":"55a49cd3e6c2470d002a648c","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-10-24T00:58:01.839Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"GET http://{URL as provided}/accounts/AU123456/HoldingsByModel?FromDate=2016-10-20&ToDate=2016-10-21 HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n   \"AccountId\":\"AU12345\",\n   \"FromDate\":\"2016-10-15T00:00:00\",\n   \"ToDate\":\"2016-10-15T00:00:00\",\n   \"HoldingsByModel\":[\n      {\n         \"Date\":\"2016-10-15T00:00:00\",\n         \"TotalValue\":48957.22,\n         \"HoldingsInModel\":[\n            {\n               \"ModelCode\":\"IV0007\",\n               \"ModelDescription\":\"Intelligent Investor Growth\",\n               \"ModelPercentage\":48.48,\n               \"Holdings\":[\n                  {\n                     \"Asset\":\"AGI\",\n                     \"Value\":433.70,\n                     \"Quantity\":202.66\n                  },\n                  {\n                     \"Asset\":\"ANN\",\n                     \"Value\":960.36,\n                     \"Quantity\":41.11\n                  },\n                  {\n                     \"Asset\":\"ASX\",\n                     \"Value\":1550.22,\n                     \"Quantity\":32.59\n                  },\n                  {\n                     \"Asset\":\"AUDCASH\",\n                     \"Value\":323.58,\n                     \"Quantity\":323.40\n                  },\n                  {\n                     \"Asset\":\"AYS\",\n                     \"Value\":1102.36,\n                     \"Quantity\":508.00\n                  },\n                  {\n                     \"Asset\":\"BHP\",\n                     \"Value\":644.13,\n                     \"Quantity\":28.58\n                  },\n                  {\n                     \"Asset\":\"CAR\",\n                     \"Value\":698.81,\n                     \"Quantity\":57.05\n                  },\n                  {\n                     \"Asset\":\"CPU\",\n                     \"Value\":1077.80,\n                     \"Quantity\":101.78\n                  },\n                  {\n                     \"Asset\":\"CWN\",\n                     \"Value\":414.40,\n                     \"Quantity\":32.00\n                  },\n                  {\n                     \"Asset\":\"FWD\",\n                     \"Value\":807.84,\n                     \"Quantity\":408.00\n                  },\n                  {\n                     \"Asset\":\"GBT\",\n                     \"Value\":1080.22,\n                     \"Quantity\":270.73\n                  },\n                  {\n                     \"Asset\":\"HSN\",\n                     \"Value\":1136.64,\n                     \"Quantity\":256.00\n                  },\n                  {\n                     \"Asset\":\"ICQ\",\n                     \"Value\":240.25,\n                     \"Quantity\":775.00\n                  },\n                  {\n                     \"Asset\":\"IFL\",\n                     \"Value\":957.44,\n                     \"Quantity\":113.31\n                  },\n                  {\n                     \"Asset\":\"MQG\",\n                     \"Value\":780.64,\n                     \"Quantity\":9.53\n                  },\n                  {\n                     \"Asset\":\"MVF\",\n                     \"Value\":911.63,\n                     \"Quantity\":383.04\n                  },\n                  {\n                     \"Asset\":\"NAN\",\n                     \"Value\":882.32,\n                     \"Quantity\":269.00\n                  },\n                  {\n                     \"Asset\":\"NWS\",\n                     \"Value\":898.44,\n                     \"Quantity\":49.39\n                  },\n                  {\n                     \"Asset\":\"OFX\",\n                     \"Value\":613.18,\n                     \"Quantity\":364.99\n                  },\n                  {\n                     \"Asset\":\"ORG\",\n                     \"Value\":324.97,\n                     \"Quantity\":58.66\n                  },\n                  {\n                     \"Asset\":\"PPT\",\n                     \"Value\":937.94,\n                     \"Quantity\":20.05\n                  },\n                  {\n                     \"Asset\":\"RMD\",\n                     \"Value\":848.00,\n                     \"Quantity\":100.00\n                  },\n                  {\n                     \"Asset\":\"S32\",\n                     \"Value\":1252.07,\n                     \"Quantity\":504.87\n                  },\n                  {\n                     \"Asset\":\"SEK\",\n                     \"Value\":1008.28,\n                     \"Quantity\":65.18\n                  },\n                  {\n                     \"Asset\":\"SYD\",\n                     \"Value\":1101.84,\n                     \"Quantity\":167.45\n                  },\n                  {\n                     \"Asset\":\"TME\",\n                     \"Value\":1639.47,\n                     \"Quantity\":333.90\n                  },\n                  {\n                     \"Asset\":\"VRT\",\n                     \"Value\":1041.77,\n                     \"Quantity\":144.89\n                  }\n               ]\n            },\n            {\n               \"ModelCode\":\"IV0008\",\n               \"ModelDescription\":\"Intelligent Investor Equity Income\",\n               \"ModelPercentage\":49.52,\n               \"Holdings\":[\n                  {\n                     \"Asset\":\"AGI\",\n                     \"Value\":431.35,\n                     \"Quantity\":201.57\n                  },\n                  {\n                     \"Asset\":\"ANN\",\n                     \"Value\":955.16,\n                     \"Quantity\":40.89\n                  },\n                  {\n                     \"Asset\":\"ASX\",\n                     \"Value\":1541.83,\n                     \"Quantity\":32.41\n                  },\n                  {\n                     \"Asset\":\"AUDCASH\",\n                     \"Value\":321.83,\n                     \"Quantity\":321.65\n                  },\n                  {\n                     \"Asset\":\"BHP\",\n                     \"Value\":640.65,\n                     \"Quantity\":28.42\n                  },\n                  {\n                     \"Asset\":\"CAR\",\n                     \"Value\":695.03,\n                     \"Quantity\":56.74\n                  },\n                  {\n                     \"Asset\":\"CBA\",\n                     \"Value\":1342.44,\n                     \"Quantity\":18.00\n                  },\n                  {\n                     \"Asset\":\"CPU\",\n                     \"Value\":1071.97,\n                     \"Quantity\":101.22\n                  },\n                  {\n                     \"Asset\":\"GBT\",\n                     \"Value\":1074.38,\n                     \"Quantity\":269.27\n                  },\n                  {\n                     \"Asset\":\"HPI\",\n                     \"Value\":671.58,\n                     \"Quantity\":234.00\n                  },\n                  {\n                     \"Asset\":\"IFL\",\n                     \"Value\":952.26,\n                     \"Quantity\":112.69\n                  },\n                  {\n                     \"Asset\":\"LEP\",\n                     \"Value\":996.80,\n                     \"Quantity\":224.00\n                  },\n                  {\n                     \"Asset\":\"MQG\",\n                     \"Value\":776.41,\n                     \"Quantity\":9.47\n                  },\n                  {\n                     \"Asset\":\"MVF\",\n                     \"Value\":906.69,\n                     \"Quantity\":380.96\n                  },\n                  {\n                     \"Asset\":\"NWS\",\n                     \"Value\":893.57,\n                     \"Quantity\":49.12\n                  },\n                  {\n                     \"Asset\":\"OFX\",\n                     \"Value\":609.86,\n                     \"Quantity\":363.01\n                  },\n                  {\n                     \"Asset\":\"ORG\",\n                     \"Value\":323.21,\n                     \"Quantity\":58.34\n                  },\n                  {\n                     \"Asset\":\"PMP\",\n                     \"Value\":801.45,\n                     \"Quantity\":1233.00\n                  },\n                  {\n                     \"Asset\":\"PPT\",\n                     \"Value\":932.86,\n                     \"Quantity\":19.95\n                  },\n                  {\n                     \"Asset\":\"S32\",\n                     \"Value\":1245.29,\n                     \"Quantity\":502.13\n                  },\n                  {\n                     \"Asset\":\"SEK\",\n                     \"Value\":1002.82,\n                     \"Quantity\":64.82\n                  },\n                  {\n                     \"Asset\":\"SYD\",\n                     \"Value\":1095.88,\n                     \"Quantity\":166.55\n                  },\n                  {\n                     \"Asset\":\"TME\",\n                     \"Value\":1630.59,\n                     \"Quantity\":332.10\n                  },\n                  {\n                     \"Asset\":\"VRT\",\n                     \"Value\":1036.14,\n                     \"Quantity\":144.11\n                  },\n                  {\n                     \"Asset\":\"WBC\",\n                     \"Value\":967.68,\n                     \"Quantity\":32.00\n                  },\n                  {\n                     \"Asset\":\"WOW\",\n                     \"Value\":1262.56,\n                     \"Quantity\":52.00\n                  }\n               ]\n            }\n         ],\n         \"HoldingsNotInModel\":[\n            {\n               \"Asset\":\"AUDCASH\",\n               \"Value\":1108.63,\n               \"Quantity\":1108.63\n            }\n         ]\n      }\n   ]\n}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","auth":"required","params":[{"_id":"5ada8b908274b9000307921a","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ada9005c30da50003c50210","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"},{"_id":"5ade6108b8a2a900035dc508","ref":"","in":"query","required":true,"desc":"The `AccountID` as returned by the Accounts endpoint.","default":"","type":"string","name":"Id"},{"_id":"5ade6108b8a2a900035dc507","ref":"","in":"query","required":true,"desc":"The start of the calculation period.","default":"","type":"yyyy-mm-dd","name":"FromDate"},{"_id":"5ade6108b8a2a900035dc506","ref":"","in":"query","required":true,"desc":"The end of the calculation period.","default":"","type":"yyyy-mm-dd","name":"ToDate"}],"url":"/Accounts/{Id}/HoldingsByModel"},"isReference":true,"order":17,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"What is this all about?\",\n  \"body\": \"Unlike other platforms, we blend the assets held within our managed accounts into one holding. This gives a more efficient investment outcome for your clients.\\n\\nThis endpoint takes the holdings of an account and attributes them to the models that the account is linked to. If more than one model contains a given stock then you will see that stock listed against each of those models, with that model's share.\\n\\nYou can use this data to present a breakdown of an account's value by model at a point in time, or over a time period. Value by model over a time period also forms the core of a time weighted performance calculation.\\n\\nSome holdings are not in a model due to customisations; the account in the sample results has a minimum holding lock set for WPL, which is above the linked models' weights in that security, so the excess portion is shown as not being in a model. You will also see securities categorised this way if the account has a substitution in place.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **SMA/Robo, Enterprise**\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"AccountID\",\n    \"1-0\": \"FromDate\",\n    \"2-0\": \"ToDate\",\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"3-0\": \"HoldingsByModel\",\n    \"4-0\": \"HoldingsByModel.Date\",\n    \"5-0\": \"HoldingsByModel.TotalValue\",\n    \"6-0\": \"HoldingsByModel.HoldingsInModel\",\n    \"7-0\": \"HoldingsByModel.HoldingsInModel.ModelCode\",\n    \"8-0\": \"HoldingsByModel.HoldingsInModel.ModelDescription\",\n    \"9-0\": \"HoldingsByModel.HoldingsInModel.ModelPercentage\",\n    \"10-0\": \"HoldingsByModel.HoldingsInModel.Holdings\",\n    \"11-0\": \"HoldingsByModel.HoldingsInModel.Holdings.Asset\",\n    \"13-0\": \"HoldingsByModel.HoldingsInModel.Holdings.Value\",\n    \"14-0\": \"HoldingsByModel.HoldingsNotInModel\",\n    \"15-0\": \"HoldingsByModel.HoldingsNotInModel.Asset\",\n    \"17-0\": \"HoldingsByModel.HoldingsNotInModel.Value\",\n    \"3-1\": \"Contains the account's holdings, by date, broken down by model\",\n    \"1-1\": \"The start date of the period you requested\",\n    \"2-1\": \"The end date of the period you requested\",\n    \"4-1\": \"The date that these holdings relate to\",\n    \"5-1\": \"The total value of the account on the date\",\n    \"6-1\": \"Contains the assets that are held by the account due to its model subscriptions\",\n    \"14-1\": \"Contains the assets that are not attributable to a model on the date\",\n    \"7-1\": \"The model code of the model that these assets relate to\",\n    \"0-1\": \"The ID of the account you requested\",\n    \"8-1\": \"The name of the model\",\n    \"9-1\": \"The percentage that the account was subscribed to the model on the date\",\n    \"10-1\": \"Contains the holdings attributable to the model on the date.\",\n    \"11-1\": \"Our identifier for the asset\",\n    \"13-1\": \"The value of the asset that is attributable to the model on the date\",\n    \"15-1\": \"Our identifier for the asset\",\n    \"17-1\": \"The value of the asset that is not attributable to a model on the date\",\n    \"16-0\": \"HoldingsByModel.HoldingsNotInModel.Quantity\",\n    \"16-1\": \"The quantity of the asset that is not attributable to a model on the date. Please note that this may not be a whole number of shares.\",\n    \"12-1\": \"The quantity of the asset that is attributable to the model on the date. Please note that this may not be a whole number of shares because we blend holdings within our system in order to give a better investment outcome.\",\n    \"12-0\": \"HoldingsByModel.HoldingsInModel.Value\"\n  },\n  \"cols\": 2,\n  \"rows\": 18\n}\n[/block]","excerpt":"This endpoint returns a breakdown of the value of stocks held by an account, according to the models that the account is subscribed to.","slug":"account-breakdown-by-model","type":"get","title":"Account Breakdown by Model","__v":8,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getAccount Breakdown by Model

This endpoint returns a breakdown of the value of stocks held by an account, according to the models that the account is subscribed to.

Query Params

Id:
required
string
The `AccountID` as returned by the Accounts endpoint.
FromDate:
required
yyyy-mm-dd
The start of the calculation period.
ToDate:
required
yyyy-mm-dd
The end of the calculation period.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
[block:callout] { "type": "info", "title": "What is this all about?", "body": "Unlike other platforms, we blend the assets held within our managed accounts into one holding. This gives a more efficient investment outcome for your clients.\n\nThis endpoint takes the holdings of an account and attributes them to the models that the account is linked to. If more than one model contains a given stock then you will see that stock listed against each of those models, with that model's share.\n\nYou can use this data to present a breakdown of an account's value by model at a point in time, or over a time period. Value by model over a time period also forms the core of a time weighted performance calculation.\n\nSome holdings are not in a model due to customisations; the account in the sample results has a minimum holding lock set for WPL, which is above the linked models' weights in that security, so the excess portion is shown as not being in a model. You will also see securities categorised this way if the account has a substitution in place." } [/block] [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block] [block:parameters] { "data": { "0-0": "AccountID", "1-0": "FromDate", "2-0": "ToDate", "h-0": "Property", "h-1": "Description", "3-0": "HoldingsByModel", "4-0": "HoldingsByModel.Date", "5-0": "HoldingsByModel.TotalValue", "6-0": "HoldingsByModel.HoldingsInModel", "7-0": "HoldingsByModel.HoldingsInModel.ModelCode", "8-0": "HoldingsByModel.HoldingsInModel.ModelDescription", "9-0": "HoldingsByModel.HoldingsInModel.ModelPercentage", "10-0": "HoldingsByModel.HoldingsInModel.Holdings", "11-0": "HoldingsByModel.HoldingsInModel.Holdings.Asset", "13-0": "HoldingsByModel.HoldingsInModel.Holdings.Value", "14-0": "HoldingsByModel.HoldingsNotInModel", "15-0": "HoldingsByModel.HoldingsNotInModel.Asset", "17-0": "HoldingsByModel.HoldingsNotInModel.Value", "3-1": "Contains the account's holdings, by date, broken down by model", "1-1": "The start date of the period you requested", "2-1": "The end date of the period you requested", "4-1": "The date that these holdings relate to", "5-1": "The total value of the account on the date", "6-1": "Contains the assets that are held by the account due to its model subscriptions", "14-1": "Contains the assets that are not attributable to a model on the date", "7-1": "The model code of the model that these assets relate to", "0-1": "The ID of the account you requested", "8-1": "The name of the model", "9-1": "The percentage that the account was subscribed to the model on the date", "10-1": "Contains the holdings attributable to the model on the date.", "11-1": "Our identifier for the asset", "13-1": "The value of the asset that is attributable to the model on the date", "15-1": "Our identifier for the asset", "17-1": "The value of the asset that is not attributable to a model on the date", "16-0": "HoldingsByModel.HoldingsNotInModel.Quantity", "16-1": "The quantity of the asset that is not attributable to a model on the date. Please note that this may not be a whole number of shares.", "12-1": "The quantity of the asset that is attributable to the model on the date. Please note that this may not be a whole number of shares because we blend holdings within our system in order to give a better investment outcome.", "12-0": "HoldingsByModel.HoldingsInModel.Value" }, "cols": 2, "rows": 18 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "title": "What is this all about?", "body": "Unlike other platforms, we blend the assets held within our managed accounts into one holding. This gives a more efficient investment outcome for your clients.\n\nThis endpoint takes the holdings of an account and attributes them to the models that the account is linked to. If more than one model contains a given stock then you will see that stock listed against each of those models, with that model's share.\n\nYou can use this data to present a breakdown of an account's value by model at a point in time, or over a time period. Value by model over a time period also forms the core of a time weighted performance calculation.\n\nSome holdings are not in a model due to customisations; the account in the sample results has a minimum holding lock set for WPL, which is above the linked models' weights in that security, so the excess portion is shown as not being in a model. You will also see securities categorised this way if the account has a substitution in place." } [/block] [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block] [block:parameters] { "data": { "0-0": "AccountID", "1-0": "FromDate", "2-0": "ToDate", "h-0": "Property", "h-1": "Description", "3-0": "HoldingsByModel", "4-0": "HoldingsByModel.Date", "5-0": "HoldingsByModel.TotalValue", "6-0": "HoldingsByModel.HoldingsInModel", "7-0": "HoldingsByModel.HoldingsInModel.ModelCode", "8-0": "HoldingsByModel.HoldingsInModel.ModelDescription", "9-0": "HoldingsByModel.HoldingsInModel.ModelPercentage", "10-0": "HoldingsByModel.HoldingsInModel.Holdings", "11-0": "HoldingsByModel.HoldingsInModel.Holdings.Asset", "13-0": "HoldingsByModel.HoldingsInModel.Holdings.Value", "14-0": "HoldingsByModel.HoldingsNotInModel", "15-0": "HoldingsByModel.HoldingsNotInModel.Asset", "17-0": "HoldingsByModel.HoldingsNotInModel.Value", "3-1": "Contains the account's holdings, by date, broken down by model", "1-1": "The start date of the period you requested", "2-1": "The end date of the period you requested", "4-1": "The date that these holdings relate to", "5-1": "The total value of the account on the date", "6-1": "Contains the assets that are held by the account due to its model subscriptions", "14-1": "Contains the assets that are not attributable to a model on the date", "7-1": "The model code of the model that these assets relate to", "0-1": "The ID of the account you requested", "8-1": "The name of the model", "9-1": "The percentage that the account was subscribed to the model on the date", "10-1": "Contains the holdings attributable to the model on the date.", "11-1": "Our identifier for the asset", "13-1": "The value of the asset that is attributable to the model on the date", "15-1": "Our identifier for the asset", "17-1": "The value of the asset that is not attributable to a model on the date", "16-0": "HoldingsByModel.HoldingsNotInModel.Quantity", "16-1": "The quantity of the asset that is not attributable to a model on the date. Please note that this may not be a whole number of shares.", "12-1": "The quantity of the asset that is attributable to the model on the date. Please note that this may not be a whole number of shares because we blend holdings within our system in order to give a better investment outcome.", "12-0": "HoldingsByModel.HoldingsInModel.Value" }, "cols": 2, "rows": 18 } [/block]
{"_id":"5d8b0b31c4b9960018c59a3c","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","category":"5d8b0b31c4b9960018c59a01","user":"598003249cea430015ae631d","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-04-27T01:00:59.820Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{ \"applicationId\": \"c1bdac67-39a0-4835-8168-e99f44f09cd0\" }","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5ae2772b1d400700034f3cb0","ref":"","in":"body","required":true,"desc":"The Adviser ID to create the application under.","default":"","type":"string","name":"Adviser"},{"_id":"5ae2772b1d400700034f3caf","ref":"","in":"body","required":true,"desc":"Objects containing the applicant data. There must be at least one applicant for the request to succeed. The array of objects may contain a mix of `Individual` and `Corporate` applicants.","default":"","type":"array_object","name":"Applicants"},{"_id":"5d229a67f0dcb800244d0266","ref":"","in":"body","required":false,"desc":"The user ID that you have been provided with","default":"","type":"string","name":"Applicants.OwnerAdviserId"},{"_id":"5d229a67f0dcb800244d0265","ref":"","in":"body","required":true,"desc":"Corporate or Individual","default":"","type":"string","name":"Applicants.ApplicantType"},{"_id":"5d229a67f0dcb800244d0264","ref":"","in":"body","required":false,"desc":"Used for `Corporate` applicants.","default":"","type":"object","name":"Applicants.CorporateDetails"},{"_id":"5d229a67f0dcb800244d0263","ref":"","in":"body","required":true,"desc":"Name of the corporate applicant","default":"","type":"string","name":"Applicants.CorporateDetails.Name"},{"_id":"5d229a67f0dcb800244d0262","ref":"","in":"body","required":false,"desc":"Array of TFN / TIN / ABN / NIN","default":"","type":"array_object","name":"Applicants.CorporateDetails.Identifications"},{"_id":"5d229a67f0dcb800244d0261","ref":"","in":"body","required":false,"desc":"Tfn = 0, Abn = 1, Tin = 2, Nin = 3","default":"","type":"int","name":"Applicants.CorporateDetails.Identifications.Type"},{"_id":"5d229a67f0dcb800244d0260","ref":"","in":"body","required":false,"desc":"Identification number (eg TFN number)","default":"","type":"string","name":"Applicants.CorporateDetails.Identifications.Value"},{"_id":"5d229a67f0dcb800244d025e","ref":"","in":"body","required":false,"desc":"Reason if identification not provided.","default":"","type":"string","name":"Applicants.CorporateDetails.Identifications.MissingReasonText"},{"_id":"5d229a67f0dcb800244d025f","ref":"","in":"body","required":false,"desc":"CountryDoesntIssue = 1, DontNeedOne = 2, Other = 99","default":"","type":"int","name":"Applicants.CorporateDetails.Identifications.MissingReason"},{"_id":"5d229a67f0dcb800244d025d","ref":"","in":"body","required":false,"desc":"Business address","default":"","type":"object","name":"Applicants.CorporateDetails.BusinessAddress"},{"_id":"5d229a67f0dcb800244d025c","ref":"","in":"body","required":false,"desc":"Street of business address","default":"","type":"string","name":"Applicants.CorporateDetails.BusinessAddress.Street"},{"_id":"5d229a67f0dcb800244d025b","ref":"","in":"body","required":false,"desc":"Postcode of business address","default":"","type":"string","name":"Applicants.CorporateDetails.BusinessAddress.Postcode"},{"_id":"5d229a67f0dcb800244d025a","ref":"","in":"body","required":false,"desc":"Suburb of business address","default":"","type":"string","name":"Applicants.CorporateDetails.BusinessAddress.Suburb"},{"_id":"5d229a67f0dcb800244d0259","ref":"","in":"body","required":false,"desc":"Country code of business address","default":"","type":"string","name":"Applicants.CorporateDetails.BusinessAddress.CountryCode"},{"_id":"5d229a67f0dcb800244d0258","ref":"","in":"body","required":false,"desc":"Whether business address is registered","default":"","type":"boolean","name":"Applicants.CorporateDetails.BusinessAddress.IsRegistered"},{"_id":"5d229a67f0dcb800244d0257","ref":"","in":"body","required":false,"desc":"Mailing address","default":"","type":"object","name":"Applicants.CorporateDetails.MailingAddress"},{"_id":"5d229a67f0dcb800244d0256","ref":"","in":"body","required":false,"desc":"Street of mailing address","default":"","type":"string","name":"Applicants.CorporateDetails.MailingAddress.Street"},{"_id":"5d229a67f0dcb800244d0255","ref":"","in":"body","required":false,"desc":"Postcode of mailing address","default":"","type":"string","name":"Applicants.CorporateDetails.MailingAddress.Postcode"},{"_id":"5d229a67f0dcb800244d0254","ref":"","in":"body","required":false,"desc":"Suburb of mailing address","default":"","type":"string","name":"Applicants.CorporateDetails.MailingAddress.Suburb"},{"_id":"5d229a67f0dcb800244d0253","ref":"","in":"body","required":false,"desc":"Country code of mailing address","default":"","type":"string","name":"Applicants.CorporateDetails.MailingAddress.CountryCode"},{"_id":"5d229a67f0dcb800244d0252","ref":"","in":"body","required":false,"desc":"Whether mailing address is registered","default":"","type":"boolean","name":"Applicants.CorporateDetails.MailingAddress.IsRegistered"},{"_id":"5d229a67f0dcb800244d0251","ref":"","in":"body","required":false,"desc":"Whether the corporate contact is signatory","default":"","type":"boolean","name":"Applicants.CorporateDetails.ContactIsSignatory."},{"_id":"5d229a67f0dcb800244d0250","ref":"","in":"body","required":false,"desc":"Corporate contact","default":"","type":"object","name":"Applicants.CorporateDetails.Contact"},{"_id":"5d229a67f0dcb800244d024f","ref":"","in":"body","required":false,"desc":"Title of contact","default":"","type":"string","name":"Applicants.CorporateDetails.Contact.Title"},{"_id":"5d229a67f0dcb800244d024e","ref":"","in":"body","required":false,"desc":"First name of contact","default":"","type":"string","name":"Applicants.CorporateDetails.Contact.FirstName"},{"_id":"5d229a67f0dcb800244d024d","ref":"","in":"body","required":false,"desc":"Last name of contact","default":"","type":"string","name":"Applicants.CorporateDetails.Contact.LastName"},{"_id":"5d229a67f0dcb800244d024c","ref":"","in":"body","required":false,"desc":"Date of birth of contact","default":"","type":"yyyy-mm-dd","name":"Applicants.CorporateDetails.Contact.DateOfBirth"},{"_id":"5d229a67f0dcb800244d024b","ref":"","in":"body","required":false,"desc":"Email of contact","default":"","type":"string","name":"Applicants.CorporateDetails.Contact.Email"},{"_id":"5d229a67f0dcb800244d024a","ref":"","in":"body","required":false,"desc":"Phone of contact","default":"","type":"string","name":"Applicants.CorporateDetails.Contact.Phone"},{"_id":"5d229a67f0dcb800244d0249","ref":"","in":"body","required":false,"desc":"Corporate signatories","default":"","type":"array_object","name":"Applicants.CorporateDetails.Signatories"},{"_id":"5d229a67f0dcb800244d0248","ref":"","in":"body","required":false,"desc":"Director = 0, SoleDirector = 1, CompanySecretary = 2","default":"","type":"int","name":"Applicants.CorporateDetails.Signatories.Capacity"},{"_id":"5d229e0554949000122858c1","ref":"","in":"body","required":false,"desc":"Used for `Individual` applicants","default":"","type":"object","name":"Applicants.IndividualDetails"},{"_id":"5d229e0554949000122858a9","ref":"","in":"body","required":false,"desc":"User ID of individual applicant","default":"","type":"string","name":"Applicants.IndividualDetails.UserId"},{"_id":"5d229e0554949000122858aa","ref":"","in":"body","required":false,"desc":"User name of individual applicant","default":"","type":"string","name":"Applicants.IndividualDetails.UserName"},{"_id":"5d2577bd93dd65006d99c8d5","ref":"","in":"body","required":false,"desc":"Title of individual applicant","default":"","type":"string","name":"Applicants.IndividualDetails.Title"},{"_id":"5d2577bd93dd65006d99c8d4","ref":"","in":"body","required":true,"desc":"First name of individual applicant","default":"","type":"string","name":"Applicants.IndividualDetails.FirstName"},{"_id":"5d2577bd93dd65006d99c8d0","ref":"","in":"body","required":true,"desc":"Last name of individual applicant","default":"","type":"string","name":"Applicants.IndividualDetails.LastName"},{"_id":"5d229e0554949000122858ab","ref":"","in":"body","required":true,"desc":"Gender of individual applicant","default":"","type":"string","name":"Applicants.IndividualDetails.Gender"},{"_id":"5d229e0554949000122858c0","ref":"","in":"body","required":false,"desc":"Other phone of individual applicant","default":"","type":"string","name":"Applicants.IndividualDetails.PhoneOther"},{"_id":"5d2577bd93dd65006d99c8d3","ref":"","in":"body","required":false,"desc":"Date of birth of individual applicant","default":"","type":"yyyy-mm-dd","name":"Applicants.IndividualDetails.DateOfBirth"},{"_id":"5d2577bd93dd65006d99c8d2","ref":"","in":"body","required":false,"desc":"Email of individual applicant","default":"","type":"string","name":"Applicants.IndividualDetails.Email"},{"_id":"5d2577bd93dd65006d99c8d1","ref":"","in":"body","required":false,"desc":"Phone of individual applicant","default":"","type":"string","name":"Applicants.IndividualDetails.Phone"},{"_id":"5d229e0554949000122858bf","ref":"","in":"body","required":false,"desc":"Identifications of individual applicant","default":"","type":"array_object","name":"Applicants.IndividualDetails.Identifications"},{"_id":"5d229e0554949000122858be","ref":"","in":"body","required":false,"desc":"Tfn = 0, Abn = 1, Tin = 2, Nin = 3","default":"","type":"int","name":"Applicants.IndividualDetails.Identifications.Type"},{"_id":"5d229e0554949000122858bd","ref":"","in":"body","required":false,"desc":"Identification value","default":"","type":"string","name":"Applicants.IndividualDetails.Identifications.Value"},{"_id":"5d229e0554949000122858bc","ref":"","in":"body","required":false,"desc":"CountryDoesntIssue = 1, DontNeedOne = 2, Other = 99","default":"","type":"int","name":"Applicants.IndividualDetails.Identifications.MissingReason"},{"_id":"5d229e0554949000122858bb","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"Applicants.IndividualDetails.Identifications.MissingReasonText"},{"_id":"5d229e0554949000122858ba","ref":"","in":"body","required":false,"desc":"Tax residence country code","default":"","type":"string","name":"Applicants.IndividualDetails.TaxResidenceCountryCode"},{"_id":"5d229e0554949000122858b9","ref":"","in":"body","required":false,"desc":"Citizenship country code","default":"","type":"string","name":"Applicants.IndividualDetails.CitizenshipCountryCode"},{"_id":"5d229e0554949000122858b8","ref":"","in":"body","required":false,"desc":"Birth country code","default":"","type":"string","name":"Applicants.IndividualDetails.BirthCountryCode"},{"_id":"5d229e0554949000122858b7","ref":"","in":"body","required":false,"desc":"Home address of individual applicant","default":"","type":"object","name":"Applicants.IndividualDetails.HomeAddress"},{"_id":"5d229e0554949000122858b6","ref":"","in":"body","required":false,"desc":"Street of home address","default":"","type":"string","name":"Applicants.IndividualDetails.HomeAddress.Street"},{"_id":"5d229e0554949000122858b5","ref":"","in":"body","required":false,"desc":"Postcode of home address","default":"","type":"string","name":"Applicants.IndividualDetails.HomeAddress.Postcode"},{"_id":"5d229e0554949000122858b4","ref":"","in":"body","required":false,"desc":"Suburb of home address","default":"","type":"string","name":"Applicants.IndividualDetails.HomeAddress.Suburb"},{"_id":"5d229e0554949000122858b3","ref":"","in":"body","required":false,"desc":"Country code of home address","default":"","type":"string","name":"Applicants.IndividualDetails.HomeAddress.CountryCode"},{"_id":"5d229e0554949000122858b2","ref":"","in":"body","required":false,"desc":"Whether home address is registered","default":"","type":"boolean","name":"Applicants.IndividualDetails.HomeAddress.IsRegistered"},{"_id":"5d229e0554949000122858b1","ref":"","in":"body","required":false,"desc":"Mailing address of individual applicant","default":"","type":"object","name":"Applicants.IndividualDetails.MailingAddress."},{"_id":"5d229e0554949000122858b0","ref":"","in":"body","required":false,"desc":"Street of mailing address","default":"","type":"string","name":"Applicants.IndividualDetails.MailingAddress.Street"},{"_id":"5d229e0554949000122858af","ref":"","in":"body","required":false,"desc":"Postcode of mailing address","default":"","type":"string","name":"Applicants.IndividualDetails.MailingAddress.Postcode"},{"_id":"5d229e0554949000122858ad","ref":"","in":"body","required":false,"desc":"Country code of mailing address","default":"","type":"string","name":"Applicants.IndividualDetails.MailingAddress.CountryCode"},{"_id":"5d229e0554949000122858ae","ref":"","in":"body","required":false,"desc":"Suburb of mailing address","default":"","type":"string","name":"Applicants.IndividualDetails.MailingAddress.Suburb"},{"_id":"5d229e0554949000122858ac","ref":"","in":"body","required":false,"desc":"Whether mailing address is registered","default":"","type":"string","name":"Applicants.IndividualDetails.MailingAddress.IsRegistered"},{"_id":"5ae2772b1d400700034f3cae","ref":"","in":"body","required":false,"desc":"Array of accounts to be opened with the application. Must be linked to an included applicant.","default":"","type":"array_object","name":"Accounts"},{"_id":"5d229e0554949000122858a8","ref":"","in":"body","required":false,"desc":"Company or Individual","default":"","type":"string","name":"Accounts.AccountType"},{"_id":"5d229e0554949000122858a7","ref":"","in":"body","required":false,"desc":"Index of applicants supplied in your request (starting from 0)","default":"","type":"array_int","name":"Accounts.ApplicantIndexes"},{"_id":"5d229e0554949000122858a6","ref":"","in":"body","required":false,"desc":"PDS ID of account","default":"","type":"string","name":"Accounts.PdsId"},{"_id":"5d229e0554949000122858a5","ref":"","in":"body","required":false,"desc":"Account fees","default":"","type":"array_object","name":"Accounts.Fees"},{"_id":"5d229e0554949000122858a4","ref":"","in":"body","required":false,"desc":"Fee ID of account","default":"","type":"string","name":"Accounts.Fees.Id"},{"_id":"5d229e0554949000122858a3","ref":"","in":"body","required":false,"desc":"Fee rate of account","default":"","type":"double","name":"Accounts.Fees.Rate"},{"_id":"5d229e0554949000122858a2","ref":"","in":"body","required":false,"desc":"Fee unit of account","default":"","type":"string","name":"Accounts.Fees.Unit"},{"_id":"5d229e0554949000122858a1","ref":"","in":"body","required":false,"desc":"Account models","default":"","type":"array_object","name":"Accounts.Models"},{"_id":"5d229e0554949000122858a0","ref":"","in":"body","required":false,"desc":"Model code of account","default":"","type":"string","name":"Accounts.Models.Code"},{"_id":"5d229e05549490001228589f","ref":"","in":"body","required":false,"desc":"Model proportion of account","default":"","type":"double","name":"Accounts.Models.Proportion"},{"_id":"5d229e05549490001228589e","ref":"","in":"body","required":false,"desc":"Bank accounts","default":"","type":"array_object","name":"Accounts.BankAccounts"},{"_id":"5d229e05549490001228589d","ref":"","in":"body","required":false,"desc":"Bank account BSB","default":"","type":"string","name":"Accounts.BankAccounts.AccountBsb"},{"_id":"5d229e05549490001228589c","ref":"","in":"body","required":false,"desc":"Bank account number","default":"","type":"string","name":"Accounts.BankAccounts.AccountNumber"},{"_id":"5d229e05549490001228589b","ref":"","in":"body","required":false,"desc":"Bank account name","default":"","type":"string","name":"Accounts.BankAccounts.AccountName"},{"_id":"5d229e05549490001228589a","ref":"","in":"body","required":false,"desc":"Bank account usages","default":"","type":"array_string","name":"Accounts.BankAccounts.Usages"},{"_id":"5d229e055494900012285899","ref":"","in":"body","required":false,"desc":"Bank account BIC","default":"","type":"string","name":"Accounts.BankAccounts.Bic"},{"_id":"5d229e055494900012285898","ref":"","in":"body","required":false,"desc":"Bank account IBAN","default":"","type":"string","name":"Accounts.BankAccounts.Iban"},{"_id":"5d229e055494900012285897","ref":"","in":"body","required":false,"desc":"Bank account type","default":"","type":"string","name":"Accounts.BankAccounts.Type"},{"_id":"5d229e055494900012285896","ref":"","in":"body","required":false,"desc":"Account exclusions","default":"","type":"array_object","name":"Accounts.Exclusions"},{"_id":"5d229e055494900012285895","ref":"","in":"body","required":false,"desc":"Security in account exclusions","default":"","type":"object","name":"Accounts.Exclusions.Security"},{"_id":"5d229e055494900012285894","ref":"","in":"body","required":false,"desc":"Security code in account exclusions","default":"","type":"string","name":"Accounts.Exclusions.Security.Code"},{"_id":"5d229e055494900012285893","ref":"","in":"body","required":false,"desc":"Security exchange code in account exclusions","default":"","type":"string","name":"Accounts.Exclusions.Security.Exchange"},{"_id":"5d229e055494900012285892","ref":"","in":"body","required":false,"desc":"Initial investment of account","default":"","type":"object","name":"Accounts.InitialInvestment"},{"_id":"5d229e055494900012285891","ref":"","in":"body","required":false,"desc":"Cash amount of account initial investment","default":"","type":"double","name":"Accounts.InitialInvestment.Cash"},{"_id":"5d229e055494900012285890","ref":"","in":"body","required":false,"desc":"BPay = 0, DirectDebit = 1","default":"","type":"int","name":"Accounts.InitialInvestment.Method"},{"_id":"5d229e05549490001228588f","ref":"","in":"body","required":false,"desc":"Account ABN","default":"","type":"string","name":"Accounts.Abn"},{"_id":"5d229e05549490001228588e","ref":"","in":"body","required":false,"desc":"Account TFN","default":"","type":"string","name":"Accounts.Tfn"},{"_id":"5ae2772b1d400700034f3cad","ref":"","in":"body","required":false,"desc":"Array of Praemium User ID's","default":"","type":"array_string","name":"InterestedParties"},{"_id":"5ae27676ba91d70003876feb","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ae27676ba91d70003876fea","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Applications/Draft","examples":{"codes":[{"name":"Individual","language":"json","code":"POST http://{URL as provided}/draft/applications\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\n\n{\n  \"adviser\": \"advlogin\",\n  \"applicants\": [\n    {\n      \"applicantType\": \"Individual\",\n      \"individualDetails\":\n      {\n        \"firstName\": \"John\",\n        \"lastName\": \"Smith\",\n        \"email\": \"john.smith@example.com\"\n      }\n    }\n  ]\n}"},{"name":"Corporate","language":"json","code":"POST http://{URL as provided}/draft/applications\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\n\n{\n  \"adviser\": \"advlogin\",\n  \"applicants\": [\n    {\n      \"applicantType\": \"Corporate\",\n      \"corporateDetails\":\n      {\n        \"name\": \"Smith & Smith\",\n        \"businessAddress\":\n        {\n          \"street\": \"123 Fake St\",\n          \"postcode\": \"3000\",\n          \"suburb\": \"Melbourne\",\n          \"state\": \"VIC\",\n          \"countryCode\": \"AUS\",\n        },\n        \"signatories\": [\n          {\n            \"title\": \"Mr\",\n            \"firstName\": \"John\",\n            \"lastName\": \"Smith\",\n            \"email\": \"j.smith@example.com\",\n            \"capacity\": \"Director\"\n          }\n        ],\n        \"Identifications\": [\n          {\n            \"type\": \"TFN\",\n            \"value\": \"123456789\"\n          }\n        ]\n      }\n    }\n  ]\n}"},{"name":"Mixed","language":"json","code":"POST http://{URL as provided}/draft/applications\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\n\n{\n  \"adviser\": \"advlogin\",\n  \"applicants\": [\n    {\n      \"applicantType\": \"Corporate\",\n      \"corporateDetails\":\n      {\n        \"name\": \"Smith & Smith\",\n        \"businessAddress\":\n        {\n          \"street\": \"123 Fake St\",\n          \"postcode\": \"3000\",\n          \"suburb\": \"Melbourne\",\n          \"state\": \"VIC\",\n          \"countryCode\": \"AUS\"\n        },\n        \"signatories\": [\n          {\n            \"title\": \"Mr\",\n            \"firstName\": \"John\",\n            \"lastName\": \"Smith\",\n            \"email\": \"j.smith@example.com\",\n            \"capacity\": \"Director\"\n          }\n        ],\n        \"Identifications\": [\n          {\n            \"type\": \"TFN\",\n            \"value\": \"123456789\"\n          }\n        ]\n      }\n    },\n    {\n      \"applicantType\": \"Individual\",\n      \"individualDetails\":\n      {\n        \"title\": \"Mr.\",\n        \"firstName\": \"John\",\n        \"lastName\": \"Smith\",\n        \"email\": \"j.smith@example.com\",\n        \"phone\": \"012489235\",\n        \"phoneOther\": \"012489235\",\n        \"gender\": \"male\",\n        \"birthCountryCode\": \"AUS\",\n        \"HomeAddress\":\n        {\n          \"street\": \"123 Fake St\",\n          \"postcode\": \"3000\",\n          \"suburb\": \"Melbourne\",\n          \"state\": \"VIC\",\n          \"countryCode\": \"AUS\"\n        },\n        \"MailingAddress\":\n        {\n          \"street\": \"123 Fake St\",\n          \"postcode\": \"3000\",\n          \"suburb\": \"Melbourne\",\n          \"state\": \"VIC\",\n          \"countryCode\": \"AUS\"\n        },\n        \"Identifications\": [\n          {\n            \"type\": \"TFN\",\n            \"value\": \"123456789\"\n          },\n          {\n            \"type\": \"NIN\",\n            \"value\": \"123456789\",\n            \"MissingReason\": 1,\n            \"MissingReasonText\": \"test\"\n          }\n        ]\n      }\n    }\n  ],\n  \"accounts\": [\n    {\n      \"accountType\": \"Company\",\n      \"pdsId\": \"AU00\",\n      \"initialInvestment\":\n      {\n        \"cash\": 3000.52,\n        \"method\": \"Bpay\"\n      },\n      \"applicantIndexes\": [\n        0\n      ]\n    },\n    {\n      \"accountType\": \"Individual\",\n      \"pdsId\": \"AU00\",\n      \"initialInvestment\":\n      {\n        \"cash\": 15000.32,\n        \"method\": \"DirectDebit\"\n      },\n      \"applicantIndexes\": [\n        1\n      ]\n    }\n  ]\n}"}]},"method":"post"},"isReference":true,"order":18,"body":"This endpoint allows your application to create draft applications.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **SMA/Robo, Enterprise**\"\n}\n[/block]","excerpt":"Create Applications via AP","slug":"applications-draft","type":"post","title":"Draft Applications","__v":26,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postDraft Applications

Create Applications via AP

Body Params

Adviser:
required
string
The Adviser ID to create the application under.
Applicants:
required
array of objects
Objects containing the applicant data. There must be at least one applicant for the request to succeed. The array of objects may contain a mix of `Individual` and `Corporate` applicants.
Applicants.OwnerAdviserId:
string
The user ID that you have been provided with
Applicants.ApplicantType:
required
string
Corporate or Individual
Applicants.CorporateDetails:
object
Used for `Corporate` applicants.
Applicants.CorporateDetails.Name:
required
string
Name of the corporate applicant
Applicants.CorporateDetails.Identifications:
array of objects
Array of TFN / TIN / ABN / NIN
Applicants.CorporateDetails.Identifications.Type:
integer
Tfn = 0, Abn = 1, Tin = 2, Nin = 3
Applicants.CorporateDetails.Identifications.Value:
string
Identification number (eg TFN number)
Applicants.CorporateDetails.Identifications.MissingReasonText:
string
Reason if identification not provided.
Applicants.CorporateDetails.Identifications.MissingReason:
integer
CountryDoesntIssue = 1, DontNeedOne = 2, Other = 99
Applicants.CorporateDetails.BusinessAddress:
object
Business address
Applicants.CorporateDetails.BusinessAddress.Street:
string
Street of business address
Applicants.CorporateDetails.BusinessAddress.Postcode:
string
Postcode of business address
Applicants.CorporateDetails.BusinessAddress.Suburb:
string
Suburb of business address
Applicants.CorporateDetails.BusinessAddress.CountryCode:
string
Country code of business address
Applicants.CorporateDetails.BusinessAddress.IsRegistered:
boolean
Whether business address is registered
Applicants.CorporateDetails.MailingAddress:
object
Mailing address
Applicants.CorporateDetails.MailingAddress.Street:
string
Street of mailing address
Applicants.CorporateDetails.MailingAddress.Postcode:
string
Postcode of mailing address
Applicants.CorporateDetails.MailingAddress.Suburb:
string
Suburb of mailing address
Applicants.CorporateDetails.MailingAddress.CountryCode:
string
Country code of mailing address
Applicants.CorporateDetails.MailingAddress.IsRegistered:
boolean
Whether mailing address is registered
Applicants.CorporateDetails.ContactIsSignatory:
boolean
Whether the corporate contact is signatory
Applicants.CorporateDetails.Contact:
object
Corporate contact
Applicants.CorporateDetails.Contact.Title:
string
Title of contact
Applicants.CorporateDetails.Contact.FirstName:
string
First name of contact
Applicants.CorporateDetails.Contact.LastName:
string
Last name of contact
Applicants.CorporateDetails.Contact.DateOfBirth:
yyyy-mm-dd
Date of birth of contact
Applicants.CorporateDetails.Contact.Email:
string
Email of contact
Applicants.CorporateDetails.Contact.Phone:
string
Phone of contact
Applicants.CorporateDetails.Signatories:
array of objects
Corporate signatories
Applicants.CorporateDetails.Signatories.Capacity:
integer
Director = 0, SoleDirector = 1, CompanySecretary = 2
Applicants.IndividualDetails:
object
Used for `Individual` applicants
Applicants.IndividualDetails.UserId:
string
User ID of individual applicant
Applicants.IndividualDetails.UserName:
string
User name of individual applicant
Applicants.IndividualDetails.Title:
string
Title of individual applicant
Applicants.IndividualDetails.FirstName:
required
string
First name of individual applicant
Applicants.IndividualDetails.LastName:
required
string
Last name of individual applicant
Applicants.IndividualDetails.Gender:
required
string
Gender of individual applicant
Applicants.IndividualDetails.PhoneOther:
string
Other phone of individual applicant
Applicants.IndividualDetails.DateOfBirth:
yyyy-mm-dd
Date of birth of individual applicant
Applicants.IndividualDetails.Email:
string
Email of individual applicant
Applicants.IndividualDetails.Phone:
string
Phone of individual applicant
Applicants.IndividualDetails.Identifications:
array of objects
Identifications of individual applicant
Applicants.IndividualDetails.Identifications.Type:
integer
Tfn = 0, Abn = 1, Tin = 2, Nin = 3
Applicants.IndividualDetails.Identifications.Value:
string
Identification value
Applicants.IndividualDetails.Identifications.MissingReason:
integer
CountryDoesntIssue = 1, DontNeedOne = 2, Other = 99
Applicants.IndividualDetails.Identifications.MissingReasonText:
string
Applicants.IndividualDetails.TaxResidenceCountryCode:
string
Tax residence country code
Applicants.IndividualDetails.CitizenshipCountryCode:
string
Citizenship country code
Applicants.IndividualDetails.BirthCountryCode:
string
Birth country code
Applicants.IndividualDetails.HomeAddress:
object
Home address of individual applicant
Applicants.IndividualDetails.HomeAddress.Street:
string
Street of home address
Applicants.IndividualDetails.HomeAddress.Postcode:
string
Postcode of home address
Applicants.IndividualDetails.HomeAddress.Suburb:
string
Suburb of home address
Applicants.IndividualDetails.HomeAddress.CountryCode:
string
Country code of home address
Applicants.IndividualDetails.HomeAddress.IsRegistered:
boolean
Whether home address is registered
Applicants.IndividualDetails.MailingAddress:
object
Mailing address of individual applicant
Applicants.IndividualDetails.MailingAddress.Street:
string
Street of mailing address
Applicants.IndividualDetails.MailingAddress.Postcode:
string
Postcode of mailing address
Applicants.IndividualDetails.MailingAddress.CountryCode:
string
Country code of mailing address
Applicants.IndividualDetails.MailingAddress.Suburb:
string
Suburb of mailing address
Applicants.IndividualDetails.MailingAddress.IsRegistered:
string
Whether mailing address is registered
Accounts:
array of objects
Array of accounts to be opened with the application. Must be linked to an included applicant.
Accounts.AccountType:
string
Company or Individual
Accounts.ApplicantIndexes:
array of integers
Index of applicants supplied in your request (starting from 0)
Accounts.PdsId:
string
PDS ID of account
Accounts.Fees:
array of objects
Account fees
Accounts.Fees.Id:
string
Fee ID of account
Accounts.Fees.Rate:
double
Fee rate of account
Accounts.Fees.Unit:
string
Fee unit of account
Accounts.Models:
array of objects
Account models
Accounts.Models.Code:
string
Model code of account
Accounts.Models.Proportion:
double
Model proportion of account
Accounts.BankAccounts:
array of objects
Bank accounts
Accounts.BankAccounts.AccountBsb:
string
Bank account BSB
Accounts.BankAccounts.AccountNumber:
string
Bank account number
Accounts.BankAccounts.AccountName:
string
Bank account name
Accounts.BankAccounts.Usages:
array of strings
Bank account usages
Accounts.BankAccounts.Bic:
string
Bank account BIC
Accounts.BankAccounts.Iban:
string
Bank account IBAN
Accounts.BankAccounts.Type:
string
Bank account type
Accounts.Exclusions:
array of objects
Account exclusions
Accounts.Exclusions.Security:
object
Security in account exclusions
Accounts.Exclusions.Security.Code:
string
Security code in account exclusions
Accounts.Exclusions.Security.Exchange:
string
Security exchange code in account exclusions
Accounts.InitialInvestment:
object
Initial investment of account
Accounts.InitialInvestment.Cash:
double
Cash amount of account initial investment
Accounts.InitialInvestment.Method:
integer
BPay = 0, DirectDebit = 1
Accounts.Abn:
string
Account ABN
Accounts.Tfn:
string
Account TFN
InterestedParties:
array of strings
Array of Praemium User ID's

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
This endpoint allows your application to create draft applications. [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This endpoint allows your application to create draft applications. [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block]
{"_id":"5d8b0b31c4b9960018c59a3d","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","category":"5d8b0b31c4b9960018c59a01","user":"598003249cea430015ae631d","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-04-27T01:07:03.263Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n    \"applicationId\": \"83225a21-1e9e-420d-b35a-6f1091c7a434\",\n    \"status\": \"Submitted\",\n    \"accountsStatus\": [\n        {\n            \"accountCode\": \"SMA00316002\",\n            \"status\": \"ClosureRequested\"\n        }\n    ]\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[{"_id":"5ae277ec1d400700034f3ccc","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ae277ec1d400700034f3ccb","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"},{"_id":"5ae27827e35e3600035718af","ref":"","in":"query","required":true,"desc":"The `ApplicationID` as returned by the Applications (Draft) endpoint.","default":"","type":"string","name":"ApplicationID"}],"url":"/Applications/{ApplicationId}/Status","examples":{"codes":[{"language":"json","code":"GET http://{URL as provided}/Applications/{ApplicationId}/Status\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION"}]},"method":"get"},"isReference":true,"order":19,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **SMA/Robo, Enterprise**\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Status\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"Draft\",\n    \"1-0\": \"AwaitingSignature\",\n    \"2-0\": \"AwaitingApproval\",\n    \"3-0\": \"AwaitingFunds\",\n    \"4-0\": \"Funded\",\n    \"5-0\": \"Trading\",\n    \"6-0\": \"ClosureRequested\",\n    \"7-0\": \"Closed\",\n    \"8-0\": \"Deleted\",\n    \"0-1\": \"Application has not yet been finalised.\",\n    \"1-1\": \"Awaiting signature from client.\",\n    \"2-1\": \"Awaiting approval.\",\n    \"3-1\": \"Approved, awaiting funds.\",\n    \"4-1\": \"Account is funded.\",\n    \"5-1\": \"Account is actively trading.\",\n    \"6-1\": \"Closure of the account has been requested.\",\n    \"7-1\": \"The account has been closed.\",\n    \"8-1\": \"The account has been deleted.\"\n  },\n  \"cols\": 2,\n  \"rows\": 9\n}\n[/block]","excerpt":"This endpoint returns the status of the specified application.","slug":"application-status","type":"get","title":"Application Status","__v":11,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getApplication Status

This endpoint returns the status of the specified application.

Query Params

ApplicationID:
required
string
The `ApplicationID` as returned by the Applications (Draft) endpoint.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use.
[block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block] [block:parameters] { "data": { "h-0": "Status", "h-1": "Description", "0-0": "Draft", "1-0": "AwaitingSignature", "2-0": "AwaitingApproval", "3-0": "AwaitingFunds", "4-0": "Funded", "5-0": "Trading", "6-0": "ClosureRequested", "7-0": "Closed", "8-0": "Deleted", "0-1": "Application has not yet been finalised.", "1-1": "Awaiting signature from client.", "2-1": "Awaiting approval.", "3-1": "Approved, awaiting funds.", "4-1": "Account is funded.", "5-1": "Account is actively trading.", "6-1": "Closure of the account has been requested.", "7-1": "The account has been closed.", "8-1": "The account has been deleted." }, "cols": 2, "rows": 9 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **SMA/Robo, Enterprise**" } [/block] [block:parameters] { "data": { "h-0": "Status", "h-1": "Description", "0-0": "Draft", "1-0": "AwaitingSignature", "2-0": "AwaitingApproval", "3-0": "AwaitingFunds", "4-0": "Funded", "5-0": "Trading", "6-0": "ClosureRequested", "7-0": "Closed", "8-0": "Deleted", "0-1": "Application has not yet been finalised.", "1-1": "Awaiting signature from client.", "2-1": "Awaiting approval.", "3-1": "Approved, awaiting funds.", "4-1": "Account is funded.", "5-1": "Account is actively trading.", "6-1": "Closure of the account has been requested.", "7-1": "The account has been closed.", "8-1": "The account has been deleted." }, "cols": 2, "rows": 9 } [/block]
{"_id":"5d8b0b31c4b9960018c59a49","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","category":"5d8b0b31c4b9960018c59a01","user":"5b722e3b34272200031f5957","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-08-23T04:26:43.937Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"language":"json","code":"GET http://{URL as provided}/Accounts/customisations/exclusions?AccountID=AU111111\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION"}]},"settings":"","results":{"codes":[{"name":"","code":"[\n    {\n        \"SecurityDescription\": \"AMP LIMITED FPO\",\n        \"ExchangeDescription\": \"ASX Listed\",\n        \"CreatedDate\": \"2019-08-23T11:29:36.143Z\",\n        \"SecurityCode\": \"AMP\",\n        \"ExchangeCode\": \"ASX\"\n    },\n    {\n        \"SecurityDescription\": \"BT INTERNATIONAL SHARE RETAIL\",\n        \"ExchangeDescription\": \"Managed Funds\",\n        \"CreatedDate\": \"2019-08-23T11:29:36.15Z\",\n        \"SecurityCode\": \"BTA0024AU\",\n        \"ExchangeCode\": \"FND\"\n    }\n]","language":"json","status":200},{"name":"","code":"{\n    \"Message\": \"Unauthorised to access the account.\"\n}","language":"json","status":401},{"status":422,"language":"text","code":"\"User does not have access to the portfolio.\""}]},"auth":"required","params":[{"_id":"5ae277ec1d400700034f3ccc","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ae277ec1d400700034f3ccb","ref":"","in":"header","required":true,"desc":"The API version to use. A minimum version of 2019.08.29 is required.","default":"","type":"string","name":"x-pps-api-version"},{"_id":"5ae27827e35e3600035718af","ref":"","in":"query","required":true,"desc":"AccountID","default":"","type":"string","name":"AccountID"},{"_id":"5d5f6b03d39abf002609bf8c","ref":"","in":"query","required":false,"desc":"Praemium user account login ID to check has access to the portfolio before returning data.","default":"","type":"int","name":"UserID"}],"url":"/Accounts/customisations/exclusions"},"isReference":true,"order":20,"body":"","excerpt":"Get exclusions for an SMA Account","slug":"exclusions","type":"get","title":"Exclusions","__v":3,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getExclusions

Get exclusions for an SMA Account

Query Params

AccountID:
required
string
AccountID
UserID:
integer
Praemium user account login ID to check has access to the portfolio before returning data.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use. A minimum version of 2019.08.29 is required.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"5d8b0b31c4b9960018c59a4a","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","category":"5d8b0b31c4b9960018c59a01","user":"5b722e3b34272200031f5957","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-08-23T04:41:59.602Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"","language":"json","status":204},{"name":"","code":"{\n    \"Message\": \"Unauthorised to access the account.\"\n}","language":"json","status":401},{"status":422,"language":"text","code":"\"Validation of 'add security exclusions' for account 111111 failed: User does not have account edit access.\""}]},"settings":"","examples":{"codes":[{"language":"json","code":"{\n \"AccountId\": \"AU111111\",\n \"UserID\": \"SamSmith\",\n \"SecurityExclusions\": [\n   {\n     \"SecurityCode\": \"AMP\",\n     \"ExchangeCode\": \"ASX\"\n   },\n     {\n     \"SecurityCode\": \"BTA0024AU\",\n     \"ExchangeCode\": \"FND\"\n   }\n ]\n}"}]},"method":"post","auth":"required","params":[{"_id":"5ae277ec1d400700034f3ccc","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ae277ec1d400700034f3ccb","ref":"","in":"header","required":true,"desc":"The API version to use. A minimum version of 2019.08.29 is required.","default":"","type":"string","name":"x-pps-api-version"},{"_id":"5d5f75179448330018c547c4","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"AccountId"},{"_id":"5d5f75179448330018c547c3","ref":"","in":"body","required":false,"desc":"Praemium user account login ID to check has access to the portfolio before returning data.","default":"","type":"string","name":"UserId"},{"_id":"5d5f75179448330018c547c2","ref":"","in":"body","required":false,"desc":"Array of security exclusions to add.","default":"","type":"array_object","name":"SecurityExclusions"},{"_id":"5d5f75438801b90032de84c3","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"SecurityExclusions.SecurityCode"},{"_id":"5d5f75438801b90032de84c2","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"SecurityExclusions.ExchangeCode"}],"url":"/Accounts/customisations/exclusions"},"isReference":true,"order":21,"body":"","excerpt":"Add exclusions to SMA Accounts","slug":"exclusions-1","type":"post","title":"Exclusions","__v":8,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postExclusions

Add exclusions to SMA Accounts

Body Params

AccountId:
string
UserId:
string
Praemium user account login ID to check has access to the portfolio before returning data.
SecurityExclusions:
array of objects
Array of security exclusions to add.
SecurityExclusions.SecurityCode:
string
SecurityExclusions.ExchangeCode:
string

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use. A minimum version of 2019.08.29 is required.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



{"_id":"5d8b0b31c4b9960018c59a4e","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","category":"5d8b0b31c4b9960018c59a01","user":"5b722e3b34272200031f5957","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-08-27T01:06:02.356Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"put","examples":{"codes":[{"language":"json","code":"{\n \"AccountId\": \"AU111111\",\n \"UserID\": \"SamSmith\",\n \"SecurityExclusions\": [\n   {\n     \"SecurityCode\": \"AMP\",\n     \"ExchangeCode\": \"ASX\"\n   },\n     {\n     \"SecurityCode\": \"BTA0024AU\",\n     \"ExchangeCode\": \"FND\"\n   }\n ]\n}"}]},"settings":"","results":{"codes":[{"name":"","code":"","language":"json","status":204},{"name":"","code":"{\n    \"Message\": \"Unauthorised to access the account.\"\n}","language":"json","status":401},{"status":422,"language":"text","code":"\"Validation of 'add security exclusions' for account 111111 failed: User does not have account edit access.\""}]},"auth":"required","params":[{"_id":"5ae277ec1d400700034f3ccc","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ae277ec1d400700034f3ccb","ref":"","in":"header","required":true,"desc":"The API version to use. A minimum version of 2019.08.29 is required.","default":"","type":"string","name":"x-pps-api-version"},{"_id":"5d5f75179448330018c547c4","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"AccountId"},{"_id":"5d5f75179448330018c547c3","ref":"","in":"body","required":false,"desc":"Praemium user account login ID to check has access to the portfolio before returning data.","default":"","type":"string","name":"UserId"},{"_id":"5d5f75179448330018c547c2","ref":"","in":"body","required":false,"desc":"Array of security exclusions to add.","default":"","type":"array_object","name":"SecurityExclusions"},{"_id":"5d5f75438801b90032de84c3","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"SecurityExclusions.SecurityCode"},{"_id":"5d5f75438801b90032de84c2","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"SecurityExclusions.ExchangeCode"}],"url":"/Accounts/customisations/exclusions"},"isReference":true,"order":22,"body":"","excerpt":"Replace exclusions for SMA Accounts","slug":"exclusions-2","type":"put","title":"Exclusions","__v":1,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

putExclusions

Replace exclusions for SMA Accounts

Body Params

AccountId:
string
UserId:
string
Praemium user account login ID to check has access to the portfolio before returning data.
SecurityExclusions:
array of objects
Array of security exclusions to add.
SecurityExclusions.SecurityCode:
string
SecurityExclusions.ExchangeCode:
string

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use. A minimum version of 2019.08.29 is required.

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



{"_id":"5d8b0b31c4b9960018c59a4b","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","category":"5d8b0b31c4b9960018c59a01","user":"5b722e3b34272200031f5957","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-08-23T04:48:46.926Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"","language":"json","status":204},{"status":422,"language":"text","code":"\"Validation of 'delete security exclusions' for account 111111 failed: Security exclusion does not exist.\""}]},"settings":"","examples":{"codes":[{"language":"json","code":""}]},"method":"delete","auth":"required","params":[{"_id":"5ae277ec1d400700034f3ccc","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ae277ec1d400700034f3ccb","ref":"","in":"header","required":true,"desc":"The API version to use. A minimum version of 2019.08.29 is required.","default":"","type":"string","name":"x-pps-api-version"},{"_id":"5d5f702e808f0500231c643c","ref":"","in":"query","required":true,"desc":"","default":"","type":"string","name":"AccountID"},{"_id":"5d5f702e808f0500231c643b","ref":"","in":"query","required":false,"desc":"Praemium user account login ID to check has access to the portfolio before returning data.","default":"","type":"string","name":"UserID"},{"_id":"5d5f702e808f0500231c643a","ref":"","in":"query","required":false,"desc":"If SecurityCode and ExchangeCode are not provided, all exclusions will be deleted.","default":"","type":"string","name":"SecurityCode"},{"_id":"5d5f702e808f0500231c6439","ref":"","in":"query","required":false,"desc":"If SecurityCode and ExchangeCode are not provided, all exclusions will be deleted.","default":"","type":"string","name":"ExchangeCode"}],"url":"/Accounts/customisations/exclusions"},"isReference":true,"order":23,"body":"","excerpt":"Delete exclusions from SMA Accounts","slug":"exclusions-3","type":"delete","title":"Exclusions","__v":2,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

deleteExclusions

Delete exclusions from SMA Accounts

Query Params

AccountID:
required
string
UserID:
string
Praemium user account login ID to check has access to the portfolio before returning data.
SecurityCode:
string
If SecurityCode and ExchangeCode are not provided, all exclusions will be deleted.
ExchangeCode:
string
If SecurityCode and ExchangeCode are not provided, all exclusions will be deleted.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use. A minimum version of 2019.08.29 is required.

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"5d8b0b31c4b9960018c59a4c","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","category":"5d8b0b31c4b9960018c59a01","user":"5b722e3b34272200031f5957","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-08-23T04:55:06.042Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"[\n    {\n        \"ModelId\": \"AU111\",\n        \"Description\": \"Managed Account Cash AUD\",\n        \"OriginalPercent\": 30,   \n        \"ModelCode\": \"MACAUD\",\n        \"Percent\": 31.5\n    },\n    {\n        \"ModelId\": \"AU460\",\n        \"Description\": \"Smart Investment ASX Top20\",\n        \"OriginalPercent\": 70,         \n        \"ModelCode\": \"SM0001\",\n        \"Percent\": 68.5\n    }\n]","language":"json","status":200},{"name":"","code":"{\n    \"Message\": \"Unauthorised to access the account.\"\n}","language":"json","status":401},{"status":404,"language":"text","code":"\"Account does not exist.\""},{"status":422,"language":"text","code":"\"User does not have access to the portfolio.\""}]},"settings":"","examples":{"codes":[{"language":"json","code":"GET http://{URL as provided}/Accounts/modelsubscriptions?AccountID=AU111111\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION"}]},"method":"get","auth":"required","params":[{"_id":"5ae277ec1d400700034f3ccc","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ae277ec1d400700034f3ccb","ref":"","in":"header","required":true,"desc":"The API version to use. A minimum version of 2019.08.29 is required.","default":"","type":"string","name":"x-pps-api-version"},{"_id":"5ae27827e35e3600035718af","ref":"","in":"query","required":true,"desc":"AccountID","default":"","type":"string","name":"AccountID"},{"_id":"5d5f6b03d39abf002609bf8c","ref":"","in":"query","required":false,"desc":"Praemium user account login ID to check has access to the portfolio before returning data.","default":"","type":"int","name":"UserID"}],"url":"/Accounts/ModelSubscriptions"},"isReference":true,"order":24,"body":"Call supported in versions greater than 2019.08.29\n\nOriginalPercent supported in versions greater than 2019.09.26","excerpt":"Returns model subscription details for SMA Accounts","slug":"modelsubscriptions","type":"get","title":"Model Subscriptions","__v":4,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getModel Subscriptions

Returns model subscription details for SMA Accounts

Query Params

AccountID:
required
string
AccountID
UserID:
integer
Praemium user account login ID to check has access to the portfolio before returning data.

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use. A minimum version of 2019.08.29 is required.
Call supported in versions greater than 2019.08.29 OriginalPercent supported in versions greater than 2019.09.26

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Call supported in versions greater than 2019.08.29 OriginalPercent supported in versions greater than 2019.09.26
{"_id":"5d8b0b31c4b9960018c59a4d","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","category":"5d8b0b31c4b9960018c59a01","user":"5b722e3b34272200031f5957","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-08-23T05:02:38.759Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"put","examples":{"codes":[{"language":"json","code":"{\n  \"AccountId\": \"AU2111111\",\n  \"UserID\": \"SamSmith\",\n  \"RebalanceType\": \"floating\",\n  \"ModelSubscriptions\": [\n    {\n      \"ModelCode\": \"MACAUD\",\n      \"Percent\": 30\n    \t\n    },\n    {\n      \"ModelCode\": \"0001\",\n      \"Percent\": 70\n    }    \n  ]\n}"}]},"settings":"","results":{"codes":[{"name":"","code":"","language":"json","status":204},{"name":"","code":"{\n    \"Message\": \"Unauthorised to access the account.\"\n}","language":"json","status":401},{"status":404,"language":"text","code":"\"Account does not exist.\""},{"status":422,"language":"text","code":"\"Invalid rebalance type. Please supply either Floating or Fixed.\"\n\n\"Validation of 'update model subscriptions' for account 267769 failed: Percentages do not add up to 100%.\"\n\n\"Models MACAUS are not found.\""}]},"auth":"required","params":[{"_id":"5ae27827e35e3600035718af","ref":"","in":"body","required":true,"desc":"AccountID","default":"","type":"string","name":"AccountID"},{"_id":"5d5f6b03d39abf002609bf8c","ref":"","in":"body","required":false,"desc":"Praemium user account login ID to check has access to the portfolio before returning data.","default":"","type":"string","name":"UserID"},{"_id":"5ae277ec1d400700034f3ccc","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ae277ec1d400700034f3ccb","ref":"","in":"header","required":true,"desc":"The API version to use. A minimum version of 2019.08.29 is required.","default":"","type":"string","name":"x-pps-api-version"},{"_id":"5d5f736e25810a00596ea556","ref":"","in":"body","required":false,"desc":"Either \"Floating\" or \"Fixed\"","default":"","type":"string","name":"RebalanceType"}],"url":"/Accounts/ModelSubscriptions"},"isReference":true,"order":25,"body":"","excerpt":"Modify model subscriptions for SMA Accounts.","slug":"modelsubscriptions-1","type":"put","title":"Model Subscriptions","__v":4,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

putModel Subscriptions

Modify model subscriptions for SMA Accounts.

Body Params

AccountID:
required
string
AccountID
UserID:
string
Praemium user account login ID to check has access to the portfolio before returning data.
RebalanceType:
string
Either "Floating" or "Fixed"

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
required
string
The API version to use. A minimum version of 2019.08.29 is required.

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



{"_id":"5d8b0b31c4b9960018c59a44","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","category":"5d8b0b31c4b9960018c59a06","user":"5c0db8c00fa7b60042af110d","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-05-30T05:32:16.373Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","settings":"","results":{"codes":[{"name":"","code":"{\n  \"PortfolioCount\":\n  {\n    \"RecordsFound\": 2,\n    \"RecordsReturned\": 2,\n    \"PageCount\": 1\n  },\n  \"Portfolios\":\n  {\n    \"SMA\": [\n      {\n        \"InternalID\": 12345,\n        \"Valuation\":\n        {\n          \"ValuationDate\": \"1950-01-01T00:00:00\",\n          \"TotalCost\": 1329302.67,\n          \"TotalValue\": 2220008.19,\n          \"NetValue\": 2238889.2,\n          \"TotalGainOrLoss\": 890705.52,\n          \"EstIncome\": 69280.3,\n          \"Yield\": 3.12\n        },\n        \"Holdings\": [\n          {\n            \"SecurityCode\": \"ARI\",\n            \"SecurityDescription\": \"ARRIUM LIMITED FPO\",\n            \"AssetClassDescription\": \"Domestic Shares\",\n            \"AssetClassCode\": \"DS\",\n            \"AssetClassCategory\": \"Growth\",\n            \"AssetType\": \"ASX Listed\",\n            \"GICSDescription\": \"Materials\",\n            \"Quantity\": 375,\n            \"UnitCost\": 2.64,\n            \"Cost\": 990,\n            \"UnitValue\": 0.12,\n            \"UnitPriceDate\": \"1950-01-01T00:00:00Z\",\n            \"Value\": 45,\n            \"PercentTotalValue\": 0,\n            \"GainOrLoss\": -945,\n            \"PercentTotalGainOrLoss\": -0.11,\n            \"EstIncome\": 11.25,\n            \"Yield\": 25,\n            \"AssetCurrency\": \"AUD\",\n            \"ValueAssetCurrency\": 45,\n            \"CostBaseUnknown\": 0,\n            \"TaxCredits\": 120\n          }\n        ],\n        \"ReceivablesAndPayables\": [\n          {\n            \"Code\": \"AUDDIVSNOTPAID\",\n            \"Description\": \"Income declared but not paid\",\n            \"Type\": \"\",\n            \"Amount\": 18881.01,\n            \"IncludedInNetValue\": 1\n          }\n        ],\n        \"Subscriptions\": [\n          {\n            \"Models\": [\n              {\n                \"ModelCode\": \"AU00\",\n                \"Weighting\": 50.1234\n              },\n              {\n                \"ModelCode\": \"AU000\",\n                \"Weighting\": 47.8766\n              }\n            ],\n            \"CashHub\":\n            {\n              \"AUD\": 2\n            }\n          }\n        ]\n      }\n    ],\n    \"NonSMA\": [\n      {\n        \"InternalID\": 54321,\n        \"Valuation\":\n        {\n          \"ValuationDate\": \"1950-01-01T00:00:00\",\n          \"TotalCost\": 1329302.67,\n          \"TotalValue\": 2220008.19,\n          \"NetValue\": 2238889.2,\n          \"TotalGainOrLoss\": 890705.52,\n          \"EstIncome\": 69280.3,\n          \"Yield\": 3.12\n        },\n        \"Holdings\": [\n          {\n            \"SecurityCode\": \"ARI\",\n            \"SecurityDescription\": \"ARRIUM LIMITED FPO\",\n            \"AssetClassDescription\": \"Domestic Shares\",\n            \"AssetClassCode\": \"DS\",\n            \"AssetClassCategory\": \"Growth\",\n            \"AssetType\": \"ASX Listed\",\n            \"GICSDescription\": \"Materials\",\n            \"Quantity\": 375,\n            \"UnitCost\": 2.64,\n            \"Cost\": 990,\n            \"UnitValue\": 0.12,\n            \"UnitPriceDate\": \"1950-01-01T00:00:00Z\",\n            \"Value\": 45,\n            \"PercentTotalValue\": 0,\n            \"GainOrLoss\": -945,\n            \"PercentTotalGainOrLoss\": -0.11,\n            \"EstIncome\": 11.25,\n            \"Yield\": 25,\n            \"AssetCurrency\": \"AUD\",\n            \"ValueAssetCurrency\": 45,\n            \"CostBaseUnknown\": 0,\n            \"TaxCredits\": 120\n          }\n        ],\n        \"ReceivablesAndPayables\": [\n          {\n            \"Code\": \"AUDDIVSNOTPAID\",\n            \"Description\": \"Income declared but not paid\",\n            \"Type\": \"\",\n            \"Amount\": 18881.01,\n            \"IncludedInNetValue\": 1\n          }\n        ]\n      }\n    ]\n  }\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":422}]},"examples":{"codes":[{"language":"json","code":"GET http://{URL as provided}/Portfolios/Valuation/Bulk HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION\n\n{\n  \"InternalIDs\": [\n    12345,\n    54321,\n    00000\n  ],\n  \"AccountType\": 3,\n  \"ValuationDate\": \"1950-01-01\"\n}"}]},"auth":"required","params":[{"_id":"5ae27528e35e36000357187c","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ae27528e35e36000357187b","ref":"","in":"header","required":false,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"},{"_id":"5ae27528e35e36000357187a","ref":"","in":"query","required":false,"desc":"multi InternalIds as string seperated by comma","default":"","type":"string","name":"InternalIds"},{"_id":"5ae27528e35e360003571879","ref":"","in":"query","required":false,"desc":"Specify 1 for Non-SMA, 2 for SMA and 3 for both types of accounts.","default":"","type":"int","name":"AccountType"},{"_id":"5ae27528e35e360003571878","ref":"","in":"query","required":false,"desc":"The As At date of the portfolio valuations.","default":"","type":"yyyy-mm-dd","name":"ValuationDate"},{"_id":"5ae27528e35e360003571877","ref":"","in":"query","required":false,"desc":"","default":"","type":"int","name":"Page"}],"url":"/Portfolios/BulkValuation"},"isReference":false,"order":0,"body":"For SMA accounts, this endpoint will also return the model subscription weights as of the specified `ValuationDate`.\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Usage Restrictions\",\n  \"body\": \"Your application should only query this endpoint between **12-6am AEST**.\\n\\nAbuse of this endpoint (including but not limited to excessive calls or calls outside the permitted period above) can result in suspension of your access to the API.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **Enterprise**\"\n}\n[/block]","excerpt":"This endpoint returns the valuation data for all the specified portfolios.","slug":"bulk-valuation","type":"get","title":"Bulk Valuation","__v":2,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getBulk Valuation

This endpoint returns the valuation data for all the specified portfolios.

Query Params

InternalIds:
string
multi InternalIds as string seperated by comma
AccountType:
integer
Specify 1 for Non-SMA, 2 for SMA and 3 for both types of accounts.
ValuationDate:
yyyy-mm-dd
The As At date of the portfolio valuations.
Page:
integer

Headers

x-pps-token:
required
string
Your authentication token.
x-pps-api-version:
string
The API version to use.
For SMA accounts, this endpoint will also return the model subscription weights as of the specified `ValuationDate`. [block:callout] { "type": "danger", "title": "Usage Restrictions", "body": "Your application should only query this endpoint between **12-6am AEST**.\n\nAbuse of this endpoint (including but not limited to excessive calls or calls outside the permitted period above) can result in suspension of your access to the API." } [/block] [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **Enterprise**" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



For SMA accounts, this endpoint will also return the model subscription weights as of the specified `ValuationDate`. [block:callout] { "type": "danger", "title": "Usage Restrictions", "body": "Your application should only query this endpoint between **12-6am AEST**.\n\nAbuse of this endpoint (including but not limited to excessive calls or calls outside the permitted period above) can result in suspension of your access to the API." } [/block] [block:callout] { "type": "info", "title": "Endpoint Access", "body": "Access to this endpoint is available to **Enterprise**" } [/block]
{"_id":"5d8b0b31c4b9960018c59a3e","project":"55ca8813e583751700f78a58","version":"5d8b0b31c4b9960018c59a51","category":"5d8b0b31c4b9960018c59a06","user":"598003249cea430015ae631d","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-04-30T06:02:04.657Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"language":"json","code":"GET http://{URL as provided}/Recalc/AsatDate HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\nx-pps-api-version: THE-API-VERSION"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"AsAtDate\": \"2018-03-20\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5ae6b17aa3490f0003035dda","ref":"","in":"header","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"x-pps-token"},{"_id":"5ae6b17aa3490f0003035dd9","ref":"","in":"header","required":true,"desc":"The API version to use.","default":"","type":"string","name":"x-pps-api-version"}],"url":"/Recalc/AsatDate"},"isReference":false,"order":1,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Access\",\n  \"body\": \"Access to this endpoint is available to **Enterprise**\"\n}\n[/block]","excerpt":"This Bulk endpoint returns the latest recalc date for your service.","slug":"recalc-asat","type":"get","title":"Recalc Date for Service","__v":9,"parentDoc":null,"metadata":{"title":"","description":&quo