Campaign Manager 360 API . advertiserInvoices

close()

Close httplib2 connections.

list(profileId, advertiserId, issueMonth=None, maxResults=None, pageToken=None, x__xgafv=None)

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.

Args:
  profileId: string, User profile ID associated with this request. (required)
  advertiserId: string, Advertiser ID of this invoice. (required)
  issueMonth: string, Month for which invoices are needed in the format YYYYMM. Required field
  maxResults: integer, Maximum number of results to return.
  pageToken: string, Value of the nextPageToken from the previous result page.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Invoice List Response
  "invoices": [ # Invoice collection
    { # Contains information about a single invoice
      "campaign_summaries": [ # The list of summarized campaign information associated with this invoice.
        { # Represents a summarized campaign information associated with this invoice.
          "billingInvoiceCode": "A String", # Campaign billing invoice code.
          "campaignId": "A String", # Campaign ID.
          "preTaxAmountMicros": "A String", # The pre-tax amount for this campaign, in micros of the invoice's currency.
          "taxAmountMicros": "A String", # The tax amount for this campaign, in micros of the invoice's currency.
          "totalAmountMicros": "A String", # The total amount of charges for this campaign, in micros of the invoice's currency.
        },
      ],
      "correctedInvoiceId": "A String", # The originally issued invoice that is being adjusted by this invoice, if applicable. May appear on invoice PDF as *Reference invoice number*.
      "currencyCode": "A String", # Invoice currency code in ISO 4217 format.
      "dueDate": "A String", # The invoice due date.
      "id": "A String", # ID of this invoice.
      "invoiceType": "A String", # The type of invoice document.
      "issueDate": "A String", # The date when the invoice was issued.
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#invoice".
      "paymentsAccountId": "A String", # The ID of the payments account the invoice belongs to. Appears on the invoice PDF as *Billing Account Number*.
      "paymentsProfileId": "A String", # The ID of the payments profile the invoice belongs to. Appears on the invoice PDF as *Billing ID*.
      "pdfUrl": "A 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": "A String", # Purchase order number associated with the invoice.
      "replacedInvoiceIds": [ # 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.
        "A String",
      ],
      "serviceEndDate": "A String", # The invoice service end date.
      "serviceStartDate": "A String", # The invoice service start date.
      "subtotalAmountMicros": "A String", # The pre-tax subtotal amount, in micros of the invoice's currency.
      "totalAmountMicros": "A String", # The invoice total amount, in micros of the invoice's currency.
      "totalTaxAmountMicros": "A String", # The sum of all taxes in invoice, in micros of the invoice's currency.
    },
  ],
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserInvoicesListResponse".
  "nextPageToken": "A String", # Pagination token to be used for the next list operation.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.