A single line item from an Affiliate Invoice.
| Name | Type | Description |
|---|---|---|
| actions | Integer | The contents of this field are applicable only if "type" is "stats". Count of the number of clicks, conversions, or impressions, for the date covered by the Invoice start and end dates. The type of event contained in this column depends on the "payout_type". For "cpc" payout type this is number of clicks. For "cpm" this is number of impressions. For other payout types this is number of conversions. |
| amount | Decimal | Amount owed for the offer based on invoice start and end dates |
| conversions | Integer | DEPRECATED. The "actions" field should be consulted instead, to determine the number of clicks/conversions/impressions (if "type" is "stats"). |
| datetime | Datetime | Date that the invoice item was created |
| goal_id | Nullable Integer | This field is present only if the network has Offer Goals enabled. It specifies the Goal this invoice item is attributed, or NULL if the item is not attributed to a Goal. |
| id | Integer | ID of unique object for this Item This parameter is non-writable |
| invoice_id | Integer | The ID of the Invoice to which this item belongs |
| memo | String | Memo added to the item by the Network |
| offer_id | Nullable Integer | The ID of the Offer to which this item is attributed. Present when the "type" is "stats". |
| offer_name | Nullable String | The name of the Offer this item relates to (see: "offer_id") |
| offer_is_visible | Boolean | Whether or not the Affiliate currently has access to view the referenced Offer. This may not be true if the Offer has since expired or been deleted. |
| payout_type | String | The payout type of the Offer (or the Goal if present) if the "type" is "stats", or the adjustment type if the "type" is "adjustment". For types other than "stats" set to "amount".Show Supported Values |
| type | String | Type of invoice item. "stats" indicates this is for clicks/conversions/impressions (depending on "payout_type"). "adjustment" is for an adjustment, "referrals" are for referrals, and "vat" is for VAT/tax items.Show Supported Values |
| vat_code | Nullable String | id of VAT code objectentified by the Network. Only applicable if "type" is "vat". |
| vat_id | Nullable Integer | An arbitrary, unique ID generated to identify this VAT rate in the Network. Only applicable if "type" is "vat". |
| vat_name | Nullable String | A Network-defined name for this VAT rate. Only applicable if "type" is "vat". |
| vat_rate | Nullable Decimal | The Network-specified VAT rate being used to calculate tax, as a percentage (e.g. 15.00). Only applicable if "type" is "vat". |