{"_id":"5a779cc0befbca0043ffed56","category":"5a779cc0befbca0043ffed4d","project":"55ca8813e583751700f78a58","user":"55ca87c48705a70d00b8fc5c","parentDoc":null,"version":"5a779cc0befbca0043ffed4c","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-11T23:41:10.686Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Introduction\"\n}\n[/block]\nThe Praemium API enables your organisation to access information about your clients' portfolios from our portfolio administration system, and to set up accounts on our award-winning SMA platform, 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[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Privilege permission\",\n  \"body\": \"This API provides general information about your clients' portfolios. \\n\\nSome parts of the API require an additional *privilege* permission for setting up or interacting with a Portfolio or SMA account. We will grant this permission if appropriate for your needs.\\n\\nAdditional features are available but may not be published here, so if a desired feature or function does not appear here, please get in contact to gain access the other API components.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Authentication & Tokens\"\n}\n[/block]\nThe Praemium API uses a token based approach for authenticating and authorising your integrations. Simply add the token header to each request to the API.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"x-pps-token: XXXX-XXXXXXXXXXXXXXXXXXXXXXX-XXXXXXXXXXXXX\",\n      \"language\": \"http\",\n      \"name\": \"Token HTTP Header\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Deprecated header\",\n  \"body\": \"Previously we required the HTTP header `token` but in adopting better standards we have deprecated this header. Please ensure you use the supported one above.\"\n}\n[/block]\nA token will be provided to grant access to the API. \n\nSome parts of the API require additional 'privilege' permission. We will grant this permission to a token if appropriate for your needs. In cases where the token doesn't have this permission but is trying to request these routes, we will respond with a `403 (Forbidden)` HTTP status code.\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Security\",\n  \"body\": \"This token is your access to our API. Please treat it as extremely sensitive, similarly to an admin password. Ensure that this token is kept secure as anyone with it will have access to your data. \\n\\n**Do not **expose this token to your clients, but keep this token private within your secured self-hosted application only. Deploying software with this token outside of a trusted environment, or passing this token to a browser client-side script, is effectively exposing your private token to your clients.\\n\\n**If you believe your token has been compromised**, please contact us immediately and we can revoke the token, and reissue a new one.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Documentation API Testing\",\n  \"body\": \"This documentation provides a way to test the API although we highly recommend that you **do not** input your token as it would then be shared with the third-party site provider.\"\n}\n[/block]\nSee the single-sign-on section for 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[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Versioning\"\n}\n[/block]\nAs the API evolves we ensure changes will not affect existing client integrations by supporting API versioning. Client integrations will need to include a version HTTP header in all requests for a particular version of the Praemium API. \n\nThis documentation relates to the API version `2018.02.05`\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"x-pps-api-version: 2018.02.05\",\n      \"language\": \"http\",\n      \"name\": \"Version HTTP Header\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Time is running out\",\n  \"body\": \"To ensure that we can continue to advance our API, we require that this header is provided so any integrations without it may cease to work after a reasonable time.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Previous version documentation\"\n}\n[/block]\n- [2017.12.08](http://dev.praemium.com/v2017.12.08/docs)\n- [2017.06.01](http://dev.praemium.com/v2017.06.01/docs)\n- [2017.03.01](http://dev.praemium.com/v2017.03.01/docs)\n- [2017.01.01](http://dev.praemium.com/v2017.01.01/docs)\n- [2016.01.01](http://dev.praemium.com/v2016.01.01/docs)\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Endpoints in the Public API\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Data method\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"[Get Portfolios](doc:api-request)\",\n    \"0-1\": \"Searches for and returns a list of portfolios based on a string matching the portfolio ID and/or name.\\nImportantly also returns an ‘Internal ID’ element required when requesting portfolio specific data methods.\",\n    \"1-0\": \"[ChildPortfolios](doc:getchildportfolios)\",\n    \"1-1\": \"Returns a list of the child portfolios for a consolidated portfolio.\",\n    \"2-0\": \"[PortfolioDetail](doc:portfoliodetail)\",\n    \"3-0\": \"[Valuation](doc:valuation)\",\n    \"2-1\": \"Returns additional information about a single portfolio.\",\n    \"3-1\": \"Returns a portfolio valuation for a single portfolio.\",\n    \"4-0\": \"[AssetClassSummary](doc:assetclasssummary)\",\n    \"4-1\": \"Returns a summary of the asset class allocation for a single portfolio.\",\n    \"5-0\": \"[Performance](doc:performance)\",\n    \"6-0\": \"[DailyReturns](doc:dailyreturns)\",\n    \"5-1\": \"Returns dollar and percentage investment performance returns for a single portfolio for a required period using the time-weighted return (TWR) calculation method.\",\n    \"7-0\": \"[HoldingsExcluded](doc:holdingsexcluded-1)\",\n    \"8-0\": \"[Benchmarks](doc:holdingsexcluded)\",\n    \"9-0\": \"[BenchmarkPerformance](doc:benchmarkperformance)\",\n    \"6-1\": \"Returns the investment performance of a single portfolio for each day in a given period.\",\n    \"7-1\": \"Returns a list of the assets that are excluded from the calculation of a portfolio's investment performance.\",\n    \"8-1\": \"Returns a list of the benchmark indices that are available.\",\n    \"9-1\": \"Returns the performance for a benchmark over a period.\",\n    \"10-0\": \"[UnrealisedCGT](doc:unrealisedcgt)\",\n    \"11-0\": \"[UnrealisedCGTSummary](doc:unrealisedcgtsummary)\",\n    \"12-0\": \"[Transactions](doc:transactions)\",\n    \"13-0\": \"[CashTransactions](doc:cashtransactions)\",\n    \"14-0\": \"[InvestmentMovements](doc:investmentmovements)\",\n    \"10-1\": \"Returns unrealised CGT positions for an account.\",\n    \"11-1\": \"Returns unrealised CGT, summarised at the stock level, for an account.\",\n    \"12-1\": \"Returns stock transactions for an account\",\n    \"13-1\": \"Returns cash transactions for an account\",\n    \"14-1\": \"Returns the percentage return, split between capital and income, for an account over a period\"\n  },\n  \"cols\": 2,\n  \"rows\": 15\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Endpoints in the Privileged suite\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Data Method\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"[PDS](doc:pds)\",\n    \"0-1\": \"Use this to get the information you need about the investment product, before you create an account.\",\n    \"2-0\": \"[Applicants](doc:applicants)\",\n    \"3-0\": \"\",\n    \"1-0\": \"[Account](doc:account)\",\n    \"1-1\": \"Use this to create an SMA account on our system.\",\n    \"2-1\": \"Use this to tell us about the people linked to the account.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\nNote that further endpoints are available, connect with your account manager or support, should you require additional/specific functionality.","excerpt":"This page will help you get started with Praemium API. You'll be up and running in a jiffy!","slug":"getting-started","type":"basic","title":"Getting Started with Praemium API","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Getting Started with Praemium API

This page will help you get started with Praemium API. You'll be up and running in a jiffy!

[block:api-header] { "type": "basic", "title": "Introduction" } [/block] The Praemium API enables your organisation to access information about your clients' portfolios from our portfolio administration system, and to set up accounts on our award-winning SMA platform, 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. [block:callout] { "type": "info", "title": "Privilege permission", "body": "This API provides general information about your clients' portfolios. \n\nSome parts of the API require an additional *privilege* permission for setting up or interacting with a Portfolio or SMA account. We will grant this permission if appropriate for your needs.\n\nAdditional features are available but may not be published here, so if a desired feature or function does not appear here, please get in contact to gain access the other API components." } [/block] [block:api-header] { "type": "basic", "title": "Authentication & Tokens" } [/block] The Praemium API uses a token based approach for authenticating and authorising your integrations. Simply add the token header to each request to the API. [block:code] { "codes": [ { "code": "x-pps-token: XXXX-XXXXXXXXXXXXXXXXXXXXXXX-XXXXXXXXXXXXX", "language": "http", "name": "Token HTTP Header" } ] } [/block] [block:callout] { "type": "warning", "title": "Deprecated header", "body": "Previously we required the HTTP header `token` but in adopting better standards we have deprecated this header. Please ensure you use the supported one above." } [/block] A token will be provided to grant access to the API. Some parts of the API require additional 'privilege' permission. We will grant this permission to a token if appropriate for your needs. In cases where the token doesn't have this permission but is trying to request these routes, we will respond with a `403 (Forbidden)` HTTP status code. [block:callout] { "type": "danger", "title": "Security", "body": "This token is your access to our API. Please treat it as extremely sensitive, similarly to an admin password. Ensure that this token is kept secure as anyone with it will have access to your data. \n\n**Do not **expose this token to your clients, but keep this token private within your secured self-hosted application only. Deploying software with this token outside of a trusted environment, or passing this token to a browser client-side script, is effectively exposing your private token to your clients.\n\n**If you believe your token has been compromised**, please contact us immediately and we can revoke the token, and reissue a new one." } [/block] [block:callout] { "type": "warning", "title": "Documentation API Testing", "body": "This documentation provides a way to test the API although we highly recommend that you **do not** input your token as it would then be shared with the third-party site provider." } [/block] See the single-sign-on section for 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. [block:api-header] { "type": "basic", "title": "Versioning" } [/block] As the API evolves we ensure changes will not affect existing client integrations by supporting API versioning. Client integrations will need to include a version HTTP header in all requests for a particular version of the Praemium API. This documentation relates to the API version `2018.02.05` [block:code] { "codes": [ { "code": "x-pps-api-version: 2018.02.05", "language": "http", "name": "Version HTTP Header" } ] } [/block] [block:callout] { "type": "warning", "title": "Time is running out", "body": "To ensure that we can continue to advance our API, we require that this header is provided so any integrations without it may cease to work after a reasonable time." } [/block] [block:api-header] { "title": "Previous version documentation" } [/block] - [2017.12.08](http://dev.praemium.com/v2017.12.08/docs) - [2017.06.01](http://dev.praemium.com/v2017.06.01/docs) - [2017.03.01](http://dev.praemium.com/v2017.03.01/docs) - [2017.01.01](http://dev.praemium.com/v2017.01.01/docs) - [2016.01.01](http://dev.praemium.com/v2016.01.01/docs) [block:api-header] { "type": "basic", "title": "Endpoints in the Public API" } [/block] [block:parameters] { "data": { "h-0": "Data method", "h-1": "Description", "0-0": "[Get Portfolios](doc:api-request)", "0-1": "Searches for and returns a list of portfolios based on a string matching the portfolio ID and/or name.\nImportantly also returns an ‘Internal ID’ element required when requesting portfolio specific data methods.", "1-0": "[ChildPortfolios](doc:getchildportfolios)", "1-1": "Returns a list of the child portfolios for a consolidated portfolio.", "2-0": "[PortfolioDetail](doc:portfoliodetail)", "3-0": "[Valuation](doc:valuation)", "2-1": "Returns additional information about a single portfolio.", "3-1": "Returns a portfolio valuation for a single portfolio.", "4-0": "[AssetClassSummary](doc:assetclasssummary)", "4-1": "Returns a summary of the asset class allocation for a single portfolio.", "5-0": "[Performance](doc:performance)", "6-0": "[DailyReturns](doc:dailyreturns)", "5-1": "Returns dollar and percentage investment performance returns for a single portfolio for a required period using the time-weighted return (TWR) calculation method.", "7-0": "[HoldingsExcluded](doc:holdingsexcluded-1)", "8-0": "[Benchmarks](doc:holdingsexcluded)", "9-0": "[BenchmarkPerformance](doc:benchmarkperformance)", "6-1": "Returns the investment performance of a single portfolio for each day in a given period.", "7-1": "Returns a list of the assets that are excluded from the calculation of a portfolio's investment performance.", "8-1": "Returns a list of the benchmark indices that are available.", "9-1": "Returns the performance for a benchmark over a period.", "10-0": "[UnrealisedCGT](doc:unrealisedcgt)", "11-0": "[UnrealisedCGTSummary](doc:unrealisedcgtsummary)", "12-0": "[Transactions](doc:transactions)", "13-0": "[CashTransactions](doc:cashtransactions)", "14-0": "[InvestmentMovements](doc:investmentmovements)", "10-1": "Returns unrealised CGT positions for an account.", "11-1": "Returns unrealised CGT, summarised at the stock level, for an account.", "12-1": "Returns stock transactions for an account", "13-1": "Returns cash transactions for an account", "14-1": "Returns the percentage return, split between capital and income, for an account over a period" }, "cols": 2, "rows": 15 } [/block] [block:api-header] { "type": "basic", "title": "Endpoints in the Privileged suite" } [/block] [block:parameters] { "data": { "h-0": "Data Method", "h-1": "Description", "0-0": "[PDS](doc:pds)", "0-1": "Use this to get the information you need about the investment product, before you create an account.", "2-0": "[Applicants](doc:applicants)", "3-0": "", "1-0": "[Account](doc:account)", "1-1": "Use this to create an SMA account on our system.", "2-1": "Use this to tell us about the people linked to the account." }, "cols": 2, "rows": 4 } [/block] Note that further endpoints are available, connect with your account manager or support, should you require additional/specific functionality.
[block:api-header] { "type": "basic", "title": "Introduction" } [/block] The Praemium API enables your organisation to access information about your clients' portfolios from our portfolio administration system, and to set up accounts on our award-winning SMA platform, 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. [block:callout] { "type": "info", "title": "Privilege permission", "body": "This API provides general information about your clients' portfolios. \n\nSome parts of the API require an additional *privilege* permission for setting up or interacting with a Portfolio or SMA account. We will grant this permission if appropriate for your needs.\n\nAdditional features are available but may not be published here, so if a desired feature or function does not appear here, please get in contact to gain access the other API components." } [/block] [block:api-header] { "type": "basic", "title": "Authentication & Tokens" } [/block] The Praemium API uses a token based approach for authenticating and authorising your integrations. Simply add the token header to each request to the API. [block:code] { "codes": [ { "code": "x-pps-token: XXXX-XXXXXXXXXXXXXXXXXXXXXXX-XXXXXXXXXXXXX", "language": "http", "name": "Token HTTP Header" } ] } [/block] [block:callout] { "type": "warning", "title": "Deprecated header", "body": "Previously we required the HTTP header `token` but in adopting better standards we have deprecated this header. Please ensure you use the supported one above." } [/block] A token will be provided to grant access to the API. Some parts of the API require additional 'privilege' permission. We will grant this permission to a token if appropriate for your needs. In cases where the token doesn't have this permission but is trying to request these routes, we will respond with a `403 (Forbidden)` HTTP status code. [block:callout] { "type": "danger", "title": "Security", "body": "This token is your access to our API. Please treat it as extremely sensitive, similarly to an admin password. Ensure that this token is kept secure as anyone with it will have access to your data. \n\n**Do not **expose this token to your clients, but keep this token private within your secured self-hosted application only. Deploying software with this token outside of a trusted environment, or passing this token to a browser client-side script, is effectively exposing your private token to your clients.\n\n**If you believe your token has been compromised**, please contact us immediately and we can revoke the token, and reissue a new one." } [/block] [block:callout] { "type": "warning", "title": "Documentation API Testing", "body": "This documentation provides a way to test the API although we highly recommend that you **do not** input your token as it would then be shared with the third-party site provider." } [/block] See the single-sign-on section for 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. [block:api-header] { "type": "basic", "title": "Versioning" } [/block] As the API evolves we ensure changes will not affect existing client integrations by supporting API versioning. Client integrations will need to include a version HTTP header in all requests for a particular version of the Praemium API. This documentation relates to the API version `2018.02.05` [block:code] { "codes": [ { "code": "x-pps-api-version: 2018.02.05", "language": "http", "name": "Version HTTP Header" } ] } [/block] [block:callout] { "type": "warning", "title": "Time is running out", "body": "To ensure that we can continue to advance our API, we require that this header is provided so any integrations without it may cease to work after a reasonable time." } [/block] [block:api-header] { "title": "Previous version documentation" } [/block] - [2017.12.08](http://dev.praemium.com/v2017.12.08/docs) - [2017.06.01](http://dev.praemium.com/v2017.06.01/docs) - [2017.03.01](http://dev.praemium.com/v2017.03.01/docs) - [2017.01.01](http://dev.praemium.com/v2017.01.01/docs) - [2016.01.01](http://dev.praemium.com/v2016.01.01/docs) [block:api-header] { "type": "basic", "title": "Endpoints in the Public API" } [/block] [block:parameters] { "data": { "h-0": "Data method", "h-1": "Description", "0-0": "[Get Portfolios](doc:api-request)", "0-1": "Searches for and returns a list of portfolios based on a string matching the portfolio ID and/or name.\nImportantly also returns an ‘Internal ID’ element required when requesting portfolio specific data methods.", "1-0": "[ChildPortfolios](doc:getchildportfolios)", "1-1": "Returns a list of the child portfolios for a consolidated portfolio.", "2-0": "[PortfolioDetail](doc:portfoliodetail)", "3-0": "[Valuation](doc:valuation)", "2-1": "Returns additional information about a single portfolio.", "3-1": "Returns a portfolio valuation for a single portfolio.", "4-0": "[AssetClassSummary](doc:assetclasssummary)", "4-1": "Returns a summary of the asset class allocation for a single portfolio.", "5-0": "[Performance](doc:performance)", "6-0": "[DailyReturns](doc:dailyreturns)", "5-1": "Returns dollar and percentage investment performance returns for a single portfolio for a required period using the time-weighted return (TWR) calculation method.", "7-0": "[HoldingsExcluded](doc:holdingsexcluded-1)", "8-0": "[Benchmarks](doc:holdingsexcluded)", "9-0": "[BenchmarkPerformance](doc:benchmarkperformance)", "6-1": "Returns the investment performance of a single portfolio for each day in a given period.", "7-1": "Returns a list of the assets that are excluded from the calculation of a portfolio's investment performance.", "8-1": "Returns a list of the benchmark indices that are available.", "9-1": "Returns the performance for a benchmark over a period.", "10-0": "[UnrealisedCGT](doc:unrealisedcgt)", "11-0": "[UnrealisedCGTSummary](doc:unrealisedcgtsummary)", "12-0": "[Transactions](doc:transactions)", "13-0": "[CashTransactions](doc:cashtransactions)", "14-0": "[InvestmentMovements](doc:investmentmovements)", "10-1": "Returns unrealised CGT positions for an account.", "11-1": "Returns unrealised CGT, summarised at the stock level, for an account.", "12-1": "Returns stock transactions for an account", "13-1": "Returns cash transactions for an account", "14-1": "Returns the percentage return, split between capital and income, for an account over a period" }, "cols": 2, "rows": 15 } [/block] [block:api-header] { "type": "basic", "title": "Endpoints in the Privileged suite" } [/block] [block:parameters] { "data": { "h-0": "Data Method", "h-1": "Description", "0-0": "[PDS](doc:pds)", "0-1": "Use this to get the information you need about the investment product, before you create an account.", "2-0": "[Applicants](doc:applicants)", "3-0": "", "1-0": "[Account](doc:account)", "1-1": "Use this to create an SMA account on our system.", "2-1": "Use this to tell us about the people linked to the account." }, "cols": 2, "rows": 4 } [/block] Note that further endpoints are available, connect with your account manager or support, should you require additional/specific functionality.
{"_id":"5a779cc0befbca0043ffed57","category":"5a779cc0befbca0043ffed4d","project":"55ca8813e583751700f78a58","parentDoc":null,"user":"55ca87c48705a70d00b8fc5c","version":"5a779cc0befbca0043ffed4c","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":1,"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":"5a779cc0befbca0043ffed58","category":"5a779cc0befbca0043ffed4d","parentDoc":null,"project":"55ca8813e583751700f78a58","user":"55ca87c48705a70d00b8fc5c","version":"5a779cc0befbca0043ffed4c","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":2,"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.  If you genuinely need to make more requests, please speak to our support team, however best practices are to handle the limitation as this will be breached no matter the upper limit number.\n\nSee RFC for handling [https://tools.ietf.org/html/rfc6585](https://tools.ietf.org/html/rfc6585)","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. If you genuinely need to make more requests, please speak to our support team, however best practices are to handle the limitation as this will be breached no matter the upper limit number. See RFC for handling [https://tools.ietf.org/html/rfc6585](https://tools.ietf.org/html/rfc6585)
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. If you genuinely need to make more requests, please speak to our support team, however best practices are to handle the limitation as this will be breached no matter the upper limit number. See RFC for handling [https://tools.ietf.org/html/rfc6585](https://tools.ietf.org/html/rfc6585)
{"_id":"5a779cc0befbca0043ffed64","category":"5a779cc0befbca0043ffed4e","project":"55ca8813e583751700f78a58","parentDoc":null,"user":"55ca87c48705a70d00b8fc5c","version":"5a779cc0befbca0043ffed4c","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\n\n{\n  \"Portfolio\": \"*\",\n  \"UserID\": \"smithj\",\n  \"Page\": 1\n}","name":null,"language":"json"},{"code":"","language":"xml","name":null}]},"method":"get","results":{"codes":[{"status":200,"name":"","code":"{\n  \"ResponseStatus\": {\n    \"Success\": true,\n    \"Errors\": []\n  },\n  \"ResponseData\": {\n    \"PortfolioCount\": {\n      \"RecordsFound\": 1,\n      \"RecordsReturned\": 1,\n      \"PageCount\": 1\n    },\n    \"Portfolios\": [\n      {\n        \"InternalID\": 11111,\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      }\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":"Optional","default":"smithj","type":"string","name":"UserID"},{"_id":"55d277c43c74062300aee6be","ref":"","in":"query","required":false,"desc":"Optional","default":"","type":"int","name":"InternalID"},{"_id":"55d277c43c74062300aee6bd","ref":"","in":"query","required":false,"desc":"Optional","default":"","type":"int","name":"Page"}],"url":"/portfolios"},"isReference":true,"order":0,"body":"The purpose of the Portfolios method is to search for and return a list of portfolios based on a string matching the portfolio ID and/or name. Wildcards (*) can be used. Your system can then do further filtering on the results returned.\n\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. Refer to API setup.\n \nThe response object contains a count of the total number of records found and a count of the total number returned. When the number is different, your system can use this as an indicator that additional pages exist or to narrow the search criterion.\n\nUnlike the other API data methods, this request will allow closed portfolios to be returned in the response.","excerpt":"","slug":"api-request","type":"get","title":"Portfolios","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getPortfolios


Query Params

Portfolio:
required
string*
Portfolio search string
UserID:
stringsmithj
Optional
InternalID:
integer
Optional
Page:
integer
Optional
The purpose of the Portfolios method is to search for and return a list of portfolios based on a string matching the portfolio ID and/or name. Wildcards (*) can be used. Your system can then do further filtering on the results returned. 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. Refer to API setup. The response object contains a count of the total number of records found and a count of the total number returned. When the number is different, your system can use this as an indicator that additional pages exist or to narrow the search criterion. Unlike the other API data methods, this request will allow closed portfolios to be returned in the response.

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 the Portfolios method is to search for and return a list of portfolios based on a string matching the portfolio ID and/or name. Wildcards (*) can be used. Your system can then do further filtering on the results returned. 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. Refer to API setup. The response object contains a count of the total number of records found and a count of the total number returned. When the number is different, your system can use this as an indicator that additional pages exist or to narrow the search criterion. Unlike the other API data methods, this request will allow closed portfolios to be returned in the response.
{"_id":"5a779cc0befbca0043ffed65","category":"5a779cc0befbca0043ffed4e","user":"55ca87c48705a70d00b8fc5c","parentDoc":null,"project":"55ca8813e583751700f78a58","version":"5a779cc0befbca0043ffed4c","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-19T01:40:09.770Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"name":"","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    }\n  }\n}","language":"json"}]},"settings":"","examples":{"codes":[{"code":"GET http://{URL as provided}/portfolios/PortfolioDetail HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\n\n{\n  \"InternalID\": 11111,\n  \"UserID\": \"smithj\"\n}","name":"","language":"json"}]},"method":"get","auth":"required","params":[{"_id":"55d2ed5f86807b2b0066b733","ref":"","in":"query","required":true,"desc":"The internal ID returned in the portfolios method","default":"11111","type":"int","name":"InternalID"},{"_id":"55d2edce2463351700f67e2b","ref":"","in":"query","required":false,"desc":"Optional. Praemium user account login ID to check has access to the portfolio before returning data.","default":"smithj","type":"string","name":"UserID"}],"url":"/portfolios/PortfolioDetail"},"isReference":true,"order":1,"body":"The purpose of the PortfolioDetail method is to return details for a single portfolio. This data method provides more attributes for a portfolio than returned in the GetPortfolios response.\n\nUnlike the other API data methods, this request will allow a request for a closed portfolio.","excerpt":"","slug":"portfoliodetail","type":"get","title":"PortfolioDetail","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getPortfolioDetail


