Sign in

v1

latestOpenAPI 3.0.32026-07-2226694862.5 KB
Billing

Get Partner Invoice

get/networks/billings/affiliates/invoices/{invoiceId}

Path parameters

invoiceIdinteger required

The unique invoice ID.

Query parameters

relationship'affiliate' | 'all'

Include additional related data in the response. The details and payments relationships are always returned. Use affiliate to add the affiliate object, or all to include everything.

Response

network_affiliate_invoice_idinteger

Unique invoice ID.

network_idinteger

Network ID.

network_affiliate_idinteger

The ID of the partner that was invoiced.

status'paid' | 'unpaid' | 'deleted'

Invoice status.

start_timestring

Invoice period start date.

end_timestring

Invoice period end date.

timezone_idinteger

Timezone ID for the invoice period.

balancenumber double

Outstanding balance.

currency_idstring

Currency code (e.g. USD).

payment_termsinteger

Number of days for the affiliate payment term (e.g. 20 for NET 20).

is_hidden_affiliateboolean

Whether the invoice is visible to the partner or not.

public_notesstring

Notes visible to both network employees and the invoiced partner.

internal_notesstring

Notes visible to network employees but not the invoiced partner.

time_createdinteger

Unix timestamp of creation.

time_savedinteger

Unix timestamp of last update.

extra_periodsobject[] nullable

Additional billing periods associated with this invoice.

Example response

{
  "time_created": 1734455015,
  "time_saved": 1734455015,
  "relationship": {
    "details": [
      {
        "time_created": 1734455015,
        "time_saved": 1734455015
      }
    ],
    "payments": [
      {
        "unix_timestamp": 1734455015,
        "time_approved": 1734455015,
        "time_completed": 1734455015
      }
    ]
  },
  "details": [
    {
      "time_created": 1734455015,
      "time_saved": 1734455015
    }
  ]
}