API Reference
Start typing to search…

The invoices object

Attributes

Id string

Unique identifier for the invoice object.

CreatedDate datetime

ISO 8601 format of the date and time when the invoice was created.

RecipientId integer

Unique identifier of the recipient of the invoice.

RecipientName string

The display name of the recipient of the invoice.

Currency currency

Three-letter ISO 4217 currency code for the currency of the payments detailed in the invoice.

TotalAmount decimal

The total amount due to the partner in the invoice.

TotalVatAmount decimal

Value-added tax applied to the invoice, if any exists.

LineItems object

Line items displayed in the invoice.

Show attributes

CampaignId integer

Unique identifier for the campaign (or program) for the line item.

CampaignName string

Display name for the campaign (or program) for the line item.

Description enum

This is the description for the type of payout, it can be either MEDIA_PAYOUT or BONUS.

Possible enum values
MEDIA_PAYOUTA standard payout for actions driven.
BONUSA bonus payout for meeting bonus requirements.

EventMonthYear string

Month (M or MM) and four-digit year (YYYY) of when the events that are being paid out occurred (e.g., April 2021 would be 42021).

Actions integer

The number of actions that relate to the payout.

NetItemAmount decimal

Cost of the line item before any applicable taxes.

VatItemAmount decimal

Amount of taxes levied on the payout amount.

TotalItemAmount decimal

The total amount of the line item, combining NetItemAmount and VatItemAmount.

Status enum

This is the payment status of the line item.

Possible enum values
PENDINGPayment for the line item is still pending.
PAIDLine item has already been paid for.
OVERDUEPayment for the line item is overdue.

DueDate datetime

ISO 8416 format of the date and time when payment for the line item is due.

PaidDate datetime

ISO 8416 format of the date and time when the line item was paid, if available.

DetailedLineItems array

Show attributes

AccountId integer

The unique identifier for the partner or media account.

Name string

The name of the partner or media account.

ProgramId integer

The unique identifier for the program.

ProgramName string

The name of the program.

EventMonthYear string

Month (M or MM) and four-digit year (YYYY) of when the events that are being paid out occurred (e.g., April 2021 would be 42021).

ActionAmount decimal

The total amount from actions during the event month.

OtherAmount decimal

Additional amount not tied to tracked actions (e.g., bonuses or adjustments).

TotalAmount decimal

The sum of actions and other amounts paid for the event month.

PDF string

Link to download the PDF for the invoice.

URI string

Unique identifier for the specific invoice in the impact.com API.

{
  "Id": "116142-1",
  "CreatedDate": "2019-03-02T06:46:04-08:00",
  "RecipientId": "469437",
  "RecipientName": "Wile E Coyote",
  "Currency": "USD",
  "TotalAmount": "25.50",
  "TotalVatAmount": "0.00",
  "LineItems": [
    {
      "CampaignId": "1234",
      "CampaignName": "ACME Ltd",
      "Description": "MEDIA_PAYOUT",
      "EventMonthYear": "22019",
      "Actions": "12",
      "NetItemAmount": "25.50",
      "VatItemAmount": "0.00",
      "TotalItemAmount": "25.50",
      "Status": "PAID",
      "DueDate": "2019-02-27T00:00:00-08:00",
      "PaidDate": "2019-02-27T00:15:43-08:00"
    }
  ],
  "DetailedLineItems": [
    {
      "AccountId": "1299679",
      "Name": "ACME Online",
      "ProgramId": "1000",
      "ProgramName": "ACME Online",
      "EventMonthYear": "92018",
      "ActionAmount": "65.00",
      "OtherAmount": "",
      "TotalAmount": "65.00"
    }
  ],
  "PDF": "/Mediapartners/IRjnYtzeHhaR116142yBQMg6n76dULQUn1/Invoices/116142-1/Download",
  "Uri": "/Mediapartners/IRjnYtzeHhaR116142yBQMg6n76dULQUn1/Invoices/116142-1"
}