> 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/property-cashflow.md).

# Property Cashflow

Property-level cashflow analysis and reporting

## Get portfolio-wide property cashflow analysis

> Retrieves cashflow data for all properties in the portfolio with financial year breakdown.

```json
{"openapi":"3.0.0","info":{"title":"ScaleApp API","version":"1.0.0"},"tags":[{"name":"Property Cashflow","description":"Property-level cashflow analysis and reporting"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"PortfolioCashflowResponseDto":{"type":"object","properties":{"operatingYears":{"description":"Array of operating years (currently identical to financialYears)","type":"array","items":{"$ref":"#/components/schemas/PortfolioFinancialYearCashflowDto"}},"financialYears":{"description":"Array of financial years","type":"array","items":{"$ref":"#/components/schemas/PortfolioFinancialYearCashflowDto"}}}},"PortfolioFinancialYearCashflowDto":{"type":"object","properties":{"year":{"type":"string","description":"Financial year identifier"},"cashFlow":{"description":"Cash flow","allOf":[{"$ref":"#/components/schemas/FinancialYearCashflowCashFlowDto"}]},"taxBenefits":{"description":"Tax benefits","allOf":[{"$ref":"#/components/schemas/FinancialYearCashflowTaxBenefitsDto"}]},"funding":{"description":"Funding","allOf":[{"$ref":"#/components/schemas/FinancialYearCashflowFundingDto"}]},"equityCashflows":{"description":"Equity cashflows","allOf":[{"$ref":"#/components/schemas/FinancialYearCashflowEquityCashflowsDto"}]},"sale":{"description":"Sale","allOf":[{"$ref":"#/components/schemas/FinancialYearCashflowSaleDto"}]},"entityTax":{"description":"Entity-related tax for the financial year","allOf":[{"$ref":"#/components/schemas/PortfolioEntityTaxDto"}]},"entityBalances":{"description":"Entity balances at the financial year end date","allOf":[{"$ref":"#/components/schemas/PortfolioEntityBalancesDto"}]}},"required":["year","cashFlow","taxBenefits","funding","equityCashflows","sale","entityTax","entityBalances"]},"FinancialYearCashflowCashFlowDto":{"type":"object","properties":{"grossRent":{"type":"number","description":"Gross rent"},"operatingExpenses":{"type":"number","description":"Operating expenses"},"netOperatingIncome":{"type":"number","description":"Net operating income"},"principalRepayments":{"type":"number","description":"Principal repayments"},"interest":{"type":"number","description":"Interest"},"operatingProfit":{"type":"number","description":"Operating profit"}},"required":["grossRent","operatingExpenses","netOperatingIncome","principalRepayments","interest","operatingProfit"]},"FinancialYearCashflowTaxBenefitsDto":{"type":"object","properties":{"grossRent":{"type":"number","description":"Gross rent"},"deductibleExpenses":{"type":"number","description":"Deductible expenses"},"deductibleInterest":{"type":"number","description":"Deductible interest"},"ppeDepreciation":{"type":"number","description":"PPE depreciation"},"landTax":{"type":"number","description":"Land tax"},"capitalWorksDepreciation":{"type":"number","description":"Capital works depreciation"},"capitalGainLoss":{"type":"number","description":"Capital gain loss"},"netTaxable":{"type":"number","description":"Net taxable"},"estTax":{"type":"number","description":"Estimated tax"}},"required":["grossRent","deductibleExpenses","deductibleInterest","ppeDepreciation","landTax","capitalWorksDepreciation","capitalGainLoss","netTaxable","estTax"]},"FinancialYearCashflowFundingDto":{"type":"object","properties":{"portfolioValue":{"type":"number","description":"Portfolio value"},"debtOutstanding":{"type":"number","description":"Debt outstanding"},"totalEquity":{"type":"number","description":"Total equity"},"equityAvailable":{"type":"number","description":"Equity available"}},"required":["portfolioValue","debtOutstanding","totalEquity","equityAvailable"]},"FinancialYearCashflowEquityCashflowsDto":{"type":"object","properties":{"depositClosing":{"type":"number","description":"Deposit closing"},"constructionEquity":{"type":"number","description":"Construction equity"},"voluntaryLoan":{"type":"number","description":"Voluntary loan"},"contingentEquity":{"type":"number","description":"Contingent equity"},"totalEquity":{"type":"number","description":"Total equity"}},"required":["depositClosing","constructionEquity","voluntaryLoan","contingentEquity","totalEquity"]},"FinancialYearCashflowSaleDto":{"type":"object","properties":{"salePrice":{"type":"number","description":"Sale price"},"debtOutstanding":{"type":"number","description":"Debt outstanding"},"sellingCosts":{"type":"number","description":"Selling costs"},"estCGT":{"type":"number","description":"Estimated CGT"},"proceedsFromSale":{"type":"number","description":"Proceeds from sale"}},"required":["salePrice","debtOutstanding","sellingCosts","estCGT","proceedsFromSale"]},"PortfolioEntityTaxDto":{"type":"object","properties":{"entityTax":{"type":"number","description":"Net entity-related tax paid for the financial year (company tax, SMSF tax, contributions tax, Div 293, franking offset). DASHBOARD!H316 = -H281. Negative means tax paid."},"totalTaxPayableIncludingEntities":{"type":"number","description":"Tax payable for the financial year including entities. DASHBOARD!H318 = SUM(H315:H317) = personal tax payable + entity tax."}},"required":["entityTax","totalTaxPayableIncludingEntities"]},"PortfolioEntityBalancesDto":{"type":"object","properties":{"smsfFundBalance":{"type":"number","description":"SMSF closing fund balance at the financial year end date. DASHBOARD!H324 = LOOKUP(H14, PERSONAL!M5:WZ5, PERSONAL!M2081:WZ2081) (end-of-period lookup)."},"companyNetPositionExcludingFranking":{"type":"number","description":"Company net position (all companies) excluding the franking balance, at the financial year end date. DASHBOARD!H325 = EOP PERSONAL!2028 - EOP PERSONAL!2029."},"companyFrankingBalance":{"type":"number","description":"Company franking account balance (all companies) at the financial year end date. DASHBOARD!H326 = EOP PERSONAL!2029."},"totalEntitiesNetPosition":{"type":"number","description":"Total entities net position. DASHBOARD!H327 = H322 (total equity invested) + H324 + H325 + H326."}},"required":["smsfFundBalance","companyNetPositionExcludingFranking","companyFrankingBalance","totalEntitiesNetPosition"]}}},"paths":{"/v1/property-cashflow":{"get":{"description":"Retrieves cashflow data for all properties in the portfolio with financial year breakdown.","operationId":"PropertyCashflowController_findAll_v1","parameters":[{"name":"strategyId","required":false,"in":"query","description":"Optional strategy/control centre ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved portfolio-wide property cashflow data, including entity tax and entity balances per financial year","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortfolioCashflowResponseDto"}}}},"401":{"description":"Unauthorized"}},"summary":"Get portfolio-wide property cashflow analysis","tags":["Property Cashflow"]}}}}
```

