---
title: "GET /userprofiles/{userprofilesId}/advertisers/{advertisersId}/invoices"
method: GET
path: "/userprofiles/{userprofilesId}/advertisers/{advertisersId}/invoices"
tags: ["advertiserInvoices"]
---

# GET /userprofiles/{userprofilesId}/advertisers/{advertisersId}/invoices

`GET /userprofiles/{userprofilesId}/advertisers/{advertisersId}/invoices`

## Request

- Base URL: `https://dfareporting.googleapis.com/dfareporting/v5`
- URL: `https://dfareporting.googleapis.com/dfareporting/v5/userprofiles/{userprofilesId}/advertisers/{advertisersId}/invoices`
- Auth: OAuth 2 and OAuth 2
  - Implicit: `https://accounts.google.com/o/oauth2/auth`
  - Scopes: `https://www.googleapis.com/auth/dfatrafficking`
  - Authorization code: `https://accounts.google.com/o/oauth2/auth`
  - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/dfatrafficking`
- TypeScript: <https://skmtc.dev/google/apis/dfareporting/docs/userprofiles/:userprofilesId/advertisers/:advertisersId/invoices/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a list of invoices for a particular issue month. The api only works if the billing profile invoice level is set to either advertiser or campaign non-consolidated invoice level.

## Path parameters

- `userprofilesId` string, required
- `advertisersId` string, required

## Query parameters

- `issueMonth` string
- `maxResults` integer
- `pageToken` string

## Response `200`

Successful response

- AdvertiserInvoicesListResponse: Invoice List Response
  - `invoices` Invoice[]: Invoice collection
    - `campaign_summaries` CampaignSummary[]: The list of summarized campaign information associated with this invoice.
      - `billingInvoiceCode` string: Campaign billing invoice code.
      - `campaignId` string, int64: Campaign ID.
      - `preTaxAmountMicros` string, int64: The pre-tax amount for this campaign, in micros of the invoice's currency.
      - `taxAmountMicros` string, int64: The tax amount for this campaign, in micros of the invoice's currency.
      - `totalAmountMicros` string, int64: The total amount of charges for this campaign, in micros of the invoice's currency.
    - `correctedInvoiceId` string: The originally issued invoice that is being adjusted by this invoice, if applicable. May appear on invoice PDF as *Reference invoice number*.
    - `currencyCode` string: Invoice currency code in ISO 4217 format.
    - `dueDate` string: The invoice due date.
    - `id` string: ID of this invoice.
    - `invoiceType` 'INVOICE_TYPE_UNSPECIFIED' | 'INVOICE_TYPE_CREDIT' | 'INVOICE_TYPE_INVOICE': The type of invoice document.
    - `issueDate` string: The date when the invoice was issued.
    - `kind` string: Identifies what kind of resource this is. Value: the fixed string "dfareporting#invoice".
    - `paymentsAccountId` string: The ID of the payments account the invoice belongs to. Appears on the invoice PDF as *Billing Account Number*.
    - `paymentsProfileId` string: The ID of the payments profile the invoice belongs to. Appears on the invoice PDF as *Billing ID*.
    - `pdfUrl` string: The URL to download a PDF copy of the invoice. Note that this URL is user specific and requires a valid OAuth 2.0 access token to access. The access token must be provided in an *Authorization: Bearer* HTTP header. The URL will only be usable for 7 days from when the api is called.
    - `purchaseOrderNumber` string: Purchase order number associated with the invoice.
    - `replacedInvoiceIds` string[]: The originally issued invoice(s) that is being cancelled by this invoice, if applicable. May appear on invoice PDF as *Replaced invoice numbers*. Note: There may be multiple replaced invoices due to consolidation of multiple invoices into a single invoice.
    - `serviceEndDate` string: The invoice service end date.
    - `serviceStartDate` string: The invoice service start date.
    - `subtotalAmountMicros` string, int64: The pre-tax subtotal amount, in micros of the invoice's currency.
    - `totalAmountMicros` string, int64: The invoice total amount, in micros of the invoice's currency.
    - `totalTaxAmountMicros` string, int64: The sum of all taxes in invoice, in micros of the invoice's currency.
  - `kind` string: Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserInvoicesListResponse".
  - `nextPageToken` string: Pagination token to be used for the next list operation.

---

[API](https://skmtc.dev/google/apis/dfareporting.md) - [All operations](https://skmtc.dev/google/apis/dfareporting/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/dfareporting/revisions/1a6f46a2467c?raw)