aws-sdk-invoicing 1.6.0 → 1.7.0

data/lib/aws-sdk-invoicing/types.rb

@@ -28,6 +28,35 @@ module Aws::Invoicing
       include Aws::Structure
     end
 
+    # Details about how the total amount was calculated and categorized.
+    #
+    # @!attribute [rw] sub_total_amount
+    #   The total of a set of the breakdown.
+    #   @return [String]
+    #
+    # @!attribute [rw] discounts
+    #   The discounted amount.
+    #   @return [Types::DiscountsBreakdown]
+    #
+    # @!attribute [rw] taxes
+    #   The tax amount.
+    #   @return [Types::TaxesBreakdown]
+    #
+    # @!attribute [rw] fees
+    #   The fee amount.
+    #   @return [Types::FeesBreakdown]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/AmountBreakdown AWS API Documentation
+    #
+    class AmountBreakdown < Struct.new(
+      :sub_total_amount,
+      :discounts,
+      :taxes,
+      :fees)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] account_ids
     #   Retrieves the corresponding invoice profile data for these account
     #   IDs.
@@ -53,6 +82,26 @@ module Aws::Invoicing
       include Aws::Structure
     end
 
+    # The billing period for which you want to retrieve invoice-related
+    # documents.
+    #
+    # @!attribute [rw] month
+    #   The billing period month.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] year
+    #   The billing period year.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/BillingPeriod AWS API Documentation
+    #
+    class BillingPeriod < Struct.new(
+      :month,
+      :year)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] name
     #   The unique name of the invoice unit that is shown on the generated
     #   invoice. This can't be changed once it is set. To change this name,
@@ -109,6 +158,56 @@ module Aws::Invoicing
       include Aws::Structure
     end
 
+    # The details of currency exchange.
+    #
+    # @!attribute [rw] source_currency_code
+    #   The exchange source currency.
+    #   @return [String]
+    #
+    # @!attribute [rw] target_currency_code
+    #   The exchange target currency.
+    #   @return [String]
+    #
+    # @!attribute [rw] rate
+    #   The currency exchange rate.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/CurrencyExchangeDetails AWS API Documentation
+    #
+    class CurrencyExchangeDetails < Struct.new(
+      :source_currency_code,
+      :target_currency_code,
+      :rate)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The time period that you want invoice-related documents for.
+    #
+    # @!attribute [rw] start_date
+    #   The beginning of the time period that you want invoice-related
+    #   documents for. The start date is inclusive. For example, if `start`
+    #   is `2019-01-01`, AWS retrieves invoices starting at `2019-01-01` up
+    #   to the end date.
+    #   @return [Time]
+    #
+    # @!attribute [rw] end_date
+    #   The end of the time period that you want invoice-related documents
+    #   for. The end date is exclusive. For example, if `end` is
+    #   `2019-01-10`, Amazon Web Services retrieves invoice-related
+    #   documents from the start date up to, but not including,
+    #   `2018-01-10`.
+    #   @return [Time]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/DateInterval AWS API Documentation
+    #
+    class DateInterval < Struct.new(
+      :start_date,
+      :end_date)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] invoice_unit_arn
     #   The ARN to identify an invoice unit. This information can't be
     #   modified or deleted.
@@ -135,6 +234,106 @@ module Aws::Invoicing
       include Aws::Structure
     end
 
