Skip to main content
GET
List bills

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Query Parameters

page
integer
default:1

Page number for pagination

per_page
integer
default:10

Number of items per page (max 100)

Required range: x <= 100
vendor_id
integer

Only bills for this vendor (supplier) ID.

status
enum<string>

Only bills in this status.

Available options:
draft,
open,
partially_paid,
paid,
cancelled
overdue
boolean

When true, only open or partially_paid bills whose due date is before today.

due_soon
boolean

When true, only draft, open or partially_paid bills due within the next 14 days (today included).

due_from
string<date>

Only bills due on or after this date.

due_to
string<date>

Only bills due on or before this date.

purchase_order_id
integer

Only bills linked to this purchase order, either directly, through a bill line that references one of its lines, or through a purchase order linked to the bill after the fact (for example via purchase_order_ids or a later PO link).

Partial match on bill number, vendor invoice number, the bill's alternate IDs, or the alternate IDs of any linked purchase order (direct, through a bill line, or linked to the bill after the fact).

Maximum string length: 255
reconcile_status
enum<string>

Only bills with this line-reconciliation state. reconciled: every non-adjustment line is fully allocated. partial: some allocation exists. unreconciled: no allocations. n/a: the bill has no non-adjustment lines.

Available options:
reconciled,
partial,
unreconciled,
n/a
variance_status
enum<string>

Only bills with this variance status. detected also matches bills where a line's allocated amount differs from the line amount by more than 0.01.

Available options:
detected,
resolved
sync_status
enum<string>

Only bills in this accounting sync state (QuickBooks or Xero). not_pushed: never queued for sync. waiting: queued to post or re-sync. syncing: push in progress. synced: posted to the accounting system. failed: the last push failed.

Available options:
not_pushed,
waiting,
syncing,
synced,
failed
completion
enum<string>

Only bills in this completion view. completed: paid bills whose lines are all reconciled (reconcile_status of reconciled or n/a). needs_attention: every other bill that is not cancelled. Combines with the other filters.

Available options:
completed,
needs_attention

Response

Successful response

data
object[]
meta
object