Skip to content

List bills

GET/api/v1/bills

Retrieve all bills for a business with cursor-based pagination. Can filter by vendor name (fuzzy search) or associated journal entry.

Operation ID: list_bills·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Query

idarray · stringdefault: []

Filter bills by specific bill UUIDs (batch fetch — avoids N+1 single-bill requests)

vendor_searchstring

Fuzzy search bills by vendor name (uses PostgreSQL trigram matching)

journal_entry_idstring

Filter bills by associated journal entry UUID

payment_methodstring

Filter bills by payment method: 'Wire Transfer', 'ACH', 'Check', 'Credit Card'

vendor_idstring

Filter bills by vendor UUID

statusstring

Filter by bill status (e.g. draft, approved, received, paid, canceled)

searchstring

Search bills by bill number, description, or vendor name (case-insensitive partial match)

bill_numberstring

Filter bills by invoice/bill number (case-insensitive partial match)

due_date_fromstring

Filter bills with due date on or after this date (YYYY-MM-DD)

due_date_tostring

Filter bills with due date on or before this date (YYYY-MM-DD)

on_holdboolean

true: only bills with an active payment hold; false: only bills without one

cursorstring

Cursor for pagination

limitinteger

Pagination limit

directionstringdefault: next

Pagination direction: 'next' or 'prev'

include_total_countbooleandefault: False

Whether to include total count (expensive - avoid if possible)

sort_bystring

Column name to sort by (e.g. 'created_at', 'amount', 'name'). When changing sort, reset cursor to None.

descendingbooleandefault: True

Sort direction: true for descending (newest/largest first), false for ascending

Responses

200Successful Response

successboolean
messagestring
codestring
dataBillsListResponse

401Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business

errorstringrequired

Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.

messagestringrequired

Human-readable explanation, safe to show to end users.

codestringrequired

Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).

request_idstring

Correlation id for support requests. Echoes the x-request-id request header when one was supplied.

errorsobject

Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

403Forbidden - Insufficient permissions

errorstringrequired

Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.

messagestringrequired

Human-readable explanation, safe to show to end users.

codestringrequired

Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).

request_idstring

Correlation id for support requests. Echoes the x-request-id request header when one was supplied.

errorsobject

Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

422Validation Error

errorstringrequired

Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.

messagestringrequired

Human-readable explanation, safe to show to end users.

codestringrequired

Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).

request_idstring

Correlation id for support requests. Echoes the x-request-id request header when one was supplied.

errorsobject

Field-level validation messages keyed by field name. Present on 400/422 validation failures only.