aws-sdk-invoicing 1.16.0 → 1.17.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-invoicing/client.rb +771 -1
- data/lib/aws-sdk-invoicing/client_api.rb +299 -0
- data/lib/aws-sdk-invoicing/errors.rb +26 -0
- data/lib/aws-sdk-invoicing/types.rb +796 -0
- data/lib/aws-sdk-invoicing.rb +1 -1
- data/sig/client.rbs +147 -0
- data/sig/errors.rbs +5 -0
- data/sig/types.rbs +192 -0
- metadata +3 -3
|
@@ -102,6 +102,52 @@ module Aws::Invoicing
|
|
|
102
102
|
include Aws::Structure
|
|
103
103
|
end
|
|
104
104
|
|
|
105
|
+
# The request could not be completed due to a conflict with the current
|
|
106
|
+
# state of the resource. This exception occurs when a concurrent
|
|
107
|
+
# modification is detected during an update operation, or when
|
|
108
|
+
# attempting to create a resource that already exists.
|
|
109
|
+
#
|
|
110
|
+
# @!attribute [rw] message
|
|
111
|
+
# @return [String]
|
|
112
|
+
#
|
|
113
|
+
# @!attribute [rw] resource_id
|
|
114
|
+
# The identifier of the resource that caused the conflict.
|
|
115
|
+
# @return [String]
|
|
116
|
+
#
|
|
117
|
+
# @!attribute [rw] resource_type
|
|
118
|
+
# The type of resource that caused the conflict.
|
|
119
|
+
# @return [String]
|
|
120
|
+
#
|
|
121
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/ConflictException AWS API Documentation
|
|
122
|
+
#
|
|
123
|
+
class ConflictException < Struct.new(
|
|
124
|
+
:message,
|
|
125
|
+
:resource_id,
|
|
126
|
+
:resource_type)
|
|
127
|
+
SENSITIVE = []
|
|
128
|
+
include Aws::Structure
|
|
129
|
+
end
|
|
130
|
+
|
|
131
|
+
# Represents contact information for a person or role associated with
|
|
132
|
+
# the procurement portal preference.
|
|
133
|
+
#
|
|
134
|
+
# @!attribute [rw] name
|
|
135
|
+
# The name of the contact person or role.
|
|
136
|
+
# @return [String]
|
|
137
|
+
#
|
|
138
|
+
# @!attribute [rw] email
|
|
139
|
+
# The email address of the contact person or role.
|
|
140
|
+
# @return [String]
|
|
141
|
+
#
|
|
142
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/Contact AWS API Documentation
|
|
143
|
+
#
|
|
144
|
+
class Contact < Struct.new(
|
|
145
|
+
:name,
|
|
146
|
+
:email)
|
|
147
|
+
SENSITIVE = []
|
|
148
|
+
include Aws::Structure
|
|
149
|
+
end
|
|
150
|
+
|
|
105
151
|
# @!attribute [rw] name
|
|
106
152
|
# The unique name of the invoice unit that is shown on the generated
|
|
107
153
|
# invoice. This can't be changed once it is set. To change this name,
|
|
@@ -158,6 +204,118 @@ module Aws::Invoicing
|
|
|
158
204
|
include Aws::Structure
|
|
159
205
|
end
|
|
160
206
|
|
|
207
|
+
# @!attribute [rw] procurement_portal_name
|
|
208
|
+
# The name of the procurement portal.
|
|
209
|
+
# @return [String]
|
|
210
|
+
#
|
|
211
|
+
# @!attribute [rw] buyer_domain
|
|
212
|
+
# The domain identifier for the buyer in the procurement portal.
|
|
213
|
+
# @return [String]
|
|
214
|
+
#
|
|
215
|
+
# @!attribute [rw] buyer_identifier
|
|
216
|
+
# The unique identifier for the buyer in the procurement portal.
|
|
217
|
+
# @return [String]
|
|
218
|
+
#
|
|
219
|
+
# @!attribute [rw] supplier_domain
|
|
220
|
+
# The domain identifier for the supplier in the procurement portal.
|
|
221
|
+
# @return [String]
|
|
222
|
+
#
|
|
223
|
+
# @!attribute [rw] supplier_identifier
|
|
224
|
+
# The unique identifier for the supplier in the procurement portal.
|
|
225
|
+
# @return [String]
|
|
226
|
+
#
|
|
227
|
+
# @!attribute [rw] selector
|
|
228
|
+
# Specifies criteria for selecting which invoices should be processed
|
|
229
|
+
# using a particular procurement portal preference.
|
|
230
|
+
# @return [Types::ProcurementPortalPreferenceSelector]
|
|
231
|
+
#
|
|
232
|
+
# @!attribute [rw] procurement_portal_shared_secret
|
|
233
|
+
# The shared secret or authentication credential used to establish
|
|
234
|
+
# secure communication with the procurement portal. This value must be
|
|
235
|
+
# encrypted at rest.
|
|
236
|
+
# @return [String]
|
|
237
|
+
#
|
|
238
|
+
# @!attribute [rw] procurement_portal_instance_endpoint
|
|
239
|
+
# The endpoint URL where e-invoices will be delivered to the
|
|
240
|
+
# procurement portal. Must be a valid HTTPS URL.
|
|
241
|
+
# @return [String]
|
|
242
|
+
#
|
|
243
|
+
# @!attribute [rw] test_env_preference
|
|
244
|
+
# Configuration settings for the test environment of the procurement
|
|
245
|
+
# portal. Includes test credentials and endpoints that are used for
|
|
246
|
+
# validation before production deployment.
|
|
247
|
+
# @return [Types::TestEnvPreferenceInput]
|
|
248
|
+
#
|
|
249
|
+
# @!attribute [rw] einvoice_delivery_enabled
|
|
250
|
+
# Indicates whether e-invoice delivery is enabled for this procurement
|
|
251
|
+
# portal preference. Set to true to enable e-invoice delivery, false
|
|
252
|
+
# to disable.
|
|
253
|
+
# @return [Boolean]
|
|
254
|
+
#
|
|
255
|
+
# @!attribute [rw] einvoice_delivery_preference
|
|
256
|
+
# Specifies the e-invoice delivery configuration including document
|
|
257
|
+
# types, attachment types, and customization settings for the portal.
|
|
258
|
+
# @return [Types::EinvoiceDeliveryPreference]
|
|
259
|
+
#
|
|
260
|
+
# @!attribute [rw] purchase_order_retrieval_enabled
|
|
261
|
+
# Indicates whether purchase order retrieval is enabled for this
|
|
262
|
+
# procurement portal preference. Set to true to enable PO retrieval,
|
|
263
|
+
# false to disable.
|
|
264
|
+
# @return [Boolean]
|
|
265
|
+
#
|
|
266
|
+
# @!attribute [rw] contacts
|
|
267
|
+
# List of contact information for portal administrators and technical
|
|
268
|
+
# contacts responsible for the e-invoice integration.
|
|
269
|
+
# @return [Array<Types::Contact>]
|
|
270
|
+
#
|
|
271
|
+
# @!attribute [rw] resource_tags
|
|
272
|
+
# The tags to apply to this procurement portal preference resource.
|
|
273
|
+
# Each tag consists of a key and an optional value.
|
|
274
|
+
# @return [Array<Types::ResourceTag>]
|
|
275
|
+
#
|
|
276
|
+
# @!attribute [rw] client_token
|
|
277
|
+
# A unique, case-sensitive identifier that you provide to ensure
|
|
278
|
+
# idempotency of the request.
|
|
279
|
+
#
|
|
280
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
281
|
+
# not need to pass this option.
|
|
282
|
+
# @return [String]
|
|
283
|
+
#
|
|
284
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/CreateProcurementPortalPreferenceRequest AWS API Documentation
|
|
285
|
+
#
|
|
286
|
+
class CreateProcurementPortalPreferenceRequest < Struct.new(
|
|
287
|
+
:procurement_portal_name,
|
|
288
|
+
:buyer_domain,
|
|
289
|
+
:buyer_identifier,
|
|
290
|
+
:supplier_domain,
|
|
291
|
+
:supplier_identifier,
|
|
292
|
+
:selector,
|
|
293
|
+
:procurement_portal_shared_secret,
|
|
294
|
+
:procurement_portal_instance_endpoint,
|
|
295
|
+
:test_env_preference,
|
|
296
|
+
:einvoice_delivery_enabled,
|
|
297
|
+
:einvoice_delivery_preference,
|
|
298
|
+
:purchase_order_retrieval_enabled,
|
|
299
|
+
:contacts,
|
|
300
|
+
:resource_tags,
|
|
301
|
+
:client_token)
|
|
302
|
+
SENSITIVE = [:procurement_portal_shared_secret, :contacts]
|
|
303
|
+
include Aws::Structure
|
|
304
|
+
end
|
|
305
|
+
|
|
306
|
+
# @!attribute [rw] procurement_portal_preference_arn
|
|
307
|
+
# The Amazon Resource Name (ARN) of the created procurement portal
|
|
308
|
+
# preference.
|
|
309
|
+
# @return [String]
|
|
310
|
+
#
|
|
311
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/CreateProcurementPortalPreferenceResponse AWS API Documentation
|
|
312
|
+
#
|
|
313
|
+
class CreateProcurementPortalPreferenceResponse < Struct.new(
|
|
314
|
+
:procurement_portal_preference_arn)
|
|
315
|
+
SENSITIVE = []
|
|
316
|
+
include Aws::Structure
|
|
317
|
+
end
|
|
318
|
+
|
|
161
319
|
# The details of currency exchange.
|
|
162
320
|
#
|
|
163
321
|
# @!attribute [rw] source_currency_code
|
|
@@ -234,6 +392,32 @@ module Aws::Invoicing
|
|
|
234
392
|
include Aws::Structure
|
|
235
393
|
end
|
|
236
394
|
|
|
395
|
+
# @!attribute [rw] procurement_portal_preference_arn
|
|
396
|
+
# The Amazon Resource Name (ARN) of the procurement portal preference
|
|
397
|
+
# to delete.
|
|
398
|
+
# @return [String]
|
|
399
|
+
#
|
|
400
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/DeleteProcurementPortalPreferenceRequest AWS API Documentation
|
|
401
|
+
#
|
|
402
|
+
class DeleteProcurementPortalPreferenceRequest < Struct.new(
|
|
403
|
+
:procurement_portal_preference_arn)
|
|
404
|
+
SENSITIVE = []
|
|
405
|
+
include Aws::Structure
|
|
406
|
+
end
|
|
407
|
+
|
|
408
|
+
# @!attribute [rw] procurement_portal_preference_arn
|
|
409
|
+
# The Amazon Resource Name (ARN) of the deleted procurement portal
|
|
410
|
+
# preference.
|
|
411
|
+
# @return [String]
|
|
412
|
+
#
|
|
413
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/DeleteProcurementPortalPreferenceResponse AWS API Documentation
|
|
414
|
+
#
|
|
415
|
+
class DeleteProcurementPortalPreferenceResponse < Struct.new(
|
|
416
|
+
:procurement_portal_preference_arn)
|
|
417
|
+
SENSITIVE = []
|
|
418
|
+
include Aws::Structure
|
|
419
|
+
end
|
|
420
|
+
|
|
237
421
|
# The discounts details.
|
|
238
422
|
#
|
|
239
423
|
# @!attribute [rw] breakdown
|
|
@@ -277,6 +461,49 @@ module Aws::Invoicing
|
|
|
277
461
|
include Aws::Structure
|
|
278
462
|
end
|
|
279
463
|
|
|
464
|
+
# Specifies the preferences for e-invoice delivery, including document
|
|
465
|
+
# types, attachment types, and customization settings.
|
|
466
|
+
#
|
|
467
|
+
# @!attribute [rw] einvoice_delivery_document_types
|
|
468
|
+
# The types of e-invoice documents to be delivered.
|
|
469
|
+
# @return [Array<String>]
|
|
470
|
+
#
|
|
471
|
+
# @!attribute [rw] einvoice_delivery_attachment_types
|
|
472
|
+
# The types of attachments to include with the e-invoice delivery.
|
|
473
|
+
# @return [Array<String>]
|
|
474
|
+
#
|
|
475
|
+
# @!attribute [rw] protocol
|
|
476
|
+
# The communication protocol to use for e-invoice delivery.
|
|
477
|
+
# @return [String]
|
|
478
|
+
#
|
|
479
|
+
# @!attribute [rw] purchase_order_data_sources
|
|
480
|
+
# The sources of purchase order data to use for e-invoice generation
|
|
481
|
+
# and delivery.
|
|
482
|
+
# @return [Array<Types::PurchaseOrderDataSource>]
|
|
483
|
+
#
|
|
484
|
+
# @!attribute [rw] connection_testing_method
|
|
485
|
+
# The method to use for testing the connection to the procurement
|
|
486
|
+
# portal.
|
|
487
|
+
# @return [String]
|
|
488
|
+
#
|
|
489
|
+
# @!attribute [rw] einvoice_delivery_activation_date
|
|
490
|
+
# The date when e-invoice delivery should be activated for this
|
|
491
|
+
# preference.
|
|
492
|
+
# @return [Time]
|
|
493
|
+
#
|
|
494
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/EinvoiceDeliveryPreference AWS API Documentation
|
|
495
|
+
#
|
|
496
|
+
class EinvoiceDeliveryPreference < Struct.new(
|
|
497
|
+
:einvoice_delivery_document_types,
|
|
498
|
+
:einvoice_delivery_attachment_types,
|
|
499
|
+
:protocol,
|
|
500
|
+
:purchase_order_data_sources,
|
|
501
|
+
:connection_testing_method,
|
|
502
|
+
:einvoice_delivery_activation_date)
|
|
503
|
+
SENSITIVE = []
|
|
504
|
+
include Aws::Structure
|
|
505
|
+
end
|
|
506
|
+
|
|
280
507
|
# The organization name providing Amazon Web Services services.
|
|
281
508
|
#
|
|
282
509
|
# @!attribute [rw] invoicing_entity
|
|
@@ -478,6 +705,32 @@ module Aws::Invoicing
|
|
|
478
705
|
include Aws::Structure
|
|
479
706
|
end
|
|
480
707
|
|
|
708
|
+
# @!attribute [rw] procurement_portal_preference_arn
|
|
709
|
+
# The Amazon Resource Name (ARN) of the procurement portal preference
|
|
710
|
+
# to retrieve.
|
|
711
|
+
# @return [String]
|
|
712
|
+
#
|
|
713
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/GetProcurementPortalPreferenceRequest AWS API Documentation
|
|
714
|
+
#
|
|
715
|
+
class GetProcurementPortalPreferenceRequest < Struct.new(
|
|
716
|
+
:procurement_portal_preference_arn)
|
|
717
|
+
SENSITIVE = []
|
|
718
|
+
include Aws::Structure
|
|
719
|
+
end
|
|
720
|
+
|
|
721
|
+
# @!attribute [rw] procurement_portal_preference
|
|
722
|
+
# The detailed configuration of the requested procurement portal
|
|
723
|
+
# preference.
|
|
724
|
+
# @return [Types::ProcurementPortalPreference]
|
|
725
|
+
#
|
|
726
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/GetProcurementPortalPreferenceResponse AWS API Documentation
|
|
727
|
+
#
|
|
728
|
+
class GetProcurementPortalPreferenceResponse < Struct.new(
|
|
729
|
+
:procurement_portal_preference)
|
|
730
|
+
SENSITIVE = []
|
|
731
|
+
include Aws::Structure
|
|
732
|
+
end
|
|
733
|
+
|
|
481
734
|
# The processing request failed because of an unknown error, exception,
|
|
482
735
|
# or failure.
|
|
483
736
|
#
|
|
@@ -896,6 +1149,45 @@ module Aws::Invoicing
|
|
|
896
1149
|
include Aws::Structure
|
|
897
1150
|
end
|
|
898
1151
|
|
|
1152
|
+
# @!attribute [rw] next_token
|
|
1153
|
+
# The token for the next set of results. (You received this token from
|
|
1154
|
+
# a previous call.)
|
|
1155
|
+
# @return [String]
|
|
1156
|
+
#
|
|
1157
|
+
# @!attribute [rw] max_results
|
|
1158
|
+
# The maximum number of results to return in a single call. To
|
|
1159
|
+
# retrieve the remaining results, make another call with the returned
|
|
1160
|
+
# NextToken value.
|
|
1161
|
+
# @return [Integer]
|
|
1162
|
+
#
|
|
1163
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/ListProcurementPortalPreferencesRequest AWS API Documentation
|
|
1164
|
+
#
|
|
1165
|
+
class ListProcurementPortalPreferencesRequest < Struct.new(
|
|
1166
|
+
:next_token,
|
|
1167
|
+
:max_results)
|
|
1168
|
+
SENSITIVE = []
|
|
1169
|
+
include Aws::Structure
|
|
1170
|
+
end
|
|
1171
|
+
|
|
1172
|
+
# @!attribute [rw] procurement_portal_preferences
|
|
1173
|
+
# The list of procurement portal preferences associated with the
|
|
1174
|
+
# Amazon Web Services account.
|
|
1175
|
+
# @return [Array<Types::ProcurementPortalPreferenceSummary>]
|
|
1176
|
+
#
|
|
1177
|
+
# @!attribute [rw] next_token
|
|
1178
|
+
# The token to use to retrieve the next set of results, or null if
|
|
1179
|
+
# there are no more results.
|
|
1180
|
+
# @return [String]
|
|
1181
|
+
#
|
|
1182
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/ListProcurementPortalPreferencesResponse AWS API Documentation
|
|
1183
|
+
#
|
|
1184
|
+
class ListProcurementPortalPreferencesResponse < Struct.new(
|
|
1185
|
+
:procurement_portal_preferences,
|
|
1186
|
+
:next_token)
|
|
1187
|
+
SENSITIVE = []
|
|
1188
|
+
include Aws::Structure
|
|
1189
|
+
end
|
|
1190
|
+
|
|
899
1191
|
# @!attribute [rw] resource_arn
|
|
900
1192
|
# The Amazon Resource Name (ARN) of tags to list.
|
|
901
1193
|
# @return [String]
|
|
@@ -920,6 +1212,366 @@ module Aws::Invoicing
|
|
|
920
1212
|
include Aws::Structure
|
|
921
1213
|
end
|
|
922
1214
|
|
|
1215
|
+
# Represents the full configuration of a procurement portal preference,
|
|
1216
|
+
# including settings for e-invoice delivery and purchase order
|
|
1217
|
+
# retrieval.
|
|
1218
|
+
#
|
|
1219
|
+
# @!attribute [rw] aws_account_id
|
|
1220
|
+
# The Amazon Web Services account ID associated with this procurement
|
|
1221
|
+
# portal preference.
|
|
1222
|
+
# @return [String]
|
|
1223
|
+
#
|
|
1224
|
+
# @!attribute [rw] procurement_portal_preference_arn
|
|
1225
|
+
# The Amazon Resource Name (ARN) of the procurement portal preference.
|
|
1226
|
+
# @return [String]
|
|
1227
|
+
#
|
|
1228
|
+
# @!attribute [rw] procurement_portal_name
|
|
1229
|
+
# The name of the procurement portal.
|
|
1230
|
+
# @return [String]
|
|
1231
|
+
#
|
|
1232
|
+
# @!attribute [rw] buyer_domain
|
|
1233
|
+
# The domain identifier for the buyer in the procurement portal.
|
|
1234
|
+
# @return [String]
|
|
1235
|
+
#
|
|
1236
|
+
# @!attribute [rw] buyer_identifier
|
|
1237
|
+
# The unique identifier for the buyer in the procurement portal.
|
|
1238
|
+
# @return [String]
|
|
1239
|
+
#
|
|
1240
|
+
# @!attribute [rw] supplier_domain
|
|
1241
|
+
# The domain identifier for the supplier in the procurement portal.
|
|
1242
|
+
# @return [String]
|
|
1243
|
+
#
|
|
1244
|
+
# @!attribute [rw] supplier_identifier
|
|
1245
|
+
# The unique identifier for the supplier in the procurement portal.
|
|
1246
|
+
# @return [String]
|
|
1247
|
+
#
|
|
1248
|
+
# @!attribute [rw] selector
|
|
1249
|
+
# Specifies criteria for selecting which invoices should be processed
|
|
1250
|
+
# using a particular procurement portal preference.
|
|
1251
|
+
# @return [Types::ProcurementPortalPreferenceSelector]
|
|
1252
|
+
#
|
|
1253
|
+
# @!attribute [rw] procurement_portal_shared_secret
|
|
1254
|
+
# The shared secret or authentication credential used for secure
|
|
1255
|
+
# communication with the procurement portal.
|
|
1256
|
+
# @return [String]
|
|
1257
|
+
#
|
|
1258
|
+
# @!attribute [rw] procurement_portal_instance_endpoint
|
|
1259
|
+
# The endpoint URL where e-invoices are delivered to the procurement
|
|
1260
|
+
# portal.
|
|
1261
|
+
# @return [String]
|
|
1262
|
+
#
|
|
1263
|
+
# @!attribute [rw] purchase_order_retrieval_endpoint
|
|
1264
|
+
# The endpoint URL used for retrieving purchase orders from the
|
|
1265
|
+
# procurement portal.
|
|
1266
|
+
# @return [String]
|
|
1267
|
+
#
|
|
1268
|
+
# @!attribute [rw] test_env_preference
|
|
1269
|
+
# Configuration on settings for the test environment of the
|
|
1270
|
+
# procurement portal.
|
|
1271
|
+
# @return [Types::TestEnvPreference]
|
|
1272
|
+
#
|
|
1273
|
+
# @!attribute [rw] einvoice_delivery_enabled
|
|
1274
|
+
# Indicates whether e-invoice delivery is enabled for this procurement
|
|
1275
|
+
# portal preference.
|
|
1276
|
+
# @return [Boolean]
|
|
1277
|
+
#
|
|
1278
|
+
# @!attribute [rw] einvoice_delivery_preference
|
|
1279
|
+
# The configuration settings that specify how e-invoices are delivered
|
|
1280
|
+
# to the procurement portal.
|
|
1281
|
+
# @return [Types::EinvoiceDeliveryPreference]
|
|
1282
|
+
#
|
|
1283
|
+
# @!attribute [rw] purchase_order_retrieval_enabled
|
|
1284
|
+
# Indicates whether purchase order retrieval is enabled for this
|
|
1285
|
+
# procurement portal preference.
|
|
1286
|
+
# @return [Boolean]
|
|
1287
|
+
#
|
|
1288
|
+
# @!attribute [rw] contacts
|
|
1289
|
+
# List of contact information for portal administrators and technical
|
|
1290
|
+
# contacts.
|
|
1291
|
+
# @return [Array<Types::Contact>]
|
|
1292
|
+
#
|
|
1293
|
+
# @!attribute [rw] einvoice_delivery_preference_status
|
|
1294
|
+
# The current status of the e-invoice delivery preference.
|
|
1295
|
+
# @return [String]
|
|
1296
|
+
#
|
|
1297
|
+
# @!attribute [rw] einvoice_delivery_preference_status_reason
|
|
1298
|
+
# The reason for the current e-invoice delivery preference status.
|
|
1299
|
+
# @return [String]
|
|
1300
|
+
#
|
|
1301
|
+
# @!attribute [rw] purchase_order_retrieval_preference_status
|
|
1302
|
+
# The current status of the purchase order retrieval preference.
|
|
1303
|
+
# @return [String]
|
|
1304
|
+
#
|
|
1305
|
+
# @!attribute [rw] purchase_order_retrieval_preference_status_reason
|
|
1306
|
+
# The reason for the current purchase order retrieval preference
|
|
1307
|
+
# status.
|
|
1308
|
+
# @return [String]
|
|
1309
|
+
#
|
|
1310
|
+
# @!attribute [rw] version
|
|
1311
|
+
# The version number of the procurement portal preference
|
|
1312
|
+
# configuration.
|
|
1313
|
+
# @return [Integer]
|
|
1314
|
+
#
|
|
1315
|
+
# @!attribute [rw] create_date
|
|
1316
|
+
# The date and time when the procurement portal preference was
|
|
1317
|
+
# created.
|
|
1318
|
+
# @return [Time]
|
|
1319
|
+
#
|
|
1320
|
+
# @!attribute [rw] last_update_date
|
|
1321
|
+
# The date and time when the procurement portal preference was last
|
|
1322
|
+
# updated.
|
|
1323
|
+
# @return [Time]
|
|
1324
|
+
#
|
|
1325
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/ProcurementPortalPreference AWS API Documentation
|
|
1326
|
+
#
|
|
1327
|
+
class ProcurementPortalPreference < Struct.new(
|
|
1328
|
+
:aws_account_id,
|
|
1329
|
+
:procurement_portal_preference_arn,
|
|
1330
|
+
:procurement_portal_name,
|
|
1331
|
+
:buyer_domain,
|
|
1332
|
+
:buyer_identifier,
|
|
1333
|
+
:supplier_domain,
|
|
1334
|
+
:supplier_identifier,
|
|
1335
|
+
:selector,
|
|
1336
|
+
:procurement_portal_shared_secret,
|
|
1337
|
+
:procurement_portal_instance_endpoint,
|
|
1338
|
+
:purchase_order_retrieval_endpoint,
|
|
1339
|
+
:test_env_preference,
|
|
1340
|
+
:einvoice_delivery_enabled,
|
|
1341
|
+
:einvoice_delivery_preference,
|
|
1342
|
+
:purchase_order_retrieval_enabled,
|
|
1343
|
+
:contacts,
|
|
1344
|
+
:einvoice_delivery_preference_status,
|
|
1345
|
+
:einvoice_delivery_preference_status_reason,
|
|
1346
|
+
:purchase_order_retrieval_preference_status,
|
|
1347
|
+
:purchase_order_retrieval_preference_status_reason,
|
|
1348
|
+
:version,
|
|
1349
|
+
:create_date,
|
|
1350
|
+
:last_update_date)
|
|
1351
|
+
SENSITIVE = [:contacts]
|
|
1352
|
+
include Aws::Structure
|
|
1353
|
+
end
|
|
1354
|
+
|
|
1355
|
+
# Specifies criteria for selecting which invoices should be processed
|
|
1356
|
+
# using a particular procurement portal preference.
|
|
1357
|
+
#
|
|
1358
|
+
# @!attribute [rw] invoice_unit_arns
|
|
1359
|
+
# The Amazon Resource Name (ARN) of invoice unit identifiers to which
|
|
1360
|
+
# this preference applies.
|
|
1361
|
+
# @return [Array<String>]
|
|
1362
|
+
#
|
|
1363
|
+
# @!attribute [rw] seller_of_records
|
|
1364
|
+
# The list of seller of record IDs to which this preference applies.
|
|
1365
|
+
# @return [Array<String>]
|
|
1366
|
+
#
|
|
1367
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/ProcurementPortalPreferenceSelector AWS API Documentation
|
|
1368
|
+
#
|
|
1369
|
+
class ProcurementPortalPreferenceSelector < Struct.new(
|
|
1370
|
+
:invoice_unit_arns,
|
|
1371
|
+
:seller_of_records)
|
|
1372
|
+
SENSITIVE = []
|
|
1373
|
+
include Aws::Structure
|
|
1374
|
+
end
|
|
1375
|
+
|
|
1376
|
+
# Provides a summary of a procurement portal preference, including key
|
|
1377
|
+
# identifiers and status information.
|
|
1378
|
+
#
|
|
1379
|
+
# @!attribute [rw] aws_account_id
|
|
1380
|
+
# The Amazon Web Services account ID associated with this procurement
|
|
1381
|
+
# portal preference summary.
|
|
1382
|
+
# @return [String]
|
|
1383
|
+
#
|
|
1384
|
+
# @!attribute [rw] procurement_portal_preference_arn
|
|
1385
|
+
# The Amazon Resource Name (ARN) of the procurement portal preference.
|
|
1386
|
+
# @return [String]
|
|
1387
|
+
#
|
|
1388
|
+
# @!attribute [rw] procurement_portal_name
|
|
1389
|
+
# The name of the procurement portal.
|
|
1390
|
+
# @return [String]
|
|
1391
|
+
#
|
|
1392
|
+
# @!attribute [rw] buyer_domain
|
|
1393
|
+
# The domain identifier for the buyer in the procurement portal.
|
|
1394
|
+
# @return [String]
|
|
1395
|
+
#
|
|
1396
|
+
# @!attribute [rw] buyer_identifier
|
|
1397
|
+
# The unique identifier for the buyer in the procurement portal.
|
|
1398
|
+
# @return [String]
|
|
1399
|
+
#
|
|
1400
|
+
# @!attribute [rw] supplier_domain
|
|
1401
|
+
# The domain identifier for the supplier in the procurement portal.
|
|
1402
|
+
# @return [String]
|
|
1403
|
+
#
|
|
1404
|
+
# @!attribute [rw] supplier_identifier
|
|
1405
|
+
# The unique identifier for the supplier in the procurement portal.
|
|
1406
|
+
# @return [String]
|
|
1407
|
+
#
|
|
1408
|
+
# @!attribute [rw] selector
|
|
1409
|
+
# Specifies criteria for selecting which invoices should be processed
|
|
1410
|
+
# using a particular procurement portal preference.
|
|
1411
|
+
# @return [Types::ProcurementPortalPreferenceSelector]
|
|
1412
|
+
#
|
|
1413
|
+
# @!attribute [rw] einvoice_delivery_enabled
|
|
1414
|
+
# Indicates whether e-invoice delivery is enabled for this procurement
|
|
1415
|
+
# portal preference.
|
|
1416
|
+
# @return [Boolean]
|
|
1417
|
+
#
|
|
1418
|
+
# @!attribute [rw] purchase_order_retrieval_enabled
|
|
1419
|
+
# Indicates whether purchase order retrieval is enabled for this
|
|
1420
|
+
# procurement portal preference.
|
|
1421
|
+
# @return [Boolean]
|
|
1422
|
+
#
|
|
1423
|
+
# @!attribute [rw] einvoice_delivery_preference_status
|
|
1424
|
+
# The current status of the e-invoice delivery preference in this
|
|
1425
|
+
# summary.
|
|
1426
|
+
# @return [String]
|
|
1427
|
+
#
|
|
1428
|
+
# @!attribute [rw] einvoice_delivery_preference_status_reason
|
|
1429
|
+
# The reason for the current e-invoice delivery preference status in
|
|
1430
|
+
# this summary.
|
|
1431
|
+
# @return [String]
|
|
1432
|
+
#
|
|
1433
|
+
# @!attribute [rw] purchase_order_retrieval_preference_status
|
|
1434
|
+
# The current status of the purchase order retrieval preference in
|
|
1435
|
+
# this summary.
|
|
1436
|
+
# @return [String]
|
|
1437
|
+
#
|
|
1438
|
+
# @!attribute [rw] purchase_order_retrieval_preference_status_reason
|
|
1439
|
+
# The reason for the current purchase order retrieval preference
|
|
1440
|
+
# status in this summary.
|
|
1441
|
+
# @return [String]
|
|
1442
|
+
#
|
|
1443
|
+
# @!attribute [rw] version
|
|
1444
|
+
# The version number of the procurement portal preference
|
|
1445
|
+
# configuration in this summary.
|
|
1446
|
+
# @return [Integer]
|
|
1447
|
+
#
|
|
1448
|
+
# @!attribute [rw] create_date
|
|
1449
|
+
# The date and time when the procurement portal preference was
|
|
1450
|
+
# created.
|
|
1451
|
+
# @return [Time]
|
|
1452
|
+
#
|
|
1453
|
+
# @!attribute [rw] last_update_date
|
|
1454
|
+
# The date and time when the procurement portal preference was last
|
|
1455
|
+
# updated.
|
|
1456
|
+
# @return [Time]
|
|
1457
|
+
#
|
|
1458
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/ProcurementPortalPreferenceSummary AWS API Documentation
|
|
1459
|
+
#
|
|
1460
|
+
class ProcurementPortalPreferenceSummary < Struct.new(
|
|
1461
|
+
:aws_account_id,
|
|
1462
|
+
:procurement_portal_preference_arn,
|
|
1463
|
+
:procurement_portal_name,
|
|
1464
|
+
:buyer_domain,
|
|
1465
|
+
:buyer_identifier,
|
|
1466
|
+
:supplier_domain,
|
|
1467
|
+
:supplier_identifier,
|
|
1468
|
+
:selector,
|
|
1469
|
+
:einvoice_delivery_enabled,
|
|
1470
|
+
:purchase_order_retrieval_enabled,
|
|
1471
|
+
:einvoice_delivery_preference_status,
|
|
1472
|
+
:einvoice_delivery_preference_status_reason,
|
|
1473
|
+
:purchase_order_retrieval_preference_status,
|
|
1474
|
+
:purchase_order_retrieval_preference_status_reason,
|
|
1475
|
+
:version,
|
|
1476
|
+
:create_date,
|
|
1477
|
+
:last_update_date)
|
|
1478
|
+
SENSITIVE = []
|
|
1479
|
+
include Aws::Structure
|
|
1480
|
+
end
|
|
1481
|
+
|
|
1482
|
+
# Specifies the source configuration for retrieving purchase order data.
|
|
1483
|
+
#
|
|
1484
|
+
# @!attribute [rw] einvoice_delivery_document_type
|
|
1485
|
+
# The type of e-invoice document that requires purchase order data.
|
|
1486
|
+
# @return [String]
|
|
1487
|
+
#
|
|
1488
|
+
# @!attribute [rw] purchase_order_data_source_type
|
|
1489
|
+
# The type of source for purchase order data.
|
|
1490
|
+
# @return [String]
|
|
1491
|
+
#
|
|
1492
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/PurchaseOrderDataSource AWS API Documentation
|
|
1493
|
+
#
|
|
1494
|
+
class PurchaseOrderDataSource < Struct.new(
|
|
1495
|
+
:einvoice_delivery_document_type,
|
|
1496
|
+
:purchase_order_data_source_type)
|
|
1497
|
+
SENSITIVE = []
|
|
1498
|
+
include Aws::Structure
|
|
1499
|
+
end
|
|
1500
|
+
|
|
1501
|
+
# @!attribute [rw] procurement_portal_preference_arn
|
|
1502
|
+
# The Amazon Resource Name (ARN) of the procurement portal preference
|
|
1503
|
+
# to update.
|
|
1504
|
+
# @return [String]
|
|
1505
|
+
#
|
|
1506
|
+
# @!attribute [rw] selector
|
|
1507
|
+
# Specifies criteria for selecting which invoices should be processed
|
|
1508
|
+
# using a particular procurement portal preference.
|
|
1509
|
+
# @return [Types::ProcurementPortalPreferenceSelector]
|
|
1510
|
+
#
|
|
1511
|
+
# @!attribute [rw] procurement_portal_shared_secret
|
|
1512
|
+
# The updated shared secret or authentication credential for the
|
|
1513
|
+
# procurement portal. This value must be encrypted at rest.
|
|
1514
|
+
# @return [String]
|
|
1515
|
+
#
|
|
1516
|
+
# @!attribute [rw] procurement_portal_instance_endpoint
|
|
1517
|
+
# The updated endpoint URL where e-invoices will be delivered to the
|
|
1518
|
+
# procurement portal. Must be a valid HTTPS URL.
|
|
1519
|
+
# @return [String]
|
|
1520
|
+
#
|
|
1521
|
+
# @!attribute [rw] test_env_preference
|
|
1522
|
+
# Updated configuration settings for the test environment of the
|
|
1523
|
+
# procurement portal.
|
|
1524
|
+
# @return [Types::TestEnvPreferenceInput]
|
|
1525
|
+
#
|
|
1526
|
+
# @!attribute [rw] einvoice_delivery_enabled
|
|
1527
|
+
# Updated flag indicating whether e-invoice delivery is enabled for
|
|
1528
|
+
# this procurement portal preference.
|
|
1529
|
+
# @return [Boolean]
|
|
1530
|
+
#
|
|
1531
|
+
# @!attribute [rw] einvoice_delivery_preference
|
|
1532
|
+
# Updated e-invoice delivery configuration including document types,
|
|
1533
|
+
# attachment types, and customization settings for the portal.
|
|
1534
|
+
# @return [Types::EinvoiceDeliveryPreference]
|
|
1535
|
+
#
|
|
1536
|
+
# @!attribute [rw] purchase_order_retrieval_enabled
|
|
1537
|
+
# Updated flag indicating whether purchase order retrieval is enabled
|
|
1538
|
+
# for this procurement portal preference.
|
|
1539
|
+
# @return [Boolean]
|
|
1540
|
+
#
|
|
1541
|
+
# @!attribute [rw] contacts
|
|
1542
|
+
# Updated list of contact information for portal administrators and
|
|
1543
|
+
# technical contacts.
|
|
1544
|
+
# @return [Array<Types::Contact>]
|
|
1545
|
+
#
|
|
1546
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/PutProcurementPortalPreferenceRequest AWS API Documentation
|
|
1547
|
+
#
|
|
1548
|
+
class PutProcurementPortalPreferenceRequest < Struct.new(
|
|
1549
|
+
:procurement_portal_preference_arn,
|
|
1550
|
+
:selector,
|
|
1551
|
+
:procurement_portal_shared_secret,
|
|
1552
|
+
:procurement_portal_instance_endpoint,
|
|
1553
|
+
:test_env_preference,
|
|
1554
|
+
:einvoice_delivery_enabled,
|
|
1555
|
+
:einvoice_delivery_preference,
|
|
1556
|
+
:purchase_order_retrieval_enabled,
|
|
1557
|
+
:contacts)
|
|
1558
|
+
SENSITIVE = [:procurement_portal_shared_secret, :contacts]
|
|
1559
|
+
include Aws::Structure
|
|
1560
|
+
end
|
|
1561
|
+
|
|
1562
|
+
# @!attribute [rw] procurement_portal_preference_arn
|
|
1563
|
+
# The Amazon Resource Name (ARN) of the updated procurement portal
|
|
1564
|
+
# preference.
|
|
1565
|
+
# @return [String]
|
|
1566
|
+
#
|
|
1567
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/PutProcurementPortalPreferenceResponse AWS API Documentation
|
|
1568
|
+
#
|
|
1569
|
+
class PutProcurementPortalPreferenceResponse < Struct.new(
|
|
1570
|
+
:procurement_portal_preference_arn)
|
|
1571
|
+
SENSITIVE = []
|
|
1572
|
+
include Aws::Structure
|
|
1573
|
+
end
|
|
1574
|
+
|
|
923
1575
|
# The details of the address associated with the receiver.
|
|
924
1576
|
#
|
|
925
1577
|
# @!attribute [rw] address_line_1
|
|
@@ -1109,6 +1761,102 @@ module Aws::Invoicing
|
|
|
1109
1761
|
include Aws::Structure
|
|
1110
1762
|
end
|
|
1111
1763
|
|
|
1764
|
+
# Contains configuration settings for testing the procurement portal
|
|
1765
|
+
# integration in a non-production environment.
|
|
1766
|
+
#
|
|
1767
|
+
# @!attribute [rw] buyer_domain
|
|
1768
|
+
# The domain identifier for the buyer in the test environment of the
|
|
1769
|
+
# procurement portal.
|
|
1770
|
+
# @return [String]
|
|
1771
|
+
#
|
|
1772
|
+
# @!attribute [rw] buyer_identifier
|
|
1773
|
+
# The unique identifier for the buyer in the test environment of the
|
|
1774
|
+
# procurement portal.
|
|
1775
|
+
# @return [String]
|
|
1776
|
+
#
|
|
1777
|
+
# @!attribute [rw] supplier_domain
|
|
1778
|
+
# The domain identifier for the supplier in the test environment of
|
|
1779
|
+
# the procurement portal.
|
|
1780
|
+
# @return [String]
|
|
1781
|
+
#
|
|
1782
|
+
# @!attribute [rw] supplier_identifier
|
|
1783
|
+
# The unique identifier for the supplier in the test environment of
|
|
1784
|
+
# the procurement portal.
|
|
1785
|
+
# @return [String]
|
|
1786
|
+
#
|
|
1787
|
+
# @!attribute [rw] procurement_portal_shared_secret
|
|
1788
|
+
# The shared secret or authentication credential used for secure
|
|
1789
|
+
# communication with the test environment.
|
|
1790
|
+
# @return [String]
|
|
1791
|
+
#
|
|
1792
|
+
# @!attribute [rw] procurement_portal_instance_endpoint
|
|
1793
|
+
# The endpoint URL where e-invoices are delivered in the test
|
|
1794
|
+
# environment.
|
|
1795
|
+
# @return [String]
|
|
1796
|
+
#
|
|
1797
|
+
# @!attribute [rw] purchase_order_retrieval_endpoint
|
|
1798
|
+
# The endpoint URL used for retrieving purchase orders in the test
|
|
1799
|
+
# environment.
|
|
1800
|
+
# @return [String]
|
|
1801
|
+
#
|
|
1802
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/TestEnvPreference AWS API Documentation
|
|
1803
|
+
#
|
|
1804
|
+
class TestEnvPreference < Struct.new(
|
|
1805
|
+
:buyer_domain,
|
|
1806
|
+
:buyer_identifier,
|
|
1807
|
+
:supplier_domain,
|
|
1808
|
+
:supplier_identifier,
|
|
1809
|
+
:procurement_portal_shared_secret,
|
|
1810
|
+
:procurement_portal_instance_endpoint,
|
|
1811
|
+
:purchase_order_retrieval_endpoint)
|
|
1812
|
+
SENSITIVE = []
|
|
1813
|
+
include Aws::Structure
|
|
1814
|
+
end
|
|
1815
|
+
|
|
1816
|
+
# Input parameters for configuring test environment preferences for a
|
|
1817
|
+
# procurement portal.
|
|
1818
|
+
#
|
|
1819
|
+
# @!attribute [rw] buyer_domain
|
|
1820
|
+
# The domain identifier to use for the buyer in the test environment.
|
|
1821
|
+
# @return [String]
|
|
1822
|
+
#
|
|
1823
|
+
# @!attribute [rw] buyer_identifier
|
|
1824
|
+
# The unique identifier to use for the buyer in the test environment.
|
|
1825
|
+
# @return [String]
|
|
1826
|
+
#
|
|
1827
|
+
# @!attribute [rw] supplier_domain
|
|
1828
|
+
# The domain identifier to use for the supplier in the test
|
|
1829
|
+
# environment.
|
|
1830
|
+
# @return [String]
|
|
1831
|
+
#
|
|
1832
|
+
# @!attribute [rw] supplier_identifier
|
|
1833
|
+
# The unique identifier to use for the supplier in the test
|
|
1834
|
+
# environment.
|
|
1835
|
+
# @return [String]
|
|
1836
|
+
#
|
|
1837
|
+
# @!attribute [rw] procurement_portal_shared_secret
|
|
1838
|
+
# The shared secret or authentication credential to use for secure
|
|
1839
|
+
# communication in the test environment.
|
|
1840
|
+
# @return [String]
|
|
1841
|
+
#
|
|
1842
|
+
# @!attribute [rw] procurement_portal_instance_endpoint
|
|
1843
|
+
# The endpoint URL where e-invoices will be delivered in the test
|
|
1844
|
+
# environment.
|
|
1845
|
+
# @return [String]
|
|
1846
|
+
#
|
|
1847
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/TestEnvPreferenceInput AWS API Documentation
|
|
1848
|
+
#
|
|
1849
|
+
class TestEnvPreferenceInput < Struct.new(
|
|
1850
|
+
:buyer_domain,
|
|
1851
|
+
:buyer_identifier,
|
|
1852
|
+
:supplier_domain,
|
|
1853
|
+
:supplier_identifier,
|
|
1854
|
+
:procurement_portal_shared_secret,
|
|
1855
|
+
:procurement_portal_instance_endpoint)
|
|
1856
|
+
SENSITIVE = []
|
|
1857
|
+
include Aws::Structure
|
|
1858
|
+
end
|
|
1859
|
+
|
|
1112
1860
|
# The request was denied due to request throttling.
|
|
1113
1861
|
#
|
|
1114
1862
|
# @!attribute [rw] message
|
|
@@ -1186,6 +1934,54 @@ module Aws::Invoicing
|
|
|
1186
1934
|
include Aws::Structure
|
|
1187
1935
|
end
|
|
1188
1936
|
|
|
1937
|
+
# @!attribute [rw] procurement_portal_preference_arn
|
|
1938
|
+
# The Amazon Resource Name (ARN) of the procurement portal preference
|
|
1939
|
+
# to update.
|
|
1940
|
+
# @return [String]
|
|
1941
|
+
#
|
|
1942
|
+
# @!attribute [rw] einvoice_delivery_preference_status
|
|
1943
|
+
# The updated status of the e-invoice delivery preference.
|
|
1944
|
+
# @return [String]
|
|
1945
|
+
#
|
|
1946
|
+
# @!attribute [rw] einvoice_delivery_preference_status_reason
|
|
1947
|
+
# The reason for the e-invoice delivery preference status update,
|
|
1948
|
+
# providing context for the change.
|
|
1949
|
+
# @return [String]
|
|
1950
|
+
#
|
|
1951
|
+
# @!attribute [rw] purchase_order_retrieval_preference_status
|
|
1952
|
+
# The updated status of the purchase order retrieval preference.
|
|
1953
|
+
# @return [String]
|
|
1954
|
+
#
|
|
1955
|
+
# @!attribute [rw] purchase_order_retrieval_preference_status_reason
|
|
1956
|
+
# The reason for the purchase order retrieval preference status
|
|
1957
|
+
# update, providing context for the change.
|
|
1958
|
+
# @return [String]
|
|
1959
|
+
#
|
|
1960
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/UpdateProcurementPortalPreferenceStatusRequest AWS API Documentation
|
|
1961
|
+
#
|
|
1962
|
+
class UpdateProcurementPortalPreferenceStatusRequest < Struct.new(
|
|
1963
|
+
:procurement_portal_preference_arn,
|
|
1964
|
+
:einvoice_delivery_preference_status,
|
|
1965
|
+
:einvoice_delivery_preference_status_reason,
|
|
1966
|
+
:purchase_order_retrieval_preference_status,
|
|
1967
|
+
:purchase_order_retrieval_preference_status_reason)
|
|
1968
|
+
SENSITIVE = []
|
|
1969
|
+
include Aws::Structure
|
|
1970
|
+
end
|
|
1971
|
+
|
|
1972
|
+
# @!attribute [rw] procurement_portal_preference_arn
|
|
1973
|
+
# The Amazon Resource Name (ARN) of the procurement portal preference
|
|
1974
|
+
# with updated status.
|
|
1975
|
+
# @return [String]
|
|
1976
|
+
#
|
|
1977
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/UpdateProcurementPortalPreferenceStatusResponse AWS API Documentation
|
|
1978
|
+
#
|
|
1979
|
+
class UpdateProcurementPortalPreferenceStatusResponse < Struct.new(
|
|
1980
|
+
:procurement_portal_preference_arn)
|
|
1981
|
+
SENSITIVE = []
|
|
1982
|
+
include Aws::Structure
|
|
1983
|
+
end
|
|
1984
|
+
|
|
1189
1985
|
# The input fails to satisfy the constraints specified by an Amazon Web
|
|
1190
1986
|
# Services service.
|
|
1191
1987
|
#
|