+    # The discounts details.
+    #
+    # @!attribute [rw] breakdown
+    #   The list of discounts information.
+    #   @return [Array<Types::DiscountsBreakdownAmount>]
+    #
+    # @!attribute [rw] total_amount
+    #   The discount's total amount.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/DiscountsBreakdown AWS API Documentation
+    #
+    class DiscountsBreakdown < Struct.new(
+      :breakdown,
+      :total_amount)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The discounted amount.
+    #
+    # @!attribute [rw] description
+    #   The list of discounts information.
+    #   @return [String]
+    #
+    # @!attribute [rw] amount
+    #   The discounted amount.
+    #   @return [String]
+    #
+    # @!attribute [rw] rate
+    #   The details for the discount rate..
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/DiscountsBreakdownAmount AWS API Documentation
+    #
+    class DiscountsBreakdownAmount < Struct.new(
+      :description,
+      :amount,
+      :rate)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The organization name providing Amazon Web Services services.
+    #
+    # @!attribute [rw] invoicing_entity
+    #   The name of the entity that issues the Amazon Web Services invoice.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/Entity AWS API Documentation
+    #
+    class Entity < Struct.new(
+      :invoicing_entity)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The details of fees.
+    #
+    # @!attribute [rw] breakdown
+    #   The list of fees information.
+    #   @return [Array<Types::FeesBreakdownAmount>]
+    #
+    # @!attribute [rw] total_amount
+    #   The total amount of fees.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/FeesBreakdown AWS API Documentation
+    #
+    class FeesBreakdown < Struct.new(
+      :breakdown,
+      :total_amount)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The fee amount.
+    #
+    # @!attribute [rw] description
+    #   The list of fees information.
+    #   @return [String]
+    #
+    # @!attribute [rw] amount
+    #   The fee amount.
+    #   @return [String]
+    #
+    # @!attribute [rw] rate
+    #   Details about the rate amount.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/FeesBreakdownAmount AWS API Documentation
+    #
+    class FeesBreakdownAmount < Struct.new(
+      :description,
+      :amount,
+      :rate)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # An optional input to the list API. If multiple filters are specified,
     # the returned list will be a configuration that match all of the
     # provided filters. Supported filter types are `InvoiceReceivers`,
@@ -266,6 +465,40 @@ module Aws::Invoicing
       include Aws::Structure
     end
 
+    # The amount charged after taxes, in the preferred currency.
+    #
+    # @!attribute [rw] total_amount
+    #   The invoice currency amount.
+    #   @return [String]
+    #
+    # @!attribute [rw] total_amount_before_tax
+    #   Details about the invoice total amount before tax.
+    #   @return [String]
+    #
+    # @!attribute [rw] currency_code
+    #   The currency dominion of the invoice document.
+    #   @return [String]
+    #
+    # @!attribute [rw] amount_breakdown
+    #   Details about the invoice currency amount.
+    #   @return [Types::AmountBreakdown]
+    #
+    # @!attribute [rw] currency_exchange_details
+    #   The details of currency exchange.
+    #   @return [Types::CurrencyExchangeDetails]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/InvoiceCurrencyAmount AWS API Documentation
+    #
+    class InvoiceCurrencyAmount < Struct.new(
+      :total_amount,
+      :total_amount_before_tax,
+      :currency_code,
+      :amount_breakdown,
+      :currency_exchange_details)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Contains high-level information about the invoice receiver.
     #
     # @!attribute [rw] account_id
@@ -305,6 +538,118 @@ module Aws::Invoicing
       include Aws::Structure
     end
 
