Skip to main content
GET
List invoices

Headers

x-environment
string<uuid>
required

Configure which environment the request will handle. If the provided credentials do not allow access to this specified environment, a 403 Forbidden response is returned.

Query Parameters

filter
string[]

Optional filter(s) to apply. Multiple filters will be combined with 'and'.

orderby
string

Optional column to order by. Defaults to Id.

after
string

Paging token.

limit
integer<int32>
default:20

Optional limit of response. Value between 1 and 100, defaults to 20.

Required range: 1 <= x <= 100

Response

OK

currency
string | null
required
createdAt
string<date-time>
required
customerId
string<uuid>
required
memo
string | null
read-only
handle
string | null
read-only

Unique invoice number.

status
enum<string>
Available options:
draft,
booked
id
string<uuid>
read-only
date
string<date>
read-only
dueDate
string<date> | null
read-only
updatedAt
string<date-time> | null
totalExclVat
integer<int64>
totalVat
integer<int64>
totalInclVat
integer<int64>
type
enum<string>
Available options:
invoice,
credit_note