Query Params

InternalID:
required
integer11111
The internal ID returned in the portfolios method
UserID:
stringsmithj
Optional. Praemium user account login ID to check has access to the portfolio before returning data.
The purpose of the PortfolioDetail method is to return details for a single portfolio. This data method provides more attributes for a portfolio than returned in the GetPortfolios response. Unlike the other API data methods, this request will allow a request for a closed portfolio.

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 the PortfolioDetail method is to return details for a single portfolio. This data method provides more attributes for a portfolio than returned in the GetPortfolios response. Unlike the other API data methods, this request will allow a request for a closed portfolio.
{"_id":"5a779cc0befbca0043ffed66","category":"5a779cc0befbca0043ffed4e","parentDoc":null,"project":"55ca8813e583751700f78a58","user":"55d13d9d18e19f0d003e428b","version":"5a779cc0befbca0043ffed4c","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\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 internal ID returned in the portfolios method","default":"111111","type":"int","name":"InternalID"},{"_id":"55d2edce2463351700f67e2b","ref":"","in":"query","required":false,"desc":"Optional. Praemium user account login ID to check has access to the portfolio before returning data.","default":"smithj","type":"string","name":"UserID"}],"url":"/portfolios/ChildPortfolios"},"isReference":true,"order":2,"body":"The ChildPortfolios endpoint returns the child portfolios of a consolidated portfolio.\n\nThis endpoint is only available for a single portfolio, which must be a consolidated portfolio as given in the ConsolidatedPortfolioType property of the GetPortfolios response.","excerpt":"","slug":"getchildportfolios","type":"get","title":"ChildPortfolios","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getChildPortfolios


Query Params

InternalID:
required
integer111111
The internal ID returned in the portfolios method
UserID:
stringsmithj
Optional. Praemium user account login ID to check has access to the portfolio before returning data.
The ChildPortfolios endpoint returns the child portfolios of a consolidated portfolio. This endpoint is only available for a single portfolio, which must be a consolidated portfolio as given in the ConsolidatedPortfolioType property of the GetPortfolios response.

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 ChildPortfolios endpoint returns the child portfolios of a consolidated portfolio. This endpoint is only available for a single portfolio, which must be a consolidated portfolio as given in the ConsolidatedPortfolioType property of the GetPortfolios response.
{"_id":"5a779cc0befbca0043ffed67","category":"5a779cc0befbca0043ffed4e","parentDoc":null,"project":"55ca8813e583751700f78a58","user":"55ca87c48705a70d00b8fc5c","version":"5a779cc0befbca0043ffed4c","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\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 internal ID returned in the portfolio method","default":"11111","type":"string","name":"InternalID"},{"_id":"55d2edce2463351700f67e2b","ref":"","in":"query","required":false,"desc":"Optional. 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":"Optional. Whether or not to include loans in the net portfolio value.","default":"1","type":"string","name":"Loans"},{"_id":"55d688fbd2a8eb1900109eb3","ref":"","in":"query","required":false,"desc":"Optional. Praemium user account login ID to check has access to the portfolio before returning data.","default":"smithj","type":"string","name":"UserID"}],"url":"/portfolios/Valuation"},"isReference":true,"order":3,"body":"The purpose of the Valuation method is to return portfolio valuation data. This data method is only available for a single portfolio.","excerpt":"","slug":"valuation","type":"get","title":"Valuation","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getValuation