+    # Filters for your invoice summaries.
+    #
+    # @!attribute [rw] time_interval
+    #   The date range for invoice summary retrieval.
+    #   @return [Types::DateInterval]
+    #
+    # @!attribute [rw] billing_period
+    #   The billing period associated with the invoice documents.
+    #   @return [Types::BillingPeriod]
+    #
+    # @!attribute [rw] invoicing_entity
+    #   The name of the entity that issues the Amazon Web Services invoice.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/InvoiceSummariesFilter AWS API Documentation
+    #
+    class InvoiceSummariesFilter < Struct.new(
+      :time_interval,
+      :billing_period,
+      :invoicing_entity)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Specifies the invoice summary.
+    #
+    # @!attribute [rw] resource_type
+    #   The query identifier type (`INVOICE_ID` or `ACCOUNT_ID`).
+    #   @return [String]
+    #
+    # @!attribute [rw] value
+    #   The value of the query identifier.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/InvoiceSummariesSelector AWS API Documentation
+    #
+    class InvoiceSummariesSelector < Struct.new(
+      :resource_type,
+      :value)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The invoice that the API retrieved.
+    #
+    # @!attribute [rw] account_id
+    #   The Amazon Web Services account ID.
+    #   @return [String]
+    #
+    # @!attribute [rw] invoice_id
+    #   The invoice ID.
+    #   @return [String]
+    #
+    # @!attribute [rw] issued_date
+    #   The issued date of the invoice.
+    #   @return [Time]
+    #
+    # @!attribute [rw] due_date
+    #   The invoice due date.
+    #   @return [Time]
+    #
+    # @!attribute [rw] entity
+    #   The organization name providing Amazon Web Services services.
+    #   @return [Types::Entity]
+    #
+    # @!attribute [rw] billing_period
+    #   The billing period of the invoice-related document.
+    #   @return [Types::BillingPeriod]
+    #
+    # @!attribute [rw] invoice_type
+    #   The type of invoice.
+    #   @return [String]
+    #
+    # @!attribute [rw] original_invoice_id
+    #   The initial or original invoice ID.
+    #   @return [String]
+    #
+    # @!attribute [rw] purchase_order_number
+    #   The purchase order number associated to the invoice.
+    #   @return [String]
+    #
+    # @!attribute [rw] base_currency_amount
+    #   The summary with the product and service currency.
+    #   @return [Types::InvoiceCurrencyAmount]
+    #
+    # @!attribute [rw] tax_currency_amount
+    #   The summary with the tax currency.
+    #   @return [Types::InvoiceCurrencyAmount]
+    #
+    # @!attribute [rw] payment_currency_amount
+    #   The summary with the customer configured currency.
+    #   @return [Types::InvoiceCurrencyAmount]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/InvoiceSummary AWS API Documentation
+    #
+    class InvoiceSummary < Struct.new(
+      :account_id,
+      :invoice_id,
+      :issued_date,
+      :due_date,
+      :entity,
+      :billing_period,
+      :invoice_type,
+      :original_invoice_id,
+      :purchase_order_number,
+      :base_currency_amount,
+      :tax_currency_amount,
+      :payment_currency_amount)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # An invoice unit is a set of mutually exclusive accounts that
     # correspond to your business entity. Invoice units allow you separate
     # Amazon Web Services account costs and configures your invoice for each
@@ -375,6 +720,58 @@ module Aws::Invoicing
       include Aws::Structure
     end
 
+    # @!attribute [rw] selector
+    #   The option to retrieve details for a specific invoice by providing
+    #   its unique ID. Alternatively, access information for all invoices
+    #   linked to the account by providing an account ID.
+    #   @return [Types::InvoiceSummariesSelector]
+    #
+    # @!attribute [rw] filter
+    #   Filters you can use to customize your invoice summary.
+    #   @return [Types::InvoiceSummariesFilter]
+    #
+    # @!attribute [rw] next_token
+    #   The token to retrieve the next set of results. Amazon Web Services
+    #   provides the token when the response from a previous call has more
+    #   results than the maximum page size.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of invoice summaries a paginated response can
+    #   contain.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/ListInvoiceSummariesRequest AWS API Documentation
+    #
+    class ListInvoiceSummariesRequest < Struct.new(
+      :selector,
+      :filter,
+      :next_token,
+      :max_results)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] invoice_summaries
+    #   List of key (summary level) invoice details without line item
+    #   details.
+    #   @return [Array<Types::InvoiceSummary>]
+    #
+    # @!attribute [rw] next_token
+    #   The token to retrieve the next set of results. Amazon Web Services
+    #   provides the token when the response from a previous call has more
+    #   results than the maximum page size.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/ListInvoiceSummariesResponse AWS API Documentation
+    #
+    class ListInvoiceSummariesResponse < Struct.new(
+      :invoice_summaries,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] filters
     #   An optional input to the list API. If multiple filters are
     #   specified, the returned list will be a configuration that match all
@@ -579,6 +976,49 @@ module Aws::Invoicing
     #
     class TagResourceResponse < Aws::EmptyStructure; end
 
+    # The details of the taxes.
+    #
+    # @!attribute [rw] breakdown
+    #   A list of tax information.
+    #   @return [Array<Types::TaxesBreakdownAmount>]
+    #
+    # @!attribute [rw] total_amount
+    #   The total amount for your taxes.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/TaxesBreakdown AWS API Documentation
+    #
+    class TaxesBreakdown < Struct.new(
+      :breakdown,
+      :total_amount)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The tax amount.
+    #
+    # @!attribute [rw] description
+    #   The details of the taxes.
+    #   @return [String]
+    #
+    # @!attribute [rw] amount
+    #   The tax amount.
+    #   @return [String]
+    #
+    # @!attribute [rw] rate
+    #   The details of the tax rate.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/TaxesBreakdownAmount AWS API Documentation
+    #
+    class TaxesBreakdownAmount < Struct.new(
+      :description,
+      :amount,
+      :rate)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The request was denied due to request throttling.
     #
     # @!attribute [rw] message

