Invoices

List All Invoices

get

Returns a list of partner invoices, with an option to filter by a creation date range.

Authorizations

basicAuth

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

Your unique Account SID.

Query parameters

StartDatestring · date-timeOptional

The start of the date range (ISO 8601) to filter invoices by their creation date.

EndDatestring · date-timeOptional

The end of the date range (ISO 8601) to filter invoices by their creation date.

Responses

200

A list of invoice objects.

application/json

get/Advertisers/{AccountSID}/Invoices

cURL

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

200

A list of invoice objects.

{
  "Invoices": [
    {
      "Id": "1299679-33",
      "CreatedDate": "2018-11-02T11:43:30-04:00",
      "MediaId": 1299679,
      "MediaName": "RoadRunner",
      "Currency": "USD",
      "TotalAmount": 65,
      "TotalVatAmount": 0,
      "LineItems": [
        {
          "CampaignId": 1000,
          "CampaignName": "Acme Online",
          "Description": "MEDIA_PAYOUT",
          "EventMonthYear": "92018",
          "Actions": 13,
          "NetItemAmount": 65,
          "VatItemAmount": 0,
          "TotalItemAmount": 65,
          "Status": "PAID",
          "DueDate": "2018-10-16T00:00:00-04:00",
          "PaidDate": "2018-10-16T00:35:47-04:00"
        }
      ],
      "DetailedLineItems": [
        {
          "AccountId": 1299679,
          "Name": "ACME Online",
          "ProgramId": 1000,
          "ProgramName": "ACME Online",
          "EventMonthYear": "92018",
          "ActionAmount": 65,
          "OtherAmount": 0,
          "TotalAmount": 65
        }
      ],
      "PDF": "/Advertisers/<AccountSID>/Invoices/1924609-1/Download",
      "Uri": "/Advertisers/<AccountSID>/Invoices/1924609-1"
    }
  ]
}

Retrieve an Invoice

get

Retrieves the details of a single, existing invoice by its unique ID.

Authorizations

basicAuth

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

Your unique Account SID.

InvoiceIdstringRequired

The unique identifier for the invoice.

Responses

200

A single invoice object.

application/json

IdstringOptional

The unique identifier for the invoice.

Example: 1299679-33

CreatedDatestring · date-timeOptional

The date and time the invoice was created.

Example: 2018-11-02T11:43:30-04:00

MediaIdintegerOptional

The unique identifier for the partner the invoice is for.

Example: 1299679

MediaNamestringOptional

The display name of the partner the invoice is for.

Example: RoadRunner

CurrencystringOptional

Three-letter ISO 4217 currency code for the invoice amounts.

Example: USD

TotalAmountnumber · decimalOptional

The total amount owed on the invoice.

Example: 65

TotalVatAmountnumber · decimalOptional

The total VAT amount on the invoice.

Example: 0

PDFstring · uri-referenceOptional

The URI to download the PDF for the invoice.

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

Uristring · uri-referenceOptional

The unique reference to this invoice in the impact.com API.

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

get/Advertisers/{AccountSID}/Invoices/{InvoiceId}

cURL

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

200

A single invoice object.

{
  "Id": "1299679-33",
  "CreatedDate": "2018-11-02T11:43:30-04:00",
  "MediaId": 1299679,
  "MediaName": "RoadRunner",
  "Currency": "USD",
  "TotalAmount": 65,
  "TotalVatAmount": 0,
  "LineItems": [
    {
      "CampaignId": 1000,
      "CampaignName": "Acme Online",
      "Description": "MEDIA_PAYOUT",
      "EventMonthYear": "92018",
      "Actions": 13,
      "NetItemAmount": 65,
      "VatItemAmount": 0,
      "TotalItemAmount": 65,
      "Status": "PAID",
      "DueDate": "2018-10-16T00:00:00-04:00",
      "PaidDate": "2018-10-16T00:35:47-04:00"
    }
  ],
  "DetailedLineItems": [
    {
      "AccountId": 1299679,
      "Name": "ACME Online",
      "ProgramId": 1000,
      "ProgramName": "ACME Online",
      "EventMonthYear": "92018",
      "ActionAmount": 65,
      "OtherAmount": 0,
      "TotalAmount": 65
    }
  ],
  "PDF": "/Advertisers/<AccountSID>/Invoices/1924609-1/Download",
  "Uri": "/Advertisers/<AccountSID>/Invoices/1924609-1"
}

Download Invoice PDF

get

Downloads the specified invoice as a PDF file.

Authorizations

basicAuth

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

Your unique Account SID.

InvoiceIdstringRequired

The unique identifier for the invoice to download.

Responses

200

The invoice in PDF format.

application/pdf

string · binaryOptional

get/Advertisers/{AccountSID}/Invoices/{InvoiceId}/Download

cURL

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

200

The invoice in PDF format.

binary