Query Params

InternalID:
required
string11111
The internal ID returned in the portfolio method
ValuationDate:
string2015-08-19
Optional. The date that the portfolio valuation is required as at.
Loans:
string1
Optional. Whether or not to include loans in the net portfolio value.
UserID:
stringsmithj
Optional. Praemium user account login ID to check has access to the portfolio before returning data.
The purpose of the Valuation method is to return portfolio valuation data. This data method is only available for a single portfolio.

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 the Valuation method is to return portfolio valuation data. This data method is only available for a single portfolio.
{"_id":"5a779cc0befbca0043ffed68","category":"5a779cc0befbca0043ffed4e","parentDoc":null,"user":"55ca87c48705a70d00b8fc5c","project":"55ca8813e583751700f78a58","version":"5a779cc0befbca0043ffed4c","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\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 internal ID returned in the portfolios method","default":"11111","type":"string","name":"InternalID"},{"_id":"55d2edce2463351700f67e2b","ref":"","in":"query","required":false,"desc":"Optional. 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":"Optional. 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":"Optional. 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":"Optional. Praemium user account login ID to verify access to portfolios before returning data.","default":"smithj","type":"string","name":"UserID"}],"url":"/portfolios/AssetClassSummary"},"isReference":true,"order":5,"body":"The AssetClassSummary endpoint returns a summary of the portfolio’s exposure to each asset class. 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\nThis endpoint is only available for a single portfolio. All values are converted to the portfolio’s presentation currency.","excerpt":"","slug":"assetclasssummary","type":"get","title":"AssetClassSummary","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getAssetClassSummary


Query Params

InternalID:
required
string11111
The internal ID returned in the portfolios method
ValuationDate:
yyyy-mm-dd2015-08-19
Optional. 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
Optional. Whether or not to include loans in the net portfolio value.
Targets:
integer1
Optional. Whether or not return asset allocation targets if applicable to the portfolio.
UserID:
stringsmithj
Optional. Praemium user account login ID to verify access to portfolios before returning data.
The AssetClassSummary endpoint returns a summary of the portfolio’s exposure to each asset class. 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. This endpoint is only available for a single portfolio. All values are converted to the portfolio’s presentation currency.

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 AssetClassSummary endpoint returns a summary of the portfolio’s exposure to each asset class. 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. This endpoint is only available for a single portfolio. All values are converted to the portfolio’s presentation currency.
{"_id":"5a779cc0befbca0043ffed69","category":"5a779cc0befbca0043ffed4f","user":"55ca87c48705a70d00b8fc5c","project":"55ca8813e583751700f78a58","parentDoc":null,"version":"5a779cc0befbca0043ffed4c","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\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 supplied in the request","default":"11111","type":"string","name":"InternalID"},{"_id":"55d2edce2463351700f67e2b","ref":"","in":"query","required":true,"desc":"The start date of the performance period required.","default":"2015-08-19","type":"yyyy-mm-dd","name":"FromDate"},{"_id":"55d67eaa250d7d0d0042745b","ref":"","in":"query","required":true,"desc":"The end date of the performance period required.","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 TWR.","default":"1","type":"int","name":"PerfCalcMethod"},{"_id":"55d67eaa250d7d0d00427459","ref":"","in":"query","required":false,"desc":"Optional. Whether or not to include cash in the performance calculations.","default":"1","type":"int","name":"Cash"},{"_id":"55d67eaa250d7d0d00427458","ref":"","in":"query","required":false,"desc":"Optional. 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":"Optional. 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":"Optional. Whether to calculate percentage returns:","default":"1","type":"int","name":"PercentReturns"},{"_id":"55d67eaa250d7d0d00427455","ref":"","in":"query","required":false,"desc":"Optional. 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":"Optional. Praemium user account login ID to verify access to portfolios before returning data.","default":"smithj","type":"string","name":"UserID"}],"url":"/performance"},"isReference":true,"order":0,"body":"The purpose of the Performance method is to return portfolio performance data for a given date period. The GetPerformance method is only available for a single portfolio. Default values for optional input parameters will match the defaults that you have set up for **Portfolio performance **in your Praemium Service.","excerpt":"","slug":"performance","type":"get","title":"Performance","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getPerformance


Query Params

InternalID:
required
string11111
The InternalID supplied in the request
FromDate:
required
yyyy-mm-dd2015-08-19
The start date of the performance period required.
ToDate:
required
yyyy-mm-dd2015-08-19
The end date of the performance period required.
PerfCalcMethod:
required
integer1
The method to calculate the percentage return. Currently always 0 for TWR.
Cash:
integer1
Optional. Whether or not to include cash in the performance calculations.
ExcludedAssets:
integer1
Optional. Whether or not to include any assets that have been excluded from performance.
TaxCredits:
integer1
Optional. Whether or not to include tax credits in the dollar and percentage return calculations.
PercentReturns:
integer1
Optional. Whether to calculate percentage returns:
MultiplePeriods:
integer1
Optional. Whether to calculate percentage returns for the period requested or other periods:
UserID:
stringsmithj
Optional. Praemium user account login ID to verify access to portfolios before returning data.
The purpose of the Performance method is to return portfolio performance data for a given date period. The GetPerformance method is only available for a single portfolio. Default values for optional input parameters will match the defaults that you have set up for **Portfolio performance **in your Praemium Service.

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 the Performance method is to return portfolio performance data for a given date period. The GetPerformance method is only available for a single portfolio. Default values for optional input parameters will match the defaults that you have set up for **Portfolio performance **in your Praemium Service.
{"_id":"5a779cc0befbca0043ffed6a","category":"5a779cc0befbca0043ffed4f","project":"55ca8813e583751700f78a58","parentDoc":null,"user":"55ca87c48705a70d00b8fc5c","version":"5a779cc0befbca0043ffed4c","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\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 internal ID returned in the portfolios method","default":"11111","type":"string","name":"InternalID"},{"_id":"55d2edce2463351700f67e2b","ref":"","in":"query","required":true,"desc":"The start date of the period required.","default":"2015-08-01","type":"yyyy-mm-dd","name":"FromDate"},{"_id":"55d6615aae529e0d00d34e85","ref":"","in":"query","required":true,"desc":"The end date of the period required.","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"}],"url":"/Performance/InvestmentMovements"},"isReference":true,"order":1,"body":"The purpose of the InvestmentMovements method is to return the movement in value for a given date period of a portfolio’s holdings, cash accounts and cash equivalents.\n\nThe 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**Note:** the percentage returns are approximation only and are not time weighted.\n\nThe GetInvestmentMovements method is only available for a single portfolio. Default values for optional input parameters will match the defaults that you have set up for **Investment movements** in your Praemium Service.","excerpt":"","slug":"investmentmovements","type":"get","title":"InvestmentMovements","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getInvestmentMovements


Query Params

InternalID:
required
string11111
The internal ID returned in the portfolios method
FromDate:
required
yyyy-mm-dd2015-08-01
The start date of the period required.
ToDate:
required
yyyy-mm-dd2015-08-19
The end date of the period required.
PercentReturnMethod:
integer1
0 = Time Weighted Return (TWR), 1 = Approximate returns
The purpose of the InvestmentMovements method is to return the movement in value for a given date period of a portfolio’s holdings, cash accounts and cash equivalents. 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. **Note:** the percentage returns are approximation only and are not time weighted. The GetInvestmentMovements method is only available for a single portfolio. Default values for optional input parameters will match the defaults that you have set up for **Investment movements** in your Praemium Service.

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 the InvestmentMovements method is to return the movement in value for a given date period of a portfolio’s holdings, cash accounts and cash equivalents. 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. **Note:** the percentage returns are approximation only and are not time weighted. The GetInvestmentMovements method is only available for a single portfolio. Default values for optional input parameters will match the defaults that you have set up for **Investment movements** in your Praemium Service.
{"_id":"5a779cc0befbca0043ffed6b","category":"5a779cc0befbca0043ffed4f","user":"55ca87c48705a70d00b8fc5c","parentDoc":null,"project":"55ca8813e583751700f78a58","version":"5a779cc0befbca0043ffed4c","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-19T01:44:33.704Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"","code":"GET http://{URL as provided}/Performance/DailyReturns HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\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}","language":"json"}]},"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 internal ID returned in the Portfolios method","default":"11111","type":"string","name":"InternalID"},{"_id":"55d2edce2463351700f67e2b","ref":"","in":"query","required":true,"desc":"The start date of the performance period required.","default":"2015-08-19","type":"yyyy-mm-dd","name":"FromDate"},{"_id":"55d65a43250d7d0d004273fb","ref":"","in":"query","required":true,"desc":"The end date of the performance period required. Must not 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":"Optional. 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":"Optional. 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":"Optional. 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":"","default":"1","type":"int","name":"PercentReturns"},{"_id":"55d65a43250d7d0d004273f5","ref":"","in":"query","required":false,"desc":"","default":"1","type":"int","name":"MultiplePeriods"},{"_id":"55d65a43250d7d0d004273f4","ref":"","in":"query","required":false,"desc":"Optional. Praemium user account login ID to verify access to portfolios before returning data.","default":"smithj","type":"string","name":"UserID"}],"url":"/Performance/DailyReturns"},"isReference":true,"order":2,"body":"The purpose of the DailyReturn method is to provide the percentage return of a portfolio for each day within a performance period in order to, for example, chart the performance or reconcile the percentage returns contained in the GetPerformance response.\n\nThis API data method:\n  * Is only relevant to the time-weighted return (TWR) performance calculation method.\n  * Can only be requested for a period of 31 days or less. You will need to send multiple requests to build up data for a longer period.\n  * Is only available for a single portfolio.","excerpt":"","slug":"dailyreturns","type":"get","title":"DailyReturns","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getDailyReturns


Query Params

InternalID:
required
string11111
The internal ID returned in the Portfolios method
FromDate:
required
yyyy-mm-dd2015-08-19
The start date of the performance period required.
ToDate:
required
yyyy-mm-dd2015-08-19
The end date of the performance period required. Must not be more than 31 days after FromDate.
PerfCalcMethod:
required
integer1
0 = Time Weighted Return (TWR)
Cash:
integer1
Optional. Whether or not to include cash in the performance calculations. 0=Exclude, 1=Include
ExcludedAssets:
integer1
Optional. Whether or not to include any assets that have been excluded from performance. 0=Exclude, 1=Include
TaxCredits:
integer1
Optional. Whether or not to include tax credits in the dollar and percentage return calculations. 0=Exclude, 1=Include
PercentReturns:
integer1
MultiplePeriods:
integer1
UserID:
stringsmithj
Optional. Praemium user account login ID to verify access to portfolios before returning data.
The purpose of the DailyReturn method is to provide the percentage return of a portfolio for each day within a performance period in order to, for example, chart the performance or reconcile the percentage returns contained in the GetPerformance response. This API data method: * Is only relevant to the time-weighted return (TWR) performance calculation method. * Can only be requested for a period of 31 days or less. You will need to send multiple requests to build up data for a longer period. * Is only available for a single portfolio.

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 the DailyReturn method is to provide the percentage return of a portfolio for each day within a performance period in order to, for example, chart the performance or reconcile the percentage returns contained in the GetPerformance response. This API data method: * Is only relevant to the time-weighted return (TWR) performance calculation method. * Can only be requested for a period of 31 days or less. You will need to send multiple requests to build up data for a longer period. * Is only available for a single portfolio.
{"_id":"5a779cc0befbca0043ffed6c","category":"5a779cc0befbca0043ffed4f","parentDoc":null,"user":"55ca87c48705a70d00b8fc5c","project":"55ca8813e583751700f78a58","version":"5a779cc0befbca0043ffed4c","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\n","name":"","language":"json"}]},"auth":"required","params":[],"url":"/Performance/Benchmarks"},"isReference":true,"order":3,"body":"The Benchmarks method returns the full list of benchmark indices maintained by Praemium.\n\nNo input parameters are required.\n\nThe purpose of this method is for your system to enable a user to select a benchmark\nindex and then request the [BenchmarkPerformance](doc:benchmarkperformance) data method.","excerpt":"","slug":"holdingsexcluded","type":"get","title":"Benchmarks","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getBenchmarks


The Benchmarks method returns the full list of benchmark indices maintained by Praemium. No input parameters are required. The purpose of this method is for your system to enable a user to select a benchmark index and then request the [BenchmarkPerformance](doc:benchmarkperformance) data method.

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 Benchmarks method returns the full list of benchmark indices maintained by Praemium. No input parameters are required. The purpose of this method is for your system to enable a user to select a benchmark index and then request the [BenchmarkPerformance](doc:benchmarkperformance) data method.
{"_id":"5a779cc0befbca0043ffed6d","category":"5a779cc0befbca0043ffed4f","user":"55ca87c48705a70d00b8fc5c","parentDoc":null,"project":"55ca8813e583751700f78a58","version":"5a779cc0befbca0043ffed4c","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\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 numerical identifier assigned to the benchmark.","default":"2","type":"int","name":"BenchmarkID"},{"_id":"55d2edce2463351700f67e2b","ref":"","in":"query","required":true,"desc":"Start date of the performance period.","default":"2015-08-19","type":"yyyy-mm-dd","name":"FromDate"},{"_id":"55d56924e60a2f0d00b88b4d","ref":"","in":"query","required":true,"desc":"End date of the performance period.","default":"2015-08-19","type":"yyyy-mm-dd","name":"ToDate"},{"_id":"55d56924e60a2f0d00b88b4c","ref":"","in":"query","required":false,"desc":"Optional. Whether to calculate percentage returns for the period requested or other periods","default":"0","type":"int","name":"MultiplePeriods"}],"url":"/Performance/BenchmarkPerformance"},"isReference":true,"order":4,"body":"The purpose of BenchmarkPerformance method is to get the percentage return of a benchmark for a given date period in order to compare with a portfolio’s performance.\n\nThe date range supplied in the request object should therefore match the date range for the portfolio performance calculated.\n\nThis data method is only available to a single benchmark index.","excerpt":"","slug":"benchmarkperformance","type":"get","title":"BenchmarkPerformance","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getBenchmarkPerformance