data/lib/aws-sdk-invoicing.rb

@@ -55,7 +55,7 @@ module Aws::Invoicing
   autoload :EndpointProvider, 'aws-sdk-invoicing/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-invoicing/endpoints'
 
-  GEM_VERSION = '1.6.0'
+  GEM_VERSION = '1.7.0'
 
 end
 

data/sig/client.rbs

@@ -137,6 +137,33 @@ module Aws
                             ) -> _GetInvoiceUnitResponseSuccess
                           | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetInvoiceUnitResponseSuccess
 
+      interface _ListInvoiceSummariesResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::ListInvoiceSummariesResponse]
+        def invoice_summaries: () -> ::Array[Types::InvoiceSummary]
+        def next_token: () -> ::String
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Invoicing/Client.html#list_invoice_summaries-instance_method
+      def list_invoice_summaries: (
+                                    selector: {
+                                      resource_type: ("ACCOUNT_ID" | "INVOICE_ID"),
+                                      value: ::String
+                                    },
+                                    ?filter: {
+                                      time_interval: {
+                                        start_date: ::Time,
+                                        end_date: ::Time
+                                      }?,
+                                      billing_period: {
+                                        month: ::Integer,
+                                        year: ::Integer
+                                      }?,
+                                      invoicing_entity: ::String?
+                                    },
+                                    ?next_token: ::String,
+                                    ?max_results: ::Integer
+                                  ) -> _ListInvoiceSummariesResponseSuccess
+                                | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListInvoiceSummariesResponseSuccess
+
       interface _ListInvoiceUnitsResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::ListInvoiceUnitsResponse]
         def invoice_units: () -> ::Array[Types::InvoiceUnit]

data/sig/types.rbs

@@ -14,6 +14,14 @@ module Aws::Invoicing
       SENSITIVE: []
     end
 
+    class AmountBreakdown
+      attr_accessor sub_total_amount: ::String
+      attr_accessor discounts: Types::DiscountsBreakdown
+      attr_accessor taxes: Types::TaxesBreakdown
+      attr_accessor fees: Types::FeesBreakdown
+      SENSITIVE: []
+    end
+
     class BatchGetInvoiceProfileRequest
       attr_accessor account_ids: ::Array[::String]
       SENSITIVE: []
@@ -24,6 +32,12 @@ module Aws::Invoicing
       SENSITIVE: []
     end
 
+    class BillingPeriod
+      attr_accessor month: ::Integer
+      attr_accessor year: ::Integer
+      SENSITIVE: []
+    end
+
     class CreateInvoiceUnitRequest
       attr_accessor name: ::String
       attr_accessor invoice_receiver: ::String
@@ -39,6 +53,19 @@ module Aws::Invoicing
       SENSITIVE: []
     end
 
+    class CurrencyExchangeDetails
+      attr_accessor source_currency_code: ::String
+      attr_accessor target_currency_code: ::String
+      attr_accessor rate: ::String
+      SENSITIVE: []
+    end
+
+    class DateInterval
+      attr_accessor start_date: ::Time
+      attr_accessor end_date: ::Time
+      SENSITIVE: []
+    end
+
     class DeleteInvoiceUnitRequest
       attr_accessor invoice_unit_arn: ::String
       SENSITIVE: []
@@ -49,6 +76,37 @@ module Aws::Invoicing
       SENSITIVE: []
     end
 
