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 (2.1, 2.2, or 2.3).

string
ubl_json
required

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

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
buyer_contact_id
required

UUID of the address book contact this invoice was issued to, if any.

string | null
branding_profile_id
required

UUID of the branding profile used for the PDF; null means the company default profile.

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

Public invoice metadata, e.g. the delivery method. Always a JSON object.

object
key
additional properties
delivery_method
required

Delivery method selected when sending: auto, peppol, email, etc.

peppol_response

Final Peppol access-point response for the send attempt.

mlr_sent_at
required

Timestamp the Message Level Response was forwarded, if any.

mls
required

Outbound Message Level Response verdict from the recipient’s access point:

  • verdict: received_ap (delivered) | received_ab (delivered with note) | received_re (rejected)
  • received_at: ISO 8601 timestamp the MLR was processed by the AP
  • error_details: rejection reason if verdict is received_re Null until the recipient AP returns an MLR or 72h elapses.
string | null
documents
Array<object>
DocumentResource
object
id
required
string
type
required
string
status
required
string
original_filename
required
string
mime_type
required
string
size
required
integer
human_size
required
string
has_thumbnail
required
boolean
is_image
required
boolean
tags
Array<object>
TagResource
object
id
required
string
name
required
string
slug
required
string
is_generic
required
boolean
created_at
required
string
documentable_key
required
string | null
documentable_id
required
integer | null
uploaded_by
Array
metadata
required
string
is_deletable
required
boolean
deletable_reason
required
string | null
created_at
required
string
checksum
string
virus_scanned_at
string | null
updated_at
string
created_at
required

ISO 8601 timestamp when the invoice was created.

string | null
updated_at
required

ISO 8601 timestamp when the invoice was last updated.

string | null
deleted_at
required

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

string | null
public_access_revoked_at
required

ISO 8601 timestamp when the public (signed-URL) link was revoked, or null if active.

string | null
links
required
object
first
required
string | null
last
required
string | null
prev
required
string | null
next
required
string | null
meta
required
object
current_page
required
integer
>= 1
from
required
integer | null
>= 1
last_page
required
integer
>= 1
links
required

Generated paginator links.

Array<object>
object
url
required
string | null
label
required
string
active
required
boolean
path
required

Base path for paginator generated URLs.

string | null
per_page
required

Number of items shown per page.

integer
to
required

Number of the last item in the slice.

integer | null
>= 1
total
required

Total number of items being paginated.

integer

API key is not associated with a company.

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