Skip to main content
GET
List

Authorizations

Authorization
string
header
required

Client API key sent as a bearer token.

X-Client-Directory
string
header
required

Client directory identifier. Legacy directory header is still accepted for backward compatibility.

Query Parameters

page
integer
default:1

Page number. Default: 1.

Required range: x >= 1
per_page
integer
default:250

Number of results per page. Default: 250, maximum: 500.

Required range: 1 <= x <= 500
period
enum<string>

Predefined date range filter.

Available options:
cur_month,
prev_month,
last_30_days,
last_60_days,
last_90_days,
custom
period_by
enum<string>

Invoice date field used together with period.

Available options:
added_date,
issue_date,
service_date,
payment_term,
payment_date
from
string<date>

Start date for period=custom in YYYY-MM-DD format.

to
string<date>

End date for period=custom in YYYY-MM-DD format.

type
string

Comma-separated invoice types. Available options: s - sales invoices, c - correcting invoices, p - purchase invoices.

Example:

"s,c"

status
string

Comma-separated invoice statuses. Available options: issued, paid, semipaid, overdue.

Example:

"issued,overdue"

branch
string

Comma-separated branch IDs.

Example:

"1,2"

customer
string

Comma-separated customer VAT numbers.

Example:

"PL1234567890,DE123456789"

customer_name
string

Partial customer name.

customer_country
string

Customer country code.

Example:

"pl"

nr
string

Search by invoice number, related order number, or invoice item text.

sort_by
enum<string>
default:issue_date

Sort field. Default: issue_date.

Available options:
issue_date,
service_date,
payment_term,
payment_date,
nr,
amount_gross,
amount_net,
amount_tax,
customer_name,
added_time
sort_dir
enum<string>
default:desc

Sort direction. Default: desc.

Available options:
asc,
desc

Response

Invoice list returned

status
integer
required
Example:

200

message
string
required
Example:

"OK"

data
object
required