Skip to main content
GET
List received invoices

Query Parameters

orgId
string
required

Organization ID. Use GET /v1/companies to discover available org/company pairs.

Example:

"1"

companyId
string
required

Company ID. Use GET /v1/companies to discover available companies and their access levels.

Example:

"1"

status
enum<string>

Lifecycle filter. Default "all". "review" is the human inbox; "approved" the booked set.

Available options:
processing,
review,
approved,
failed,
all
published
enum<string>

published = a bill exists at ANY provider (Xero/QuickBooks/Bexio); unpublished = still needs publishing. Default "all".

Available options:
published,
unpublished,
all
books
enum<string>

inBooks = approved AND journal-eligible; notInBooks = approved but missing something the books need. Default "all".

Available options:
inBooks,
notInBooks,
all
payment
enum<string>

Approved invoices only: paid, partial (allocated payments below the total), unpaid, or overdue (unpaid past the due date). Default "all".

Available options:
paid,
partial,
unpaid,
overdue,
all
vendorContactId
string

Narrow to invoices resolved to this vendor entity contact.

Substring match over vendor name, invoice number, file name.

Maximum string length: 200
limit
string
default:50

Rows per page (1-200, default 50).

offset
string
default:0

Rows to skip (offset pagination, default 0).

orderBy
enum<string>

Sort column (default createdAt). account / vat sort by the GL coding, the table's inline columns.

Available options:
createdAt,
vendorName,
invoiceNumber,
invoiceDate,
dueDate,
totalAmount,
status,
account,
vat
sorting
enum<string>

Sort direction (default desc).

Available options:
asc,
desc

Response

Invoices retrieved

success
enum<boolean>
required
Available options:
true
data
object[]
required
pagination
object
required
Last modified on November 13, 2026