Payee category hints
payee_category_hintsCategory evidence per payee, for categorising, in ONE call: name, defaultCategoryId, topCategoryId + topCategoryCount (the category this household used most for the payee), lastCategoryId (its most recent category) and uncategorisedCount (rows still without a category). Fields that are null or zero are omitted; isTransfer: true marks a transfer payee whose rows are never categorised; looksLike ("cash_withdrawal", "bank_fee", "card_payment") marks a payee whose name matches one of the fixed categorising rules (cash withdrawal, bank fee, card payment), which win over its history. When a cash_withdrawal payee is present the result also carries cashAccounts (the open accounts of type cash, by id and name; empty means there is none), cashWithdrawalCategory (the existing cash-withdrawal category, or null) and cashRule, the exact call those rows take: follow it literally. Filter with onlyWithUncategorised: true (the working set of a categorising turn, pending payees first) or payeeIds (up to 200). Use this instead of calling list_transactions per payee: it replaces the same-payee history lookup for every payee at once.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| payeeIds | No | Only these payees, ids from list_payees. | |
| householdId | No | Household ULID to act on. Call list_households for the covered households; may be omitted only when the connection covers exactly one. | |
| onlyWithUncategorised | No | Only payees that still have uncategorised transactions. |