List records
list_recordsLists income and expense records, newest first by default, each with its category name and type and its payment method name. Amounts are in each record's own currency. Returns at most limit records (default 50) together with the total number that matched; filter by date range, category, payment methods or text to narrow the result. Date filters are calendar days in UTC, and "today" from get_profile is the UTC date: for ranges such as today or this month, pass the user's local dates (YYYY-MM-DD) when you know them.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of records to return (default 50, max 500). | |
| search | No | Case-insensitive text matched against record descriptions and category names. | |
| sortBy | No | Sort field; default date. | |
| endDate | No | Only include records on or before this date (23:59:59 UTC for a date-only value). Format: YYYY-MM-DD or an RFC 3339 timestamp such as 2026-03-05T14:30:00Z. | |
| sortOrder | No | Sort direction; default desc. | |
| startDate | No | Only include records on or after this date (00:00:00 UTC for a date-only value). Format: YYYY-MM-DD or an RFC 3339 timestamp such as 2026-03-05T14:30:00Z. | |
| categoryId | No | Only include records in this category (ID from list_categories). | |
| paymentMethodIds | No | Only include records paid with one of these payment methods (IDs from list_payment_methods). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| total | Yes | ||
| records | Yes | ||
| returned | Yes | ||
| truncated | Yes |