get_fx_exposure
Returns net FX exposure by currency pair, entity, and time bucket (overdue, 0-30d, 31-60d, 61-90d, 90d+, undated). An invoice with no due date has no tenor, so it stays in net exposure and sits in the undated bucket. Each exposure line distinguishes confirmed (invoices and POs from the accounting system) from forecasted, and includes a source field citing provenance ('€2.3M from 47 Xero invoices'). On multi-entity books the exposure honours the workspace inter-company mode and the response carries an intercompany block naming that mode; realised P&L does not move with that mode, and it is reported as the accounting system recorded it, so settled inter-company invoices stay inside it. On an unscoped call also returns counterparty_concentration (per contact/currency/direction with share of gross exposure), risk_snapshot (top currency and share, signed and gross net position, breach and overdue counts, worst-case as published), sensitivity (impact of a 1% move per currency) and total_net_exposure_base, all lifted from the same context the in-app Scout assistant answers from.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "get_fx_exposure"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| currency | No | ISO 4217 code to filter to one currency (e.g. 'EUR', 'USD'). Omit for all currencies. | |
| entity_id | No | Specific entity ID from list_entities. Omit for consolidated group exposure. | |
| horizon_days | No | Forward-looking window in days. | |
| include_chart | No | When true, the tool response includes an image/png content block containing a horizontal bar chart of net exposure by currency (green = receivable, red = payable). Requires no additional API calls - uses the same data as the text response. | |
| include_forecasted | No | Include forecasted exposure alongside confirmed accounting-system data. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | Tool-specific payload. Null when connection_status.state is 'setup_required'. | |
| connection_status | Yes |