# Models ## The Invoice object ```json {"openapi":"3.1.0","info":{"title":"Partner Invoices API","version":"16"},"components":{"schemas":{"Invoice":{"type":"object","properties":{"Id":{"type":"string","description":"Unique identifier for the invoice object."},"CreatedDate":{"type":"string","format":"date-time","description":"ISO 8601 format of the date and time when the invoice was created."},"RecipientId":{"type":"integer","description":"Unique identifier of the recipient of the invoice."},"RecipientName":{"type":"string","description":"The display name of the recipient of the invoice."},"Currency":{"type":"string","description":"Three-letter ISO 4217 currency code."},"TotalAmount":{"type":"string","format":"decimal","description":"The total amount due to the partner in the invoice."},"TotalVatAmount":{"type":"string","format":"decimal","description":"Value-added tax applied to the invoice, if any exists."},"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 or MM) and YYYY of when the events occurred (e.g., 42021)."},"Actions":{"type":"string","description":"The number of actions that relate to the payout. May be empty if not applicable."},"NetItemAmount":{"type":"string","format":"decimal","description":"Net payout amount for this line item before VAT."},"VatItemAmount":{"type":"string","format":"decimal","description":"VAT amount applied to this line item. May be empty if not applicable."},"TotalItemAmount":{"type":"string","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 or MM) and YYYY of when the events occurred (e.g., 42021)."},"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."}}}}}} ``` ## The LineItem object ```json {"openapi":"3.1.0","info":{"title":"Partner Invoices API","version":"16"},"components":{"schemas":{"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 or MM) and YYYY of when the events occurred (e.g., 42021)."},"Actions":{"type":"string","description":"The number of actions that relate to the payout. May be empty if not applicable."},"NetItemAmount":{"type":"string","format":"decimal","description":"Net payout amount for this line item before VAT."},"VatItemAmount":{"type":"string","format":"decimal","description":"VAT amount applied to this line item. May be empty if not applicable."},"TotalItemAmount":{"type":"string","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."}}}}}} ``` ## The DetailedLineItem object ```json {"openapi":"3.1.0","info":{"title":"Partner Invoices API","version":"16"},"components":{"schemas":{"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 or MM) and YYYY of when the events occurred (e.g., 42021)."},"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."}}}}}} ``` --- # Agent Instructions: 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: ``` GET https://integrations.impact.com/partner-api-reference/reference/invoices/models.md?ask= ``` The question should be specific, self-contained, and written in natural language. 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.