Digits

Summarizes transactions and aggregates them into multi-dimensional summaries.

You can use it to receive timeseries data for that is aggregated and bucketed into dimensions (e.g. Category, Party, Time).

Important Notes

• If you are only requesting a Time summary, you must provide a filter (such as category ID/type, party ID/role, etc)
• Origin is required. Origin's "index" is 1 based for interval Day, Week, Month, and Quarter; it's the year for interval Year. "IntervalCount" is the number of lookback intervals. All fields in "origin" must be set.
• You must include "Time" in the Along dimensions when using intervalCount > 1.
• When filtering by balance sheet categories (Assets, Liabilities, Equity), you must set asPermanentAccount to true.
• Always resolve the party / category / department / location using search_term first, then use the IDs returned in the filter.
• The response may include a "summary" field where the current period amount is zero while prior period is non-zero; do not treat prior amounts as current-period values.
• Cannot answer questions specific to bills or invoices. Do not use expense or income transaction data to approximate bill or invoice amounts.

Examples

Retrieve a Party summary filtered by a specific category from June

• August 2023, where the parties are sorted by amount spent descending

{"filter":{"category_ids":{"ids":["6c11f4d9-3431-44cd-bb59-a51c490c1e19"]}},"origin":{"interval":"Month","year":"2023","index":"8","interval_count":"3"},"along":{"dimensions":["Party"]},"pagination":{"sort_direction":"Descending","sort_field":"Amount"}}

This will return a DimensionalSummary for August (index 8) , with the total amount booked to the specified category broken down by party. Note: pagination can only be used with a single dimension. If you want to compare August and July's' top parties, you must request for July and August separately with the Pagination sort set to descending by amount.

Retrieve a Time x Party summary with filters

{"filter":{"category_types":{"types":["Income"]},"party_ids":{"ids":["<party_id_for_acme_inc>"]},"party_roles":["EntityCustomerRole"]},"origin":{"interval":"Month","year":"2024","index":"12","interval_count":"12"},"along":{"dimensions":["Time","Party"]}}

This will return a DimensionalSummary for all Income transactions for the specified customer party_id for every month of 2024. This will include parties from both the credit and debit side of the transaction. You must pass a role (Vendor, Customer, etc) or some other appropriate filter. Note: since we are summarizing along 2 dimensions Time and Party, pagination field cannot be set.

Retrieve the top 5 vendors by spend for Q3 2024

{"filter":{"category_types":{"types":["Expenses"]}},"origin":{"interval":"Quarter","year":"2024","index":"3","interval_count":"1"},"along":{"dimensions":["Party"]},"pagination":{"page":{"limit":"5"},"sort_direction":"Descending","sort_field":"Amount"}}

Generate complete financial statements: Profit & Loss, Balance Sheet, Cash Flow, AR/AP Aging.

Statement Types (kind)

1. ProfitAndLoss

• Income Statement showing revenue, expenses, and net income

2. BalanceSheet

• Financial position with assets, liabilities, and equity

3. CashFlow

• Cash movements categorized by operating, investing, and financing activities

4. APAging

• Accounts Payable aging report. ONLY use for questions about total amount currently outstanding or due to vendors. Do NOT use for general bill questions (counts, averages, individual bill details, historical bill amounts).

5. ARAging

• Accounts Receivable aging report. ONLY use for questions about total amount currently outstanding or due from customers. Do NOT use for general invoice questions (counts, averages, individual invoice details, historical invoice amounts).

Parameters

Required:

• kind: Statement type ("ProfitAndLoss", "BalanceSheet", "CashFlow", "APAging", "ARAging")
• origin: Time period for the statement. Origin's "index" is 1 based for interval Day, Week, Month, and Quarter; it's the year for interval Year. All fields in "origin" must be set.
• interval: Time unit (Day, Week, Month, Quarter, Year)
• year: Calendar year
• index: Position within year (1-12 for Month, 1-4 for Quarter, etc.)
• interval_count: Number of periods to include

Optional:

• look_back_count: Number of periods to include in lookback (overrides defaults)
• For Month statements: defaults to 12 periods
• For Quarter statements: defaults to 4 periods
• For Year statements: defaults to 3 periods
• show_account_numbers: Include account numbers (bool)
• fiscal_year_start_month: Fiscal year start month (1-12 for Jan-Dec)
• tax_form: Tax form for display
• category_id: Filter to specific category (optional)
• department_ids: Filter to specific departments (array of strings)
• location_ids: Filter to specific locations (array of strings)

