aws-sdk-invoicing 1.6.0 → 1.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -28,6 +28,35 @@ module Aws::Invoicing
28
28
  include Aws::Structure
29
29
  end
30
30
 
31
+ # Details about how the total amount was calculated and categorized.
32
+ #
33
+ # @!attribute [rw] sub_total_amount
34
+ # The total of a set of the breakdown.
35
+ # @return [String]
36
+ #
37
+ # @!attribute [rw] discounts
38
+ # The discounted amount.
39
+ # @return [Types::DiscountsBreakdown]
40
+ #
41
+ # @!attribute [rw] taxes
42
+ # The tax amount.
43
+ # @return [Types::TaxesBreakdown]
44
+ #
45
+ # @!attribute [rw] fees
46
+ # The fee amount.
47
+ # @return [Types::FeesBreakdown]
48
+ #
49
+ # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/AmountBreakdown AWS API Documentation
50
+ #
51
+ class AmountBreakdown < Struct.new(
52
+ :sub_total_amount,
53
+ :discounts,
54
+ :taxes,
55
+ :fees)
56
+ SENSITIVE = []
57
+ include Aws::Structure
58
+ end
59
+
31
60
  # @!attribute [rw] account_ids
32
61
  # Retrieves the corresponding invoice profile data for these account
33
62
  # IDs.
@@ -53,6 +82,26 @@ module Aws::Invoicing
53
82
  include Aws::Structure
54
83
  end
55
84
 
85
+ # The billing period for which you want to retrieve invoice-related
86
+ # documents.
87
+ #
88
+ # @!attribute [rw] month
89
+ # The billing period month.
90
+ # @return [Integer]
91
+ #
92
+ # @!attribute [rw] year
93
+ # The billing period year.
94
+ # @return [Integer]
95
+ #
96
+ # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/BillingPeriod AWS API Documentation
97
+ #
98
+ class BillingPeriod < Struct.new(
99
+ :month,
100
+ :year)
101
+ SENSITIVE = []
102
+ include Aws::Structure
103
+ end
104
+
56
105
  # @!attribute [rw] name
57
106
  # The unique name of the invoice unit that is shown on the generated
58
107
  # invoice. This can't be changed once it is set. To change this name,
@@ -109,6 +158,56 @@ module Aws::Invoicing
109
158
  include Aws::Structure
110
159
  end
111
160
 
161
+ # The details of currency exchange.
162
+ #
163
+ # @!attribute [rw] source_currency_code
164
+ # The exchange source currency.
165
+ # @return [String]
166
+ #
167
+ # @!attribute [rw] target_currency_code
168
+ # The exchange target currency.
169
+ # @return [String]
170
+ #
171
+ # @!attribute [rw] rate
172
+ # The currency exchange rate.
173
+ # @return [String]
174
+ #
175
+ # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/CurrencyExchangeDetails AWS API Documentation
176
+ #
177
+ class CurrencyExchangeDetails < Struct.new(
178
+ :source_currency_code,
179
+ :target_currency_code,
180
+ :rate)
181
+ SENSITIVE = []
182
+ include Aws::Structure
183
+ end
184
+
185
+ # The time period that you want invoice-related documents for.
186
+ #
187
+ # @!attribute [rw] start_date
188
+ # The beginning of the time period that you want invoice-related
189
+ # documents for. The start date is inclusive. For example, if `start`
190
+ # is `2019-01-01`, AWS retrieves invoices starting at `2019-01-01` up
191
+ # to the end date.
192
+ # @return [Time]
193
+ #
194
+ # @!attribute [rw] end_date
195
+ # The end of the time period that you want invoice-related documents
196
+ # for. The end date is exclusive. For example, if `end` is
197
+ # `2019-01-10`, Amazon Web Services retrieves invoice-related
198
+ # documents from the start date up to, but not including,
199
+ # `2018-01-10`.
200
+ # @return [Time]
201
+ #
202
+ # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/DateInterval AWS API Documentation
203
+ #
204
+ class DateInterval < Struct.new(
205
+ :start_date,
206
+ :end_date)
207
+ SENSITIVE = []
208
+ include Aws::Structure
209
+ end
210
+
112
211
  # @!attribute [rw] invoice_unit_arn
