Sign in

v1

latestOpenAPI 3.0.32026-07-2226694862.5 KB
Affiliate Invoices

Get Invoice By ID

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

Path parameters

invoiceIdinteger required

The numeric ID of the invoice.

Response

network_affiliate_invoice_idinteger

Unique identifier for the invoice.

network_idinteger

The network ID.

network_affiliate_idinteger

The affiliate ID.

statusstring

Payment status of the invoice (paid, unpaid).

start_timestring date-time

Start of the billing period.

end_timestring date-time

End of the billing period.

notesstring

Notes on the invoice.

balancenumber

Outstanding balance on the invoice.

timezone_idinteger

Timezone ID for the invoice period.

currency_idstring

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

time_createdinteger

Unix timestamp of when the invoice was created.

time_savedinteger

Unix timestamp of when the invoice was last saved.

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
      }
    ],
    "extra_periods": [
      {
        "time_created": 1734455015,
        "time_saved": 1734455015,
        "relationship": {
          "associated_details": [
            {
              "time_created": 1734455015,
              "time_saved": 1734455015
            }
          ]
        }
      }
    ]
  }
}