Example Requests

Profit & Loss for Q3 2024

{ "kind": "ProfitAndLoss", "origin": { "interval": "Quarter", "year": 2024, "index": 3, "interval_count": 1 } }

Balance Sheet for December 2024

{ "kind": "BalanceSheet", "origin": { "interval": "Month", "year": 2024, "index": 12, "interval_count": 1 } }

Cash Flow Statement for Last 6 Months

{ "kind": "CashFlow", "origin": { "interval": "Month", "year": 2024, "index": 12, "interval_count": 6 } }

AP Aging Report with Account Numbers

{ "kind": "APAging", "origin": { "interval": "Month", "year": 2024, "index": 12, "interval_count": 1 }, "preferences": { "show_account_numbers": true } }

Department-Specific P&L

{ "kind": "ProfitAndLoss", "origin": { "interval": "Quarter", "year": 2024, "index": 4, "interval_count": 1 }, "department_ids": ["dept-123", "dept-456"] }

Common Patterns

"Show me the P&L for last quarter" -> kind="ProfitAndLoss", origin with Quarter interval "What's my current cash position?" -> kind="BalanceSheet", origin with current month "Show cash flow for the year" -> kind="CashFlow", origin with Year interval or interval_count=12 "What is our total outstanding A/R?" -> kind="ARAging" for total receivable amount "How much do we currently owe vendors?" -> kind="APAging" for total payable amount "Department P&L comparison" -> Use department_ids to filter

List all users with access to a business. Requires a business_id from select_business.

List all businesses (legal entities) the authenticated user has access to, including both direct employments and affiliations.

This tool is used to list categories. Use this when you need to review category names, types, or identifiers.

This tool is used to list departments. Use this when you need to review department names, status, or identifiers.

This tool is used to list locations. Use this when you need location names, active status, or ids.

Query and filter individual transactions.

This tool provides access to transaction-level data with flexible filtering capabilities.

Required Parameters

origin: Time period specification. All fields must be set.

• interval: "Day", "Week", "Month", "Quarter", or "Year"
• year: Calendar year (e.g., 2024)
• index: Position within year (1-12 for Month, 1-4 for Quarter, etc.)
• interval_count: Number of periods to include

Example: {"interval": "Month", "year": 2024, "index": 11, "interval_count": 1} means November 2024

Optional Parameters

filter: Transaction filtering criteria:

• minimum/maximum: USD dollar amounts as numbers (e.g., 10000 or 1250.75)
• occurred_after/occurred_before: Timestamps for date filtering
• category_ids: {"ids": ["cat-id-1", "cat-id-2"]}
• category_types: {"types": ["Expenses", "Income", etc.]}
• party_ids: {"ids": ["party-id-1"]} — requires either category_types or party_roles
• party_roles: ["EntityVendorRole", "EntityCustomerRole", etc.]
• digits_transaction_types: Filter by transaction type (PayIn, PayOut, JournalEntry, BankTransfer)

order: Sort order for results

direction: Direction from origin (Past or Future)

pagination: Page controls. Defaults to {"offset": 0, "limit": 250} when omitted.

Resolve a customer, vendor, category, department, location name or transaction description to its canonical form using fuzzy text matching.

Before using an ID in transaction filters, run a final search on the full phrase and verify the selected canonical name matches the intended phrase (for example, do not treat "Uber" as a definitive match for "Uber Eats"). If multiple close matches remain after full-phrase search, ask the user to confirm which one they mean before proceeding.

Required Parameters

text: The search query string. This is the user-entered term to match against canonical names (e.g., "uber eats", "office supplies").

Optional Parameters

kinds: List of object kinds to search across. Valid values: "Party", "Category", "Department", "Location", "Transaction".

• When searching for terms related to a transaction, always pass the full kinds list exactly as: ["Party", "Category", "Department", "Location", "Transaction"]. Do not pass a partial subset for transaction-term searches.
• If omitted, defaults to a limited set of kinds automatically.

sort: List of sort orderings for results. Each entry has:

• field: "Score", "Date", "DisplayNumber", "Name", or "Type"
• ascending: boolean (default false = descending)

Example: { "text": "uber eats", "kinds": ["Party", "Category", "Department", "Location", "Transaction"] }

Select a business to work with. After calling this tool, use the returned business ID as business_id in subsequent tool calls.