Skip to main content
POST
/
api
/
v2
/
network
/
aff-billing
/
invoices
Generate invoice
curl --request POST \
  --url 'https://{domain}/api/v2/network/aff-billing/invoices?api-key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "affiliate_id": 1,
  "currency": "USD",
  "amount": 1,
  "start_date": "2025-01-20",
  "end_date": "2025-01-20",
  "status": "string",
  "invoice_memo": "string"
}
'
{
  "status": "success",
  "code": 200,
  "name": "OK",
  "message": "<string>",
  "info": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.scaleo.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
api-key
string
query
required

API key passed as query parameter. User must have api_status enabled.

Body

application/json
​
affiliate_id
integer
required

Affiliate to generate invoice for.

​
currency
string
required

3-letter currency code (e.g. USD). Converted to uppercase.

Maximum string length: 3
​
amount
number

Invoice amount. If omitted, calculated automatically from balance.

Required range: x >= 0
​
start_date
string<date>

Period start date (YYYY-MM-DD).

​
end_date
string<date>

Period end date (YYYY-MM-DD). Must be >= start_date.

​
status
string

Invoice status: unpaid, paid, draft, etc.

​
invoice_memo
string

Memo text visible to affiliate.

​
internal_notes
string

Internal notes (not visible to affiliate).

​
offers
string

Comma-separated offer IDs to include.

​
commission_plan_ids
string

Comma-separated commission plan IDs.

​
commission_types
string

Comma-separated commission types: cpc, cpa, rev_share, cpl, lot_fee, flat_fee.

​
include_referral_balance
enum<integer>

Whether to include referral balance (0 or 1).

Available options:
0,
1

Response

Invoice generated.

​
status
string
Example:

"success"

​
code
integer
Example:

200

​
name
string
Example:

"OK"

​
message
string
​
info
object