Query Params

BenchmarkID:
required
integer2
The numerical identifier assigned to the benchmark.
FromDate:
required
yyyy-mm-dd2015-08-19
Start date of the performance period.
ToDate:
required
yyyy-mm-dd2015-08-19
End date of the performance period.
MultiplePeriods:
integer0
Optional. Whether to calculate percentage returns for the period requested or other periods
The purpose of BenchmarkPerformance method is to get the percentage return of a benchmark for a given date period in order to compare with a portfolio’s performance. The date range supplied in the request object should therefore match the date range for the portfolio performance calculated. This data method is only available to a single benchmark index.

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 BenchmarkPerformance method is to get the percentage return of a benchmark for a given date period in order to compare with a portfolio’s performance. The date range supplied in the request object should therefore match the date range for the portfolio performance calculated. This data method is only available to a single benchmark index.
{"_id":"5a779cc0befbca0043ffed6e","category":"5a779cc0befbca0043ffed4f","project":"55ca8813e583751700f78a58","user":"55ca87c48705a70d00b8fc5c","parentDoc":null,"version":"5a779cc0befbca0043ffed4c","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\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 internal ID returned in the portfolios method","default":"11111","type":"string","name":"InternalID"},{"_id":"55d2edce2463351700f67e2b","ref":"","in":"query","required":false,"desc":"Optional. Should be supplied if only wanting to return holdings excluded within the performance period requested in the Performance method.","default":"2015-08-19","type":"string","name":"FromDate"},{"_id":"55d660bf250d7d0d00427417","ref":"","in":"query","required":false,"desc":"Optional. Should be supplied if only wanting to return holdings excluded within the performance period requested in the Performance method.","default":"2015-08-19","type":"string","name":"ToDate"},{"_id":"55d660bf250d7d0d00427416","ref":"","in":"query","required":false,"desc":"UserID Optional. Praemium user account login ID to verify access to portfolios before returning data.","default":"smithj","type":"string","name":"UserID"}],"url":"/Performance/HoldingsExcluded"},"isReference":true,"order":5,"body":"The purpose of the HoldingsExcluded method is to provide the list of holdings that may be excluded from portfolio performance calculations.\n\nIt 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\nThis data method is only available for a single portfolio.","excerpt":"","slug":"holdingsexcluded-1","type":"get","title":"HoldingsExcluded","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getHoldingsExcluded


Query Params

InternalID:
required
string11111
The internal ID returned in the portfolios method
FromDate:
string2015-08-19
Optional. Should be supplied if only wanting to return holdings excluded within the performance period requested in the Performance method.
ToDate:
string2015-08-19
Optional. Should be supplied if only wanting to return holdings excluded within the performance period requested in the Performance method.
UserID:
stringsmithj
UserID Optional. Praemium user account login ID to verify access to portfolios before returning data.
The purpose of the HoldingsExcluded method is to provide the list of holdings that may be excluded from portfolio performance calculations. 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. This data method is only available for a single portfolio.

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 the HoldingsExcluded method is to provide the list of holdings that may be excluded from portfolio performance calculations. 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. This data method is only available for a single portfolio.
{"_id":"5a779cc0befbca0043ffed6f","category":"5a779cc0befbca0043ffed4f","project":"55ca8813e583751700f78a58","user":"55dd6ff10efd5821000d5471","parentDoc":null,"version":"5a779cc0befbca0043ffed4c","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: 2017.06.01\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 numerical identifier assigned to the account","default":"123456","type":"int","name":"AccountId"},{"_id":"55d2edce2463351700f67e2b","ref":"","in":"query","required":true,"desc":"Start date of the performance period.","default":"2015-08-19","type":"yyyy-mm-dd","name":"FromDate"},{"_id":"55d56924e60a2f0d00b88b4d","ref":"","in":"query","required":true,"desc":"End date of the performance period.","default":"2016-08-18","type":"yyyy-mm-dd","name":"ToDate"}],"url":"/Performance/AssetClassPerformance"},"isReference":true,"order":6,"body":"The purpose of AssetClassPerformance method is to get the percentage return of asset class for a given date period.","excerpt":"","slug":"assetclassperformance","type":"get","title":"AssetClassPerformance","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getAssetClassPerformance


Query Params

AccountId:
required
integer123456
The numerical identifier assigned to the account
FromDate:
required
yyyy-mm-dd2015-08-19
Start date of the performance period.
ToDate:
required
yyyy-mm-dd2016-08-18
End date of the performance period.
The purpose of AssetClassPerformance method is to get the percentage return of asset class for a given date period.

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 AssetClassPerformance method is to get the percentage return of asset class for a given date period.
{"_id":"5a779cc0befbca0043ffed60","category":"5a779cc0befbca0043ffed51","project":"55ca8813e583751700f78a58","parentDoc":null,"user":"55ca87c48705a70d00b8fc5c","version":"5a779cc0befbca0043ffed4c","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\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 internal ID returned in the portfolio method","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":"Optional. Praemium user account login ID to check has access to the portfolio before returning data.","default":"smithj","type":"string","name":"UserID"}],"url":"/tax/UnrealisedCgt"},"isReference":true,"order":0,"body":"The purpose of the UnrealisedCGT method is to return cost bases, tax parcels and the unrealised CGT gain/loss for CGT assets.\n\nThis data method is only available for a single portfolio and only as at the portfolio’s current 'processed to' date.\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.","excerpt":"","slug":"unrealisedcgt","type":"get","title":"UnrealisedCGT","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getUnrealisedCGT


Query Params

InternalID:
required
string11111
The internal ID returned in the portfolio method
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
Optional. Praemium user account login ID to check has access to the portfolio before returning data.
The purpose of the UnrealisedCGT method is to return cost bases, tax parcels and the unrealised CGT gain/loss for CGT assets. This data method is only available for a single portfolio and only as at the portfolio’s current 'processed to' date. 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.

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 the UnrealisedCGT method is to return cost bases, tax parcels and the unrealised CGT gain/loss for CGT assets. This data method is only available for a single portfolio and only as at the portfolio’s current 'processed to' date. 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.
{"_id":"5a779cc0befbca0043ffed61","category":"5a779cc0befbca0043ffed51","parentDoc":null,"user":"55ca87c48705a70d00b8fc5c","project":"55ca8813e583751700f78a58","version":"5a779cc0befbca0043ffed4c","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\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 internal ID returned in the portfolio method","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":"Optional. Praemium user account login ID to check has access to the portfolio before returning data.","default":"smithj","type":"string","name":"UserID"}],"url":"/tax/UnrealisedCgtSummary"},"isReference":true,"order":1,"body":"The purpose of the UnrealisedCGTSummary method is to return the total cost base and total unrealised CGT gain/loss for the portfolio. This method takes care of business logic for you to exclude from the portfolio totals any gains returned by the GetUnrealisedCGT method 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\nThis data method is only available for a single portfolio and only as at the portfolio’s current 'processed to' date.\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.","excerpt":"","slug":"unrealisedcgtsummary","type":"get","title":"UnrealisedCGTSummary","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getUnrealisedCGTSummary


Query Params

InternalID:
required
string11111
The internal ID returned in the portfolio method
ValuationDate:
yyyy-mm-dd
Must always be the current processed to date of the portfolio.
UserID:
stringsmithj
Optional. Praemium user account login ID to check has access to the portfolio before returning data.
The purpose of the UnrealisedCGTSummary method is to return the total cost base and total unrealised CGT gain/loss for the portfolio. This method takes care of business logic for you to exclude from the portfolio totals any gains returned by the GetUnrealisedCGT method 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. This data method is only available for a single portfolio and only as at the portfolio’s current 'processed to' date. 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.

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 the UnrealisedCGTSummary method is to return the total cost base and total unrealised CGT gain/loss for the portfolio. This method takes care of business logic for you to exclude from the portfolio totals any gains returned by the GetUnrealisedCGT method 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. This data method is only available for a single portfolio and only as at the portfolio’s current 'processed to' date. 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.
{"_id":"5a779cc0befbca0043ffed62","category":"5a779cc0befbca0043ffed51","project":"55ca8813e583751700f78a58","parentDoc":null,"user":"55dd6ff10efd5821000d5471","version":"5a779cc0befbca0043ffed4c","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\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 internal ID returned in the portfolio method","default":"11111","type":"string","name":"InternalID"}],"url":"/tax/RealisedCgt"},"isReference":true,"order":2,"body":"The purpose of the RealisedCGT method is to return cost bases, tax parcels and the realised CGT gain/loss for CGT assets.","excerpt":"","slug":"realisedcgt","type":"get","title":"RealisedCGT","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getRealisedCGT


Query Params

InternalID:
required
string11111
The internal ID returned in the portfolio method
The purpose of the RealisedCGT method is to return cost bases, tax parcels and the realised CGT gain/loss for CGT assets.

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 the RealisedCGT method is to return cost bases, tax parcels and the realised CGT gain/loss for CGT assets.
{"_id":"5a779cc0befbca0043ffed63","category":"5a779cc0befbca0043ffed51","parentDoc":null,"project":"55ca8813e583751700f78a58","user":"55dd6ff10efd5821000d5471","version":"5a779cc0befbca0043ffed4c","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\n\n{\n  \"InternalID\": 11111\n}","name":""}]},"auth":"required","params":[{"_id":"55d2ed5f86807b2b0066b733","ref":"","in":"query","required":true,"desc":"The internal ID returned in the portfolio method","default":"11111","type":"string","name":"InternalID"}],"url":"/tax/RealisedCgtSummary"},"isReference":true,"order":3,"body":"The purpose of the RealisedCGT method is to return cost bases, tax parcels and the realised CGT gain/loss for CGT assets.","excerpt":"","slug":"realisedcgtsummary","type":"get","title":"RealisedCGTSummary","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getRealisedCGTSummary


Query Params

InternalID:
required
string11111
The internal ID returned in the portfolio method
The purpose of the RealisedCGT method is to return cost bases, tax parcels and the realised CGT gain/loss for CGT assets.

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 the RealisedCGT method is to return cost bases, tax parcels and the realised CGT gain/loss for CGT assets.
{"_id":"5a779cc0befbca0043ffed5a","category":"5a779cc0befbca0043ffed52","parentDoc":null,"user":"55ca87c48705a70d00b8fc5c","project":"55ca8813e583751700f78a58","version":"5a779cc0befbca0043ffed4c","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\n\n{\n  \"InternalID\": 11111,\n  \"UserID\": \"smithj\",\n  \"FromDate\": \"2015-08-19\",\n  \"ToDate\": \"2015-08-19\",\n  \"BuysAndSellsOnly\": 1\n}","name":""}]},"auth":"required","params":[{"_id":"55d2ed5f86807b2b0066b733","ref":"","in":"query","required":true,"desc":"The internal ID returned in the portfolio method","default":"11111","type":"string","name":"InternalID"},{"_id":"55d6b9fdae529e0d00d34f62","ref":"","in":"query","required":true,"desc":"Start date of the performance period.","default":"2015-08-01","type":"yyyy-mm-dd","name":"FromDate"},{"_id":"55d6b9fdae529e0d00d34f61","ref":"","in":"query","required":true,"desc":"Start date of the performance period.","default":"2015-09-01","type":"yyyy-mm-dd","name":"ToDate"},{"_id":"55d6b9fdae529e0d00d34f60","ref":"","in":"query","required":false,"desc":"Optional. Whether or not to include buys and sells only.","default":"1","type":"int","name":"BuysAndSellsOnly"},{"_id":"55d2edce2463351700f67e2b","ref":"","in":"query","required":false,"desc":"Optional. Praemium user account login ID to check has access to the portfolio before returning data.","default":"","type":"string","name":"UserID"}],"url":"/TradingActivity/Transactions"},"isReference":true,"order":0,"body":"","excerpt":"","slug":"transactions","type":"get","title":"Transactions","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getTransactions


Query Params

InternalID:
required
string11111
The internal ID returned in the portfolio method
FromDate:
required
yyyy-mm-dd2015-08-01
Start date of the performance period.
ToDate:
required
yyyy-mm-dd2015-09-01
Start date of the performance period.
BuysAndSellsOnly:
integer1
Optional. Whether or not to include buys and sells only.
UserID:
string
Optional. Praemium user account login ID to check has access to the portfolio before returning data.

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":"5a779cc0befbca0043ffed5b","category":"5a779cc0befbca0043ffed52","parentDoc":null,"user":"55ca87c48705a70d00b8fc5c","project":"55ca8813e583751700f78a58","version":"5a779cc0befbca0043ffed4c","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\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 internal ID returned in the portfolio method","default":"11111","type":"int","name":"InternalID"},{"_id":"55d6b98860fc730d00fc268d","ref":"","in":"query","required":true,"desc":"Start date of the performance period.","default":"2015-08-01","type":"yyyy-mm-dd","name":"FromDate"},{"_id":"55d6b98860fc730d00fc268c","ref":"","in":"query","required":true,"desc":"Start date of the performance period.","default":"2015-09-01","type":"yyyy-mm-dd","name":"ToDate"},{"_id":"55d6b98860fc730d00fc268b","ref":"","in":"query","required":false,"desc":"Optional. 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":"Optional. Praemium user account login ID to check has access to the portfolio before returning data.","default":"","type":"string","name":"UserID"}],"url":"/TradingActivity/CashTransactions"},"isReference":true,"order":1,"body":"","excerpt":"","slug":"cashtransactions","type":"get","title":"CashTransactions","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getCashTransactions


Query Params