113
212
  # The ARN to identify an invoice unit. This information can't be
114
213
  # modified or deleted.
@@ -135,6 +234,106 @@ module Aws::Invoicing
135
234
  include Aws::Structure
136
235
  end
137
236
 
237
+ # The discounts details.
238
+ #
239
+ # @!attribute [rw] breakdown
240
+ # The list of discounts information.
241
+ # @return [Array<Types::DiscountsBreakdownAmount>]
242
+ #
243
+ # @!attribute [rw] total_amount
244
+ # The discount's total amount.
245
+ # @return [String]
246
+ #
247
+ # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/DiscountsBreakdown AWS API Documentation
248
+ #
249
+ class DiscountsBreakdown < Struct.new(
250
+ :breakdown,
251
+ :total_amount)
252
+ SENSITIVE = []
253
+ include Aws::Structure
254
+ end
255
+
256
+ # The discounted amount.
257
+ #
258
+ # @!attribute [rw] description
259
+ # The list of discounts information.
260
+ # @return [String]
261
+ #
262
+ # @!attribute [rw] amount
263
+ # The discounted amount.
264
+ # @return [String]
265
+ #
266
+ # @!attribute [rw] rate
267
+ # The details for the discount rate..
268
+ # @return [String]
269
+ #
270
+ # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/DiscountsBreakdownAmount AWS API Documentation
271
+ #
272
+ class DiscountsBreakdownAmount < Struct.new(
273
+ :description,
274
+ :amount,
275
+ :rate)
276
+ SENSITIVE = []
277
+ include Aws::Structure
278
+ end
279
+
280
+ # The organization name providing Amazon Web Services services.
281
+ #
282
+ # @!attribute [rw] invoicing_entity
283
+ # The name of the entity that issues the Amazon Web Services invoice.
284
+ # @return [String]
285
+ #
286
+ # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/Entity AWS API Documentation
287
+ #
288
+ class Entity < Struct.new(
289
+ :invoicing_entity)
290
+ SENSITIVE = []
291
+ include Aws::Structure
292
+ end
293
+
294
+ # The details of fees.
295
+ #
296
+ # @!attribute [rw] breakdown
297
+ # The list of fees information.
298
+ # @return [Array<Types::FeesBreakdownAmount>]
299
+ #
300
+ # @!attribute [rw] total_amount
301
+ # The total amount of fees.
302
+ # @return [String]
303
+ #
304
+ # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/FeesBreakdown AWS API Documentation
305
+ #
306
+ class FeesBreakdown < Struct.new(
307
+ :breakdown,
308
+ :total_amount)
309
+ SENSITIVE = []
310
+ include Aws::Structure
311
+ end
312
+
313
+ # The fee amount.
314
+ #
315
+ # @!attribute [rw] description
316
+ # The list of fees information.
317
+ # @return [String]
318
+ #
319
+ # @!attribute [rw] amount
320
+ # The fee amount.
321
+ # @return [String]
322
+ #
323
+ # @!attribute [rw] rate
324
+ # Details about the rate amount.
325
+ # @return [String]
326
+ #
327
+ # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/FeesBreakdownAmount AWS API Documentation
328
+ #
329
+ class FeesBreakdownAmount < Struct.new(
330
+ :description,
331
+ :amount,
332
+ :rate)
333
+ SENSITIVE = []
334
+ include Aws::Structure
335
+ end
336
+
138
337
  # An optional input to the list API. If multiple filters are specified,
139
338
  # the returned list will be a configuration that match all of the
140
339
  # provided filters. Supported filter types are `InvoiceReceivers`,
@@ -266,6 +465,40 @@ module Aws::Invoicing
266
465
  include Aws::Structure
267
466
  end
268
467
 
