> For the complete documentation index, see [llms.txt](https://docs.scaleconnect.com.au/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.scaleconnect.com.au/api/rest-api/scaleapp-rest-api/charts.md). # Charts Dashboard visualizations and graph data (6+ charts for mobile app) ## Get capital growth chart data for single property > Retrieves capital growth visualization data for a single property. ```json {"openapi":"3.0.0","info":{"title":"ScaleApp API","version":"1.0.0"},"tags":[{"name":"Charts","description":"Dashboard visualizations and graph data (6+ charts for mobile app)"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}}},"paths":{"/v1/chart/single-property":{"get":{"description":"Retrieves capital growth visualization data for a single property.","operationId":"ChartController_singleProperty_v1","parameters":[],"responses":{"200":{"description":"Successfully retrieved property capital growth data"},"401":{"description":"Unauthorized"}},"summary":"Get capital growth chart data for single property","tags":["Charts"]}}}} ``` ## Get comprehensive chart data for strategy visualization > Retrieves all chart data needed for the 6 main dashboard graphs in the mobile app.\ > \ > \*\*Charts Included:\*\*\ > 1\. Portfolio Value by Property\ > 2\. Periodic Equity Cashflow\ > 3\. Pre vs Post Investment Cashflow\ > 4\. Debt vs Equity\ > 5\. Who Is Paying\ > 6\. Operating Cashflow\ > 7\. Cash and Wealth Impact\ > 8\. Cumulative Cashflow Impact (\`cumulativeCashflowImpact\`, workbook CHARTS!49–53: personal only / + portfolio / + entities / total)\ > 9\. Lifetime Wealth Impact (\`lifetimeWealthImpact\`, workbook CHARTS!57–61: personal only / + portfolio / related entities / total)\ > \ > Series 8–9 are one point per financial year (same FYs as GET /v1/personal-cashflow); entity terms are zero until entity inputs reach the model.\ > \ > \*\*For AI Agents:\*\*\ > \- Single endpoint returns all dashboard chart data\ > \- All timestamps in ISO 8601 format\ > \- Values in AUD\ > \- Use strategyId for specific strategy, omit for default ```json {"openapi":"3.0.0","info":{"title":"ScaleApp API","version":"1.0.0"},"tags":[{"name":"Charts","description":"Dashboard visualizations and graph data (6+ charts for mobile app)"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"SingleStrategyChartResponseDto":{"type":"object","properties":{"portfolioValueByProperty":{"description":"Portfolio value breakdown by property over time","type":"array","items":{"$ref":"#/components/schemas/PortfolioValueByPropertyDto"}},"periodicEquityCashflow":{"description":"Periodic equity cashflow with inflows and outflows","type":"array","items":{"$ref":"#/components/schemas/PeriodicEquityCashflowDto"}},"preVsPostInvestmentCashflow":{"description":"Comparison of cashflow before and after investment","type":"array","items":{"$ref":"#/components/schemas/PreVsPostInvestmentCashflowDto"}},"debtVsEquity":{"description":"Debt vs equity position over time","type":"array","items":{"$ref":"#/components/schemas/DebtVsEquityDto"}},"whoIsPaying":{"description":"Breakdown of who pays for investment (owner, tenant, tax benefits)","type":"array","items":{"$ref":"#/components/schemas/WhoIsPayingDto"}},"operatingCashflow":{"description":"Operating cashflow analysis","type":"array","items":{"$ref":"#/components/schemas/OperatingCashflowDto"}},"cashAndWealthImpact":{"description":"Cash vs wealth impact comparison","type":"array","items":{"$ref":"#/components/schemas/CashAndWealthImpactDto"}},"cumulativeCashflowImpact":{"description":"CHARTS!49–53 'CUMULATIVE CASHFLOW IMPACT' — one point per financial year (same FYs as GET /v1/personal-cashflow). Values in AUD (the workbook's /$E$2 report-unit division is not applied).","type":"array","items":{"$ref":"#/components/schemas/CumulativeCashflowImpactPointDto"}},"lifetimeWealthImpact":{"description":"CHARTS!57–61 'LIFETIME WEALTH IMPACT' — one point per financial year (same FYs as GET /v1/personal-cashflow). Values in AUD.","type":"array","items":{"$ref":"#/components/schemas/LifetimeWealthImpactPointDto"}}},"required":["portfolioValueByProperty","periodicEquityCashflow","preVsPostInvestmentCashflow","debtVsEquity","whoIsPaying","operatingCashflow","cashAndWealthImpact","cumulativeCashflowImpact","lifetimeWealthImpact"]},"PortfolioValueByPropertyDto":{"type":"object","properties":{"x":{"type":"string","description":"Timestamp for this data point","format":"date-time"},"properties":{"description":"Array of property values at this time","type":"array","items":{"$ref":"#/components/schemas/PropertyValueDataPointDto"}}},"required":["x","properties"]},"PropertyValueDataPointDto":{"type":"object","properties":{"value":{"type":"number","description":"Property value at this point in time"},"percentChange":{"type":"number","description":"Percentage change from previous period"},"label":{"type":"string","description":"Property label/name"}},"required":["value","percentChange","label"]},"PeriodicEquityCashflowDto":{"type":"object","properties":{"x":{"type":"string","description":"Timestamp for this period","format":"date-time"},"inflow":{"type":"number","description":"Total cash inflow for the period"},"outflow":{"type":"number","description":"Total cash outflow for the period"},"cashflows":{"type":"number","description":"Net cashflow for the period (inflow - outflow)"},"cumulativeCashflows":{"type":"number","description":"Cumulative cashflows to date"}},"required":["x","inflow","outflow","cashflows","cumulativeCashflows"]},"PreVsPostInvestmentCashflowDto":{"type":"object","properties":{"x":{"type":"string","description":"Timestamp for this data point","format":"date-time"},"personalPlusExistingProperty":{"type":"number","description":"Cashflow with personal finances plus existing properties"},"personalOnly":{"type":"number","description":"Cashflow from personal finances only"},"personPlusNewStrategy":{"type":"number","description":"Cashflow with personal finances plus new strategy"}},"required":["x","personalPlusExistingProperty","personalOnly","personPlusNewStrategy"]},"DebtVsEquityDto":{"type":"object","properties":{"x":{"type":"string","description":"Timestamp for this data point","format":"date-time"},"portfolioValue":{"type":"number","description":"Total portfolio value"},"debtOutstanding":{"type":"number","description":"Outstanding debt on portfolio"},"equity":{"type":"number","description":"Total equity in portfolio"},"equityAvailable":{"type":"number","description":"Available equity that can be accessed"}},"required":["x","portfolioValue","debtOutstanding","equity","equityAvailable"]},"WhoIsPayingDto":{"type":"object","properties":{"x":{"type":"string","description":"Timestamp for this period","format":"date-time"},"you":{"type":"number","description":"Amount paid by property owner"},"tenant":{"type":"number","description":"Amount paid by tenant (rental income)"},"taxman":{"type":"number","description":"Amount offset by tax benefits"}},"required":["x","you","tenant","taxman"]},"OperatingCashflowDto":{"type":"object","properties":{"x":{"type":"string","description":"Timestamp for this period","format":"date-time"},"operatingCosts":{"type":"number","description":"Total operating costs"},"operatingIncome":{"type":"number","description":"Total operating income"},"netCashflow":{"type":"number","description":"Net operating cashflow"},"cumulative":{"type":"number","description":"Cumulative operating cashflow"}},"required":["x","operatingCosts","operatingIncome","netCashflow","cumulative"]},"CashAndWealthImpactDto":{"type":"object","properties":{"x":{"type":"string","description":"Timestamp for this data point","format":"date-time"},"wealthImpact":{"type":"number","description":"Impact on overall wealth (equity growth)"},"cashImpact":{"type":"number","description":"Impact on available cash"}},"required":["x","wealthImpact","cashImpact"]},"CumulativeCashflowImpactPointDto":{"type":"object","properties":{"x":{"type":"string","description":"Financial year of this point (CHARTS!H3 = DASHBOARD!H3). Same x convention as the other single-strategy series.","format":"date-time"},"personalOnly":{"type":"number","description":"CHARTS!H50 = SUM(DASHBOARD!$H$60:H60) — running total of personal cashflows (pre-tax). AUD."},"personalPlusPortfolio":{"type":"number","description":"CHARTS!H51 = SUM(DASHBOARD!$H$60:H60, DASHBOARD!$H$72:H72) — running total of personal + portfolio cashflows (pre-tax). AUD."},"personalPlusEntities":{"type":"number","description":"CHARTS!H52 = SUM(DASHBOARD!$H$60:H60, DASHBOARD!$H$74:H74); DASHBOARD!H74 = H309 (entity cashflows), read as H309. Running total of personal + entity cashflows. AUD. Zero until the entity input adapter lands; null only if the FY has no H3-matched column.","nullable":true},"total":{"type":"number","description":"CHARTS!H53 = DASHBOARD!H80 — cashflow available including offset accounts (= H93). AUD."}},"required":["x","personalOnly","personalPlusPortfolio","personalPlusEntities","total"]},"LifetimeWealthImpactPointDto":{"type":"object","properties":{"x":{"type":"string","description":"Financial year of this point (CHARTS!H3 = DASHBOARD!H3). Same x convention as the other single-strategy series.","format":"date-time"},"personalOnly":{"type":"number","description":"CHARTS!H58 = H50 — cumulative personal-only cashflow. AUD."},"personalPlusPortfolio":{"type":"number","description":"CHARTS!H59 = H58 + DASHBOARD!H353 (Personal Lifetime Profit / Wealth Impact). AUD."},"relatedEntities":{"type":"number","description":"CHARTS!H60 = DASHBOARD!H290 (Total Entity Wealth = SUM(H285:H289)). Workbook label reads 'Personal + Related Entities' but the formula is the entity component alone. AUD. Zero until the entity input adapter lands."},"total":{"type":"number","description":"CHARTS!H61 = SUM(H58:H60). AUD."}},"required":["x","personalOnly","personalPlusPortfolio","relatedEntities","total"]}}},"paths":{"/v1/chart/single-strategy":{"get":{"description":"Retrieves all chart data needed for the 6 main dashboard graphs in the mobile app.\n \n**Charts Included:**\n1. Portfolio Value by Property\n2. Periodic Equity Cashflow\n3. Pre vs Post Investment Cashflow\n4. Debt vs Equity\n5. Who Is Paying\n6. Operating Cashflow\n7. Cash and Wealth Impact\n8. Cumulative Cashflow Impact (`cumulativeCashflowImpact`, workbook CHARTS!49–53: personal only / + portfolio / + entities / total)\n9. Lifetime Wealth Impact (`lifetimeWealthImpact`, workbook CHARTS!57–61: personal only / + portfolio / related entities / total)\n\nSeries 8–9 are one point per financial year (same FYs as GET /v1/personal-cashflow); entity terms are zero until entity inputs reach the model.\n\n**For AI Agents:**\n- Single endpoint returns all dashboard chart data\n- All timestamps in ISO 8601 format\n- Values in AUD\n- Use strategyId for specific strategy, omit for default","operationId":"ChartController_singleStrategy_v1","parameters":[{"name":"strategyId","required":false,"in":"query","description":"Optional strategy/control centre ID. If omitted, returns data for the default strategy.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved all chart data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleStrategyChartResponseDto"}}}},"401":{"description":"Unauthorized"}},"summary":"Get comprehensive chart data for strategy visualization","tags":["Charts"]}}}} ``` ## POST /v1/chart/queue-chart > ```json {"openapi":"3.0.0","info":{"title":"ScaleApp API","version":"1.0.0"},"tags":[{"name":"Charts","description":"Dashboard visualizations and graph data (6+ charts for mobile app)"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}}},"paths":{"/v1/chart/queue-chart":{"post":{"operationId":"ChartController_queueChart_v1","parameters":[],"responses":{"201":{"description":""}},"tags":["Charts"]}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.scaleconnect.com.au/api/rest-api/scaleapp-rest-api/charts.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.