InternalID:
required
integer11111
The internal ID returned in the portfolio method
FromDate:
required
yyyy-mm-dd2015-08-01
Start date of the performance period.
ToDate:
required
yyyy-mm-dd2015-09-01
Start date of the performance period.
Loans:
integer1
Optional. Whether or not to include loans in the net portfolio value.
UserID:
string
Optional. Praemium user account login ID to check has access to the portfolio before returning data.

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":"5a779cc0befbca0043ffed70","category":"5a779cc0befbca0043ffed53","user":"55a49cd3e6c2470d002a648c","parentDoc":null,"project":"55ca8813e583751700f78a58","version":"5a779cc0befbca0043ffed4c","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":"Setting up an account using the privileged API","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Setting up an account using the privileged API


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":"5a779cc0befbca0043ffed71","category":"5a779cc0befbca0043ffed53","user":"55ca87c48705a70d00b8fc5c","project":"55ca8813e583751700f78a58","parentDoc":null,"version":"5a779cc0befbca0043ffed4c","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\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":[],"url":"/pds"},"isReference":true,"order":1,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"This is a privileged endpoint\"\n}\n[/block]\n\n[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]\nWhat the PDS endpoint contains\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"ID\",\n    \"0-1\": \"Our internal ID for the PDS\",\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":"","slug":"pds","type":"get","title":"PDS","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getPDS


[block:callout] { "type": "info", "title": "This is a privileged endpoint" } [/block] [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] What the PDS endpoint contains [block:parameters] { "data": { "0-0": "ID", "0-1": "Our internal ID for the PDS", "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": "This is a privileged endpoint" } [/block] [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] What the PDS endpoint contains [block:parameters] { "data": { "0-0": "ID", "0-1": "Our internal ID for the PDS", "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":"5a779cc0befbca0043ffed72","category":"5a779cc0befbca0043ffed53","user":"55ca87c48705a70d00b8fc5c","project":"55ca8813e583751700f78a58","parentDoc":null,"version":"5a779cc0befbca0043ffed4c","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":[{"name":"Individual","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\":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}","language":"json"},{"code":"POST http://{URL as provided}/account HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\n\n","name":"Joint","language":"json"},{"name":"Pension (TTR)","language":"json","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"}]},"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":"string","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":"","default":"Miss Jane Smith","type":"string","name":"Account.Name"},{"_id":"55dfe5693d8bfd0d00c65dc8","ref":"","in":"body","required":true,"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 ID (from the PDS response) 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":"","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.BankAccount.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"}],"url":"/accounts"},"isReference":true,"order":2,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"This is a privileged endpoint\"\n}\n[/block]","excerpt":"","slug":"account","type":"post","title":"Accounts","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postAccounts


Body Params

Type:
required
string1
SMA = 1
Account:
object
Contains the account data.
Account.Name:
required
stringMiss Jane Smith
Account.AdviserId:
required
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 ID (from the PDS response) 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
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.BankAccount.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
[block:callout] { "type": "info", "title": "This is a privileged endpoint" } [/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": "This is a privileged endpoint" } [/block]
{"_id":"5a779cc0befbca0043ffed73","category":"5a779cc0befbca0043ffed53","parentDoc":null,"user":"55ca87c48705a70d00b8fc5c","project":"55ca8813e583751700f78a58","version":"5a779cc0befbca0043ffed4c","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-04T07:22:06.505Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":201,"language":"json","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]","name":""},{"language":"json","status":null,"name":"207 Multi Status","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]"},{"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]","language":"json","status":400}]},"settings":"","examples":{"codes":[{"name":"Individual","code":"POST http://{URL as provided}/accounts 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\":\"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},\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]","language":"json"},{"name":"Joint","language":"json","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 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\t    \t\t\t\"PayoutIncome\": false,\n\t    \t\t\t\"FeeOffset\": true,\n \t    \t\t\t\"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   },\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}"},{"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\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   \"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}"},{"name":"Pension","language":"json","code":"For pension accounts the below JSON changes must be made:\n\n\nCOMING SOON\n\n\n\n\n"}]},"method":"post","auth":"required","params":[],"url":"/accounts"},"isReference":true,"order":3,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"This is a privileged endpoint\"\n}\n[/block]","excerpt":"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.","slug":"accounts-bulk","type":"post","title":"Accounts (Bulk)","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postAccounts (Bulk)

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": "This is a privileged endpoint" } [/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": "This is a privileged endpoint" } [/block]
{"_id":"5a779cc0befbca0043ffed74","category":"5a779cc0befbca0043ffed53","project":"55ca8813e583751700f78a58","user":"55a49cd3e6c2470d002a648c","parentDoc":null,"version":"5a779cc0befbca0043ffed4c","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":[{"code":"POST http://{URL as provided}/account HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\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        \"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\": \"WholeAmountKeepOpenSpecifiedAmount\",\n            \"Amount\": 10000.00,\n          } \n        ],\n        \"OtherContributions\": [\n          {\n            \"ContributionType\": 11,\n            \"ExpectedAmount\": 250.00\n          }\n        ]\n  }\n}\n","language":"json","name":"Accumulation"}]},"method":"post","auth":"required","params":[{"_id":"55dfe5693d8bfd0d00c65dca","ref":"","in":"body","required":true,"desc":"SuperSMAAccumulation = 4","default":"1","type":"string","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":"","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 ID (from the PDS response) 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":"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 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"}],"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\": \"This is a privileged endpoint\"\n}\n[/block]","excerpt":"","slug":"accounts-super-accumulation","type":"post","title":"Accounts (retail super - accumulation)","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postAccounts (retail super - accumulation)


Body Params

Type:
required
string1
SuperSMAAccumulation = 4
Account:
object
Contains the account data.
Account.Name:
required
stringMiss Jane Smith
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 ID (from the PDS response) 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.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 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
[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": "This is a privileged endpoint" } [/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": "This is a privileged endpoint" } [/block]
{"_id":"5a779cc0befbca0043ffed75","category":"5a779cc0befbca0043ffed53","user":"55a49cd3e6c2470d002a648c","project":"55ca8813e583751700f78a58","parentDoc":null,"version":"5a779cc0befbca0043ffed4c","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\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":"string","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":"","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 ID (from the PDS response) 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":"","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":"","default":"1000","type":"string","name":"Account.PaymentAmount"},{"_id":"571f0abed8667f0e00a3c3fa","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"Consolidation"}],"url":"/accounts"},"isReference":true,"order":5,"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\": \"This is a privileged endpoint\"\n}\n[/block]","excerpt":"","slug":"accounts-pension","type":"post","title":"Accounts (retail super - pension)","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postAccounts (retail super - pension)


Body Params

Type:
required
string1
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
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 ID (from the PDS response) 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
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
Consolidation:
string
[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": "This is a privileged endpoint" } [/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": "This is a privileged endpoint" } [/block]
{"_id":"5a779cc0befbca0043ffed76","category":"5a779cc0befbca0043ffed53","user":"55ca87c48705a70d00b8fc5c","parentDoc":null,"project":"55ca8813e583751700f78a58","version":"5a779cc0befbca0043ffed4c","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\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":[{"status":200,"language":"json","code":"[  \n  {  \n    \"Index\":1,\n    \"CreationStatus\":0,\n    \"Applicant\":{  \n      \"Id\":\"AU21996\"\n    }\n  },\n]","name":""}]},"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 ID for the account that the applicant is linked to, 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. So that the image is not distorted when it is printed, please make the width of the image 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"}],"url":"/Applicants"},"isReference":true,"order":6,"body":"For 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\": \"This is a privileged endpoint\"\n}\n[/block]","excerpt":"Use the Applicants API to send us details of the peoples associated with an account, who may be individual investors, SuperSMA fund members, directors, trustees, etc depending on the type of legal entity that the investor is.","slug":"applicants","type":"post","title":"Applicants","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postApplicants

Use the Applicants API to send us details of the peoples associated with an account, who may be individual investors, SuperSMA fund members, directors, trustees, etc depending on the type of legal entity that the investor is.

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 ID for the account that the applicant is linked to, 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. So that the image is not distorted when it is printed, please make the width of the image 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.
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": "This is a privileged endpoint" } [/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



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": "This is a privileged endpoint" } [/block]
{"_id":"5a779cc0befbca0043ffed77","category":"5a779cc0befbca0043ffed53","parentDoc":null,"user":"55dd6ff10efd5821000d5471","project":"55ca8813e583751700f78a58","version":"5a779cc0befbca0043ffed4c","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-09T05:40:53.316Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"","language":"json","code":"POST http://{URL as provided}/Applicants HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\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\":\"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      \"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\":\"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      \"Signature_image\":\"\",\n      \"IsPoliticallyExposedPerson\":false,\n      \"Identification\":[  \n        {  \n          \"IdNumber\":\"123456782\",\n          \"Type\":5\n        }\n      ]\n    }\n  }\n]"}]},"method":"post","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":200},{"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"},{"status":400,"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"}]},"settings":"","auth":"required","params":[],"url":"/Applicants"},"isReference":true,"order":7,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"This is a privileged endpoint\"\n}\n[/block]","excerpt":"Use the Applicants endpoint to send us details of the peoples associated with an account, who may be individual investors, SuperSMA fund members, directors, trustees, etc depending on the type of legal entity that the investor is.\nThis is an example of using the Applicants endpoint to send us multiple applicants in the same request, as you would use it for setting up accounts for joint investors.\nFor further information on the parameters, please refer to the Applicants endpoint.","slug":"applicants-bulk","type":"post","title":"Applicants (Bulk)","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postApplicants (Bulk)

Use the Applicants endpoint to send us details of the peoples associated with an account, who may be individual investors, SuperSMA fund members, directors, trustees, etc depending on the type of legal entity that the investor is. This is an example of using the Applicants endpoint to send us multiple applicants in the same request, as you would use it for setting up accounts for joint investors. For further information on the parameters, please refer to the Applicants endpoint.

[block:callout] { "type": "info", "title": "This is a privileged endpoint" } [/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": "This is a privileged endpoint" } [/block]
{"_id":"5a779cc0befbca0043ffed78","category":"5a779cc0befbca0043ffed53","parentDoc":null,"user":"55a49cd3e6c2470d002a648c","project":"55ca8813e583751700f78a58","version":"5a779cc0befbca0043ffed4c","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}/Applicants HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\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\": \"50 Queen 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 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 ID for the account that the applicant is linked to, 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 investor, so eg the super fund's ABN, not the super fund's corporate trustee's ABN","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 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":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"}],"url":"/TrusteeApplicants"},"isReference":true,"order":8,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"For digital signatures, which appear on any resulting app forms should you need those printed/produced, 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\": \"This is a privileged endpoint\"\n}\n[/block]","excerpt":"Using the Applicants API to send us details of the peoples associated with an SMSF account with individual trustees.","slug":"applicants-smsf-with-corporate-trustee","type":"post","title":"Applicants (SMSF with corporate trustees)","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postApplicants (SMSF with corporate trustees)

Using the Applicants API to send us details of the peoples associated with an SMSF account with individual trustees.

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 ID for the account that the applicant is linked to, 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 investor, so eg the super fund's ABN, not the super fund's corporate trustee's ABN
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 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:
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
[block:callout] { "type": "info", "body": "For digital signatures, which appear on any resulting app forms should you need those printed/produced, see Applicant.SignatureImage and other components as above", "title": "Digital signatures" } [/block] [block:callout] { "type": "info", "title": "This is a privileged endpoint" } [/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": "For digital signatures, which appear on any resulting app forms should you need those printed/produced, see Applicant.SignatureImage and other components as above", "title": "Digital signatures" } [/block] [block:callout] { "type": "info", "title": "This is a privileged endpoint" } [/block]
{"_id":"5a779cc0befbca0043ffed79","category":"5a779cc0befbca0043ffed53","parentDoc":null,"user":"55a49cd3e6c2470d002a648c","project":"55ca8813e583751700f78a58","version":"5a779cc0befbca0043ffed4c","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}/Applicants HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\n\n{  \n   \"AdviserId\":\"Adviser\",\n   \"AccountId\":\"AU254022\",\n   \"Name\":\"FTW Super Fund\",\n   \"RegisteredNumber\":\"51824753556\",\n   \"Addresses\":[  \n      {  \n         \"Type\":0,\n         \"Line1\":\"50 Queen 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 ID for the account that the applicant is linked to, 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"}],"url":"/TrusteeApplicants"},"isReference":true,"order":9,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"For digital signatures, which appear on any resulting app forms should you need those printed/produced, 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\": \"This is a privileged endpoint\"\n}\n[/block]","excerpt":"Using the Applicants API to send us details of the peoples associated with an SMSF account with individual trustees.","slug":"applicants-smsf-with-individual-trustees","type":"post","title":"Applicants (SMSF with individual trustees)","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postApplicants (SMSF with individual trustees)

Using the Applicants API to send us details of the peoples associated with an SMSF account with individual trustees.

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 ID for the account that the applicant is linked to, 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
[block:callout] { "type": "info", "body": "For digital signatures, which appear on any resulting app forms should you need those printed/produced, see Applicant.SignatureImage and other components as above", "title": "Digital signatures" } [/block] [block:callout] { "type": "info", "title": "This is a privileged endpoint" } [/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": "For digital signatures, which appear on any resulting app forms should you need those printed/produced, see Applicant.SignatureImage and other components as above", "title": "Digital signatures" } [/block] [block:callout] { "type": "info", "title": "This is a privileged endpoint" } [/block]
{"_id":"5a779cc0befbca0043ffed7a","category":"5a779cc0befbca0043ffed53","project":"55ca8813e583751700f78a58","user":"55dd6ff10efd5821000d5471","parentDoc":null,"version":"5a779cc0befbca0043ffed4c","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":"","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\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 applicant that you sending a signature for","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"}],"url":"/accounts/{id}/signature"},"isReference":true,"order":10,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"This is a privileged endpoint\"\n}\n[/block]","excerpt":"You can send us digital signatures (either click-wrapped acceptance data, or, graphical images of signatures captured on your side if you prefer that approach), along with metadata to assist with surety of digital acceptance - such as GPS coordinates, AML reference numbers and more","slug":"signature","type":"post","title":"Electronic signatures","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postElectronic signatures

You can send us digital signatures (either click-wrapped acceptance data, or, graphical images of signatures captured on your side if you prefer that approach), along with metadata to assist with surety of digital acceptance - such as GPS coordinates, AML reference numbers and more

Body Params

ApplicantID:
required
string
The applicant that you sending a signature for
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
[block:callout] { "type": "info", "title": "This is a privileged endpoint" } [/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



[block:callout] { "type": "info", "title": "This is a privileged endpoint" } [/block]
{"_id":"5a779cc0befbca0043ffed7b","category":"5a779cc0befbca0043ffed53","parentDoc":null,"project":"55ca8813e583751700f78a58","user":"55dd6ff10efd5821000d5471","version":"5a779cc0befbca0043ffed4c","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/{Id}/appform HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\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 ID for the account, as provided in the Accounts response.","default":"AU123456","type":"string","name":"Id"}],"url":"/accounts/{Id}/appform"},"isReference":true,"order":11,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"This is a privileged endpoint\"\n}\n[/block]\n\n[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]","excerpt":"Use this endpoint to request a PDF application form for an account","slug":"appform","type":"get","title":"AppForm","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getAppForm

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

