get_refunds
Read refund links, the pairs of an original transaction and the transaction that refunds it. Three modes: give transactionId for the refunds of one transaction; give originalTxId and refundTxId for one link; give neither (optionally page, limit, categoryId, accountId, transactionType) to list all of them, newest page first. Each link carries both transactions with their payee. Returns { refunds } and, in list mode, { meta: { total, page, limit } }. To find rows a refund could link to, use get_refund_recommendations (review toolset).
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_refunds"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Mode 3: page number, from 1 (default 1) | |
| limit | No | Mode 3: refund links per page, 1 to 100 (default 20) | |
| accountId | No | Mode 3: only refunds whose original transaction is on this account | |
| categoryId | No | Mode 3: only refunds whose original transaction is in this category | |
| refundTxId | No | Mode 2: with originalTxId, read the one refund link between the two | |
| originalTxId | No | Mode 2: with refundTxId, read the one refund link between the two | |
| transactionId | No | Mode 1: every refund link that has this transaction as the original or as the refund | |
| transactionType | No | Mode 3: only refunds whose original transaction is of this type |