get_pnl_attribution
Returns FX P&L broken down by currency with top contributor, unrealised mark-to-market (open invoices, booking rate vs current spot), and realised gain/loss from settled invoices where the accounting system provides it. Use to answer 'which currencies are hurting us?', 'what is our total FX impact this period?', or 'show me P&L by currency'. All amounts are in base currency. Sorts by absolute total P&L so the biggest contributors appear first. Also returns the Scout-aligned P&L family: dashboard_hero (the Monitor Total FX Impact exactly as the dashboard published it), totals.bank_pnl_base and totals.hedge_mtm_base, the four contributor families (top_unrealised_contributors, top_realised_contributors, bank_contributors, hedge_contributors), materiality (FX as % of profit and revenue, margin before/after FX on the operating basis only), fy_windows (realised by settlement date for the current FY, previous FY and all-time) and provider_fx_ledger. Every aligned block is the figure the in-app Scout assistant quotes.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| entity_id | No | Filter to a specific entity. Omit for consolidated group. | |
| include_chart | No | When true, the tool response includes an image/png content block containing a horizontal bar chart of P&L by currency (green = gain, red = loss). Uses the same data as the text response. | |
| include_realised | No | Include realised P&L from settled invoices where the accounting system provides the FX gain/loss. Default true. | |
| include_unrealised | No | Include unrealised P&L from open invoices (booking rate vs current spot). Default true. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | Tool-specific payload. Null when connection_status.state is 'setup_required'. | |
| connection_status | Yes |