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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-invoicing/client.rb +661 -9
- data/lib/aws-sdk-invoicing/client_api.rb +176 -30
- data/lib/aws-sdk-invoicing/types.rb +440 -0
- data/lib/aws-sdk-invoicing.rb +1 -1
- data/sig/client.rbs +28 -0
- data/sig/resource.rbs +1 -0
- data/sig/types.rbs +123 -0
- metadata +3 -3
|
@@ -95,7 +95,7 @@ module Aws::Invoicing
|
|
|
95
95
|
# class name or an instance of a plugin class.
|
|
96
96
|
#
|
|
97
97
|
# @option options [required, Aws::CredentialProvider] :credentials
|
|
98
|
-
# Your AWS credentials. This can be an instance of any one of the
|
|
98
|
+
# Your AWS credentials used for authentication. This can be an instance of any one of the
|
|
99
99
|
# following classes:
|
|
100
100
|
#
|
|
101
101
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
|
@@ -128,18 +128,23 @@ module Aws::Invoicing
|
|
|
128
128
|
# locations will be searched for credentials:
|
|
129
129
|
#
|
|
130
130
|
# * `Aws.config[:credentials]`
|
|
131
|
+
#
|
|
131
132
|
# * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
|
|
132
133
|
# `:account_id` options.
|
|
133
|
-
#
|
|
134
|
-
#
|
|
134
|
+
#
|
|
135
|
+
# * `ENV['AWS_ACCESS_KEY_ID']`, `ENV['AWS_SECRET_ACCESS_KEY']`,
|
|
136
|
+
# `ENV['AWS_SESSION_TOKEN']`, and `ENV['AWS_ACCOUNT_ID']`.
|
|
137
|
+
#
|
|
135
138
|
# * `~/.aws/credentials`
|
|
139
|
+
#
|
|
136
140
|
# * `~/.aws/config`
|
|
141
|
+
#
|
|
137
142
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
|
138
143
|
# are very aggressive. Construct and pass an instance of
|
|
139
144
|
# `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
|
|
140
145
|
# enable retries and extended timeouts. Instance profile credential
|
|
141
|
-
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
|
142
|
-
# to true
|
|
146
|
+
# fetching can be disabled by setting `ENV['AWS_EC2_METADATA_DISABLED']`
|
|
147
|
+
# to `true`.
|
|
143
148
|
#
|
|
144
149
|
# @option options [required, String] :region
|
|
145
150
|
# The AWS region to connect to. The configured `:region` is
|
|
@@ -167,6 +172,11 @@ module Aws::Invoicing
|
|
|
167
172
|
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
|
168
173
|
# not retry instead of sleeping.
|
|
169
174
|
#
|
|
175
|
+
# @option options [Array<String>] :auth_scheme_preference
|
|
176
|
+
# A list of preferred authentication schemes to use when making a request. Supported values are:
|
|
177
|
+
# `sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV['AWS_AUTH_SCHEME_PREFERENCE']` or in
|
|
178
|
+
# shared config as `auth_scheme_preference`, the value should be a comma-separated list.
|
|
179
|
+
#
|
|
170
180
|
# @option options [Boolean] :client_side_monitoring (false)
|
|
171
181
|
# When `true`, client-side metrics will be collected for all API requests from
|
|
172
182
|
# this client.
|
|
@@ -253,8 +263,8 @@ module Aws::Invoicing
|
|
|
253
263
|
# 4 times. Used in `standard` and `adaptive` retry modes.
|
|
254
264
|
#
|
|
255
265
|
# @option options [String] :profile ("default")
|
|
256
|
-
# Used when loading credentials from the shared credentials file
|
|
257
|
-
#
|
|
266
|
+
# Used when loading credentials from the shared credentials file at `HOME/.aws/credentials`.
|
|
267
|
+
# When not specified, 'default' is used.
|
|
258
268
|
#
|
|
259
269
|
# @option options [String] :request_checksum_calculation ("when_supported")
|
|
260
270
|
# Determines when a checksum will be calculated for request payloads. Values are:
|
|
@@ -374,7 +384,7 @@ module Aws::Invoicing
|
|
|
374
384
|
# `Aws::Telemetry::OTelProvider` for telemetry provider.
|
|
375
385
|
#
|
|
376
386
|
# @option options [Aws::TokenProvider] :token_provider
|
|
377
|
-
#
|
|
387
|
+
# Your Bearer token used for authentication. This can be an instance of any one of the
|
|
378
388
|
# following classes:
|
|
379
389
|
#
|
|
380
390
|
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
|
@@ -769,6 +779,648 @@ module Aws::Invoicing
|
|
|
769
779
|
req.send_request(options)
|
|
770
780
|
end
|
|
771
781
|
|
|
782
|
+
# Retrieves your invoice details programmatically, without line item
|
|
783
|
+
# details.
|
|
784
|
+
#
|
|
785
|
+
# @option params [required, Types::InvoiceSummariesSelector] :selector
|
|
786
|
+
# The option to retrieve details for a specific invoice by providing its
|
|
787
|
+
# unique ID. Alternatively, access information for all invoices linked
|
|
788
|
+
# to the account by providing an account ID.
|
|
789
|
+
#
|
|
790
|
+
# @option params [Types::InvoiceSummariesFilter] :filter
|
|
791
|
+
# Filters you can use to customize your invoice summary.
|
|
792
|
+
#
|
|
793
|
+
# @option params [String] :next_token
|
|
794
|
+
# The token to retrieve the next set of results. Amazon Web Services
|
|
795
|
+
# provides the token when the response from a previous call has more
|
|
796
|
+
# results than the maximum page size.
|
|
797
|
+
#
|
|
798
|
+
# @option params [Integer] :max_results
|
|
799
|
+
# The maximum number of invoice summaries a paginated response can
|
|
800
|
+
# contain.
|
|
801
|
+
#
|
|
802
|
+
# @return [Types::ListInvoiceSummariesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
803
|
+
#
|
|
804
|
+
# * {Types::ListInvoiceSummariesResponse#invoice_summaries #invoice_summaries} => Array<Types::InvoiceSummary>
|
|
805
|
+
# * {Types::ListInvoiceSummariesResponse#next_token #next_token} => String
|
|
806
|
+
#
|
|
807
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
808
|
+
#
|
|
809
|
+
#
|
|
810
|
+
# @example Example: ListInvoiceSummaries with InvoiceId as selector
|
|
811
|
+
#
|
|
812
|
+
# resp = client.list_invoice_summaries({
|
|
813
|
+
# selector: {
|
|
814
|
+
# resource_type: "INVOICE_ID",
|
|
815
|
+
# value: "1111111111",
|
|
816
|
+
# },
|
|
817
|
+
# })
|
|
818
|
+
#
|
|
819
|
+
# resp.to_h outputs the following:
|
|
820
|
+
# {
|
|
821
|
+
# invoice_summaries: [
|
|
822
|
+
# {
|
|
823
|
+
# account_id: "111111111111",
|
|
824
|
+
# base_currency_amount: {
|
|
825
|
+
# amount_breakdown: {
|
|
826
|
+
# discounts: {
|
|
827
|
+
# total_amount: "1.00",
|
|
828
|
+
# },
|
|
829
|
+
# sub_total_amount: "1.00",
|
|
830
|
+
# taxes: {
|
|
831
|
+
# total_amount: "1.00",
|
|
832
|
+
# },
|
|
833
|
+
# },
|
|
834
|
+
# currency_code: "USD",
|
|
835
|
+
# total_amount: "1.00",
|
|
836
|
+
# total_amount_before_tax: "1.00",
|
|
837
|
+
# },
|
|
838
|
+
# billing_period: {
|
|
839
|
+
# month: 1,
|
|
840
|
+
# year: 2025,
|
|
841
|
+
# },
|
|
842
|
+
# due_date: Time.parse("2025-04-01T01:00:00.000Z"),
|
|
843
|
+
# entity: {
|
|
844
|
+
# invoicing_entity: "Amazon Web Services, Inc.",
|
|
845
|
+
# },
|
|
846
|
+
# invoice_id: "1111111111",
|
|
847
|
+
# invoice_type: "INVOICE",
|
|
848
|
+
# issued_date: Time.parse("2025-04-01T01:00:00.000Z"),
|
|
849
|
+
# payment_currency_amount: {
|
|
850
|
+
# amount_breakdown: {
|
|
851
|
+
# discounts: {
|
|
852
|
+
# total_amount: "1.00",
|
|
853
|
+
# },
|
|
854
|
+
# sub_total_amount: "1.00",
|
|
855
|
+
# taxes: {
|
|
856
|
+
# breakdown: [
|
|
857
|
+
# {
|
|
858
|
+
# amount: "1",
|
|
859
|
+
# description: "VAT",
|
|
860
|
+
# rate: "1.0",
|
|
861
|
+
# },
|
|
862
|
+
# ],
|
|
863
|
+
# total_amount: "1.00",
|
|
864
|
+
# },
|
|
865
|
+
# },
|
|
866
|
+
# currency_code: "USD",
|
|
867
|
+
# currency_exchange_details: {
|
|
868
|
+
# rate: "1.0",
|
|
869
|
+
# source_currency_code: "USD",
|
|
870
|
+
# target_currency_code: "USD",
|
|
871
|
+
# },
|
|
872
|
+
# total_amount: "1.00",
|
|
873
|
+
# total_amount_before_tax: "1.00",
|
|
874
|
+
# },
|
|
875
|
+
# tax_currency_amount: {
|
|
876
|
+
# amount_breakdown: {
|
|
877
|
+
# discounts: {
|
|
878
|
+
# total_amount: "1.00",
|
|
879
|
+
# },
|
|
880
|
+
# sub_total_amount: "1.00",
|
|
881
|
+
# taxes: {
|
|
882
|
+
# breakdown: [
|
|
883
|
+
# {
|
|
884
|
+
# amount: "1",
|
|
885
|
+
# description: "VAT",
|
|
886
|
+
# rate: "1.0",
|
|
887
|
+
# },
|
|
888
|
+
# ],
|
|
889
|
+
# total_amount: "1.00",
|
|
890
|
+
# },
|
|
891
|
+
# },
|
|
892
|
+
# currency_code: "USD",
|
|
893
|
+
# currency_exchange_details: {
|
|
894
|
+
# rate: "1.0",
|
|
895
|
+
# source_currency_code: "USD",
|
|
896
|
+
# target_currency_code: "USD",
|
|
897
|
+
# },
|
|
898
|
+
# total_amount: "1.00",
|
|
899
|
+
# total_amount_before_tax: "1.00",
|
|
900
|
+
# },
|
|
901
|
+
# },
|
|
902
|
+
# ],
|
|
903
|
+
# }
|
|
904
|
+
#
|
|
905
|
+
# @example Example: ListInvoiceSummaries with AccountId as selector and billing period
|
|
906
|
+
#
|
|
907
|
+
# resp = client.list_invoice_summaries({
|
|
908
|
+
# filter: {
|
|
909
|
+
# billing_period: {
|
|
910
|
+
# month: 1,
|
|
911
|
+
# year: 2025,
|
|
912
|
+
# },
|
|
913
|
+
# },
|
|
914
|
+
# selector: {
|
|
915
|
+
# resource_type: "ACCOUNT_ID",
|
|
916
|
+
# value: "111111111111",
|
|
917
|
+
# },
|
|
918
|
+
# })
|
|
919
|
+
#
|
|
920
|
+
# resp.to_h outputs the following:
|
|
921
|
+
# {
|
|
922
|
+
# invoice_summaries: [
|
|
923
|
+
# {
|
|
924
|
+
# account_id: "111111111111",
|
|
925
|
+
# base_currency_amount: {
|
|
926
|
+
# amount_breakdown: {
|
|
927
|
+
# discounts: {
|
|
928
|
+
# total_amount: "1.00",
|
|
929
|
+
# },
|
|
930
|
+
# sub_total_amount: "1.00",
|
|
931
|
+
# taxes: {
|
|
932
|
+
# total_amount: "1.00",
|
|
933
|
+
# },
|
|
934
|
+
# },
|
|
935
|
+
# currency_code: "USD",
|
|
936
|
+
# total_amount: "1.00",
|
|
937
|
+
# total_amount_before_tax: "1.00",
|
|
938
|
+
# },
|
|
939
|
+
# billing_period: {
|
|
940
|
+
# month: 1,
|
|
941
|
+
# year: 2025,
|
|
942
|
+
# },
|
|
943
|
+
# due_date: Time.parse("2025-04-01T01:00:00.000Z"),
|
|
944
|
+
# entity: {
|
|
945
|
+
# invoicing_entity: "Amazon Web Services, Inc.",
|
|
946
|
+
# },
|
|
947
|
+
# invoice_id: "1111111111",
|
|
948
|
+
# invoice_type: "INVOICE",
|
|
949
|
+
# issued_date: Time.parse("2025-04-01T01:00:00.000Z"),
|
|
950
|
+
# payment_currency_amount: {
|
|
951
|
+
# amount_breakdown: {
|
|
952
|
+
# discounts: {
|
|
953
|
+
# total_amount: "1.00",
|
|
954
|
+
# },
|
|
955
|
+
# sub_total_amount: "1.00",
|
|
956
|
+
# taxes: {
|
|
957
|
+
# breakdown: [
|
|
958
|
+
# {
|
|
959
|
+
# amount: "1",
|
|
960
|
+
# description: "VAT",
|
|
961
|
+
# rate: "1.0",
|
|
962
|
+
# },
|
|
963
|
+
# ],
|
|
964
|
+
# total_amount: "1.00",
|
|
965
|
+
# },
|
|
966
|
+
# },
|
|
967
|
+
# currency_code: "USD",
|
|
968
|
+
# currency_exchange_details: {
|
|
969
|
+
# rate: "1.0",
|
|
970
|
+
# source_currency_code: "USD",
|
|
971
|
+
# target_currency_code: "USD",
|
|
972
|
+
# },
|
|
973
|
+
# total_amount: "1.00",
|
|
974
|
+
# total_amount_before_tax: "1.00",
|
|
975
|
+
# },
|
|
976
|
+
# tax_currency_amount: {
|
|
977
|
+
# amount_breakdown: {
|
|
978
|
+
# discounts: {
|
|
979
|
+
# total_amount: "1.00",
|
|
980
|
+
# },
|
|
981
|
+
# sub_total_amount: "1.00",
|
|
982
|
+
# taxes: {
|
|
983
|
+
# breakdown: [
|
|
984
|
+
# {
|
|
985
|
+
# amount: "1",
|
|
986
|
+
# description: "VAT",
|
|
987
|
+
# rate: "1.0",
|
|
988
|
+
# },
|
|
989
|
+
# ],
|
|
990
|
+
# total_amount: "1.00",
|
|
991
|
+
# },
|
|
992
|
+
# },
|
|
993
|
+
# currency_code: "USD",
|
|
994
|
+
# currency_exchange_details: {
|
|
995
|
+
# rate: "1.0",
|
|
996
|
+
# source_currency_code: "USD",
|
|
997
|
+
# target_currency_code: "USD",
|
|
998
|
+
# },
|
|
999
|
+
# total_amount: "1.00",
|
|
1000
|
+
# total_amount_before_tax: "1.00",
|
|
1001
|
+
# },
|
|
1002
|
+
# },
|
|
1003
|
+
# ],
|
|
1004
|
+
# }
|
|
1005
|
+
#
|
|
1006
|
+
# @example Example: ListInvoiceSummaries with AccountId as selector and time interval
|
|
1007
|
+
#
|
|
1008
|
+
# resp = client.list_invoice_summaries({
|
|
1009
|
+
# filter: {
|
|
1010
|
+
# time_interval: {
|
|
1011
|
+
# end_date: Time.parse(1592639007),
|
|
1012
|
+
# start_date: Time.parse(1590997407),
|
|
1013
|
+
# },
|
|
1014
|
+
# },
|
|
1015
|
+
# selector: {
|
|
1016
|
+
# resource_type: "ACCOUNT_ID",
|
|
1017
|
+
# value: "111111111111",
|
|
1018
|
+
# },
|
|
1019
|
+
# })
|
|
1020
|
+
#
|
|
1021
|
+
# resp.to_h outputs the following:
|
|
1022
|
+
# {
|
|
1023
|
+
# invoice_summaries: [
|
|
1024
|
+
# {
|
|
1025
|
+
# account_id: "111111111111",
|
|
1026
|
+
# base_currency_amount: {
|
|
1027
|
+
# amount_breakdown: {
|
|
1028
|
+
# discounts: {
|
|
1029
|
+
# total_amount: "1.00",
|
|
1030
|
+
# },
|
|
1031
|
+
# sub_total_amount: "1.00",
|
|
1032
|
+
# taxes: {
|
|
1033
|
+
# total_amount: "1.00",
|
|
1034
|
+
# },
|
|
1035
|
+
# },
|
|
1036
|
+
# currency_code: "USD",
|
|
1037
|
+
# total_amount: "1.00",
|
|
1038
|
+
# total_amount_before_tax: "1.00",
|
|
1039
|
+
# },
|
|
1040
|
+
# billing_period: {
|
|
1041
|
+
# month: 1,
|
|
1042
|
+
# year: 2025,
|
|
1043
|
+
# },
|
|
1044
|
+
# due_date: Time.parse("2025-04-01T01:00:00.000Z"),
|
|
1045
|
+
# entity: {
|
|
1046
|
+
# invoicing_entity: "Amazon Web Services, Inc.",
|
|
1047
|
+
# },
|
|
1048
|
+
# invoice_id: "1111111111",
|
|
1049
|
+
# invoice_type: "INVOICE",
|
|
1050
|
+
# issued_date: Time.parse("2025-04-01T01:00:00.000Z"),
|
|
1051
|
+
# payment_currency_amount: {
|
|
1052
|
+
# amount_breakdown: {
|
|
1053
|
+
# discounts: {
|
|
1054
|
+
# total_amount: "1.00",
|
|
1055
|
+
# },
|
|
1056
|
+
# sub_total_amount: "1.00",
|
|
1057
|
+
# taxes: {
|
|
1058
|
+
# breakdown: [
|
|
1059
|
+
# {
|
|
1060
|
+
# amount: "1",
|
|
1061
|
+
# description: "VAT",
|
|
1062
|
+
# rate: "1.0",
|
|
1063
|
+
# },
|
|
1064
|
+
# ],
|
|
1065
|
+
# total_amount: "1.00",
|
|
1066
|
+
# },
|
|
1067
|
+
# },
|
|
1068
|
+
# currency_code: "USD",
|
|
1069
|
+
# currency_exchange_details: {
|
|
1070
|
+
# rate: "1.0",
|
|
1071
|
+
# source_currency_code: "USD",
|
|
1072
|
+
# target_currency_code: "USD",
|
|
1073
|
+
# },
|
|
1074
|
+
# total_amount: "1.00",
|
|
1075
|
+
# total_amount_before_tax: "1.00",
|
|
1076
|
+
# },
|
|
1077
|
+
# tax_currency_amount: {
|
|
1078
|
+
# amount_breakdown: {
|
|
1079
|
+
# discounts: {
|
|
1080
|
+
# total_amount: "1.00",
|
|
1081
|
+
# },
|
|
1082
|
+
# sub_total_amount: "1.00",
|
|
1083
|
+
# taxes: {
|
|
1084
|
+
# breakdown: [
|
|
1085
|
+
# {
|
|
1086
|
+
# amount: "1",
|
|
1087
|
+
# description: "VAT",
|
|
1088
|
+
# rate: "1.0",
|
|
1089
|
+
# },
|
|
1090
|
+
# ],
|
|
1091
|
+
# total_amount: "1.00",
|
|
1092
|
+
# },
|
|
1093
|
+
# },
|
|
1094
|
+
# currency_code: "USD",
|
|
1095
|
+
# currency_exchange_details: {
|
|
1096
|
+
# rate: "1.0",
|
|
1097
|
+
# source_currency_code: "USD",
|
|
1098
|
+
# target_currency_code: "USD",
|
|
1099
|
+
# },
|
|
1100
|
+
# total_amount: "1.00",
|
|
1101
|
+
# total_amount_before_tax: "1.00",
|
|
1102
|
+
# },
|
|
1103
|
+
# },
|
|
1104
|
+
# ],
|
|
1105
|
+
# }
|
|
1106
|
+
#
|
|
1107
|
+
# @example Example: ListInvoiceSummaries with AccountId as selector and a billing period and max results
|
|
1108
|
+
#
|
|
1109
|
+
# resp = client.list_invoice_summaries({
|
|
1110
|
+
# filter: {
|
|
1111
|
+
# billing_period: {
|
|
1112
|
+
# month: 1,
|
|
1113
|
+
# year: 2025,
|
|
1114
|
+
# },
|
|
1115
|
+
# },
|
|
1116
|
+
# max_results: 1,
|
|
1117
|
+
# selector: {
|
|
1118
|
+
# resource_type: "ACCOUNT_ID",
|
|
1119
|
+
# value: "111111111111",
|
|
1120
|
+
# },
|
|
1121
|
+
# })
|
|
1122
|
+
#
|
|
1123
|
+
# resp.to_h outputs the following:
|
|
1124
|
+
# {
|
|
1125
|
+
# invoice_summaries: [
|
|
1126
|
+
# {
|
|
1127
|
+
# account_id: "111111111111",
|
|
1128
|
+
# base_currency_amount: {
|
|
1129
|
+
# amount_breakdown: {
|
|
1130
|
+
# discounts: {
|
|
1131
|
+
# total_amount: "1.00",
|
|
1132
|
+
# },
|
|
1133
|
+
# sub_total_amount: "1.00",
|
|
1134
|
+
# taxes: {
|
|
1135
|
+
# total_amount: "1.00",
|
|
1136
|
+
# },
|
|
1137
|
+
# },
|
|
1138
|
+
# currency_code: "USD",
|
|
1139
|
+
# total_amount: "1.00",
|
|
1140
|
+
# total_amount_before_tax: "1.00",
|
|
1141
|
+
# },
|
|
1142
|
+
# billing_period: {
|
|
1143
|
+
# month: 1,
|
|
1144
|
+
# year: 2025,
|
|
1145
|
+
# },
|
|
1146
|
+
# due_date: Time.parse("2025-04-01T01:00:00.000Z"),
|
|
1147
|
+
# entity: {
|
|
1148
|
+
# invoicing_entity: "Amazon Web Services, Inc.",
|
|
1149
|
+
# },
|
|
1150
|
+
# invoice_id: "1111111111",
|
|
1151
|
+
# invoice_type: "INVOICE",
|
|
1152
|
+
# issued_date: Time.parse("2025-04-01T01:00:00.000Z"),
|
|
1153
|
+
# payment_currency_amount: {
|
|
1154
|
+
# amount_breakdown: {
|
|
1155
|
+
# discounts: {
|
|
1156
|
+
# total_amount: "1.00",
|
|
1157
|
+
# },
|
|
1158
|
+
# sub_total_amount: "1.00",
|
|
1159
|
+
# taxes: {
|
|
1160
|
+
# breakdown: [
|
|
1161
|
+
# {
|
|
1162
|
+
# amount: "1",
|
|
1163
|
+
# description: "VAT",
|
|
1164
|
+
# rate: "1.0",
|
|
1165
|
+
# },
|
|
1166
|
+
# ],
|
|
1167
|
+
# total_amount: "1.00",
|
|
1168
|
+
# },
|
|
1169
|
+
# },
|
|
1170
|
+
# currency_code: "USD",
|
|
1171
|
+
# currency_exchange_details: {
|
|
1172
|
+
# rate: "1.0",
|
|
1173
|
+
# source_currency_code: "USD",
|
|
1174
|
+
# target_currency_code: "USD",
|
|
1175
|
+
# },
|
|
1176
|
+
# total_amount: "1.00",
|
|
1177
|
+
# total_amount_before_tax: "1.00",
|
|
1178
|
+
# },
|
|
1179
|
+
# tax_currency_amount: {
|
|
1180
|
+
# amount_breakdown: {
|
|
1181
|
+
# discounts: {
|
|
1182
|
+
# total_amount: "1.00",
|
|
1183
|
+
# },
|
|
1184
|
+
# sub_total_amount: "1.00",
|
|
1185
|
+
# taxes: {
|
|
1186
|
+
# breakdown: [
|
|
1187
|
+
# {
|
|
1188
|
+
# amount: "1",
|
|
1189
|
+
# description: "VAT",
|
|
1190
|
+
# rate: "1.0",
|
|
1191
|
+
# },
|
|
1192
|
+
# ],
|
|
1193
|
+
# total_amount: "1.00",
|
|
1194
|
+
# },
|
|
1195
|
+
# },
|
|
1196
|
+
# currency_code: "USD",
|
|
1197
|
+
# currency_exchange_details: {
|
|
1198
|
+
# rate: "1.0",
|
|
1199
|
+
# source_currency_code: "USD",
|
|
1200
|
+
# target_currency_code: "USD",
|
|
1201
|
+
# },
|
|
1202
|
+
# total_amount: "1.00",
|
|
1203
|
+
# total_amount_before_tax: "1.00",
|
|
1204
|
+
# },
|
|
1205
|
+
# },
|
|
1206
|
+
# ],
|
|
1207
|
+
# next_token: "abcde12345",
|
|
1208
|
+
# }
|
|
1209
|
+
#
|
|
1210
|
+
# @example Example: ListInvoiceSummaries with AccountId as selector and a billing period and next token
|
|
1211
|
+
#
|
|
1212
|
+
# resp = client.list_invoice_summaries({
|
|
1213
|
+
# filter: {
|
|
1214
|
+
# billing_period: {
|
|
1215
|
+
# month: 1,
|
|
1216
|
+
# year: 2025,
|
|
1217
|
+
# },
|
|
1218
|
+
# },
|
|
1219
|
+
# next_token: "abcde12345",
|
|
1220
|
+
# selector: {
|
|
1221
|
+
# resource_type: "ACCOUNT_ID",
|
|
1222
|
+
# value: "111111111111",
|
|
1223
|
+
# },
|
|
1224
|
+
# })
|
|
1225
|
+
#
|
|
1226
|
+
# resp.to_h outputs the following:
|
|
1227
|
+
# {
|
|
1228
|
+
# invoice_summaries: [
|
|
1229
|
+
# {
|
|
1230
|
+
# account_id: "111111111111",
|
|
1231
|
+
# base_currency_amount: {
|
|
1232
|
+
# amount_breakdown: {
|
|
1233
|
+
# discounts: {
|
|
1234
|
+
# total_amount: "1.00",
|
|
1235
|
+
# },
|
|
1236
|
+
# sub_total_amount: "1.00",
|
|
1237
|
+
# taxes: {
|
|
1238
|
+
# total_amount: "1.00",
|
|
1239
|
+
# },
|
|
1240
|
+
# },
|
|
1241
|
+
# currency_code: "USD",
|
|
1242
|
+
# total_amount: "1.00",
|
|
1243
|
+
# total_amount_before_tax: "1.00",
|
|
1244
|
+
# },
|
|
1245
|
+
# billing_period: {
|
|
1246
|
+
# month: 1,
|
|
1247
|
+
# year: 2025,
|
|
1248
|
+
# },
|
|
1249
|
+
# due_date: Time.parse("2025-04-01T01:00:00.000Z"),
|
|
1250
|
+
# entity: {
|
|
1251
|
+
# invoicing_entity: "Amazon Web Services, Inc.",
|
|
1252
|
+
# },
|
|
1253
|
+
# invoice_id: "1111111111",
|
|
1254
|
+
# invoice_type: "INVOICE",
|
|
1255
|
+
# issued_date: Time.parse("2025-04-01T01:00:00.000Z"),
|
|
1256
|
+
# payment_currency_amount: {
|
|
1257
|
+
# amount_breakdown: {
|
|
1258
|
+
# discounts: {
|
|
1259
|
+
# total_amount: "1.00",
|
|
1260
|
+
# },
|
|
1261
|
+
# sub_total_amount: "1.00",
|
|
1262
|
+
# taxes: {
|
|
1263
|
+
# breakdown: [
|
|
1264
|
+
# {
|
|
1265
|
+
# amount: "1",
|
|
1266
|
+
# description: "VAT",
|
|
1267
|
+
# rate: "1.0",
|
|
1268
|
+
# },
|
|
1269
|
+
# ],
|
|
1270
|
+
# total_amount: "1.00",
|
|
1271
|
+
# },
|
|
1272
|
+
# },
|
|
1273
|
+
# currency_code: "USD",
|
|
1274
|
+
# currency_exchange_details: {
|
|
1275
|
+
# rate: "1.0",
|
|
1276
|
+
# source_currency_code: "USD",
|
|
1277
|
+
# target_currency_code: "USD",
|
|
1278
|
+
# },
|
|
1279
|
+
# total_amount: "1.00",
|
|
1280
|
+
# total_amount_before_tax: "1.00",
|
|
1281
|
+
# },
|
|
1282
|
+
# tax_currency_amount: {
|
|
1283
|
+
# amount_breakdown: {
|
|
1284
|
+
# discounts: {
|
|
1285
|
+
# total_amount: "1.00",
|
|
1286
|
+
# },
|
|
1287
|
+
# sub_total_amount: "1.00",
|
|
1288
|
+
# taxes: {
|
|
1289
|
+
# breakdown: [
|
|
1290
|
+
# {
|
|
1291
|
+
# amount: "1",
|
|
1292
|
+
# description: "VAT",
|
|
1293
|
+
# rate: "1.0",
|
|
1294
|
+
# },
|
|
1295
|
+
# ],
|
|
1296
|
+
# total_amount: "1.00",
|
|
1297
|
+
# },
|
|
1298
|
+
# },
|
|
1299
|
+
# currency_code: "USD",
|
|
1300
|
+
# currency_exchange_details: {
|
|
1301
|
+
# rate: "1.0",
|
|
1302
|
+
# source_currency_code: "USD",
|
|
1303
|
+
# target_currency_code: "USD",
|
|
1304
|
+
# },
|
|
1305
|
+
# total_amount: "1.00",
|
|
1306
|
+
# total_amount_before_tax: "1.00",
|
|
1307
|
+
# },
|
|
1308
|
+
# },
|
|
1309
|
+
# ],
|
|
1310
|
+
# }
|
|
1311
|
+
#
|
|
1312
|
+
# @example Request syntax with placeholder values
|
|
1313
|
+
#
|
|
1314
|
+
# resp = client.list_invoice_summaries({
|
|
1315
|
+
# selector: { # required
|
|
1316
|
+
# resource_type: "ACCOUNT_ID", # required, accepts ACCOUNT_ID, INVOICE_ID
|
|
1317
|
+
# value: "StringWithoutNewLine", # required
|
|
1318
|
+
# },
|
|
1319
|
+
# filter: {
|
|
1320
|
+
# time_interval: {
|
|
1321
|
+
# start_date: Time.now, # required
|
|
1322
|
+
# end_date: Time.now, # required
|
|
1323
|
+
# },
|
|
1324
|
+
# billing_period: {
|
|
1325
|
+
# month: 1, # required
|
|
1326
|
+
# year: 1, # required
|
|
1327
|
+
# },
|
|
1328
|
+
# invoicing_entity: "BasicString",
|
|
1329
|
+
# },
|
|
1330
|
+
# next_token: "NextTokenString",
|
|
1331
|
+
# max_results: 1,
|
|
1332
|
+
# })
|
|
1333
|
+
#
|
|
1334
|
+
# @example Response structure
|
|
1335
|
+
#
|
|
1336
|
+
# resp.invoice_summaries #=> Array
|
|
1337
|
+
# resp.invoice_summaries[0].account_id #=> String
|
|
1338
|
+
# resp.invoice_summaries[0].invoice_id #=> String
|
|
1339
|
+
# resp.invoice_summaries[0].issued_date #=> Time
|
|
1340
|
+
# resp.invoice_summaries[0].due_date #=> Time
|
|
1341
|
+
# resp.invoice_summaries[0].entity.invoicing_entity #=> String
|
|
1342
|
+
# resp.invoice_summaries[0].billing_period.month #=> Integer
|
|
1343
|
+
# resp.invoice_summaries[0].billing_period.year #=> Integer
|
|
1344
|
+
# resp.invoice_summaries[0].invoice_type #=> String, one of "INVOICE", "CREDIT_MEMO"
|
|
1345
|
+
# resp.invoice_summaries[0].original_invoice_id #=> String
|
|
1346
|
+
# resp.invoice_summaries[0].purchase_order_number #=> String
|
|
1347
|
+
# resp.invoice_summaries[0].base_currency_amount.total_amount #=> String
|
|
1348
|
+
# resp.invoice_summaries[0].base_currency_amount.total_amount_before_tax #=> String
|
|
1349
|
+
# resp.invoice_summaries[0].base_currency_amount.currency_code #=> String
|
|
1350
|
+
# resp.invoice_summaries[0].base_currency_amount.amount_breakdown.sub_total_amount #=> String
|
|
1351
|
+
# resp.invoice_summaries[0].base_currency_amount.amount_breakdown.discounts.breakdown #=> Array
|
|
1352
|
+
# resp.invoice_summaries[0].base_currency_amount.amount_breakdown.discounts.breakdown[0].description #=> String
|
|
1353
|
+
# resp.invoice_summaries[0].base_currency_amount.amount_breakdown.discounts.breakdown[0].amount #=> String
|
|
1354
|
+
# resp.invoice_summaries[0].base_currency_amount.amount_breakdown.discounts.breakdown[0].rate #=> String
|
|
1355
|
+
# resp.invoice_summaries[0].base_currency_amount.amount_breakdown.discounts.total_amount #=> String
|
|
1356
|
+
# resp.invoice_summaries[0].base_currency_amount.amount_breakdown.taxes.breakdown #=> Array
|
|
1357
|
+
# resp.invoice_summaries[0].base_currency_amount.amount_breakdown.taxes.breakdown[0].description #=> String
|
|
1358
|
+
# resp.invoice_summaries[0].base_currency_amount.amount_breakdown.taxes.breakdown[0].amount #=> String
|
|
1359
|
+
# resp.invoice_summaries[0].base_currency_amount.amount_breakdown.taxes.breakdown[0].rate #=> String
|
|
1360
|
+
# resp.invoice_summaries[0].base_currency_amount.amount_breakdown.taxes.total_amount #=> String
|
|
1361
|
+
# resp.invoice_summaries[0].base_currency_amount.amount_breakdown.fees.breakdown #=> Array
|
|
1362
|
+
# resp.invoice_summaries[0].base_currency_amount.amount_breakdown.fees.breakdown[0].description #=> String
|
|
1363
|
+
# resp.invoice_summaries[0].base_currency_amount.amount_breakdown.fees.breakdown[0].amount #=> String
|
|
1364
|
+
# resp.invoice_summaries[0].base_currency_amount.amount_breakdown.fees.breakdown[0].rate #=> String
|
|
1365
|
+
# resp.invoice_summaries[0].base_currency_amount.amount_breakdown.fees.total_amount #=> String
|
|
1366
|
+
# resp.invoice_summaries[0].base_currency_amount.currency_exchange_details.source_currency_code #=> String
|
|
1367
|
+
# resp.invoice_summaries[0].base_currency_amount.currency_exchange_details.target_currency_code #=> String
|
|
1368
|
+
# resp.invoice_summaries[0].base_currency_amount.currency_exchange_details.rate #=> String
|
|
1369
|
+
# resp.invoice_summaries[0].tax_currency_amount.total_amount #=> String
|
|
1370
|
+
# resp.invoice_summaries[0].tax_currency_amount.total_amount_before_tax #=> String
|
|
1371
|
+
# resp.invoice_summaries[0].tax_currency_amount.currency_code #=> String
|
|
1372
|
+
# resp.invoice_summaries[0].tax_currency_amount.amount_breakdown.sub_total_amount #=> String
|
|
1373
|
+
# resp.invoice_summaries[0].tax_currency_amount.amount_breakdown.discounts.breakdown #=> Array
|
|
1374
|
+
# resp.invoice_summaries[0].tax_currency_amount.amount_breakdown.discounts.breakdown[0].description #=> String
|
|
1375
|
+
# resp.invoice_summaries[0].tax_currency_amount.amount_breakdown.discounts.breakdown[0].amount #=> String
|
|
1376
|
+
# resp.invoice_summaries[0].tax_currency_amount.amount_breakdown.discounts.breakdown[0].rate #=> String
|
|
1377
|
+
# resp.invoice_summaries[0].tax_currency_amount.amount_breakdown.discounts.total_amount #=> String
|
|
1378
|
+
# resp.invoice_summaries[0].tax_currency_amount.amount_breakdown.taxes.breakdown #=> Array
|
|
1379
|
+
# resp.invoice_summaries[0].tax_currency_amount.amount_breakdown.taxes.breakdown[0].description #=> String
|
|
1380
|
+
# resp.invoice_summaries[0].tax_currency_amount.amount_breakdown.taxes.breakdown[0].amount #=> String
|
|
1381
|
+
# resp.invoice_summaries[0].tax_currency_amount.amount_breakdown.taxes.breakdown[0].rate #=> String
|
|
1382
|
+
# resp.invoice_summaries[0].tax_currency_amount.amount_breakdown.taxes.total_amount #=> String
|
|
1383
|
+
# resp.invoice_summaries[0].tax_currency_amount.amount_breakdown.fees.breakdown #=> Array
|
|
1384
|
+
# resp.invoice_summaries[0].tax_currency_amount.amount_breakdown.fees.breakdown[0].description #=> String
|
|
1385
|
+
# resp.invoice_summaries[0].tax_currency_amount.amount_breakdown.fees.breakdown[0].amount #=> String
|
|
1386
|
+
# resp.invoice_summaries[0].tax_currency_amount.amount_breakdown.fees.breakdown[0].rate #=> String
|
|
1387
|
+
# resp.invoice_summaries[0].tax_currency_amount.amount_breakdown.fees.total_amount #=> String
|
|
1388
|
+
# resp.invoice_summaries[0].tax_currency_amount.currency_exchange_details.source_currency_code #=> String
|
|
1389
|
+
# resp.invoice_summaries[0].tax_currency_amount.currency_exchange_details.target_currency_code #=> String
|
|
1390
|
+
# resp.invoice_summaries[0].tax_currency_amount.currency_exchange_details.rate #=> String
|
|
1391
|
+
# resp.invoice_summaries[0].payment_currency_amount.total_amount #=> String
|
|
1392
|
+
# resp.invoice_summaries[0].payment_currency_amount.total_amount_before_tax #=> String
|
|
1393
|
+
# resp.invoice_summaries[0].payment_currency_amount.currency_code #=> String
|
|
1394
|
+
# resp.invoice_summaries[0].payment_currency_amount.amount_breakdown.sub_total_amount #=> String
|
|
1395
|
+
# resp.invoice_summaries[0].payment_currency_amount.amount_breakdown.discounts.breakdown #=> Array
|
|
1396
|
+
# resp.invoice_summaries[0].payment_currency_amount.amount_breakdown.discounts.breakdown[0].description #=> String
|
|
1397
|
+
# resp.invoice_summaries[0].payment_currency_amount.amount_breakdown.discounts.breakdown[0].amount #=> String
|
|
1398
|
+
# resp.invoice_summaries[0].payment_currency_amount.amount_breakdown.discounts.breakdown[0].rate #=> String
|
|
1399
|
+
# resp.invoice_summaries[0].payment_currency_amount.amount_breakdown.discounts.total_amount #=> String
|
|
1400
|
+
# resp.invoice_summaries[0].payment_currency_amount.amount_breakdown.taxes.breakdown #=> Array
|
|
1401
|
+
# resp.invoice_summaries[0].payment_currency_amount.amount_breakdown.taxes.breakdown[0].description #=> String
|
|
1402
|
+
# resp.invoice_summaries[0].payment_currency_amount.amount_breakdown.taxes.breakdown[0].amount #=> String
|
|
1403
|
+
# resp.invoice_summaries[0].payment_currency_amount.amount_breakdown.taxes.breakdown[0].rate #=> String
|
|
1404
|
+
# resp.invoice_summaries[0].payment_currency_amount.amount_breakdown.taxes.total_amount #=> String
|
|
1405
|
+
# resp.invoice_summaries[0].payment_currency_amount.amount_breakdown.fees.breakdown #=> Array
|
|
1406
|
+
# resp.invoice_summaries[0].payment_currency_amount.amount_breakdown.fees.breakdown[0].description #=> String
|
|
1407
|
+
# resp.invoice_summaries[0].payment_currency_amount.amount_breakdown.fees.breakdown[0].amount #=> String
|
|
1408
|
+
# resp.invoice_summaries[0].payment_currency_amount.amount_breakdown.fees.breakdown[0].rate #=> String
|
|
1409
|
+
# resp.invoice_summaries[0].payment_currency_amount.amount_breakdown.fees.total_amount #=> String
|
|
1410
|
+
# resp.invoice_summaries[0].payment_currency_amount.currency_exchange_details.source_currency_code #=> String
|
|
1411
|
+
# resp.invoice_summaries[0].payment_currency_amount.currency_exchange_details.target_currency_code #=> String
|
|
1412
|
+
# resp.invoice_summaries[0].payment_currency_amount.currency_exchange_details.rate #=> String
|
|
1413
|
+
# resp.next_token #=> String
|
|
1414
|
+
#
|
|
1415
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/ListInvoiceSummaries AWS API Documentation
|
|
1416
|
+
#
|
|
1417
|
+
# @overload list_invoice_summaries(params = {})
|
|
1418
|
+
# @param [Hash] params ({})
|
|
1419
|
+
def list_invoice_summaries(params = {}, options = {})
|
|
1420
|
+
req = build_request(:list_invoice_summaries, params)
|
|
1421
|
+
req.send_request(options)
|
|
1422
|
+
end
|
|
1423
|
+
|
|
772
1424
|
# This fetches a list of all invoice unit definitions for a given
|
|
773
1425
|
# account, as of the provided `AsOf` date.
|
|
774
1426
|
#
|
|
@@ -1185,7 +1837,7 @@ module Aws::Invoicing
|
|
|
1185
1837
|
tracer: tracer
|
|
1186
1838
|
)
|
|
1187
1839
|
context[:gem_name] = 'aws-sdk-invoicing'
|
|
1188
|
-
context[:gem_version] = '1.
|
|
1840
|
+
context[:gem_version] = '1.8.0'
|
|
1189
1841
|
Seahorse::Client::Request.new(handlers, context)
|
|
1190
1842
|
end
|
|
1191
1843
|
|