+    class DiscountsBreakdown
+      attr_accessor breakdown: ::Array[Types::DiscountsBreakdownAmount]
+      attr_accessor total_amount: ::String
+      SENSITIVE: []
+    end
+
+    class DiscountsBreakdownAmount
+      attr_accessor description: ::String
+      attr_accessor amount: ::String
+      attr_accessor rate: ::String
+      SENSITIVE: []
+    end
+
+    class Entity
+      attr_accessor invoicing_entity: ::String
+      SENSITIVE: []
+    end
+
+    class FeesBreakdown
+      attr_accessor breakdown: ::Array[Types::FeesBreakdownAmount]
+      attr_accessor total_amount: ::String
+      SENSITIVE: []
+    end
+
+    class FeesBreakdownAmount
+      attr_accessor description: ::String
+      attr_accessor amount: ::String
+      attr_accessor rate: ::String
+      SENSITIVE: []
+    end
+
     class Filters
       attr_accessor names: ::Array[::String]
       attr_accessor invoice_receivers: ::Array[::String]
@@ -79,6 +137,15 @@ module Aws::Invoicing
       SENSITIVE: []
     end
 
+    class InvoiceCurrencyAmount
+      attr_accessor total_amount: ::String
+      attr_accessor total_amount_before_tax: ::String
+      attr_accessor currency_code: ::String
+      attr_accessor amount_breakdown: Types::AmountBreakdown
+      attr_accessor currency_exchange_details: Types::CurrencyExchangeDetails
+      SENSITIVE: []
+    end
+
     class InvoiceProfile
       attr_accessor account_id: ::String
       attr_accessor receiver_name: ::String
@@ -89,6 +156,35 @@ module Aws::Invoicing
       SENSITIVE: [:receiver_address, :receiver_email, :tax_registration_number]
     end
 
+    class InvoiceSummariesFilter
+      attr_accessor time_interval: Types::DateInterval
+      attr_accessor billing_period: Types::BillingPeriod
+      attr_accessor invoicing_entity: ::String
+      SENSITIVE: []
+    end
+
+    class InvoiceSummariesSelector
+      attr_accessor resource_type: ("ACCOUNT_ID" | "INVOICE_ID")
+      attr_accessor value: ::String
+      SENSITIVE: []
+    end
+
+    class InvoiceSummary
+      attr_accessor account_id: ::String
+      attr_accessor invoice_id: ::String
+      attr_accessor issued_date: ::Time
+      attr_accessor due_date: ::Time
+      attr_accessor entity: Types::Entity
+      attr_accessor billing_period: Types::BillingPeriod
+      attr_accessor invoice_type: ("INVOICE" | "CREDIT_MEMO")
+      attr_accessor original_invoice_id: ::String
+      attr_accessor purchase_order_number: ::String
+      attr_accessor base_currency_amount: Types::InvoiceCurrencyAmount
+      attr_accessor tax_currency_amount: Types::InvoiceCurrencyAmount
+      attr_accessor payment_currency_amount: Types::InvoiceCurrencyAmount
+      SENSITIVE: []
+    end
+
     class InvoiceUnit
       attr_accessor invoice_unit_arn: ::String
       attr_accessor invoice_receiver: ::String
@@ -105,6 +201,20 @@ module Aws::Invoicing
       SENSITIVE: []
     end
 
+    class ListInvoiceSummariesRequest
+      attr_accessor selector: Types::InvoiceSummariesSelector
+      attr_accessor filter: Types::InvoiceSummariesFilter
+      attr_accessor next_token: ::String
+      attr_accessor max_results: ::Integer
+      SENSITIVE: []
+    end
+
+    class ListInvoiceSummariesResponse
+      attr_accessor invoice_summaries: ::Array[Types::InvoiceSummary]
+      attr_accessor next_token: ::String
+      SENSITIVE: []
+    end
+
     class ListInvoiceUnitsRequest
       attr_accessor filters: Types::Filters
       attr_accessor next_token: ::String
@@ -168,6 +278,19 @@ module Aws::Invoicing
     class TagResourceResponse < Aws::EmptyStructure
     end
 
+    class TaxesBreakdown
+      attr_accessor breakdown: ::Array[Types::TaxesBreakdownAmount]
+      attr_accessor total_amount: ::String
+      SENSITIVE: []
+    end
+
+    class TaxesBreakdownAmount
+      attr_accessor description: ::String
+      attr_accessor amount: ::String
+      attr_accessor rate: ::String
+      SENSITIVE: []
+    end
+
     class ThrottlingException
       attr_accessor message: ::String
       SENSITIVE: []