Skip to main content
GET
List documents

Authorizations

Authorization
string
header
required

API token issued from the Equated app under Settings → API Tokens.

Query Parameters

type
enum<string>

One kind. Shorthand for a types naming it alone.

Available options:
UNKNOWN,
RECEIPT,
REIMBURSEMENT,
BILL,
INVOICE,
PAYROLL_REPORT,
SETTLEMENT_REPORT,
SHOPIFY_TRANSACTION,
SHOPIFY_ORDER,
SQUARE_PAYMENT
types

Document kinds to list together, repeated or comma-separated. Replaces type.

stage
enum<string>

inbox (awaiting work), outstanding (confirmed, still owed or owing), or done, read per kind. Omit for every stage.

Available options:
inbox,
outstanding,
done
lifecycle
string
is_matched
enum<string>
Available options:
true,
false
resolution
enum<string>

Receipts: unresolved (inbox — not linked to a transaction) or matched (linked to one).

Available options:
unresolved,
matched
integration_kind
string
integration_id
number | null
org_merchant_id
integer
Required range: x > 0
date_from
string
date_to
string
ai_typenames
limit
number
default:50
Required range: 1 <= x <= 200
offset
number | null
default:0
Required range: x >= 0

Response

200 - application/json

Documents matching the filter

documents
object[]
required
total
integer
required
Required range: x >= 0
counts
object
required
countsByKind
object
required