Filarise

Compares spending or income between two inclusive date ranges. delta is the second period minus the first. percentChange is null when the first amount is zero. partial is true when the second period ends today and its week (a range of 7 days or less that does not end on Sunday) or calendar month (a longer range that does not end on the last day of the month) is not finished. Do not call a partial period a complete month or week. LOAN_PAYMENTS (credit-card and loan payments) are already left out of spending, because those amounts are also purchases on the card. Do not add them back. Totals already leave out a transfer between the user's own linked accounts. A card payment is the same amount leaving a depository account and arriving on a credit account within 3 days, with no merchant on either side. A transfer between two depository accounts counts only when both names share one number of at least 6 digits. internalTransferAmount is already removed from this total. Do not add it back. On get_cash_flow that field is the spending side plus the income side. An unmatched TRANSFER_IN or TRANSFER_OUT is a transfer with another person and stays in the total. transferInAmount and transferOutAmount are that unmatched portion already inside the total. Do not add them to the total or subtract them. If the other account is not linked, no pair is found and the transaction stays in the total. transferAmount is transferOutAmount for spending and transferInAmount for income.

Returns the authenticated user's linked financial accounts, each with its bank connection status. currentBalance null means the bank did not report a balance. It is not zero. Zero is returned only when the bank reported zero. emptyState is why a list is empty: no accounts, a bank connection needs reconnect (status, errorCode, institutionName), or the date range has no transactions. Do not say the data is still syncing. warnings lists banks that need reconnect while other data is still returned. Read-only. Does not accept a userId.

Returns income, spending, and net (income minus spending) for each month or week in a date range, including periods with no transactions as zeros. Averages include those zero periods. At most 12 periods; a wider range must be shortened or grouped by month. LOAN_PAYMENTS (credit-card and loan payments) are already left out of spending, because those amounts are also purchases on the card. Do not add them back. Totals already leave out a transfer between the user's own linked accounts. A card payment is the same amount leaving a depository account and arriving on a credit account within 3 days, with no merchant on either side. A transfer between two depository accounts counts only when both names share one number of at least 6 digits. internalTransferAmount is already removed from this total. Do not add it back. On get_cash_flow that field is the spending side plus the income side. An unmatched TRANSFER_IN or TRANSFER_OUT is a transfer with another person and stays in the total. transferInAmount and transferOutAmount are that unmatched portion already inside the total. Do not add them to the total or subtract them. If the other account is not linked, no pair is found and the transaction stays in the total. Each period includes transferInAmount and transferOutAmount.

Returns total income for a date range using database aggregation. totalIncome is the amount to answer income questions. Income transactions have negative amounts; the returned total is positive. pending rows are included. Totals already leave out a transfer between the user's own linked accounts. A card payment is the same amount leaving a depository account and arriving on a credit account within 3 days, with no merchant on either side. A transfer between two depository accounts counts only when both names share one number of at least 6 digits. internalTransferAmount is already removed from this total. Do not add it back. On get_cash_flow that field is the spending side plus the income side. An unmatched TRANSFER_IN or TRANSFER_OUT is a transfer with another person and stays in the total. transferInAmount and transferOutAmount are that unmatched portion already inside the total. Do not add them to the total or subtract them. If the other account is not linked, no pair is found and the transaction stays in the total. For income, read transferInAmount. Respects plan history limits.

Returns the authenticated user's name and current subscription (plan, status, period end). Read-only. Does not accept a userId.

Returns aggregated spending totals using database SUM/GROUP BY. totalSpending is the amount to answer spending questions. LOAN_PAYMENTS (credit-card and loan payments) are already left out of spending, because those amounts are also purchases on the card. Do not add them back. Totals already leave out a transfer between the user's own linked accounts. A card payment is the same amount leaving a depository account and arriving on a credit account within 3 days, with no merchant on either side. A transfer between two depository accounts counts only when both names share one number of at least 6 digits. internalTransferAmount is already removed from this total. Do not add it back. On get_cash_flow that field is the spending side plus the income side. An unmatched TRANSFER_IN or TRANSFER_OUT is a transfer with another person and stays in the total. transferInAmount and transferOutAmount are that unmatched portion already inside the total. Do not add them to the total or subtract them. If the other account is not linked, no pair is found and the transaction stays in the total. For spending, read transferOutAmount. groupBy: category | account | month. Respects plan history limits on startDate/endDate.

Returns one page of transactions for the authenticated user. Name a transaction to the user as "{customName} ({name})" when customName is set, otherwise as name. customName is the user's own label. name is the bank text. Use totalAmount for the signed sum of matches that are not internal transfers. It covers every match, not the current page. A row with internalTransfer true moves money between the user's own accounts. It is omitted from totalAmount. internalTransferAmount is the absolute sum of those rows and is already removed. Do not add it back or call those rows income or spending. Positive amount is spending, negative amount is income. pending rows are included. Filters: startDate, endDate, accountId, categoryId (Plaid category code), minAmount, maxAmount, search, limit (max 100), cursor. totalCount is the number of matches.