API Reference

Retrieve invoices

This request allows you to retrieve an invoice from both impact.com's invoicing methods.

Parameters

There are no parameters.

Returns

Returns an The invoice object if a valid invoice number was provided.

Example request

curl 'https://api.impact.com/Mediapartners/<AccountSID>/Invoices/<InvoiceNumber>' \
  -X GET \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json'

Example response

{
  "Id": "1924609-1",
  "CreatedDate": "2021-03-02T05: 18: 54-08: 00",
  "RecipientId": "1804207",
  "RecipientName": "ACME Ltd",
  "Currency": "USD",
  "TotalAmount": "50.00",
  "TotalVatAmount": "",
  "LineItems": [ 
        {
        "CampaignId": "12345",
        "CampaignName": "ACME Ltd",
        "Description": "MEDIA_PAYOUT",
        "EventMonthYear": "12021",
        "Actions": "",
        "NetItemAmount": "50.00",
        "VatItemAmount": "",
        "TotalItemAmount": "50.00",
        "Status": "OVERDUE",
        "DueDate": "2021-02-05T17: 51: 35-08: 00",
        "PaidDate": ""
        }
  ],
  "DetailedLineItems": [
    {
        "AccountId": "1234567",
        "Name": "ACME Ltd",
        "ProgramId": "12345",
        "ProgramName": "ACME Ltd",
        "EventMonthYear": "12021",
        "ActionAmount": "50.00",
        "OtherAmount": "",
        "TotalAmount": "50.00",
    }
  ],
  "PDF": "/Mediapartners/<AccountSID>/Invoices/1924609-1/Download",
  "Uri": "/Mediapartners/<AccountSID>/Invoices/1924609-1"
}