Capabilities

documents.count

Changed on

Count and aggregate all matching documents, optionally filtered by canonical reviewStatus. Supports grouping by merchant, category, date, export status, etc. Amounts are converted to the authenticated user's currency, including when grouped by source currency. Counts include both sides of linked pairs; these are document totals, not verified expenses.

post/capabilities/documents.count

Request

  • Base URL: https://developer.api.receiptor.ai/v1
  • URL: https://developer.api.receiptor.ai/v1/capabilities/documents.count
  • Auth: one of:
    • API key in header x-receiptor-api-key
    • HTTP bearer

Request body

reviewStatus'needs-review' | 'ready'

Canonical review filter, including both sides of linked pairs.

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
}

Changes