Actions41
- Transações Actions
- Relatórios Actions
- Análise IA Actions
- Oportunidades Actions
- Saúde Financeira Actions
- Investimentos Actions
- Metas Actions
- Attachments Actions
- Orçamentos Actions
- Parcelamentos Actions
- Prompts IA Actions
- Sistema Actions
Transações → Listar Transações
AI-generatedSummary
Retrieves a paginated list of financial transactions for a specified phone number, supporting filtering by type, date range, account, category, status, and search terms.
Inputs
- phone (required) — User's phone number in E.164 format (e.g., +5511999999999).
- filters — Collection of filters to narrow results: type (despesa/receita/transferencia/aporte/resgate), search term, date range (startDate/endDate), account ID, category ID, status (confirmed/pending), and person type (pf/pj).
- limit — Maximum number of results to return (default: 10, min: 1).
Output shape
A list of transaction items, one per returned transaction.
The API returns transactions matching the provided filters. The 'error' field in the response indicates failure; the 'transaction' field indicates success.
Examples
Example 1: List recent expenses for a specific phone number
Set phone to '+5511999999999', filters.type to 'despesa', and filters.limit to 20.
Example 2: Filter transactions by date range and account
Use phone '+5511999999999', filters.startDate '2025-01-01', filters.endDate '2025-01-31', and filters.accountId 123.
Example 3: Search for specific transaction descriptions
Set phone '+5511999999999', filters.search to 'supermercado', and filters.status to 'confirmed'.