- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Invoice
- InvoiceType
- CampaignSummary
- Try it!
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.
HTTP request
GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/advertisers/{advertiserId}/invoices
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
profile |
User profile ID associated with this request. |
advertiser |
Advertiser ID of this invoice. |
Query parameters
Parameters | |
---|---|
max |
Maximum number of results to return. |
issue |
Month for which invoices are needed in the format YYYYMM. Required field |
page |
Value of the
from the previous result page. |
Request body
The request body must be empty.
Response body
Invoice advertiserInvoices.list Response
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"kind": string,
"nextPageToken": string,
"invoices": [
{
object ( |
Fields | |
---|---|
kind |
Identifies what kind of resource this is. Value: the fixed string
. |
next |
Pagination token to be used for the next list operation. |
invoices[] |
Invoice collection |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/dfatrafficking
Invoice
Contains information about a single invoice
JSON representation |
---|
{ "id": string, "paymentsProfileId": string, "paymentsAccountId": string, "issueDate": string, "dueDate": string, "serviceStartDate": string, "serviceEndDate": string, "currencyCode": string, "subtotalAmountMicros": string, "totalTaxAmountMicros": string, "totalAmountMicros": string, "purchaseOrderNumber": string, "invoiceType": enum ( |
Fields | |
---|---|
id |
ID of this invoice. |
payments |
The ID of the payments profile the invoice belongs to. Appears on the invoice PDF as Billing ID. |
payments |
The ID of the payments account the invoice belongs to. Appears on the invoice PDF as Billing Account Number. |
issue |
The date when the invoice was issued. |
due |
The invoice due date. |
service |
The invoice service start date. |
service |
The invoice service end date. |
currency |
Invoice currency code in ISO 4217 format. |
subtotal |
The pre-tax subtotal amount, in micros of the invoice's currency. |
total |
The sum of all taxes in invoice, in micros of the invoice's currency. |
total |
The invoice total amount, in micros of the invoice's currency. |
purchase |
Purchase order number associated with the invoice. |
invoice |
The type of invoice document. |
corrected |
The originally issued invoice that is being adjusted by this invoice, if applicable. May appear on invoice PDF as Reference invoice number. |
replaced |
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. |
pdf |
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. |
campaign_ |
The list of summarized campaign information associated with this invoice. |
kind |
Identifies what kind of resource this is. Value: the fixed string
. |
InvoiceType
Enums | |
---|---|
INVOICE_TYPE_UNSPECIFIED |
|
INVOICE_TYPE_CREDIT |
|
INVOICE_TYPE_INVOICE |
CampaignSummary
Represents a summarized campaign information associated with this invoice.
JSON representation |
---|
{ "campaignId": string, "billingInvoiceCode": string, "preTaxAmountMicros": string, "taxAmountMicros": string, "totalAmountMicros": string } |
Fields | |
---|---|
campaign |
Campaign ID. |
billing |
Campaign billing invoice code. |
pre |
The pre-tax amount for this campaign, in micros of the invoice's currency. |
tax |
The tax amount for this campaign, in micros of the invoice's currency. |
total |
The total amount of charges for this campaign, in micros of the invoice's currency. |