Affiliate Invoices

Operations for Affiliate Invoices

Find (Advanced)

GET /v1/networks/billings/affiliates/invoicestable

Body Params

search_terms object array
search_type string

The name of the field used for search. Must pass value: name.

value string

The value to search.

filters object
network_affiliate_ids int array

ID of the affiliates.

account_manager_ids int array

ID of the account managers of the affiliates.

min_start_time string

Lower bound for the affiliate invoice start time, in the “YYYY-MM-DD” format.

max_end_time string

Upper bound the affiliate invoice start time, in the “YYYY-MM-DD” format.

min_balance double

Lower bound for the affiliate invoice balance.

min_balance double

Upper bound for the affiliate invoice balance.

affiliate_invoice_status string

Status of the affiliate invoice. Can be one of the following values: paid , unpaid or deleted.

is_hidden_affiliate boolean

Whether the invoice is hidden from affiliates.

billing_frequency string

Billing frequency of the affiliate associated with the invoice. Supported values are: weekly, bimonthly, monthly, two_months, quarterly, manual and other.

payment_terms int array

Payment terms of the invoices, in number of days.

payment_type string

Payment method of the affiliate associated with the invoice. Supported values are: none, paypal, check, wire, direct_deposit, tipalti, paxum, veem, payoneer, bitcoin, webmoney, capitalist, gift_card, masspay and skrill.

network_affiliate_invoice_ids int array

ID of the affiliate invoices requested.

Body Example
{
  "search_terms": [
    {
      "search_type": "name",
      "value": "Inc.",
    }
  ],
  "filters": {
    "network_affiliate_ids": [
      7, 
      14
    ],
    "affiliate_invoice_status": "unpaid",
    "min_balance" 50,
  }
}

cURL
curl --request POST 'https://api.eflow.team/v1/networks/billings/affiliates/invoicestable' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT BODY HERE>'
Response
{
   "draw":1,
   "recordsTotal":1,
   "recordsFiltered":1,
   "data":[
    {
      "network_affiliate_invoice_id": 1,
      "network_affiliate_id": 14,
      "network_id": 1,
      "network_affiliate_name": "Franklin Moran Inc.",
      "affiliate_invoice_status": "paid",
      "start_time": "2021-06-01 00:00:00",
      "end_time": "2021-06-30 23:59:59",
      "timezone_id": 90,
      "balance": 25,
      "paid": 75,
      "billed": 100,
      "currency_id": "USD",
      "payment_terms": 15,
      "is_hidden_affiliate": false,
      "public_notes": "",
      "internal_notes": "",
      "payment_type": "paypal",
      "time_created": 1624305380,
      "time_saved": 1624305380
    }
  ]
}