## Get single property cashflow analysis

> Retrieves detailed cashflow data for a specific property.

```json
{"openapi":"3.0.0","info":{"title":"ScaleApp API","version":"1.0.0"},"tags":[{"name":"Property Cashflow","description":"Property-level cashflow analysis and reporting"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"PropertyCashflowResponseDto":{"type":"object","properties":{"operatingYears":{"description":"Array of operating years","type":"array","items":{"$ref":"#/components/schemas/FinancialYearCashflowDto"}},"financialYears":{"description":"Array of financial years","type":"array","items":{"$ref":"#/components/schemas/FinancialYearCashflowDto"}}}},"FinancialYearCashflowDto":{"type":"object","properties":{"year":{"type":"string","description":"Financial year identifier"},"cashFlow":{"description":"Cash flow","allOf":[{"$ref":"#/components/schemas/FinancialYearCashflowCashFlowDto"}]},"taxBenefits":{"description":"Tax benefits","allOf":[{"$ref":"#/components/schemas/FinancialYearCashflowTaxBenefitsDto"}]},"funding":{"description":"Funding","allOf":[{"$ref":"#/components/schemas/FinancialYearCashflowFundingDto"}]},"equityCashflows":{"description":"Equity cashflows","allOf":[{"$ref":"#/components/schemas/FinancialYearCashflowEquityCashflowsDto"}]},"sale":{"description":"Sale","allOf":[{"$ref":"#/components/schemas/FinancialYearCashflowSaleDto"}]}},"required":["year","cashFlow","taxBenefits","funding","equityCashflows","sale"]},"FinancialYearCashflowCashFlowDto":{"type":"object","properties":{"grossRent":{"type":"number","description":"Gross rent"},"operatingExpenses":{"type":"number","description":"Operating expenses"},"netOperatingIncome":{"type":"number","description":"Net operating income"},"principalRepayments":{"type":"number","description":"Principal repayments"},"interest":{"type":"number","description":"Interest"},"operatingProfit":{"type":"number","description":"Operating profit"}},"required":["grossRent","operatingExpenses","netOperatingIncome","principalRepayments","interest","operatingProfit"]},"FinancialYearCashflowTaxBenefitsDto":{"type":"object","properties":{"grossRent":{"type":"number","description":"Gross rent"},"deductibleExpenses":{"type":"number","description":"Deductible expenses"},"deductibleInterest":{"type":"number","description":"Deductible interest"},"ppeDepreciation":{"type":"number","description":"PPE depreciation"},"landTax":{"type":"number","description":"Land tax"},"capitalWorksDepreciation":{"type":"number","description":"Capital works depreciation"},"capitalGainLoss":{"type":"number","description":"Capital gain loss"},"netTaxable":{"type":"number","description":"Net taxable"},"estTax":{"type":"number","description":"Estimated tax"}},"required":["grossRent","deductibleExpenses","deductibleInterest","ppeDepreciation","landTax","capitalWorksDepreciation","capitalGainLoss","netTaxable","estTax"]},"FinancialYearCashflowFundingDto":{"type":"object","properties":{"portfolioValue":{"type":"number","description":"Portfolio value"},"debtOutstanding":{"type":"number","description":"Debt outstanding"},"totalEquity":{"type":"number","description":"Total equity"},"equityAvailable":{"type":"number","description":"Equity available"}},"required":["portfolioValue","debtOutstanding","totalEquity","equityAvailable"]},"FinancialYearCashflowEquityCashflowsDto":{"type":"object","properties":{"depositClosing":{"type":"number","description":"Deposit closing"},"constructionEquity":{"type":"number","description":"Construction equity"},"voluntaryLoan":{"type":"number","description":"Voluntary loan"},"contingentEquity":{"type":"number","description":"Contingent equity"},"totalEquity":{"type":"number","description":"Total equity"}},"required":["depositClosing","constructionEquity","voluntaryLoan","contingentEquity","totalEquity"]},"FinancialYearCashflowSaleDto":{"type":"object","properties":{"salePrice":{"type":"number","description":"Sale price"},"debtOutstanding":{"type":"number","description":"Debt outstanding"},"sellingCosts":{"type":"number","description":"Selling costs"},"estCGT":{"type":"number","description":"Estimated CGT"},"proceedsFromSale":{"type":"number","description":"Proceeds from sale"}},"required":["salePrice","debtOutstanding","sellingCosts","estCGT","proceedsFromSale"]}}},"paths":{"/v1/property-cashflow/{id}":{"get":{"description":"Retrieves detailed cashflow data for a specific property.","operationId":"PropertyCashflowController_getSinglePropertyCashflow_v1","parameters":[{"name":"id","required":true,"in":"path","description":"Property identifier (UUID)","schema":{"type":"string"}},{"name":"strategyId","required":false,"in":"query","description":"Optional strategy/control centre ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved property cashflow","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyCashflowResponseDto"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Property not found"}},"summary":"Get single property cashflow analysis","tags":["Property Cashflow"]}}}}
```

## GET /v1/property-cashflow/{id}/capital-gains-tax

>

```json
{"openapi":"3.0.0","info":{"title":"ScaleApp API","version":"1.0.0"},"tags":[{"name":"Property Cashflow","description":"Property-level cashflow analysis and reporting"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CapitalGainsTaxResponseDto":{"type":"object","properties":{"success":{"type":"boolean","description":"Success indicator"},"data":{"type":"number","description":"Capital Gains Tax value"},"message":{"type":"string","description":"Message"}},"required":["success","data","message"]}}},"paths":{"/v1/property-cashflow/{id}/capital-gains-tax":{"get":{"operationId":"PropertyCashflowController_getCapitalGainsTax_v1","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"date","required":true,"in":"query","schema":{"type":"string"}},{"name":"strategyId","required":false,"in":"query","description":"Optional strategy/control centre ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved capital gains tax","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapitalGainsTaxResponseDto"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Property not found"}},"tags":["Property Cashflow"]}}}}
```


---

# 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/property-cashflow.md?ask=<question>&goal=<user_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.