468
+ # The amount charged after taxes, in the preferred currency.
469
+ #
470
+ # @!attribute [rw] total_amount
471
+ # The invoice currency amount.
472
+ # @return [String]
473
+ #
474
+ # @!attribute [rw] total_amount_before_tax
475
+ # Details about the invoice total amount before tax.
476
+ # @return [String]
477
+ #
478
+ # @!attribute [rw] currency_code
479
+ # The currency dominion of the invoice document.
480
+ # @return [String]
481
+ #
482
+ # @!attribute [rw] amount_breakdown
483
+ # Details about the invoice currency amount.
484
+ # @return [Types::AmountBreakdown]
485
+ #
486
+ # @!attribute [rw] currency_exchange_details
487
+ # The details of currency exchange.
488
+ # @return [Types::CurrencyExchangeDetails]
489
+ #
490
+ # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/InvoiceCurrencyAmount AWS API Documentation
491
+ #
492
+ class InvoiceCurrencyAmount < Struct.new(
493
+ :total_amount,
494
+ :total_amount_before_tax,
495
+ :currency_code,
496
+ :amount_breakdown,
497
+ :currency_exchange_details)
498
+ SENSITIVE = []
499
+ include Aws::Structure
500
+ end
501
+
269
502
  # Contains high-level information about the invoice receiver.
270
503
  #
271
504
  # @!attribute [rw] account_id
@@ -305,6 +538,118 @@ module Aws::Invoicing
305
538
  include Aws::Structure
306
539
  end
307
540
 
541
+ # Filters for your invoice summaries.
542
+ #
543
+ # @!attribute [rw] time_interval
544
+ # The date range for invoice summary retrieval.
545
+ # @return [Types::DateInterval]
546
+ #
547
+ # @!attribute [rw] billing_period
548
+ # The billing period associated with the invoice documents.
549
+ # @return [Types::BillingPeriod]
550
+ #
551
+ # @!attribute [rw] invoicing_entity
552
+ # The name of the entity that issues the Amazon Web Services invoice.
553
+ # @return [String]
554
+ #
555
+ # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/InvoiceSummariesFilter AWS API Documentation
556
+ #
557
+ class InvoiceSummariesFilter < Struct.new(
558
+ :time_interval,
559
+ :billing_period,
560
+ :invoicing_entity)
561
+ SENSITIVE = []
562
+ include Aws::Structure
563
+ end
564
+
565
+ # Specifies the invoice summary.
566
+ #
567
+ # @!attribute [rw] resource_type
568
+ # The query identifier type (`INVOICE_ID` or `ACCOUNT_ID`).
569
+ # @return [String]
570
+ #
571
+ # @!attribute [rw] value
572
+ # The value of the query identifier.
573
+ # @return [String]
574
+ #
575
+ # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/InvoiceSummariesSelector AWS API Documentation
576
+ #
577
+ class InvoiceSummariesSelector < Struct.new(
578
+ :resource_type,
579
+ :value)
580
+ SENSITIVE = []
581
+ include Aws::Structure
582
+ end
583
+
584
+ # The invoice that the API retrieved.
585
+ #
586
+ # @!attribute [rw] account_id
587
+ # The Amazon Web Services account ID.
588
+ # @return [String]
589
+ #
590
+ # @!attribute [rw] invoice_id
591
+ # The invoice ID.
592
+ # @return [String]
593
+ #
594
+ # @!attribute [rw] issued_date
595
+ # The issued date of the invoice.
596
+ # @return [Time]
597
+ #
598
+ # @!attribute [rw] due_date
599
+ # The invoice due date.
600
+ # @return [Time]
601
+ #
602
+ # @!attribute [rw] entity
603
+ # The organization name providing Amazon Web Services services.
604
+ # @return [Types::Entity]
605
+ #
606
+ # @!attribute [rw] billing_period
607
+ # The billing period of the invoice-related document.
608
+ # @return [Types::BillingPeriod]
609
+ #
610
+ # @!attribute [rw] invoice_type
611
+ # The type of invoice.
612
+ # @return [String]
613
+ #
614
+ # @!attribute [rw] original_invoice_id
615
+ # The initial or original invoice ID.
616
+ # @return [String]
617
+ #
618
+ # @!attribute [rw] purchase_order_number
619
+ # The purchase order number associated to the invoice.
620
+ # @return [String]
621
+ #
622
+ # @!attribute [rw] base_currency_amount
623
+ # The summary with the product and service currency.
624
+ # @return [Types::InvoiceCurrencyAmount]
625
+ #
626
+ # @!attribute [rw] tax_currency_amount
627
+ # The summary with the tax currency.
628
+ # @return [Types::InvoiceCurrencyAmount]
629
+ #
630
+ # @!attribute [rw] payment_currency_amount
631
+ # The summary with the customer configured currency.
632
+ # @return [Types::InvoiceCurrencyAmount]
633
+ #
634
+ # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/InvoiceSummary AWS API Documentation
635
+ #
636
+ class InvoiceSummary < Struct.new(
637
+ :account_id,
638
+ :invoice_id,
639
+ :issued_date,
640
+ :due_date,
641
+ :entity,
642
+ :billing_period,
643
+ :invoice_type,
644
+ :original_invoice_id,
645
+ :purchase_order_number,
646
+ :base_currency_amount,
647
+ :tax_currency_amount,
648
+ :payment_currency_amount)
649
+ SENSITIVE = []
650
+ include Aws::Structure
651
+ end
652
+
308
653
  # An invoice unit is a set of mutually exclusive accounts that
