Search combined
search_combinedThe unified search over business data — combine free text and/or an amount range in one call. Set 'kind' to: all, expenses, income, transactions, clients, suppliers, products, or invoices (use 'all' to search the whole business). Set 'query' for text search (case-insensitive substring match across names, descriptions, notes, references, supplier/client names, categories) and/or 'min'/'max' for an amount range on the kind's primary amount field — both are optional, so omit the amount range for a pure text search (e.g. over clients or suppliers) or omit 'query' for a pure amount search. Optionally filter by date range with 'from' and 'to' in YYYY-MM-DD format. Set 'sort' to 'amount' (default — descending by amount) or 'date' (descending by date; best for clients/suppliers, which have no amount, or when recency matters more than size). Returns ALL matches, paginated — use limit/cursor to page through the full result set; narrow query/range/date if there are more than you need.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | Upper bound of the date range to match (ISO 8601, YYYY-MM-DD). | |
| max | No | Upper bound of the amount range to match (matched on the kind's primary amount field, absolute value). | |
| min | No | Lower bound of the amount range to match (matched on the kind's primary amount field, absolute value). | |
| from | No | Lower bound of the date range to match (ISO 8601, YYYY-MM-DD). | |
| kind | Yes | Which collection to search. One of: "all" (every collection), "expenses", "income", "transactions", "clients", "suppliers", "products", "invoices". | |
| sort | No | Result ordering. "amount" (default) sorts by the kind's primary amount field descending; "date" sorts by date descending — use "date" for clients/suppliers (which have no amount) or whenever recency matters more than size. | |
| limit | No | Max rows to return in this page (default 50). Responses include next_cursor / truncated / total; pass next_cursor back as `cursor` to fetch the next page. Never silently truncated. | |
| query | No | Free-text search query (case-insensitive substring match across all text fields). | |
| cursor | No | Opaque pagination cursor. Omit for the first page; pass the next_cursor from a previous response verbatim to fetch the next page. |