Skip to content

List Invoices

GET
/invoices

Returns a paginated list of invoices for your company. Requires the invoice:read scope. Results are automatically filtered by test/live mode based on your API key. Supports filtering by status, currency, invoice number, and date range.

status
string

Filter by invoice state (e.g. draft, approved, sending, sent, delivered, failed, cancelled).

currency
string

Filter by ISO 4217 currency code (e.g. EUR, USD).

invoice_number
string

Filter by exact invoice number as stored in UBL header.

from_date
string

Return invoices created on or after this date (ISO 8601, e.g. 2025-01-01).

to_date
string

Return invoices created on or before this date (ISO 8601, e.g. 2025-12-31).

page
integer
default: 1

Page number for pagination (15 results per page).

Paginated list of invoices.

object
data
required
Array<object>
InvoiceResource
object
id
required

Unique invoice identifier (UUID).

string
company_id
required

UUID of the company that owns this invoice.

string
user_id
required

UUID of the user who created the invoice, if applicable.

string | null
state
required

Current workflow state: draft, approved, sending, sent, delivered, failed, or cancelled.

string
direction
required

Invoice direction: outgoing (sent by company) or incoming (received).

string
amount
required

Invoice total amount in cents.

integer
currency
required

ISO 4217 currency code (e.g. EUR, USD).

string
ubl_version
required

UBL specification version used. Peppol BIS 3.0 binds to UBL 2.1.

string
ubl_json
required

Full invoice data in structured UBL JSON format (header, seller, buyer, items, totals, etc.).

object | null
metadata_json
required

Additional metadata such as delivery details, error info, or processing history.

object | null
delivery_network_id
required

Delivery network used: peppol, ksef, or email.

string | null
business_entity_id
required

UUID of the business entity (seller identity) used for this invoice.

string | null
related_invoice_id
required
string | null
payment_status
required
string
total_paid_cents
required
integer
is_test
required
boolean
created_at
required

ISO 8601 timestamp when the invoice was created.

string
updated_at
required

ISO 8601 timestamp when the invoice was last updated.

string
deleted_at
required

ISO 8601 timestamp when the invoice was soft-deleted, or null.

string | null

API key is not associated with a company.

object
message
required
string
Allowed value: User must belong to a company.