309
654
  # correspond to your business entity. Invoice units allow you separate
310
655
  # Amazon Web Services account costs and configures your invoice for each
@@ -375,6 +720,58 @@ module Aws::Invoicing
375
720
  include Aws::Structure
376
721
  end
377
722
 
723
+ # @!attribute [rw] selector
724
+ # The option to retrieve details for a specific invoice by providing
725
+ # its unique ID. Alternatively, access information for all invoices
726
+ # linked to the account by providing an account ID.
727
+ # @return [Types::InvoiceSummariesSelector]
728
+ #
729
+ # @!attribute [rw] filter
730
+ # Filters you can use to customize your invoice summary.
731
+ # @return [Types::InvoiceSummariesFilter]
732
+ #
733
+ # @!attribute [rw] next_token
734
+ # The token to retrieve the next set of results. Amazon Web Services
735
+ # provides the token when the response from a previous call has more
736
+ # results than the maximum page size.
737
+ # @return [String]
738
+ #
739
+ # @!attribute [rw] max_results
740
+ # The maximum number of invoice summaries a paginated response can
741
+ # contain.
742
+ # @return [Integer]
743
+ #
744
+ # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/ListInvoiceSummariesRequest AWS API Documentation
745
+ #
746
+ class ListInvoiceSummariesRequest < Struct.new(
747
+ :selector,
748
+ :filter,
749
+ :next_token,
750
+ :max_results)
751
+ SENSITIVE = []
752
+ include Aws::Structure
753
+ end
754
+
755
+ # @!attribute [rw] invoice_summaries
756
+ # List of key (summary level) invoice details without line item
757
+ # details.
758
+ # @return [Array<Types::InvoiceSummary>]
759
+ #
760
+ # @!attribute [rw] next_token
761
+ # The token to retrieve the next set of results. Amazon Web Services
762
+ # provides the token when the response from a previous call has more
763
+ # results than the maximum page size.
764
+ # @return [String]
765
+ #
766
+ # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/ListInvoiceSummariesResponse AWS API Documentation
767
+ #
768
+ class ListInvoiceSummariesResponse < Struct.new(
769
+ :invoice_summaries,
770
+ :next_token)
771
+ SENSITIVE = []
772
+ include Aws::Structure
773
+ end
774
+
378
775
  # @!attribute [rw] filters
379
776
  # An optional input to the list API. If multiple filters are
380
777
  # specified, the returned list will be a configuration that match all
@@ -579,6 +976,49 @@ module Aws::Invoicing
579
976
  #
580
977
  class TagResourceResponse < Aws::EmptyStructure; end
581
978
 
