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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
syntax = "proto3";
package google.ads.googleads.v10.resources;
import "google/ads/googleads/v10/common/dates.proto";
import "google/ads/googleads/v10/enums/invoice_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "InvoiceProto";
option java_package = "com.google.ads.googleads.v10.resources";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
// Proto file describing the Invoice resource.
// An invoice. All invoice information is snapshotted to match the PDF invoice.
// For invoices older than the launch of InvoiceService, the snapshotted
// information may not match the PDF invoice.
message Invoice {
option (google.api.resource) = {
type: "googleads.googleapis.com/Invoice"
pattern: "customers/{customer_id}/invoices/{invoice_id}"
};
// Represents a summarized account budget billable cost.
message AccountBudgetSummary {
// Output only. The resource name of the customer associated with this account budget.
// This contains the customer ID, which appears on the invoice PDF as
// "Account ID".
// Customer resource names have the form:
//
// `customers/{customer_id}`
optional string customer = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The descriptive name of the account budget's customer. It appears on the
// invoice PDF as "Account".
optional string customer_descriptive_name = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The resource name of the account budget associated with this summarized
// billable cost.
// AccountBudget resource names have the form:
//
// `customers/{customer_id}/accountBudgets/{account_budget_id}`
optional string account_budget = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The name of the account budget. It appears on the invoice PDF as "Account
// budget".
optional string account_budget_name = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The purchase order number of the account budget. It appears on the
// invoice PDF as "Purchase order".
optional string purchase_order_number = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The pretax subtotal amount attributable to this budget during the service
// period, in micros.
optional int64 subtotal_amount_micros = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The tax amount attributable to this budget during the service period, in
// micros.
optional int64 tax_amount_micros = 16 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The total amount attributable to this budget during the service period,
// in micros. This equals the sum of the account budget subtotal amount and
// the account budget tax amount.
optional int64 total_amount_micros = 17 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The billable activity date range of the account budget, within the
// service date range of this invoice. The end date is inclusive. This can
// be different from the account budget's start and end time.
google.ads.googleads.v10.common.DateRange billable_activity_date_range = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Output only. The resource name of the invoice. Multiple customers can share a given
// invoice, so multiple resource names may point to the same invoice.
// Invoice resource names have the form:
//
// `customers/{customer_id}/invoices/{invoice_id}`
string resource_name = 1 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.resource_reference) = {
type: "googleads.googleapis.com/Invoice"
}
];
// Output only. The ID of the invoice. It appears on the invoice PDF as "Invoice number".
optional string id = 25 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The type of invoice.
google.ads.googleads.v10.enums.InvoiceTypeEnum.InvoiceType type = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The resource name of this invoice's billing setup.
//
// `customers/{customer_id}/billingSetups/{billing_setup_id}`
optional string billing_setup = 26 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. A 16 digit ID used to identify the payments account associated with the
// billing setup, e.g. "1234-5678-9012-3456". It appears on the invoice PDF as
// "Billing Account Number".
optional string payments_account_id = 27 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. A 12 digit ID used to identify the payments profile associated with the
// billing setup, e.g. "1234-5678-9012". It appears on the invoice PDF as
// "Billing ID".
optional string payments_profile_id = 28 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The issue date in yyyy-mm-dd format. It appears on the invoice PDF as
// either "Issue date" or "Invoice date".
optional string issue_date = 29 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The due date in yyyy-mm-dd format.
optional string due_date = 30 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The service period date range of this invoice. The end date is inclusive.
google.ads.googleads.v10.common.DateRange service_date_range = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The currency code. All costs are returned in this currency. A subset of the
// currency codes derived from the ISO 4217 standard is supported.
optional string currency_code = 31 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The pretax subtotal amount of invoice level adjustments, in micros.
int64 adjustments_subtotal_amount_micros = 19 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The sum of taxes on the invoice level adjustments, in micros.
int64 adjustments_tax_amount_micros = 20 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The total amount of invoice level adjustments, in micros.
int64 adjustments_total_amount_micros = 21 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The pretax subtotal amount of invoice level regulatory costs, in micros.
int64 regulatory_costs_subtotal_amount_micros = 22 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The sum of taxes on the invoice level regulatory costs, in micros.
int64 regulatory_costs_tax_amount_micros = 23 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The total amount of invoice level regulatory costs, in micros.
int64 regulatory_costs_total_amount_micros = 24 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The pretax subtotal amount, in micros. This equals the
// sum of the AccountBudgetSummary subtotal amounts,
// Invoice.adjustments_subtotal_amount_micros, and
// Invoice.regulatory_costs_subtotal_amount_micros.
// Starting with v6, the Invoice.regulatory_costs_subtotal_amount_micros is no
// longer included.
optional int64 subtotal_amount_micros = 33 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The sum of all taxes on the invoice, in micros. This equals the sum of the
// AccountBudgetSummary tax amounts, plus taxes not associated with a specific
// account budget.
optional int64 tax_amount_micros = 34 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The total amount, in micros. This equals the sum of
// Invoice.subtotal_amount_micros and Invoice.tax_amount_micros.
// Starting with v6, Invoice.regulatory_costs_subtotal_amount_micros is
// also added as it is no longer already included in
// Invoice.tax_amount_micros.
optional int64 total_amount_micros = 35 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The resource name of the original invoice corrected, wrote off, or canceled
// by this invoice, if applicable. If `corrected_invoice` is set,
// `replaced_invoices` will not be set.
// Invoice resource names have the form:
//
// `customers/{customer_id}/invoices/{invoice_id}`
optional string corrected_invoice = 36 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The resource name of the original invoice(s) being rebilled or replaced by
// this invoice, if applicable. There might be multiple replaced invoices due
// to invoice consolidation. The replaced invoices may not belong to the same
// payments account. If `replaced_invoices` is set, `corrected_invoice` will
// not be set.
// Invoice resource names have the form:
//
// `customers/{customer_id}/invoices/{invoice_id}`
repeated string replaced_invoices = 37 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The URL to a PDF copy of the invoice. Users need to pass in their OAuth
// token to request the PDF with this URL.
optional string pdf_url = 38 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The list of summarized account budget information associated with this
// invoice.
repeated AccountBudgetSummary account_budget_summaries = 18 [(google.api.field_behavior) = OUTPUT_ONLY];
}
|
