Skip to main content
POST
documents.count

Authorizations

x-api-key
string
header
required

API key prefixed with sk_. Obtain from the Receiptor AI dashboard.

Body

application/json
where
object

Typed filter clause. Allowed fields: amount, docDate, merchant, category, docType, invoiceId, receiptId, preferredCurrency, currency, paymentMethod, paymentMethodEnding, fromEmail, toEmail, summary, taxAmount, subtotal, isRecurring, recurringType. Allowed ops: eq, ne, gt, gte, lt, lte, in, nin, regex, exists.

archived
enum<string>
default:exclude

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

Available options:
exclude,
only,
include
groupBy
string

Aggregation key (e.g., merchant, category, date)

Response

Successful response

success
boolean
Example:

true

code
integer
Example:

200

data
object