Skip to main content
GET
Get Payout Invoice Statistics (v2)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

tenantUUID
string
required

UUID

Pattern: ^[a-zA-Z0-9]{8}\-[a-zA-Z0-9]{4}\-[a-zA-Z0-9]{4}\-[a-zA-Z0-9]{4}\-[a-zA-Z0-9]{12}$

Query Parameters

period_start_date
string

Filter by start period in YYYY-MM-DD format (e.g., 2025-01-15)

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

Filter by end period in YYYY-MM-DD format (e.g., 2025-03-31)

Pattern: ^\d{4}-\d{2}-\d{2}$
status
enum<string>

Filter by payout invoice status

Available options:
unpaid,
paid
sort
string

Sort field (prefix with - for descending, e.g., -date_paid). Optional, only used with pagination.

page
integer

Page number for pagination. When provided, response will be paginated.

Required range: x >= 1
per_page
integer

Items per page (default: 15, max: 100). Only used when page is provided.

Required range: 1 <= x <= 100

Response

Payout Invoice Statistics

period
object

Statistics period

data
object[]
meta
object | null

Pagination metadata (only present when pagination is requested)

total_sales
number<float>

Total sales (for all filtered data, not just current page when paginated)

total_net_payout
number<float>

Total net payout (for all filtered data, not just current page when paginated)