Skip to main content
GET
List proforma 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

view
enum<string> | null

List documents, pending purchases or closed purchases; omitted preserves the invoice history.

Mevcut seçenekler:
documents,
purchases,
closed,
null
search
string | null

The search query.

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

Filter by status (draft, pending_approval, approved, rejected, pending_payment, partially_paid, paid, refunded, cancelled).

Mevcut seçenekler:
draft,
pending_approval,
approved,
rejected,
pending_payment,
partially_paid,
paid,
refunded,
cancelled,
null
kind
enum<string> | null

Filter by kind (period, quota_purchase, subscription).

Mevcut seçenekler:
period,
subscription,
quota_purchase,
null
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).

due_date_from
string<date-time> | null

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

due_date_to
string<date-time> | null

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

per_page
integer | null

The number of items per page.

Gerekli aralık: 1 <= x <= 100
page
integer | null

The page number.

Gerekli aralık: x >= 1
sort_by
enum<string> | null

The field to sort by.

Mevcut seçenekler:
issue_date,
due_date,
total_amount,
number,
created_at,
null
sort_order
enum<string> | null

The sort direction (asc or desc).

Mevcut seçenekler:
asc,
desc,
null

Yanıt

Paginated set of ProformaInvoiceResource

data
ProformaInvoiceResource · object[]
gerekli
meta
object
gerekli