Path Params

Id:
required
stringAU123456
The ID for the account, as provided in the Accounts response.
[block:callout] { "type": "info", "title": "This is a privileged endpoint" } [/block] [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]

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": "This is a privileged endpoint" } [/block] [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]
{"_id":"5a779cc0befbca0043ffed7c","category":"5a779cc0befbca0043ffed53","user":"55dd6ff10efd5821000d5471","project":"55ca8813e583751700f78a58","parentDoc":null,"version":"5a779cc0befbca0043ffed4c","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/{Id}/appform HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\n","name":""}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"Status\":1,\n  \"Detail\":\"Created\"\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"56a9b5472d8fd90d0036eeff","ref":"","in":"path","required":true,"desc":"The ID for the account, as provided in the Accounts response.","default":"AU123456","type":"string","name":"Id"}],"url":"/accounts/{Id}/status"},"isReference":true,"order":12,"body":"Possible return/status values:\n  * 1 - Draft\n  * 2 - Submitted\n  * 3 - Awaiting Signature\n  * 4 - Approved\n  * 5 - Funded\n  * 6 - Traded\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"This is a privileged endpoint\"\n}\n[/block]","excerpt":"Use this endpoint to check account status","slug":"account-status","type":"get","title":"Account status","__v":2,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getAccount status

Use this endpoint to check account status

Path Params

Id:
required
stringAU123456
The ID for the account, as provided in the Accounts response.
Possible return/status values: * 1 - Draft * 2 - Submitted * 3 - Awaiting Signature * 4 - Approved * 5 - Funded * 6 - Traded [block:callout] { "type": "info", "title": "This is a privileged endpoint" } [/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 - Draft * 2 - Submitted * 3 - Awaiting Signature * 4 - Approved * 5 - Funded * 6 - Traded [block:callout] { "type": "info", "title": "This is a privileged endpoint" } [/block]
{"_id":"5a779cc0befbca0043ffed7d","category":"5a779cc0befbca0043ffed53","parentDoc":null,"project":"55ca8813e583751700f78a58","user":"55a49cd3e6c2470d002a648c","version":"5a779cc0befbca0043ffed4c","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":"{  \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":"","default":"","type":"string","name":"User.Name.Title"},{"_id":"5720459e5be73c17009601c6","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"User.Name.First"},{"_id":"5720459e5be73c17009601c5","ref":"","in":"body","required":true,"desc":"","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":"","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":"1998-04-24","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":"","default":"","type":"string","name":"User.Addresses.AddressLine1"},{"_id":"5720459e5be73c17009601bb","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"User.Addresses.AddressLine2"},{"_id":"5720459e5be73c17009601ba","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"User.Addresses.AddressLine3"},{"_id":"5720459e5be73c17009601b9","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"User.Addresses.SuburbCounty"},{"_id":"5720459e5be73c17009601b8","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"User.Addresses.TownCityState"},{"_id":"5720459e5be73c17009601b7","ref":"","in":"body","required":true,"desc":"","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":"","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":"","default":"","type":"string","name":"User.Location"},{"_id":"5720459e5be73c17009601b1","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"User.Team"},{"_id":"5720459e5be73c17009601b0","ref":"","in":"body","required":false,"desc":"","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":"5720459e5be73c17009601ae","ref":"","in":"body","required":false,"desc":"This feature is not in use at present","default":"","type":"boolean","name":"User.GenerateGetStartedToken"},{"_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"}],"url":"/users?modifieduserid=123456"},"isReference":true,"order":13,"body":"","excerpt":"","slug":"user","type":"post","title":"Users","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postUsers


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
User.Name.First:
required
string
User.Name.Last:
required
string
User.Gender:
string
Male, Female, or Null
User.Type:
integer
1 = investor
User.UserLevel:
integer
1 = standard investor user
User.Email:
required
string
User.DateOfBirth:
yyyy-mm-dd1998-04-24
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
User.Addresses.AddressLine2:
string
User.Addresses.AddressLine3:
string
User.Addresses.SuburbCounty:
required
string
User.Addresses.TownCityState:
string
User.Addresses.Postcode:
required
string
User.Addresses.Country:
required
string
AUS = Australia
User.Phone:
required
string
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
User.Team:
string
User.JobTitle:
string
User.AdviserID:
integer
The adviser ID for this user's adviser
User.GenerateGetStartedToken:
boolean
This feature is not in use at present

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



{"_id":"5a779cc0befbca0043ffed7e","category":"5a779cc0befbca0043ffed53","parentDoc":null,"project":"55ca8813e583751700f78a58","user":"55a49cd3e6c2470d002a648c","version":"5a779cc0befbca0043ffed4c","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\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 account ID as returned in the response to an Accounts request","default":"","type":"string","name":"AccountID"}],"url":"/Accounts"},"isReference":true,"order":14,"body":"","excerpt":"Use this patch to link a investor to be able to view an account","slug":"link-a-user-to-an-account","type":"patch","title":"Link a user to an account","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

patchLink a user to an account

Use this patch to link a investor to be able to view 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 account ID as returned in the response to an Accounts request

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



{"_id":"5a779cc0befbca0043ffed7f","category":"5a779cc0befbca0043ffed53","user":"55dd6ff10efd5821000d5471","project":"55ca8813e583751700f78a58","parentDoc":null,"version":"5a779cc0befbca0043ffed4c","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\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":[],"url":"/superfunds"},"isReference":true,"order":15,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"This is a privileged endpoint\"\n}\n[/block]\n\n[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]","excerpt":"Use this endpoint to request a PDF application form for an account","slug":"super-funds","type":"get","title":"Super funds","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getSuper funds

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

[block:callout] { "type": "info", "title": "This is a privileged endpoint" } [/block] [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]

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": "This is a privileged endpoint" } [/block] [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]
{"_id":"5a779cc0befbca0043ffed80","category":"5a779cc0befbca0043ffed53","parentDoc":null,"user":"55dd6ff10efd5821000d5471","project":"55ca8813e583751700f78a58","version":"5a779cc0befbca0043ffed4c","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}/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\": 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":"57a92d09bf6e210e00b1a389","ref":"","in":"body","required":false,"desc":"the account that the beneficiary nomination is for","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":"57a92dc27cb8f80e0031390b","ref":"","in":"body","required":false,"desc":"The user ID we have allocated for your API","default":"","type":"int","name":"ModifiedUserId"},{"_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"}],"url":"/beneficiarynominations"},"isReference":true,"order":16,"body":"","excerpt":"Use this patch to link a investor to be able to view an account","slug":"beneficiary-nominations","type":"post","title":"Beneficiary nominations","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postBeneficiary nominations

Use this patch to link a investor to be able to view an account

Body Params

AccountId:
string
the account that the beneficiary nomination is for
IsBinding:
boolean
Whether or not the nomination is binding
ModifiedUserId:
integer
The user ID we have allocated for your API
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

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



{"_id":"5a779cc0befbca0043ffed81","category":"5a779cc0befbca0043ffed53","parentDoc":null,"user":"55a49cd3e6c2470d002a648c","project":"55ca8813e583751700f78a58","version":"5a779cc0befbca0043ffed4c","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"}]},"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":[],"url":"/accounts/{id}/HoldingsByModel?fromdate={fromdate}&todate={todate}"},"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: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":"Use this endpoint to get a breakdown of the value of stocks that an account holds, broken down by the models that they are subscribed to.","slug":"account-breakdown-by-model","type":"get","title":"Account breakdown by model","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getAccount breakdown by model

Use this endpoint to get a breakdown of the value of stocks that an account holds, broken down by the models that they are subscribed to.

[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: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: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":"5a779cc0befbca0043ffed82","category":"5a779cc0befbca0043ffed53","user":"55a49cd3e6c2470d002a648c","project":"55ca8813e583751700f78a58","parentDoc":null,"version":"5a779cc0befbca0043ffed4c","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-02-26T23:02:15.112Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[{"language":"json","code":"{[\n   {\n      \"Id\":\"AU992\",\n      \"Code\":\"ZZ0002\",\n      \"Description\":\"Brand Income Equities\",\n      \"Status\":\"Open\",\n      \"FactsheetUrl\":\"http://www.praemium.com.au/sites/default/files/ZZ0002.pdf\",\n      \"ProviderName\":\"Example\",\n      \"UpdatedDate\":\"2016-04-29T21:11:35.3+10:00\",\n      \"LastTransactionDate\":\"2017-02-03T11:00:00+11:00\"\n   },\n   {\n      \"Id\":\"AU993\",\n      \"Code\":\"AE0001\",\n      \"Description\":\"Brand Growth Equities\",\n      \"Status\":\"Closed\",\n      \"FactsheetUrl\":\"http://praemiumcomau.c.presscdn.com/wp-content/uploads/ZZ0001.pdf\",\n      \"ProviderName\":\"Example\",\n      \"UpdatedDate\":\"2015-12-18T19:26:08.853+11:00\",\n      \"LastTransactionDate\":\"2015-10-29T11:00:00+11:00\"\n   },\n   {\n      \"Id\":\"AU981\",\n      \"Code\":\"ZX0001\",\n      \"Description\":\"Brand Diversified Income\",\n      \"Status\":\"Open\",\n      \"FactsheetUrl\":\"http://www.praemium.com.au/sites/default/files/ZX0001.pdf\",\n      \"ProviderName\":\"Example\",\n      \"UpdatedDate\":\"2016-05-12T19:32:26.03+10:00\",\n      \"LastTransactionDate\":\"2016-11-10T11:00:00+11:00\"\n   }\n]}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":"/models"},"isReference":true,"order":18,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"This is a privileged endpoint\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"ID\",\n    \"0-1\": \"Our internal ID for the model\",\n    \"1-0\": \"Code\",\n    \"1-1\": \"Our code for the model. Advisers see this, it is the short identifier for the model.\",\n    \"2-0\": \"Description\",\n    \"2-1\": \"The full description for the model\",\n    \"3-0\": \"Status\",\n    \"4-0\": \"FactsheetUrl\",\n    \"4-1\": \"The URL where we host the factsheet for the model\",\n    \"5-0\": \"ProviderName\",\n    \"5-1\": \"Our short name for the firm that manages the model\",\n    \"6-0\": \"UpdatedDate\",\n    \"6-1\": \"The last time the model was updated, generally early in the morning when we revalue the model with the latest prices\",\n    \"7-0\": \"LastTransactionDate\",\n    \"7-1\": \"The date of the last change made to the model, generally this is backdated one business day from a change made by a model manager\",\n    \"3-1\": \"Values are Open or Closed\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]","excerpt":"","slug":"model-details","type":"get","title":"Model details","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getModel details


[block:callout] { "type": "info", "title": "This is a privileged endpoint" } [/block] [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "ID", "0-1": "Our internal ID for the model", "1-0": "Code", "1-1": "Our code for the model. Advisers see this, it is the short identifier for the model.", "2-0": "Description", "2-1": "The full description for the model", "3-0": "Status", "4-0": "FactsheetUrl", "4-1": "The URL where we host the factsheet for the model", "5-0": "ProviderName", "5-1": "Our short name for the firm that manages the model", "6-0": "UpdatedDate", "6-1": "The last time the model was updated, generally early in the morning when we revalue the model with the latest prices", "7-0": "LastTransactionDate", "7-1": "The date of the last change made to the model, generally this is backdated one business day from a change made by a model manager", "3-1": "Values are Open or Closed" }, "cols": 2, "rows": 8 } [/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 }}

Result Format



