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

# Simulation

Financial simulations and what-if scenarios

## Get base case simulation timeline data

> Retrieves comprehensive simulation data for property and personal timelines used in the mobile app timeline widgets.\
>     \
> \*\*Business Logic:\*\*\
> \- Provides base case scenario for financial projections\
> \- Includes both property and personal data timelines\
> \- Joint account parameter determines if combining multiple users\
> \- Returns event-based timeline data spanning multiple years\
> \
> \*\*Data Structure:\*\*\
> \- propertyData: Array of properties with acquisition/sale events\
> \- personalData: Array of income/expense items with change events\
> \- years: Array of years covered in simulation\
> \
> \*\*For AI Agents:\*\*\
> \- Set jointAccount=true for combined household view\
> \- Use strategyId for specific strategy simulations\
> \- Each item has start/end dates with events\
> \- Data spans from current year to retirement/terminal date

```json
{"openapi":"3.0.0","info":{"title":"ScaleApp API","version":"1.0.0"},"tags":[{"name":"Simulation","description":"Financial simulations and what-if scenarios"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"SimulateResponseDto":{"type":"object","properties":{"propertyData":{"description":"Array of property timeline data","type":"array","items":{"$ref":"#/components/schemas/PropertyTimelineDataDto"}},"personalData":{"description":"Array of personal income/expense timeline data","type":"array","items":{"$ref":"#/components/schemas/PersonalIncomeEventDto"}},"years":{"description":"Array of years covered in the simulation","type":"array","items":{"type":"string"}}},"required":["propertyData","personalData"]},"PropertyTimelineDataDto":{"type":"object","properties":{"id":{"type":"string","description":"Property identifier"},"label":{"type":"string","description":"Property label/address"},"startDate":{"type":"string","description":"Start date of property timeline"},"endDate":{"type":"string","description":"End date of property timeline"},"events":{"description":"Array of events for this property","type":"array","items":{"$ref":"#/components/schemas/TimelineEventDto"}}},"required":["id","label","startDate","endDate","events"]},"TimelineEventDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique event identifier"},"type":{"type":"string","description":"Type of event"},"date":{"type":"string","description":"Date when event occurs"},"value":{"type":"number","description":"Value associated with the event"}},"required":["id","type","date","value"]},"PersonalIncomeEventDto":{"type":"object","properties":{"id":{"type":"string","description":"Income identifier"},"label":{"type":"string","description":"Income label/name"},"startDate":{"type":"string","description":"Start date of income"},"endDate":{"type":"string","description":"End date of income"},"value":{"type":"number","description":"Annual income value"},"events":{"description":"Array of income change events","type":"array","items":{"$ref":"#/components/schemas/TimelineEventDto"}}},"required":["id","label","startDate","endDate","value","events"]}}},"paths":{"/v1/simulate":{"get":{"description":"Retrieves comprehensive simulation data for property and personal timelines used in the mobile app timeline widgets.\n    \n**Business Logic:**\n- Provides base case scenario for financial projections\n- Includes both property and personal data timelines\n- Joint account parameter determines if combining multiple users\n- Returns event-based timeline data spanning multiple years\n\n**Data Structure:**\n- propertyData: Array of properties with acquisition/sale events\n- personalData: Array of income/expense items with change events\n- years: Array of years covered in simulation\n\n**For AI Agents:**\n- Set jointAccount=true for combined household view\n- Use strategyId for specific strategy simulations\n- Each item has start/end dates with events\n- Data spans from current year to retirement/terminal date","operationId":"SimulateController_getSimulate_v1","parameters":[{"name":"strategyId","required":false,"in":"query","description":"Optional strategy/control centre ID. If omitted, uses default strategy.","schema":{"type":"string"}},{"name":"jointAccount","required":false,"in":"query","description":"Whether to combine data for joint account holders (couples). Set to true for household view.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successfully retrieved simulation timeline data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimulateResponseDto"}}}},"401":{"description":"Unauthorized"}},"summary":"Get base case simulation timeline data","tags":["Simulation"]}}}}
```


---

# 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/simulation.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.