Skip to main content
GET
List booked-documents

Headers

Authorization
string
required

API key. Value must be formatted like so: lucca application={api_key}.

Query Parameters

invoice.conformityStates
enum<string>[]

Filter on invoices conformity state.

Available options:
ToReview,
PendingBreakdown,
Confirmed,
Litigation,
Discarded,
Removed,
Bypassed
creditNote.conformityStates
enum<string>[]

Filter on credit notes conformity state.

Available options:
ToReview,
Partial,
Confirmed,
Removed,
Bypassed
createdAt.from
string<date>

Only return documents created after given date.

createdAt.to
string<date>

Only return documents created before given date.

fields.root
enum<string>[]

Include root collection fields (paging).

Available options:
prev,
next,
count
page

Page selection. Page tokens can be retrieved by adding ?fields.root=next,prev on your GET collections requests.

limit
integer

Page size.

Required range: 0 <= x <= 1000

Response

200 - application/json

OK

items
(credit-note · object | invoice · object)[]
required
prev
next
count
integer<int32>
Required range: x >= 0