[block:callout] { "type": "info", "title": "This is a privileged endpoint" } [/block] [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "ID", "0-1": "Our internal ID for the model", "1-0": "Code", "1-1": "Our code for the model. Advisers see this, it is the short identifier for the model.", "2-0": "Description", "2-1": "The full description for the model", "3-0": "Status", "4-0": "FactsheetUrl", "4-1": "The URL where we host the factsheet for the model", "5-0": "ProviderName", "5-1": "Our short name for the firm that manages the model", "6-0": "UpdatedDate", "6-1": "The last time the model was updated, generally early in the morning when we revalue the model with the latest prices", "7-0": "LastTransactionDate", "7-1": "The date of the last change made to the model, generally this is backdated one business day from a change made by a model manager", "3-1": "Values are Open or Closed" }, "cols": 2, "rows": 8 } [/block]
{"_id":"5a779cc0befbca0043ffed83","category":"5a779cc0befbca0043ffed53","user":"55a49cd3e6c2470d002a648c","project":"55ca8813e583751700f78a58","parentDoc":null,"version":"5a779cc0befbca0043ffed4c","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-02-27T23:37:22.931Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[{"code":"{\n   \"ModelId\":\"AU992\",\n   \"Date\":\"2016-12-12T00:00:00+11:00\",\n   \"Holdings\":[\n      {\n         \"SecurityCode\":\"WPL\",\n         \"SecurityDescription\":\"WOODSIDE PETROLEUM LIMITED FPO\",\n         \"TargetlValuePercentage\":12.8408,\n         \"ActualValuePercentage\":12.7750\n      },\n      {\n         \"SecurityCode\":\"SPO\",\n         \"SecurityDescription\":\"SPOTLESS GROUP HOLDINGS LIMITED FPO\",\n         \"TargetlValuePercentage\":22.8308,\n         \"ActualValuePercentage\":22.7650\n      },\n      {\n         \"SecurityCode\":\"CWN\",\n         \"SecurityDescription\":\"CROWN RESORTS LIMITED FPO\",\n         \"TargetlValuePercentage\":7.8609,\n         \"ActualValuePercentage\":7.7950\n      },\n      {\n         \"SecurityCode\":\"WES\",\n         \"SecurityDescription\":\"WESFARMERS LIMITED FPO\",\n         \"TargetlValuePercentage\":15.1696,\n         \"ActualValuePercentage\":15.0491\n      },\n      {\n         \"SecurityCode\":\"WOW\",\n         \"SecurityDescription\":\"WOOLWORTHS LIMITED FPO\",\n         \"TargetlValuePercentage\":13.3527,\n         \"ActualValuePercentage\":13.2759\n      },\n      {\n         \"SecurityCode\":\"CCL\",\n         \"SecurityDescription\":\"COCA-COLA AMATIL LIMITED FPO\",\n         \"TargetlValuePercentage\":13.1520,\n         \"ActualValuePercentage\":13.0856\n      },\n      {\n         \"SecurityCode\":\"SHL\",\n         \"SecurityDescription\":\"SONIC HEALTHCARE LIMITED FPO\",\n         \"TargetlValuePercentage\":13.8747,\n         \"ActualValuePercentage\":13.7868\n      },\n      {\n         \"SecurityCode\":\"AUDCASH\",\n         \"SecurityDescription\":\"MAIN CASH ACCOUNT\",\n         \"TargetlValuePercentage\":0.9185,\n         \"ActualValuePercentage\":1.4676\n      }\n   ]\n}","name":"","status":200,"language":"json"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"58b4b8326e53202500297879","ref":"","in":"query","required":false,"desc":"Our internal id for the model, from the Models endpoint response.","default":"","type":"string","name":"id"},{"_id":"58b4b8326e53202500297878","ref":"","in":"query","required":false,"desc":"The date you want to see the holdings as at","default":"","type":"yyyy-mm-dd","name":"date"}],"url":"/models/{id}/holdings?date=2016-12-12"},"isReference":true,"order":19,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"This is a privileged endpoint\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"How we record 'target' and 'actual'\",\n  \"body\": \"When the model manager sets the target security weightings for a model we record these in an account for that model. For every model we also maintain a model shadow account, which acts like an investor's account, linked 100% to the model. The model shadow account is included in our rebalance, and we calculate virtual executions based on what was done for the investors' accounts.\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"SecurityCode\",\n    \"1-0\": \"SecurityDescription\",\n    \"2-0\": \"TargetValuePercentage\",\n    \"3-0\": \"ActualValuePercentage\",\n    \"0-1\": \"Our code for the security, generally the ticker for an equity or the APIR code for a managed fund\",\n    \"1-1\": \"A full description of the security\",\n    \"2-1\": \"The target value in the model for the security\",\n    \"3-1\": \"What was implemented, allowing for market movements and our minimum cash percentage. This is recorded in the model shadow account for the model.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","excerpt":"","slug":"model-holdings","type":"get","title":"Model holdings","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getModel holdings


Query Params

id:
string
Our internal id for the model, from the Models endpoint response.
date:
yyyy-mm-dd
The date you want to see the holdings as at
[block:callout] { "type": "info", "title": "This is a privileged endpoint" } [/block] [block:callout] { "type": "info", "title": "How we record 'target' and 'actual'", "body": "When the model manager sets the target security weightings for a model we record these in an account for that model. For every model we also maintain a model shadow account, which acts like an investor's account, linked 100% to the model. The model shadow account is included in our rebalance, and we calculate virtual executions based on what was done for the investors' accounts." } [/block] [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "SecurityCode", "1-0": "SecurityDescription", "2-0": "TargetValuePercentage", "3-0": "ActualValuePercentage", "0-1": "Our code for the security, generally the ticker for an equity or the APIR code for a managed fund", "1-1": "A full description of the security", "2-1": "The target value in the model for the security", "3-1": "What was implemented, allowing for market movements and our minimum cash percentage. This is recorded in the model shadow account for the model." }, "cols": 2, "rows": 4 } [/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 }}

Result Format



[block:callout] { "type": "info", "title": "This is a privileged endpoint" } [/block] [block:callout] { "type": "info", "title": "How we record 'target' and 'actual'", "body": "When the model manager sets the target security weightings for a model we record these in an account for that model. For every model we also maintain a model shadow account, which acts like an investor's account, linked 100% to the model. The model shadow account is included in our rebalance, and we calculate virtual executions based on what was done for the investors' accounts." } [/block] [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "SecurityCode", "1-0": "SecurityDescription", "2-0": "TargetValuePercentage", "3-0": "ActualValuePercentage", "0-1": "Our code for the security, generally the ticker for an equity or the APIR code for a managed fund", "1-1": "A full description of the security", "2-1": "The target value in the model for the security", "3-1": "What was implemented, allowing for market movements and our minimum cash percentage. This is recorded in the model shadow account for the model." }, "cols": 2, "rows": 4 } [/block]
{"_id":"5a779cc0befbca0043ffed84","category":"5a779cc0befbca0043ffed53","project":"55ca8813e583751700f78a58","user":"55a49cd3e6c2470d002a648c","parentDoc":null,"version":"5a779cc0befbca0043ffed4c","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-02-28T00:03:56.335Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n   \"ModelId\":\"AU992\",\n   \"Date\":\"2016-12-12T00:00:00+11:00\",\n   \"NumberOfAccountsLinked\":5,\n   \"TotalTargetFum\":60026.10,\n   \"TotalApproximateFum\":0.0,\n   \"ApproximateFumForAccounts\":[\n      {\n         \"AccountId\":\"AU192244\",\n         \"TotalValue\":26769.81,\n         \"ModelWeight\":100.00,\n         \"ApproximateFum\":26769.81\n      },\n      {\n         \"AccountId\":\"AU219623\",\n         \"TotalValue\":15769.87,\n         \"ModelWeight\":15.29,\n         \"ApproximateFum\":2411.76\n      },\n      {\n         \"AccountId\":\"AU252365\",\n         \"TotalValue\":81647.53,\n         \"ModelWeight\":19.73,\n         \"ApproximateFum\":16109.16\n      },\n      {\n         \"AccountId\":\"AU99462\",\n         \"TotalValue\":94915.13,\n         \"ModelWeight\":14.95,\n         \"ApproximateFum\":14187.6\n      },\n      {\n         \"AccountId\":\"AU221042\",\n         \"TotalValue\":547.77,\n         \"ModelWeight\":100.00,\n         \"ApproximateFum\":547.77\n      }\n   ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"_id":"58b4be6c97f2eb3700630235","ref":"","in":"query","required":false,"desc":"Our internal id for the model, from the Models endpoint response.","default":"","type":"string","name":"id"},{"_id":"58b4be6c97f2eb3700630234","ref":"","in":"query","required":false,"desc":"The date you want to see the FUM shown at","default":"","type":"yyyy-mm-dd","name":"date"}],"url":"/models/{id}/approximatefum?date=2016-12-12"},"isReference":true,"order":20,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"This is a privileged endpoint\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"AccountID\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]","excerpt":"","slug":"model-fum","type":"get","title":"Model FUM","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getModel FUM


Query Params

id:
string
Our internal id for the model, from the Models endpoint response.
date:
yyyy-mm-dd
The date you want to see the FUM shown at
[block:callout] { "type": "info", "title": "This is a privileged endpoint" } [/block] [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "AccountID" }, "cols": 2, "rows": 1 } [/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 }}

Result Format



[block:callout] { "type": "info", "title": "This is a privileged endpoint" } [/block] [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "AccountID" }, "cols": 2, "rows": 1 } [/block]
{"_id":"5a779cc0befbca0043ffed85","category":"5a779cc0befbca0043ffed53","user":"55a49cd3e6c2470d002a648c","project":"55ca8813e583751700f78a58","parentDoc":null,"version":"5a779cc0befbca0043ffed4c","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-02-28T05:14:56.237Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n   \"ModelId\":\"AU992\",\n   \"FromDate\":\"2016-06-01T00:00:00+10:00\",\n   \"ToDate\":\"2016-12-01T00:00:00+11:00\",\n   \"PercentageReturns\":[\n      {\n         \"PeriodDescription\":\"1 month\",\n         \"GrossPercentReturn\":0.1994,\n         \"NetPercentReturn\":0.1994\n      },\n      {\n         \"PeriodDescription\":\"3 months\",\n         \"GrossPercentReturn\":-0.2166,\n         \"NetPercentReturn\":-0.2166\n      },\n      {\n         \"PeriodDescription\":\"1 year\",\n         \"GrossPercentReturn\":4.5990,\n         \"NetPercentReturn\":4.5990\n      },\n      {\n         \"PeriodDescription\":\"Since 01/06/2016\",\n         \"GrossPercentReturn\":0.5773,\n         \"NetPercentReturn\":0.5773\n      }\n   ]\n}"},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","examples":{"codes":[]},"method":"get","auth":"required","params":[{"_id":"58b50d0ec50dd93700dbacb7","ref":"","in":"query","required":false,"desc":"Our internal id for the model, from the Models endpoint response.","default":"","type":"string","name":"id"},{"_id":"58b50750c50dd93700dbaca6","ref":"","in":"query","required":false,"desc":"The start date for the performance calculation","default":"","type":"yyyy-mm-dd","name":"fromdate"},{"_id":"58b50750c50dd93700dbaca5","ref":"","in":"query","required":false,"desc":"The end date of the performance calculation","default":"","type":"yyyy-mm-dd","name":"todate"}],"url":"/models/{id}/performance?fromdate=2016-06-01&todate=2016-12-01"},"isReference":true,"order":21,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"This is a privileged API\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"PeriodDescription\",\n    \"0-1\": \"The sub-period that the performance is shown for\",\n    \"1-0\": \"GrossPercentReturn\",\n    \"2-0\": \"NetPercentReturn\",\n    \"1-1\": \"Time weighted performance for the period gross of fees\",\n    \"2-1\": \"Time weighted performance for the period after  fees and expenses\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]","excerpt":"","slug":"model-performance","type":"get","title":"Model performance","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getModel performance


Query Params

id:
string
Our internal id for the model, from the Models endpoint response.
fromdate:
yyyy-mm-dd
The start date for the performance calculation
todate:
yyyy-mm-dd
The end date of the performance calculation
[block:callout] { "type": "info", "title": "This is a privileged API" } [/block] [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "PeriodDescription", "0-1": "The sub-period that the performance is shown for", "1-0": "GrossPercentReturn", "2-0": "NetPercentReturn", "1-1": "Time weighted performance for the period gross of fees", "2-1": "Time weighted performance for the period after fees and expenses" }, "cols": 2, "rows": 3 } [/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 }}

Result Format



[block:callout] { "type": "info", "title": "This is a privileged API" } [/block] [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "PeriodDescription", "0-1": "The sub-period that the performance is shown for", "1-0": "GrossPercentReturn", "2-0": "NetPercentReturn", "1-1": "Time weighted performance for the period gross of fees", "2-1": "Time weighted performance for the period after fees and expenses" }, "cols": 2, "rows": 3 } [/block]
{"_id":"5a779cc0befbca0043ffed86","category":"5a779cc0befbca0043ffed53","user":"55a49cd3e6c2470d002a648c","project":"55ca8813e583751700f78a58","parentDoc":null,"version":"5a779cc0befbca0043ffed4c","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-02-28T05:17:50.485Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n   \"ModelId\":\"AU992\",\n   \"FromDate\":\"2016-06-01T00:00:00+10:00\",\n   \"ToDate\":\"2016-06-10T00:00:00+10:00\",\n   \"DailyPercentageReturns\":[\n      {\n         \"Date\":\"2016-06-01T00:00:00+10:00\",\n         \"PercentageReturn\":-0.7562,\n         \"CumulativePercentageReturn\":-0.7562\n      },\n      {\n         \"Date\":\"2016-06-02T00:00:00+10:00\",\n         \"PercentageReturn\":-0.5639,\n         \"CumulativePercentageReturn\":-1.3158\n      },\n      {\n         \"Date\":\"2016-06-03T00:00:00+10:00\",\n         \"PercentageReturn\":0.5457,\n         \"CumulativePercentageReturn\":-0.7773\n      },\n      {\n         \"Date\":\"2016-06-04T00:00:00+10:00\",\n         \"PercentageReturn\":0.0000,\n         \"CumulativePercentageReturn\":-0.7773\n      },\n      {\n         \"Date\":\"2016-06-05T00:00:00+10:00\",\n         \"PercentageReturn\":0.0000,\n         \"CumulativePercentageReturn\":-0.7773\n      },\n      {\n         \"Date\":\"2016-06-06T00:00:00+10:00\",\n         \"PercentageReturn\":0.4137,\n         \"CumulativePercentageReturn\":-0.3668\n      },\n      {\n         \"Date\":\"2016-06-07T00:00:00+10:00\",\n         \"PercentageReturn\":-0.2101,\n         \"CumulativePercentageReturn\":-0.5762\n      },\n      {\n         \"Date\":\"2016-06-08T00:00:00+10:00\",\n         \"PercentageReturn\":-0.0339,\n         \"CumulativePercentageReturn\":-0.6099\n      },\n      {\n         \"Date\":\"2016-06-09T00:00:00+10:00\",\n         \"PercentageReturn\":-0.2000,\n         \"CumulativePercentageReturn\":-0.8086\n      },\n      {\n         \"Date\":\"2016-06-10T00:00:00+10:00\",\n         \"PercentageReturn\":-0.3321,\n         \"CumulativePercentageReturn\":-1.1381\n      }\n   ],\n   \"PercentageReturns\":[\n      {\n         \"PeriodDescription\":\"1 month\",\n         \"GrossPercentReturn\":-1.1380,\n         \"NetPercentReturn\":-1.1380\n      },\n      {\n         \"PeriodDescription\":\"3 months\",\n         \"GrossPercentReturn\":3.3814,\n         \"NetPercentReturn\":3.3814\n      },\n      {\n         \"PeriodDescription\":\"1 year\",\n         \"GrossPercentReturn\":3.6750,\n         \"NetPercentReturn\":3.6750\n      }\n   ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"58b50c86c50dd93700dbacb3","ref":"","in":"query","required":false,"desc":"Our internal id for the model, from the Models endpoint response.","default":"","type":"string","name":"id"},{"_id":"58b50750c50dd93700dbaca6","ref":"","in":"query","required":false,"desc":"The start date for the performance calculation","default":"","type":"yyyy-mm-dd","name":"fromdate"},{"_id":"58b50750c50dd93700dbaca5","ref":"","in":"query","required":false,"desc":"The end date of the performance calculation","default":"","type":"yyyy-mm-dd","name":"todate"},{"_id":"58b50c86c50dd93700dbacb2","ref":"","in":"query","required":false,"desc":"If IncludeDailyReturns = False, then the Model performance response (documented separately) is returned","default":"False","type":"boolean","name":"IncludeDailyReturns"}],"url":"/models/{id}/performance?fromdate=2016-06-01&todate=2016-12-01/models/{id}/performance?fromdate=2016-06-01&todate=2016-12-01&includedailyreturns=true"},"isReference":true,"order":22,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"This is a privileged API\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Model performance vs model performance daily returns\",\n  \"body\": \"If you add includedailyreturns=true to the model performance request we will add daily returns to the response from that endpoint. The additional properties are listed below\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"Date\",\n    \"0-1\": \"The date that the daily return is for\",\n    \"1-0\": \"PercentageReturn\",\n    \"1-1\": \"The performance return for the day\",\n    \"2-0\": \"CumulativePercentageReturn\",\n    \"2-1\": \"The cumulative performance return for the period to date\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]","excerpt":"","slug":"model-performance-daily-returns","type":"get","title":"Model performance daily returns","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getModel performance daily returns


Query Params

id:
string
Our internal id for the model, from the Models endpoint response.
fromdate:
yyyy-mm-dd
The start date for the performance calculation
todate:
yyyy-mm-dd
The end date of the performance calculation
IncludeDailyReturns:
booleanFalse
If IncludeDailyReturns = False, then the Model performance response (documented separately) is returned
[block:callout] { "type": "info", "title": "This is a privileged API" } [/block] [block:callout] { "type": "info", "title": "Model performance vs model performance daily returns", "body": "If you add includedailyreturns=true to the model performance request we will add daily returns to the response from that endpoint. The additional properties are listed below" } [/block] [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "Date", "0-1": "The date that the daily return is for", "1-0": "PercentageReturn", "1-1": "The performance return for the day", "2-0": "CumulativePercentageReturn", "2-1": "The cumulative performance return for the period to date" }, "cols": 2, "rows": 3 } [/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 }}

