Skip to main content
GET
Get all sales

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
customer_id
integer | null

Filter by customer ID.

user_id
integer | null

Filter by user ID.

status
enum<string> | null

Filter by status.

Mevcut seçenekler:
draft,
completed,
cancelled,
invoiced,
pending,
null
currency_id
integer | null

Filter by currency ID.

has_remaining_balance
boolean | null

Filter by whether the sale still has an uncollected balance.

total_price_min
number | null

Filter sales whose item total is at least this amount.

Gerekli aralık: x >= 0
total_price_max
number | null

Filter sales whose item total is at most this amount.

Gerekli aralık: x >= 0
sale_date_from
string<date-time> | null

Filter sales dated on or after this date.

sale_date_to
string<date-time> | null

Filter sales dated on or before this date.

created_at_from
string<date-time> | null

Filter records created on or after this date.

created_at_to
string<date-time> | null

Filter records created on or before this date.

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:
sale_date,
created_at,
updated_at,
status,
total_price,
balance,
null
sort_order
enum<string> | null

The sort direction (asc or desc).

Mevcut seçenekler:
asc,
desc,
null

Yanıt

Paginated set of SaleResource

data
SaleResource · object[]
gerekli
meta
object
gerekli