Skip to main content
GET
List documents

Authorizations

Authorization
string
header
required

API token issued from the Equated app under Settings → API Keys and MCP.

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,
ESTIMATE_SENT,
ESTIMATE_RECEIVED
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

Free text. Every word must appear in the row's title, its number, the file it arrived as, an extracted counterparty name, an email subject, the counterparty it names, or, for an estimate or quote, the customer and the job address.

Required string length: 1 - 120
include_archived
enum<string>

Include archived paper, which every list leaves out by default.

Available options:
true,
false
archived_only
enum<string>

List nothing but archived paper. It is at no stage, so name no stage with it.

Available options:
true,
false
integration_kind
string
integration_id
number | null
org_merchant_id
integer
Required range: x > 0
date_from
string
date_to
string
ai_typenames
sort
enum<string>

What rows sort on within each stage: date (default, the date the row shows), amount, or title (the name the row shows). A row with no amount or name yet sorts last. Stage order stays.

Available options:
date,
amount,
title
order
enum<string>

Direction of sort. Omit for the sort's own: newest first, largest first, or A to Z.

Available options:
asc,
desc
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
stageCountsByKind
object
required