Get invoice payments
get_invoice_paymentsRetrieve all payments applied to an invoice, including amounts, dates, statuses, payment types, gateway references, and the invoice's paid/due balance.
Instructions
List payments (transactions) applied to an invoice: applied amount and date, transaction status (approved/declined/void/error/pending/returned), payment type, gateway, reference and transaction number. Wraps Transactions.getApplied(invoice_id). Set include_transaction_details to also fetch each full transaction record (Transactions.get). Also returns the invoice's current paid/due summary.
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": {
"invoice_id": "<invoice_id>"
},
"name": "get_invoice_payments"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| invoice_id | Yes | Numeric invoice ID | |
| include_transaction_details | No | Fetch the full transaction record for each applied payment (one extra call per transaction) |