Skip to main content
POST
/
capabilities
/
documents.count
documents.count
curl --request POST \
  --url https://developer.api.receiptor.ai/v1/capabilities/documents.count \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "where": {
    "conditions": [
      {
        "field": "amount",
        "op": "eq",
        "value": "<unknown>"
      }
    ],
    "logic": "and"
  },
  "archived": "exclude",
  "groupBy": "<string>"
}
'
{
  "success": true,
  "code": 200,
  "data": {
    "result": {}
  }
}

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