Skip to main content
GET
Get Invoice By ID
Returns full details for a single invoice including line item breakdown, payment history, and extra periods. Line items can be of various types including referral fees, offer details, VAT, and manual adjustments.

Authorizations

X-Eflow-Api-Key
string
header
required

The affiliate's API key generated from the Affiliate Portal. Uses the X-Eflow-Api-Key header.

Path Parameters

invoiceId
integer
required

The numeric ID of the invoice.

Response

network_affiliate_invoice_id
integer

Unique identifier for the invoice.

network_id
integer

The network ID.

network_affiliate_id
integer

The affiliate ID.

status
string

Payment status of the invoice (paid, unpaid).

start_time
string<date-time>

Start of the billing period.

end_time
string<date-time>

End of the billing period.

notes
string

Notes on the invoice.

balance
number

Outstanding balance on the invoice.

timezone_id
integer

Timezone ID for the invoice period.

currency_id
string

Currency code for the invoice (e.g. "USD").

time_created
integer

Unix timestamp of when the invoice was created.

Example:

1734455015

time_saved
integer

Unix timestamp of when the invoice was last saved.

Example:

1734455015

relationship
object

Related data for the invoice.