Skip to content

List Orders

GET
/orders

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

status
string

Filter by document status (e.g. draft, approved, sending, sent, delivered, failed).

currency
string

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

from_date
string

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

to_date
string

Return orders 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 orders.

object
data
required
Array<object>
PeppolDocumentResource
object
id
required
string
peppol_document_type
required
PeppolDocumentType
string
Allowed values: invoice credit_note invoice_response mlr mls order order_response order_agreement despatch_advice catalogue catalogue_response punch_out unknown
name
required
string
document_type_id
required
string
process_id
required
string | null
direction
required
InvoiceDirection
string
Allowed values: incoming outgoing
document_number
required
string | null
referenced_document_number
required
string | null
referenced_invoice_id
required
string | null
referenced_peppol_document_id
required
string | null
response_code
required
string | null
sender_peppol_id
required
string | null
recipient_peppol_id
required
string | null
as4_message_id
required
string | null
ubl_json
required
array | null
status
required
string
user_id
required
string | null
amount
required
integer | null
currency
required
string | null
delivery_network_id
required
string | null
business_entity_id
required
string | null
is_test
required
boolean
ubl_version
required
string | null
raw_xml_url
required
object
metadata_json
required
string
created_at
required
string | null format: date-time
updated_at
required
string | null format: date-time
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.