> For the complete documentation index, see [llms.txt](https://integrations.impact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://integrations.impact.com/partner-api-reference/partner-v14/reference/invoices/invoices.md).
# Invoices
Endpoints for listing, retrieving, and downloading partner invoices.
## List all invoices
> 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.
```json
{"openapi":"3.1.0","info":{"title":"Partner Invoices API","version":"14"},"tags":[{"name":"Invoices","description":"Endpoints for listing, retrieving, and downloading partner invoices."}],"servers":[{"url":"https://api.impact.com"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"parameters":{"AccountSID":{"name":"AccountSID","in":"path","required":true,"schema":{"type":"string"},"description":"Unique identifier for the partner account."}},"schemas":{"Invoice":{"type":"object","properties":{"Id":{"type":"string","description":"Unique identifier for the invoice."},"CreatedDate":{"type":"string","format":"date-time","description":"Date and time the invoice was created (ISO 8601)."},"RecipientId":{"type":"integer","description":"Unique identifier of the invoice recipient."},"RecipientName":{"type":"string","description":"Display name of the invoice recipient."},"Currency":{"type":"string","description":"Three-letter ISO 4217 currency code."},"TotalAmount":{"type":"number","format":"decimal","description":"Total amount due to the partner in this invoice."},"TotalVatAmount":{"type":"number","format":"decimal","description":"Value-added tax applied to the invoice, if any."},"LineItems":{"type":"array","description":"List of line items summarising each payout component in the invoice.","items":{"$ref":"#/components/schemas/LineItem"}},"DetailedLineItems":{"type":"array","description":"Detailed breakdown of payout amounts per program within the invoice.","items":{"$ref":"#/components/schemas/DetailedLineItem"}},"PDF":{"type":"string","description":"API resource path to download the invoice as a PDF."},"Uri":{"type":"string","description":"Unique reference to this invoice in the impact.com API."}}},"LineItem":{"type":"object","properties":{"CampaignId":{"type":"string","description":"Unique identifier for the program associated with this line item."},"CampaignName":{"type":"string","description":"Display name of the program associated with this line item."},"Description":{"type":"string","enum":["MEDIA_PAYOUT","BONUS"],"description":"The type of payout. MEDIA_PAYOUT is a standard commission payout; BONUS is for meeting program requirements."},"EventMonthYear":{"type":"string","description":"Month (M/MM) and four-digit year (YYYY) of when the events occurred (e.g., 12021 = January 2021)."},"Actions":{"type":"string","description":"The number of actions that relate to this payout. May be empty if not applicable."},"NetItemAmount":{"type":"number","format":"decimal","description":"Net payout amount for this line item before VAT."},"VatItemAmount":{"type":"number","format":"decimal","description":"VAT amount applied to this line item. May be empty if not applicable."},"TotalItemAmount":{"type":"number","format":"decimal","description":"Total payout amount for this line item including VAT."},"Status":{"type":"string","enum":["PENDING","PAID","OVERDUE"],"description":"Payment status of this line item."},"DueDate":{"type":"string","format":"date-time","description":"Date and time payment is due for this line item (ISO 8601)."},"PaidDate":{"type":"string","format":"date-time","description":"Date and time this line item was paid (ISO 8601). Empty if not yet paid."}}},"DetailedLineItem":{"type":"object","properties":{"AccountId":{"type":"integer","description":"Unique identifier of the partner account associated with this payout."},"Name":{"type":"string","description":"Display name of the partner account associated with this payout."},"ProgramId":{"type":"string","description":"Unique identifier for the program associated with this payout."},"ProgramName":{"type":"string","description":"Display name of the program associated with this payout."},"EventMonthYear":{"type":"string","description":"Month (M/MM) and four-digit year (YYYY) of when the events occurred (e.g., 12021 = January 2021)."},"ActionAmount":{"type":"string","format":"decimal","description":"Amount attributable to tracked actions. May be empty if not applicable."},"OtherAmount":{"type":"string","format":"decimal","description":"Amount attributable to non-action payouts such as bonuses."},"TotalAmount":{"type":"string","format":"decimal","description":"Total payout amount for this detailed line item."}}}}},"paths":{"/Mediapartners/{AccountSID}/Invoices":{"get":{"operationId":"listInvoices","tags":["Invoices"],"summary":"List all invoices","description":"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.\n","parameters":[{"$ref":"#/components/parameters/AccountSID"},{"name":"StartDate","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"description":"Filters to show invoices created on or after this date."},{"name":"EndDate","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"description":"Filters to show invoices created on or before this date."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"Invoices":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}}}}}}}}}}}}
```
## Retrieve an invoice
> Retrieves the object of an existing invoice using the Invoice Id.
```json
{"openapi":"3.1.0","info":{"title":"Partner Invoices API","version":"14"},"tags":[{"name":"Invoices","description":"Endpoints for listing, retrieving, and downloading partner invoices."}],"servers":[{"url":"https://api.impact.com"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"parameters":{"AccountSID":{"name":"AccountSID","in":"path","required":true,"schema":{"type":"string"},"description":"Unique identifier for the partner account."},"InvoiceId":{"name":"Id","in":"path","required":true,"schema":{"type":"string"},"description":"Unique identifier for the invoice."}},"schemas":{"Invoice":{"type":"object","properties":{"Id":{"type":"string","description":"Unique identifier for the invoice."},"CreatedDate":{"type":"string","format":"date-time","description":"Date and time the invoice was created (ISO 8601)."},"RecipientId":{"type":"integer","description":"Unique identifier of the invoice recipient."},"RecipientName":{"type":"string","description":"Display name of the invoice recipient."},"Currency":{"type":"string","description":"Three-letter ISO 4217 currency code."},"TotalAmount":{"type":"number","format":"decimal","description":"Total amount due to the partner in this invoice."},"TotalVatAmount":{"type":"number","format":"decimal","description":"Value-added tax applied to the invoice, if any."},"LineItems":{"type":"array","description":"List of line items summarising each payout component in the invoice.","items":{"$ref":"#/components/schemas/LineItem"}},"DetailedLineItems":{"type":"array","description":"Detailed breakdown of payout amounts per program within the invoice.","items":{"$ref":"#/components/schemas/DetailedLineItem"}},"PDF":{"type":"string","description":"API resource path to download the invoice as a PDF."},"Uri":{"type":"string","description":"Unique reference to this invoice in the impact.com API."}}},"LineItem":{"type":"object","properties":{"CampaignId":{"type":"string","description":"Unique identifier for the program associated with this line item."},"CampaignName":{"type":"string","description":"Display name of the program associated with this line item."},"Description":{"type":"string","enum":["MEDIA_PAYOUT","BONUS"],"description":"The type of payout. MEDIA_PAYOUT is a standard commission payout; BONUS is for meeting program requirements."},"EventMonthYear":{"type":"string","description":"Month (M/MM) and four-digit year (YYYY) of when the events occurred (e.g., 12021 = January 2021)."},"Actions":{"type":"string","description":"The number of actions that relate to this payout. May be empty if not applicable."},"NetItemAmount":{"type":"number","format":"decimal","description":"Net payout amount for this line item before VAT."},"VatItemAmount":{"type":"number","format":"decimal","description":"VAT amount applied to this line item. May be empty if not applicable."},"TotalItemAmount":{"type":"number","format":"decimal","description":"Total payout amount for this line item including VAT."},"Status":{"type":"string","enum":["PENDING","PAID","OVERDUE"],"description":"Payment status of this line item."},"DueDate":{"type":"string","format":"date-time","description":"Date and time payment is due for this line item (ISO 8601)."},"PaidDate":{"type":"string","format":"date-time","description":"Date and time this line item was paid (ISO 8601). Empty if not yet paid."}}},"DetailedLineItem":{"type":"object","properties":{"AccountId":{"type":"integer","description":"Unique identifier of the partner account associated with this payout."},"Name":{"type":"string","description":"Display name of the partner account associated with this payout."},"ProgramId":{"type":"string","description":"Unique identifier for the program associated with this payout."},"ProgramName":{"type":"string","description":"Display name of the program associated with this payout."},"EventMonthYear":{"type":"string","description":"Month (M/MM) and four-digit year (YYYY) of when the events occurred (e.g., 12021 = January 2021)."},"ActionAmount":{"type":"string","format":"decimal","description":"Amount attributable to tracked actions. May be empty if not applicable."},"OtherAmount":{"type":"string","format":"decimal","description":"Amount attributable to non-action payouts such as bonuses."},"TotalAmount":{"type":"string","format":"decimal","description":"Total payout amount for this detailed line item."}}}}},"paths":{"/Mediapartners/{AccountSID}/Invoices/{Id}":{"get":{"operationId":"retrieveInvoice","tags":["Invoices"],"summary":"Retrieve an invoice","description":"Retrieves the object of an existing invoice using the Invoice Id.","parameters":[{"$ref":"#/components/parameters/AccountSID"},{"$ref":"#/components/parameters/InvoiceId"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}}}}}}}}
```
## Download an invoice
> Returns the specified invoice as a downloaded file in PDF format.
```json
{"openapi":"3.1.0","info":{"title":"Partner Invoices API","version":"14"},"tags":[{"name":"Invoices","description":"Endpoints for listing, retrieving, and downloading partner invoices."}],"servers":[{"url":"https://api.impact.com"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"parameters":{"AccountSID":{"name":"AccountSID","in":"path","required":true,"schema":{"type":"string"},"description":"Unique identifier for the partner account."},"InvoiceId":{"name":"Id","in":"path","required":true,"schema":{"type":"string"},"description":"Unique identifier for the invoice."}}},"paths":{"/Mediapartners/{AccountSID}/Invoices/{Id}/Download":{"get":{"operationId":"downloadInvoice","tags":["Invoices"],"summary":"Download an invoice","description":"Returns the specified invoice as a downloaded file in PDF format.","parameters":[{"$ref":"#/components/parameters/AccountSID"},{"$ref":"#/components/parameters/InvoiceId"}],"responses":{"200":{"description":"PDF File","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://integrations.impact.com/partner-api-reference/partner-v14/reference/invoices/invoices.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.