Result Format



[block:callout] { "type": "info", "title": "This is a privileged API" } [/block] [block:callout] { "type": "info", "title": "Model performance vs model performance daily returns", "body": "If you add includedailyreturns=true to the model performance request we will add daily returns to the response from that endpoint. The additional properties are listed below" } [/block] [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "Date", "0-1": "The date that the daily return is for", "1-0": "PercentageReturn", "1-1": "The performance return for the day", "2-0": "CumulativePercentageReturn", "2-1": "The cumulative performance return for the period to date" }, "cols": 2, "rows": 3 } [/block]
{"_id":"5a779cc0befbca0043ffed5c","category":"5a779cc0befbca0043ffed54","project":"55ca8813e583751700f78a58","user":"55dd6ff10efd5821000d5471","parentDoc":null,"version":"5a779cc0befbca0043ffed4c","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-12-06T23:04:16.046Z","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":"Praemium provides two types of single sign-on (SSO) approaches which allow you to log in an authenticated user without specifying the user’s credentials again.\n\n[block:api-header]\n{\n  \"title\": \"API based SSO\"\n}\n[/block]\nThe API based SSO is a custom SSO approach. By calling the SSOLogin endpoint, API will return a URL that contains a one-time login security token. By accessing the URL, an authenticated user can SSO into Praemium applications.\n\n[block:api-header]\n{\n  \"title\": \"SAML SSO\"\n}\n[/block]\nSecurity Assertion Markup Language (SAML) is a standard protocol for web browser SSO using secure tokens. The SAML SSO approach allows you to use standard cryptography and digital signatures to pass a secure sign-in token from an identity provider (IdP) to Praemium SAML Service which then allows an authenticated user to SSO into Praemium applications.\n\nWe currently support SAML 2.0 based IdP-initiated SSO.","excerpt":"This section will help you to set up an SSO process.","slug":"sso-types","type":"basic","title":"SSO into our applications","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

SSO into our applications

This section will help you to set up an SSO process.

Praemium provides two types of single sign-on (SSO) approaches which allow you to log in an authenticated user without specifying the user’s credentials again. [block:api-header] { "title": "API based SSO" } [/block] The API based SSO is a custom SSO approach. By calling the SSOLogin endpoint, API will return a URL that contains a one-time login security token. By accessing the URL, an authenticated user can SSO into Praemium applications. [block:api-header] { "title": "SAML SSO" } [/block] Security Assertion Markup Language (SAML) is a standard protocol for web browser SSO using secure tokens. The SAML SSO approach allows you to use standard cryptography and digital signatures to pass a secure sign-in token from an identity provider (IdP) to Praemium SAML Service which then allows an authenticated user to SSO into Praemium applications. We currently support SAML 2.0 based IdP-initiated SSO.
Praemium provides two types of single sign-on (SSO) approaches which allow you to log in an authenticated user without specifying the user’s credentials again. [block:api-header] { "title": "API based SSO" } [/block] The API based SSO is a custom SSO approach. By calling the SSOLogin endpoint, API will return a URL that contains a one-time login security token. By accessing the URL, an authenticated user can SSO into Praemium applications. [block:api-header] { "title": "SAML SSO" } [/block] Security Assertion Markup Language (SAML) is a standard protocol for web browser SSO using secure tokens. The SAML SSO approach allows you to use standard cryptography and digital signatures to pass a secure sign-in token from an identity provider (IdP) to Praemium SAML Service which then allows an authenticated user to SSO into Praemium applications. We currently support SAML 2.0 based IdP-initiated SSO.
{"_id":"5a779cc0befbca0043ffed5d","category":"5a779cc0befbca0043ffed54","parentDoc":null,"user":"55dd6ff10efd5821000d5471","project":"55ca8813e583751700f78a58","version":"5a779cc0befbca0043ffed4c","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-16T06:04:30.380Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"\"https://login.onpraemium.com/useraccount/sso?token=******\"","name":"Platform & Reporting SSO"}]},"settings":"","examples":{"codes":[{"language":"json","code":"POST http://{URL as provided}/ssologin HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\n\n{\n  userId: 1234,\n  application: \"Platform\" \n}\n","name":"Platform & Reporting SSOLogin By UserID"},{"code":"POST http://{URL as provided}/ssologin HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE\n\n{\n  username: \"myuser@example.com\",\n  applicationId: \"Platform\" \n}","name":"Platform & Reporting SSOLogin by Username","language":"json"}]},"method":"post","auth":"required","params":[{"_id":"58fd92a13b39ea1b00e18dca","ref":"","in":"body","required":false,"desc":"The ID of the user to log in. Either UserId or Username is required.","default":"123456","type":"string","name":"UserId"},{"_id":"55d6b9fdae529e0d00d34f62","ref":"","in":"body","required":false,"desc":"The Praemium username/Login ID of the user to log in. Either UserId or Username is required.","default":"jsmith@example.com","type":"string","name":"Username"},{"_id":"5609db0896ff420d004c8777","ref":"","in":"body","required":false,"desc":"The ID of the application the user will be sent to once logged in. Platform=V-Wrap, Investor=Investor Portal, Adviser=Adviser Portal.","default":"Platform","type":"string","name":"Application"},{"_id":"5609e67b225dee0d0026f7e9","ref":"","in":"body","required":false,"desc":"Additional parameters for SSO.","default":"","type":"array_mixed","name":"Parameters"},{"_id":"5609e67b225dee0d0026f7e8","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"Parameters.ItemKey"},{"_id":"5609e67b225dee0d0026f7e7","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"Parameters.Value"}],"url":"/ssologin"},"isReference":true,"order":1,"body":"The purpose of the SSOLogin method is to authenticate a user’s access to a Præmium application and then return a URL that contains a one-time login security token. By accessing the URL, the destination application will log in an authenticated user without specifying the user’s credentials again.\n\nEither UserId or Username is required.\n\nParameters are used to pass in additional data for certain applications. The following parameters are valid for Platform & Reporting:\n\n- **AccountID **is the internal ID of the account to be selected when the user is logged in.\n- **AreaID **is an ID to determine which page the user will load initially (e.g. 103 - Transaction History,  1171 - Reporting).\n- **Frameless **is an option to determine whether or not the menu and logo are hidden.","excerpt":"","slug":"ssologin","type":"post","title":"SSOLogin","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postSSOLogin


Body Params

UserId:
string123456
The ID of the user to log in. Either UserId or Username is required.
Username:
stringjsmith@example.com
The Praemium username/Login ID of the user to log in. Either UserId or Username is required.
Application:
stringPlatform
The ID of the application the user will be sent to once logged in. Platform=V-Wrap, Investor=Investor Portal, Adviser=Adviser Portal.
Parameters:
array of mixed
Additional parameters for SSO.
Parameters.ItemKey:
string
Parameters.Value:
string
The purpose of the SSOLogin method is to authenticate a user’s access to a Præmium application and then return a URL that contains a one-time login security token. By accessing the URL, the destination application will log in an authenticated user without specifying the user’s credentials again. Either UserId or Username is required. Parameters are used to pass in additional data for certain applications. The following parameters are valid for Platform & Reporting: - **AccountID **is the internal ID of the account to be selected when the user is logged in. - **AreaID **is an ID to determine which page the user will load initially (e.g. 103 - Transaction History, 1171 - Reporting). - **Frameless **is an option to determine whether or not the menu and logo are hidden.

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 purpose of the SSOLogin method is to authenticate a user’s access to a Præmium application and then return a URL that contains a one-time login security token. By accessing the URL, the destination application will log in an authenticated user without specifying the user’s credentials again. Either UserId or Username is required. Parameters are used to pass in additional data for certain applications. The following parameters are valid for Platform & Reporting: - **AccountID **is the internal ID of the account to be selected when the user is logged in. - **AreaID **is an ID to determine which page the user will load initially (e.g. 103 - Transaction History, 1171 - Reporting). - **Frameless **is an option to determine whether or not the menu and logo are hidden.
{"_id":"5a779cc0befbca0043ffed5e","category":"5a779cc0befbca0043ffed54","project":"55ca8813e583751700f78a58","user":"55dd6ff10efd5821000d5471","parentDoc":null,"version":"5a779cc0befbca0043ffed4c","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-12-07T00:21:54.512Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":302,"language":"json","code":"Location: https://login.onpraemium.com/useraccount/sso?token=******","name":"Redirect"}]},"settings":"5a2896591516850012fa6a6d","examples":{"codes":[{"name":"IdP-initiated SSO","language":"text","code":"Content-Type: application/x-www-form-urlencoded \n\nSAMLResponse={base64 encoded string of your SAML token}\n"}]},"method":"post","auth":"required","params":[{"_id":"5a288d0adde067001279a7a2","ref":"","in":"body","required":false,"desc":"The value of the SAMLResponse parameter is the base64 encoding of an SAML token.","default":"","type":"string","name":"SAMLResponse"}],"url":"/login"},"isReference":true,"order":2,"body":"[block:api-header]\n{\n  \"title\": \"Set up Identity Provider\"\n}\n[/block]\nIdentity Provider (IdP) has to be set up before you can use the SAML SSO. To set up IdP,  you will need to provide the followings:\n- X509 Certificate\n- Issuer of SAML token\n[block:api-header]\n{\n  \"title\": \"Destination applications\"\n}\n[/block]\nTo determine a destination application that users will be landing, you will need to add \"Application\" attribute/value into your SAML Assertion/Token. The followings are the supported values:\n- Platform (Platform & Reporting)\n- Adviser (Adviser Portal)\n- Investor (Investor Portal)\n\nIf no \"Application\" attribute/value is provided, users will SSO into Platform & Reporting by default.","excerpt":"","slug":"saml","type":"post","title":"SAML","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postSAML


Body Params

SAMLResponse:
string
The value of the SAMLResponse parameter is the base64 encoding of an SAML token.
[block:api-header] { "title": "Set up Identity Provider" } [/block] Identity Provider (IdP) has to be set up before you can use the SAML SSO. To set up IdP, you will need to provide the followings: - X509 Certificate - Issuer of SAML token [block:api-header] { "title": "Destination applications" } [/block] To determine a destination application that users will be landing, you will need to add "Application" attribute/value into your SAML Assertion/Token. The followings are the supported values: - Platform (Platform & Reporting) - Adviser (Adviser Portal) - Investor (Investor Portal) If no "Application" attribute/value is provided, users will SSO into Platform & Reporting by default.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "title": "Set up Identity Provider" } [/block] Identity Provider (IdP) has to be set up before you can use the SAML SSO. To set up IdP, you will need to provide the followings: - X509 Certificate - Issuer of SAML token [block:api-header] { "title": "Destination applications" } [/block] To determine a destination application that users will be landing, you will need to add "Application" attribute/value into your SAML Assertion/Token. The followings are the supported values: - Platform (Platform & Reporting) - Adviser (Adviser Portal) - Investor (Investor Portal) If no "Application" attribute/value is provided, users will SSO into Platform & Reporting by default.
{"_id":"5a779cc0befbca0043ffed59","category":"5a779cc0befbca0043ffed55","project":"55ca8813e583751700f78a58","user":"55dd6ff10efd5821000d5471","version":"5a779cc0befbca0043ffed4c","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":[{"code":"GET http://{URL as provided}/status HTTP/1.1\ncontent-type: application/json\nx-pps-token: YOUR-TOKEN-GOES-HERE","language":"json"}]},"method":"get","auth":"required","params":[],"url":"/status"},"isReference":false,"order":0,"body":"The purpose of the Status method is to return the status of API. There are three possible values for status:\n\n- Ok - API is working fine.\n- Degraded - API is partially working or is taking longer to respond.\n- Errored - API is down.","excerpt":"Use this endpoint to get API status","slug":"status","type":"get","title":"Status","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getStatus

Use this endpoint to get API status

The purpose of the Status method is to return 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 purpose of the Status method is to return 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.