Invoices/search_invoices
Tool · Invoices

search_invoices

Search the caller's invoices for line items whose description matches a substring (case-insensitive). Returns up to 50 matching invoices, newest first.

Read-onlyIdempotentscope read:invoices

Invoked over the MCP transport with a tools/call request naming this tool.

Authorization #

Requires a valid OAuth 2.1 bearer access_token whose grant includes the read:invoices scope — View your invoices and billing history. The broker resolves the caller from the token and returns only records the account owns.

Parameters #

querystringRequired
Substring to match against item descriptions.

Response #

200 · application/json

invoicesarray<object>
idinteger
invoice_numberstring
statusstring
One of: Unpaid Paid Cancelled Refunded Collections Draft Payment Pending Overdue
totalobject
valuestring
currencystring
due_datestring · null
datestring · null
truncatedboolean
limitinteger

Errors #

ResultWhen
{ "error": "query_too_short" }See the tool description for when this result is returned.