list_payments
Retrieve a HoneyBook workspace's payment schedule, including each file's amount, due date, paid/pending status, payment method, invoice number, and per-currency paid/unpaid totals.
Instructions
Payment schedule for a workspace — the portal's Payments tab: each file's payments with amount, due date, paid/pending state, how it was paid and the invoice number, plus paid/unpaid totals per currency. To pay one, use pay_invoice.
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": {
"workspace_id": "<workspace_id>"
},
"name": "list_payments"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| view | No | "full" (default): the files, payments and per-currency totals. "brief": one line per payment — file: description (amount) — due <ISO date or "no date"> — <paid|pending|overdue|unpaid>, inside the untrusted-data envelope as data: string[]; "-- none" when there is no payment. | |
| origin | No | Portal origin (e.g. https://<vendor>.hbportal.co). Optional when only one session is active, or when workspace_id is a listed project name. | |
| workspace_id | Yes | The workspace _id (from list_projects). |