Sign in

v3

latestOpenAPI 3.0.02026-07-31800117.7 KB
Capabilities

documents.count

Count documents and aggregate data. Use for spending totals and financial analysis. Supports grouping by merchant, category, date, export status, etc. Gets ALL matching documents.

post/capabilities/documents.count

Request body

exportStatus'all' | 'exported' | 'not-exported'

Optional export status filter before aggregation

archived'exclude' | 'only' | 'include'

Archive filter: exclude (default, active docs), only (archived docs), include (both).

groupBy'merchant' | 'category' | 'docType' | 'currency' | 'preferredCurrency' | 'paymentMethod' | 'paymentMethodEnding' | 'paymentStatus' | 'entityId' | 'docDate' | 'expenseLocation.primary.countryCode' | 'expenseLocation.primary.country' | 'expenseLocation.primary.city' | 'expenseLocation.primary.stateOrProvince' | 'expenseLocation.primary.kind' | 'exportStatus'

Aggregation key. Allowed values: merchant, category, docType, currency, preferredCurrency, paymentMethod, paymentMethodEnding, paymentStatus, entityId, docDate, expenseLocation.primary.countryCode, expenseLocation.primary.country, expenseLocation.primary.city, expenseLocation.primary.stateOrProvince, expenseLocation.primary.kind, exportStatus. Use exportStatus to summarize exported vs not-exported documents.

Response

Successful response

successboolean
codeinteger

Example response

{
  "success": true,
  "code": 200
}