Get Payout Invoice Statistics (v2)

{ "period": { "from": "string", "to": "string" }, "data": [ { "invoice_uuid": "string", "invoice_number": "string", "period": "string", "payout_date": 0, "payout_status": "processing", "ips_count": 0, "average_ip_sale": 0, "total_sales": 0, "lessee_gross": 0, "average_net_per_ip": 0, "transaction_fee": 0, "holder_fee": 0, "deductions": 0, "net_payout": 0, "payment_confirmation_uuid": "string", "payment_confirmation_number": "string" } ], "meta": { "current_page": 0, "per_page": 0, "total": 0, "last_page": 0, "from": 0, "to": 0 }, "total_sales": 0, "total_net_payout": 0 }

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

Show child attributes

data

object[]

Show child attributes