Skip to main content
Find what was paid for a product across invoices

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Query Parameters

fields
string

Return only these fields of each row, comma-separated; use dots for nested fields, such as item.name. id is always returned. Fields: id, line_number, item, note, quantity, unit, unit_price, discount_rate, surcharge_rate, vat_rate, total_excluding_vat, period, valid, errors, additional_properties, invoice, supplier.

limit
integer
default:50

Maximum number of results per page.

Required range: 1 <= x <= 1000
cursor
string

Opaque next_cursor from the previous page. Keep the same filters and sort; omit for the first page.

Maximum string length: 4096
product_codes
string

Lines with any of these product codes (the seller's article numbers), exactly.

Case-insensitive text, at least 3 characters, in the line name, product description or product code.

Required string length: 1 - 200
supplier_ids
string

Lines on invoices from any of these suppliers.

invoice_ids
string

Lines on any of these invoices.

issued_from
string

Invoice issued on or after this date.

Pattern: ^\d{4}-\d{2}-\d{2}$
issued_through
string

Invoice issued on or before this date.

Pattern: ^\d{4}-\d{2}-\d{2}$
sort
enum<string>
default:issued_date

issued_date is the invoice issue date, so the latest purchases come first.

Available options:
issued_date,
unit_price,
total_excluding_vat
direction
enum<string>
default:desc
Available options:
asc,
desc

Response

A page of invoice lines with their invoice and supplier.

data
object[]
required
Maximum array length: 1000
next_cursor
string | null
required