Returns a list of invoices. The transactions are returned in sorted order, with the most recent transactions appearing first. Parameters can be used to create a date range to only list invoices that were created within the range.
Parameters
StartDate
optional
StartDate
optionalDate and time in ISO 8601 format that filters the list to only show invoices that were created on or after the specified date.
EndDate
optional
EndDate
optionalDate and time in ISO 8601 format that filters the list to only show invoices that were created on or before the specified date.
Returns
Returns an array of invoice objects up to a limit dictated by @pagesize
. Each entry in the array is a separate invoice. If no invoices meet the criteria, the resulting array will be empty. This request should never return an error.
Example request
curl 'https://api.impact.com/Mediapartners/<AccountSID>/Invoices' \
-X GET \
-u '<AccountSID>:<AuthToken>' \
-H 'Accept: application/json' \
-d 'StartDate=2021-01-01T00:00:00Z' \
-d 'EndDate=2021-01-31T00:00:00Z' \
-G
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": []
}
],
"PDF": "/Mediapartners/<AccountSID>/Invoices/1924609-1/Download",
"Uri": "/Mediapartners/AccountSID/Invoices/1924609-1"
}