Docyt

Returns a high-level overview of what Docyt is and what it does.

about_docyt

Lists the reports the signed-in user can access for a business, given by name or handle. Each report has its name, type, and an opaque internal handle.

list_reports

Returns a business KPI group for a period. The business is given by name or handle. kpi_type picks the group; period is daily|mtd|ytd|custom (custom uses from and to; the others use the date anchor). Returns {"data": ...} on success, or {"error": ...} when access is denied or the service fails.

get_business_kpis

Lists the metrics the signed-in user can access for a business, given by name or handle. Each metric has a name and the code that identifies it.

list_metrics

A business's credit balance (ProfitBooks credit-based plans): credits available now, the free/purchased split, the daily free-credit window (size and reset cadence), and recent credit grants (credits and date only). Each processed transaction uses one credit, so categorization stops at a zero balance. A null free_credits_refreshed_at means the daily free window has not started yet; the next credit use starts it.

get_account_summary

Searches ALL of a business's bank transactions — posted (verified) and in review — by vendor, amount (sign-agnostic exact or min/max range), transaction-date range, free text, category, bank/card account, state or transaction type; or, with group_by, totals them server-side over the full match by one or two of account, category, month, year, type, vendor. Every total, and the totals on a row search, gives posted and in_review separately (count and amount). Rows are capped; total_count gives how many matched. Amounts are signed: money out is negative and money in is positive. Each row carries an opaque internal handle (txn_…).

list_transactions

Returns the values of one metric for a business over a date range. The business is given by name or handle and the metric by its code.

get_metric_values

Lists the businesses the signed-in user manages, by name. Where two businesses share a name, each of them also has a detail that tells them apart and an opaque internal handle.

list_businesses

Returns a portfolio KPI group for a period (portfolio admins only). kpi_type picks the group; period is daily|mtd|ytd|custom. When portfolio is omitted, the user's portfolio is found automatically. Returns {"data": ...} on success, a pick-list when several portfolios match, or {"error": ...}. Each business comes back with one aggregate per KPI for the whole range: a total for amounts and a properly weighted figure for rates such as ADR, RevPAR and Occupancy %.

get_portfolio_summary

Returns a report's rows for a date range, with a freshness flag. The business is given by name or handle and the report by type (e.g. profit_and_loss), name, or handle. Row items are keyed by line-item name; no internal ids are returned or accepted. Figures are posted (ledger) only: transactions still in review are not included. Reports cannot be filtered by bank or card account.

get_report_data