1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="dfareporting_v4.html">Campaign Manager 360 API</a> . <a href="dfareporting_v4.advertiserInvoices.html">advertiserInvoices</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#list">list(profileId, advertiserId, issueMonth=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">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.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="list">list(profileId, advertiserId, issueMonth=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>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.
</pre>
</div>
</body></html>
|
