Skip to main content
GET
Get all invoices

Yetkilendirmeler

Authorization
string
header
gerekli

The access token received from the authorization server in the OAuth 2.0 flow.

Başlıklar

X-Tenant
number
gerekli

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Sorgu Parametreleri

search
string | null

The search query.

Maximum string length: 255
status
enum<string> | null

Filter by status.

Mevcut seçenekler:
draft,
success,
sent,
waiting,
error,
cancelled,
null
is_archived
boolean | null

Filter by archived status.

is_draft
boolean | null

Filter by draft status.

is_cancelled
boolean | null

Filter by cancelled status.

document_class
enum<string> | null

Filter by document class (EFATURA, EARSIV or SMM).

Mevcut seçenekler:
EFATURA,
EARSIV,
SMM,
null
sale_id
integer | null

Filter by the sale the invoice belongs to.

Gerekli aralık: x >= 1
customer_id
integer | null

Filter by the customer the invoice belongs to.

Gerekli aralık: x >= 1
issue_date_from
string<date-time> | null

Filter records from this issue date (inclusive, YYYY-MM-DD).

issue_date_to
string<date-time> | null

Filter records up to this issue date (inclusive, YYYY-MM-DD).

sort_by
enum<string> | null

The field to sort by.

Mevcut seçenekler:
created_at,
issue_date,
document_number,
amount_payable,
status,
null
sort_order
enum<string> | null

The sort direction (asc or desc).

Mevcut seçenekler:
asc,
desc,
null
per_page
integer | null

The number of items per page.

Gerekli aralık: 1 <= x <= 100

Yanıt

Paginated set of InvoiceResource

data
InvoiceResource · object[]
gerekli
meta
object
gerekli