Debian Codegraph @

docs/dyn/content_v2_1.settlementreports.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="content_v2_1.html">Content API for Shopping</a> . <a href="content_v2_1.settlementreports.html">settlementreports</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#get">get(merchantId, settlementId, x__xgafv=None)</a></code></p>
82 <p class="firstline">Retrieves a settlement report from your Merchant Center account.</p>
83 <p class="toc_element">
84 <code><a href="#list">list(merchantId, maxResults=None, pageToken=None, transferEndDate=None, transferStartDate=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Retrieves a list of settlement reports from your Merchant Center account.</p>
86 <p class="toc_element">
87 <code><a href="#list_next">list_next()</a></code></p>
88 <p class="firstline">Retrieves the next page of results.</p>
89 <h3>Method Details</h3>
90 <div class="method">
91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93 </div>
94
95 <div class="method">
96 <code class="details" id="get">get(merchantId, settlementId, x__xgafv=None)</code>
97 <pre>Retrieves a settlement report from your Merchant Center account.
98
99 Args:
100 merchantId: string, The Merchant Center account of the settlement report. (required)
101 settlementId: string, The Google-provided ID of the settlement. (required)
102 x__xgafv: string, V1 error format.
103 Allowed values
104 1 - v1 error format
105 2 - v2 error format
106
107 Returns:
108 An object of the form:
109
110 { # Settlement reports detail order-level and item-level credits and debits between you and Google.
111 &quot;endDate&quot;: &quot;A String&quot;, # The end date on which all transactions are included in the report, in ISO 8601 format.
112 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#settlementReport`&quot;
113 &quot;previousBalance&quot;: { # The residual amount from the previous invoice. This is set only if the previous invoices are not paid because of negative balance.
114 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
115 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
116 },
117 &quot;settlementId&quot;: &quot;A String&quot;, # The ID of the settlement report.
118 &quot;startDate&quot;: &quot;A String&quot;, # The start date on which all transactions are included in the report, in ISO 8601 format.
119 &quot;transferAmount&quot;: { # The money due to the merchant.
120 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
121 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
122 },
123 &quot;transferDate&quot;: &quot;A String&quot;, # Date on which transfer for this payment was initiated by Google, in ISO 8601 format.
124 &quot;transferIds&quot;: [ # The list of bank identifiers used for the transfer. For example, Trace ID for Federal Automated Clearing House (ACH). This may also be known as the Wire ID.
125 &quot;A String&quot;,
126 ],
127 }</pre>
128 </div>
129
130 <div class="method">
131 <code class="details" id="list">list(merchantId, maxResults=None, pageToken=None, transferEndDate=None, transferStartDate=None, x__xgafv=None)</code>
132 <pre>Retrieves a list of settlement reports from your Merchant Center account.
133
134 Args:
135 merchantId: string, The Merchant Center account to list settlements for. (required)
136 maxResults: integer, The maximum number of settlements to return in the response, used for paging. The default value is 200 returns per page, and the maximum allowed value is 5000 returns per page.
137 pageToken: string, The token returned by the previous request.
138 transferEndDate: string, Obtains settlements which have transactions before this date (inclusively), in ISO 8601 format.
139 transferStartDate: string, Obtains settlements which have transactions after this date (inclusively), in ISO 8601 format.
140 x__xgafv: string, V1 error format.
141 Allowed values
142 1 - v1 error format
143 2 - v2 error format
144
145 Returns:
146 An object of the form:
147
148 {
149 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#settlementreportsListResponse`&quot;.
150 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token for the retrieval of the next page of returns.
151 &quot;resources&quot;: [
152 { # Settlement reports detail order-level and item-level credits and debits between you and Google.
153 &quot;endDate&quot;: &quot;A String&quot;, # The end date on which all transactions are included in the report, in ISO 8601 format.
154 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#settlementReport`&quot;
155 &quot;previousBalance&quot;: { # The residual amount from the previous invoice. This is set only if the previous invoices are not paid because of negative balance.
156 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
157 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
158 },
159 &quot;settlementId&quot;: &quot;A String&quot;, # The ID of the settlement report.
160 &quot;startDate&quot;: &quot;A String&quot;, # The start date on which all transactions are included in the report, in ISO 8601 format.
161 &quot;transferAmount&quot;: { # The money due to the merchant.
162 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
163 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
164 },
165 &quot;transferDate&quot;: &quot;A String&quot;, # Date on which transfer for this payment was initiated by Google, in ISO 8601 format.
166 &quot;transferIds&quot;: [ # The list of bank identifiers used for the transfer. For example, Trace ID for Federal Automated Clearing House (ACH). This may also be known as the Wire ID.
167 &quot;A String&quot;,
168 ],
169 },
170 ],
171 }</pre>
172 </div>
173
174 <div class="method">
175 <code class="details" id="list_next">list_next()</code>
176 <pre>Retrieves the next page of results.
177
178 Args:
179 previous_request: The request for the previous page. (required)
180 previous_response: The response from the request for the previous page. (required)
181
182 Returns:
183 A request object that you can call &#x27;execute()&#x27; on to request the next
184 page. Returns None if there are no more items in the collection.
185 </pre>
186 </div>
187
188 </body></html>