get_report_by_customer
Retrieve a financial report for a specific customer using their customer ID and report ID, with an optional purpose code.
Instructions
Fetch a report scoped to a specific customer.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"customer_id": "<customer_id>",
"report_id": "<report_id>"
},
"name": "get_report_by_customer"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| report_id | Yes | ||
| customer_id | Yes | ||
| purpose_code | No | 3F |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | True when the upstream HTTP status was < 400. | |
| data | No | Finicity's native response body. | |
| error | No | Error summary when ok is False. | |
| status_code | Yes | Upstream Finicity HTTP status code. |