Invoices

Endpoints for listing, retrieving, and downloading partner invoices.

List all invoices

get

Returns a list of invoices. The transactions are returned in sorted order, with the most recent transactions appearing first. Date range parameters can be used for filtering.

Authorizations

basicAuth

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

Query parameters

StartDatestring · date-timeOptional

Filters to show invoices created on or after this date.

EndDatestring · date-timeOptional

Filters to show invoices created on or before this date.

Responses

200

OK

application/json

get/Mediapartners/{AccountSID}/Invoices

curl

curl -L \
  --url 'https://api.impact.com/Mediapartners/{AccountSID}/Invoices' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

200

OK

{
  "Invoices": [
    {
      "Id": "1924609-1",
      "CreatedDate": "2024-09-02T07:37:12-07:00",
      "RecipientId": 1804207,
      "RecipientName": "Acme Corporation",
      "Currency": "USD",
      "TotalAmount": 50,
      "TotalVatAmount": 0,
      "LineItems": [
        {
          "CampaignId": "10306",
          "CampaignName": "Wayne Enterprises",
          "Description": "MEDIA_PAYOUT",
          "EventMonthYear": "12021",
          "Actions": "5",
          "NetItemAmount": 50,
          "VatItemAmount": 0,
          "TotalItemAmount": 50,
          "Status": "OVERDUE",
          "DueDate": "2021-02-05T17:51:35-08:00",
          "PaidDate": "2024-10-01T00:00:00-07:00"
        }
      ],
      "DetailedLineItems": [
        {
          "AccountId": 1804207,
          "Name": "Acme Corporation",
          "ProgramId": "10306",
          "ProgramName": "Wayne Enterprises",
          "EventMonthYear": "12021",
          "ActionAmount": "48.00",
          "OtherAmount": "2.00",
          "TotalAmount": "50.00"
        }
      ],
      "PDF": "/Mediapartners/<AccountSID>/Invoices/1924609-1/Download",
      "Uri": "/Mediapartners/<AccountSID>/Invoices/1924609-1"
    }
  ]
}

Retrieve an invoice

get

Retrieves the object of an existing invoice using the Invoice Id.

Authorizations

basicAuth

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

IdstringRequired

Unique identifier for the invoice.

Responses

200

OK

application/json

IdstringOptional

Unique identifier for the invoice.

Example: 1924609-1

CreatedDatestring · date-timeOptional

Date and time the invoice was created (ISO 8601).

Example: 2024-09-02T07:37:12-07:00

RecipientIdintegerOptional

Unique identifier of the invoice recipient.

Example: 1804207

RecipientNamestringOptional

Display name of the invoice recipient.

Example: Acme Corporation

CurrencystringOptional

Three-letter ISO 4217 currency code.

Example: USD

TotalAmountnumber · decimalOptional

Total amount due to the partner in this invoice.

Example: 50

TotalVatAmountnumber · decimalOptional

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

Example: 0

PDFstringOptional

API resource path to download the invoice as a PDF.

Example: /Mediapartners/<AccountSID>/Invoices/1924609-1/Download

UristringOptional

Unique reference to this invoice in the impact.com API.

Example: /Mediapartners/<AccountSID>/Invoices/1924609-1

get/Mediapartners/{AccountSID}/Invoices/{Id}

curl

curl -L \
  --url 'https://api.impact.com/Mediapartners/{AccountSID}/Invoices/{Id}' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

200

OK

{
  "Id": "1924609-1",
  "CreatedDate": "2024-09-02T07:37:12-07:00",
  "RecipientId": 1804207,
  "RecipientName": "Acme Corporation",
  "Currency": "USD",
  "TotalAmount": 50,
  "TotalVatAmount": 0,
  "LineItems": [
    {
      "CampaignId": "10306",
      "CampaignName": "Wayne Enterprises",
      "Description": "MEDIA_PAYOUT",
      "EventMonthYear": "12021",
      "Actions": "5",
      "NetItemAmount": 50,
      "VatItemAmount": 0,
      "TotalItemAmount": 50,
      "Status": "OVERDUE",
      "DueDate": "2021-02-05T17:51:35-08:00",
      "PaidDate": "2024-10-01T00:00:00-07:00"
    }
  ],
  "DetailedLineItems": [
    {
      "AccountId": 1804207,
      "Name": "Acme Corporation",
      "ProgramId": "10306",
      "ProgramName": "Wayne Enterprises",
      "EventMonthYear": "12021",
      "ActionAmount": "48.00",
      "OtherAmount": "2.00",
      "TotalAmount": "50.00"
    }
  ],
  "PDF": "/Mediapartners/<AccountSID>/Invoices/1924609-1/Download",
  "Uri": "/Mediapartners/<AccountSID>/Invoices/1924609-1"
}

Download an invoice

get

Returns the specified invoice as a downloaded file in PDF format.

Authorizations

basicAuth

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

IdstringRequired

Unique identifier for the invoice.

Responses

200

PDF File

application/pdf

string · binaryOptional

get/Mediapartners/{AccountSID}/Invoices/{Id}/Download

curl

curl -L \
  --url 'https://api.impact.com/Mediapartners/{AccountSID}/Invoices/{Id}/Download' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

200

PDF File

binary