979
+ # The details of the taxes.
980
+ #
981
+ # @!attribute [rw] breakdown
982
+ # A list of tax information.
983
+ # @return [Array<Types::TaxesBreakdownAmount>]
984
+ #
985
+ # @!attribute [rw] total_amount
986
+ # The total amount for your taxes.
987
+ # @return [String]
988
+ #
989
+ # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/TaxesBreakdown AWS API Documentation
990
+ #
991
+ class TaxesBreakdown < Struct.new(
992
+ :breakdown,
993
+ :total_amount)
994
+ SENSITIVE = []
995
+ include Aws::Structure
996
+ end
997
+
998
+ # The tax amount.
999
+ #
1000
+ # @!attribute [rw] description
1001
+ # The details of the taxes.
1002
+ # @return [String]
1003
+ #
1004
+ # @!attribute [rw] amount
1005
+ # The tax amount.
1006
+ # @return [String]
1007
+ #
1008
+ # @!attribute [rw] rate
1009
+ # The details of the tax rate.
1010
+ # @return [String]
1011
+ #
1012
+ # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/TaxesBreakdownAmount AWS API Documentation
1013
+ #
1014
+ class TaxesBreakdownAmount < Struct.new(
1015
+ :description,
1016
+ :amount,
1017
+ :rate)
1018
+ SENSITIVE = []
1019
+ include Aws::Structure
1020
+ end
1021
+
582
1022
  # The request was denied due to request throttling.
583
1023
  #
584
1024
  # @!attribute [rw] message
@@ -55,7 +55,7 @@ module Aws::Invoicing
55
55
  autoload :EndpointProvider, 'aws-sdk-invoicing/endpoint_provider'
56
56
  autoload :Endpoints, 'aws-sdk-invoicing/endpoints'
57
57
 
58
- GEM_VERSION = '1.6.0'
58
+ GEM_VERSION = '1.8.0'
59
59
 
60
60
  end
61
61
 
data/sig/client.rbs CHANGED
@@ -18,6 +18,7 @@ module Aws
18
18
  ?account_id: String,
19
19
  ?active_endpoint_cache: bool,
20
20
  ?adaptive_retry_wait_to_fill: bool,
21
+ ?auth_scheme_preference: Array[String],
21
22
  ?client_side_monitoring: bool,
22
23
  ?client_side_monitoring_client_id: String,
23
24
  ?client_side_monitoring_host: String,
@@ -137,6 +138,33 @@ module Aws
137
138
  ) -> _GetInvoiceUnitResponseSuccess
138
139
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetInvoiceUnitResponseSuccess
139
140
 
141
+ interface _ListInvoiceSummariesResponseSuccess
142
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListInvoiceSummariesResponse]
143
+ def invoice_summaries: () -> ::Array[Types::InvoiceSummary]
144
+ def next_token: () -> ::String
145
+ end
146
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Invoicing/Client.html#list_invoice_summaries-instance_method
147
+ def list_invoice_summaries: (
148
+ selector: {
149
+ resource_type: ("ACCOUNT_ID" | "INVOICE_ID"),
150
+ value: ::String
151
+ },
152
+ ?filter: {
153
+ time_interval: {
154
+ start_date: ::Time,
155
+ end_date: ::Time
156
+ }?,
157
+ billing_period: {
158
+ month: ::Integer,
159
+ year: ::Integer
160
+ }?,
161
+ invoicing_entity: ::String?
162
+ },
163
+ ?next_token: ::String,
164
+ ?max_results: ::Integer
165
+ ) -> _ListInvoiceSummariesResponseSuccess
166
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListInvoiceSummariesResponseSuccess
167
+
140
168
  interface _ListInvoiceUnitsResponseSuccess
141
169
  include ::Seahorse::Client::_ResponseSuccess[Types::ListInvoiceUnitsResponse]
142
170
  def invoice_units: () -> ::Array[Types::InvoiceUnit]
data/sig/resource.rbs CHANGED
@@ -18,6 +18,7 @@ module Aws
18
18
  ?account_id: String,
19
19
  ?active_endpoint_cache: bool,
20
20
  ?adaptive_retry_wait_to_fill: bool,
21
+ ?auth_scheme_preference: Array[String],
21
22
  ?client_side_monitoring: bool,
22
23
  ?client_side_monitoring_client_id: String,
23
24
  ?client_side_monitoring_host: String,