Skip to main content
GET
List advertiser invoices

Authorizations

X-API-Key
string
header
required

Preferred authentication method. Pass the API key in the X-API-Key HTTP request header. The user account must have api_status enabled.

Query Parameters

sortField
enum<string>

Field to sort by.

Available options:
id,
invoice_number,
date,
advertiser,
status,
amount,
period,
attachment,
internal_notes
sortDirection
enum<string>

Sort direction.

Available options:
asc,
desc
page
integer

Page number (1-based).

perPage
integer

Items per page.

fields
string

Comma-separated list of fields to return (sparse fieldset). id is always included. Note the parameter is fields, not columns. Example: id,invoice_number,date,status,amount,period,attachment,internal_notes,advertiser.

statuses
enum<string>

Filter by invoice status.

Available options:
,
paid,
unpaid,
draft,
processing
advertisers
string

Filter by advertiser IDs (comma-separated). Example: 11,14.

currencies
string

Filter by currency codes (comma-separated). Example: UAH,USD,EUR.

Free-text search.

Response

Invoices list.

status
string
Example:

"success"

code
integer
Example:

200

name
string
Example:

"OK"

message
string
info
object