procurement_portal_preferences

Creates, updates, deletes, gets or lists a procurement_portal_preferences resource.

Overview

Name	`procurement_portal_preferences`
Type	Resource
Id	`aws.invoicing.procurement_portal_preferences`

Fields

The following fields are returned by SELECT queries:

get_procurement_portal_preference
list_procurement_portal_preferences

Name	Datatype	Description
`aws_account_id`	`string`	The Amazon Web Services account ID associated with this procurement portal preference. (pattern: <code>\d{12}</code>)
`buyer_domain`	`string`	The domain identifier for the buyer in the procurement portal. (NetworkID)
`buyer_identifier`	`string`	The unique identifier for the buyer in the procurement portal. (pattern: <code>\S+</code>)
`contacts`	`array`	List of contact information for portal administrators and technical contacts.
`create_date`	`string (date-time)`	The date and time when the procurement portal preference was created.
`einvoice_delivery_enabled`	`boolean`	Indicates whether e-invoice delivery is enabled for this procurement portal preference.
`einvoice_delivery_preference`	`object`	The configuration settings that specify how e-invoices are delivered to the procurement portal.
`einvoice_delivery_preference_status`	`string`	The current status of the e-invoice delivery preference. (PENDING_VERIFICATION, VALIDATED, TEST_INITIALIZED, TEST_INITIALIZATION_FAILED, TEST_FAILED, ACTIVE, SUSPENDED)
`einvoice_delivery_preference_status_reason`	`string`	The reason for the current e-invoice delivery preference status. (pattern: <code>[\s\S]*</code>)
`last_update_date`	`string (date-time)`	The date and time when the procurement portal preference was last updated.
`procurement_portal_instance_endpoint`	`string`	The endpoint URL where e-invoices are delivered to the procurement portal. (pattern: <code>\S+</code>)
`procurement_portal_name`	`string`	The name of the procurement portal. (SAP_BUSINESS_NETWORK, COUPA)
`procurement_portal_preference_arn`	`string`	The Amazon Resource Name (ARN) of the procurement portal preference. (pattern: <code>arn:aws:invoicing::[0-9]{12}:procurement-portal-preference/[-a-zA-Z0-9]+</code>)
`procurement_portal_shared_secret`	`string`	The shared secret or authentication credential used for secure communication with the procurement portal. (pattern: <code>\S+</code>)
`purchase_order_retrieval_enabled`	`boolean`	Indicates whether purchase order retrieval is enabled for this procurement portal preference.
`purchase_order_retrieval_endpoint`	`string`	The endpoint URL used for retrieving purchase orders from the procurement portal. (pattern: <code>\S+</code>)
`purchase_order_retrieval_preference_status`	`string`	The current status of the purchase order retrieval preference. (PENDING_VERIFICATION, VALIDATED, TEST_INITIALIZED, TEST_INITIALIZATION_FAILED, TEST_FAILED, ACTIVE, SUSPENDED)
`purchase_order_retrieval_preference_status_reason`	`string`	The reason for the current purchase order retrieval preference status. (pattern: <code>[\s\S]*</code>)
`selector`	`object`	Specifies criteria for selecting which invoices should be processed using a particular procurement portal preference.
`supplier_domain`	`string`	The domain identifier for the supplier in the procurement portal. (NetworkID)
`supplier_identifier`	`string`	The unique identifier for the supplier in the procurement portal. (pattern: <code>\S+</code>)
`test_env_preference`	`object`	Configuration on settings for the test environment of the procurement portal.
`version`	`integer (int64)`	The version number of the procurement portal preference configuration.

Name	Datatype	Description
`aws_account_id`	`string`	The Amazon Web Services account ID associated with this procurement portal preference summary. (pattern: <code>\d{12}</code>)
`buyer_domain`	`string`	The domain identifier for the buyer in the procurement portal. (NetworkID)
`buyer_identifier`	`string`	The unique identifier for the buyer in the procurement portal. (pattern: <code>\S+</code>)
`create_date`	`string (date-time)`	The date and time when the procurement portal preference was created.
`einvoice_delivery_enabled`	`boolean`	Indicates whether e-invoice delivery is enabled for this procurement portal preference.
`einvoice_delivery_preference_status`	`string`	The current status of the e-invoice delivery preference in this summary. (PENDING_VERIFICATION, VALIDATED, TEST_INITIALIZED, TEST_INITIALIZATION_FAILED, TEST_FAILED, ACTIVE, SUSPENDED)
`einvoice_delivery_preference_status_reason`	`string`	The reason for the current e-invoice delivery preference status in this summary. (pattern: <code>[\s\S]*</code>)
`last_update_date`	`string (date-time)`	The date and time when the procurement portal preference was last updated.
`procurement_portal_name`	`string`	The name of the procurement portal. (SAP_BUSINESS_NETWORK, COUPA)
`procurement_portal_preference_arn`	`string`	The Amazon Resource Name (ARN) of the procurement portal preference. (pattern: <code>arn:aws:invoicing::[0-9]{12}:procurement-portal-preference/[-a-zA-Z0-9]+</code>)
`purchase_order_retrieval_enabled`	`boolean`	Indicates whether purchase order retrieval is enabled for this procurement portal preference.
`purchase_order_retrieval_preference_status`	`string`	The current status of the purchase order retrieval preference in this summary. (PENDING_VERIFICATION, VALIDATED, TEST_INITIALIZED, TEST_INITIALIZATION_FAILED, TEST_FAILED, ACTIVE, SUSPENDED)
`purchase_order_retrieval_preference_status_reason`	`string`	The reason for the current purchase order retrieval preference status in this summary. (pattern: <code>[\s\S]*</code>)
`selector`	`object`	Specifies criteria for selecting which invoices should be processed using a particular procurement portal preference.
`supplier_domain`	`string`	The domain identifier for the supplier in the procurement portal. (NetworkID)
`supplier_identifier`	`string`	The unique identifier for the supplier in the procurement portal. (pattern: <code>\S+</code>)
`version`	`integer (int64)`	The version number of the procurement portal preference configuration in this summary.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Description
`get_procurement_portal_preference`	`select`	`region`	This feature API is subject to changing at any time. For more information, see the Amazon Web Services Service Terms (Betas and Previews). Retrieves the details of a specific procurement portal preference configuration.
`list_procurement_portal_preferences`	`select`	`region`	This feature API is subject to changing at any time. For more information, see the Amazon Web Services Service Terms (Betas and Previews). Retrieves a list of procurement portal preferences associated with the Amazon Web Services account.
`create_procurement_portal_preference`	`insert`	`region`, `ProcurementPortalName`, `BuyerDomain`, `BuyerIdentifier`, `SupplierDomain`, `SupplierIdentifier`, `EinvoiceDeliveryEnabled`, `PurchaseOrderRetrievalEnabled`, `Contacts`	This feature API is subject to changing at any time. For more information, see the Amazon Web Services Service Terms (Betas and Previews). Creates a procurement portal preference configuration for e-invoice delivery and purchase order retrieval. This preference defines how invoices are delivered to a procurement portal and how purchase orders are retrieved.
`update_procurement_portal_preference_status`	`update`	`region`, `ProcurementPortalPreferenceArn`	This feature API is subject to changing at any time. For more information, see the Amazon Web Services Service Terms (Betas and Previews). Updates the status of a procurement portal preference, including the activation state of e-invoice delivery and purchase order retrieval features.
`put_procurement_portal_preference`	`replace`	`region`, `ProcurementPortalPreferenceArn`, `EinvoiceDeliveryEnabled`, `PurchaseOrderRetrievalEnabled`, `Contacts`	This feature API is subject to changing at any time. For more information, see the Amazon Web Services Service Terms (Betas and Previews). Updates an existing procurement portal preference configuration. This operation can modify settings for e-invoice delivery and purchase order retrieval.
`delete_procurement_portal_preference`	`delete`	`region`	This feature API is subject to changing at any time. For more information, see the Amazon Web Services Service Terms (Betas and Previews). Deletes an existing procurement portal preference. This action cannot be undone. Active e-invoice delivery and PO retrieval configurations will be terminated.
`send_procurement_portal_validation`	`exec`	`region`, `ProcurementPortalPreferenceArn`	This feature API is subject to changing at any time. For more information, see the Amazon Web Services Service Terms (Betas and Previews). Sends a validation request for a procurement portal preference. This operation initiates the validation process by issuing a validation code that confirms ownership and connectivity of the configured procurement portal endpoint. Use VerifyProcurementPortalValidation to submit the received code and complete validation.
`verify_procurement_portal_validation`	`exec`	`region`, `ProcurementPortalPreferenceArn`, `Code`	This feature API is subject to changing at any time. For more information, see the Amazon Web Services Service Terms (Betas and Previews). Submits a validation code to complete the validation of a procurement portal preference. Use this operation after calling SendProcurementPortalValidation to confirm ownership and connectivity of the configured procurement portal endpoint.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`region`	`string`	AWS region (default: us-east-1)

`SELECT` examples

get_procurement_portal_preference
list_procurement_portal_preferences

This feature API is subject to changing at any time. For more information, see the Amazon Web Services Service Terms (Betas and Previews). Retrieves the details of a specific procurement portal preference configuration.

SELECT
aws_account_id,
buyer_domain,
buyer_identifier,
contacts,
create_date,
einvoice_delivery_enabled,
einvoice_delivery_preference,
einvoice_delivery_preference_status,
einvoice_delivery_preference_status_reason,
last_update_date,
procurement_portal_instance_endpoint,
procurement_portal_name,
procurement_portal_preference_arn,
procurement_portal_shared_secret,
purchase_order_retrieval_enabled,
purchase_order_retrieval_endpoint,
purchase_order_retrieval_preference_status,
purchase_order_retrieval_preference_status_reason,
selector,
supplier_domain,
supplier_identifier,
test_env_preference,
version
FROM aws.invoicing.procurement_portal_preferences
WHERE region = '{{ region }}' -- required
;

This feature API is subject to changing at any time. For more information, see the Amazon Web Services Service Terms (Betas and Previews). Retrieves a list of procurement portal preferences associated with the Amazon Web Services account.

SELECT
aws_account_id,
buyer_domain,
buyer_identifier,
create_date,
einvoice_delivery_enabled,
einvoice_delivery_preference_status,
einvoice_delivery_preference_status_reason,
last_update_date,
procurement_portal_name,
procurement_portal_preference_arn,
purchase_order_retrieval_enabled,
purchase_order_retrieval_preference_status,
purchase_order_retrieval_preference_status_reason,
selector,
supplier_domain,
supplier_identifier,
version
FROM aws.invoicing.procurement_portal_preferences
WHERE region = '{{ region }}' -- required
;

`INSERT` examples

create_procurement_portal_preference
Manifest

This feature API is subject to changing at any time. For more information, see the Amazon Web Services Service Terms (Betas and Previews). Creates a procurement portal preference configuration for e-invoice delivery and purchase order retrieval. This preference defines how invoices are delivered to a procurement portal and how purchase orders are retrieved.

INSERT INTO aws.invoicing.procurement_portal_preferences (
ProcurementPortalName,
BuyerDomain,
BuyerIdentifier,
SupplierDomain,
SupplierIdentifier,
Selector,
ProcurementPortalSharedSecret,
ProcurementPortalInstanceEndpoint,
TestEnvPreference,
EinvoiceDeliveryEnabled,
EinvoiceDeliveryPreference,
PurchaseOrderRetrievalEnabled,
Contacts,
ResourceTags,
ClientToken,
region
)
SELECT 
'{{ ProcurementPortalName }}' /* required */,
'{{ BuyerDomain }}' /* required */,
'{{ BuyerIdentifier }}' /* required */,
'{{ SupplierDomain }}' /* required */,
'{{ SupplierIdentifier }}' /* required */,
'{{ Selector }}',
'{{ ProcurementPortalSharedSecret }}',
'{{ ProcurementPortalInstanceEndpoint }}',
'{{ TestEnvPreference }}',
{{ EinvoiceDeliveryEnabled }} /* required */,
'{{ EinvoiceDeliveryPreference }}',
{{ PurchaseOrderRetrievalEnabled }} /* required */,
'{{ Contacts }}' /* required */,
'{{ ResourceTags }}',
'{{ ClientToken }}',
'{{ region }}'
RETURNING
procurement_portal_preference_arn
;

# Description fields are for documentation purposes
- name: procurement_portal_preferences
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the procurement_portal_preferences resource.
  - name: ProcurementPortalName
    value: "{{ ProcurementPortalName }}"
    description: |
      The name of the procurement portal.
    valid_values: ['SAP_BUSINESS_NETWORK', 'COUPA']
  - name: BuyerDomain
    value: "{{ BuyerDomain }}"
    description: |
      The domain identifier for the buyer in the procurement portal.
    valid_values: ['NetworkID']
  - name: BuyerIdentifier
    value: "{{ BuyerIdentifier }}"
    description: |
      The unique identifier for the buyer in the procurement portal.
  - name: SupplierDomain
    value: "{{ SupplierDomain }}"
    description: |
      The domain identifier for the supplier in the procurement portal.
    valid_values: ['NetworkID']
  - name: SupplierIdentifier
    value: "{{ SupplierIdentifier }}"
    description: |
      The unique identifier for the supplier in the procurement portal.
  - name: Selector
    description: |
      Specifies criteria for selecting which invoices should be processed using a particular procurement portal preference.
    value:
      InvoiceUnitArns:
        - "{{ InvoiceUnitArns }}"
      SellerOfRecords:
        - "{{ SellerOfRecords }}"
  - name: ProcurementPortalSharedSecret
    value: "{{ ProcurementPortalSharedSecret }}"
    description: |
      The shared secret or authentication credential used to establish secure communication with the procurement portal. This value must be encrypted at rest.
  - name: ProcurementPortalInstanceEndpoint
    value: "{{ ProcurementPortalInstanceEndpoint }}"
    description: |
      The endpoint URL where e-invoices will be delivered to the procurement portal. Must be a valid HTTPS URL.
  - name: TestEnvPreference
    description: |
      Configuration settings for the test environment of the procurement portal. Includes test credentials and endpoints that are used for validation before production deployment.
    value:
      BuyerDomain: "{{ BuyerDomain }}"
      BuyerIdentifier: "{{ BuyerIdentifier }}"
      SupplierDomain: "{{ SupplierDomain }}"
      SupplierIdentifier: "{{ SupplierIdentifier }}"
      ProcurementPortalSharedSecret: "{{ ProcurementPortalSharedSecret }}"
      ProcurementPortalInstanceEndpoint: "{{ ProcurementPortalInstanceEndpoint }}"
  - name: EinvoiceDeliveryEnabled
    value: {{ EinvoiceDeliveryEnabled }}
    description: |
      Indicates whether e-invoice delivery is enabled for this procurement portal preference. Set to true to enable e-invoice delivery, false to disable.
  - name: EinvoiceDeliveryPreference
    description: |
      Specifies the e-invoice delivery configuration including document types, attachment types, and customization settings for the portal.
    value:
      EinvoiceDeliveryDocumentTypes:
        - "{{ EinvoiceDeliveryDocumentTypes }}"
      EinvoiceDeliveryAttachmentTypes:
        - "{{ EinvoiceDeliveryAttachmentTypes }}"
      Protocol: "{{ Protocol }}"
      PurchaseOrderDataSources:
        - EinvoiceDeliveryDocumentType: "{{ EinvoiceDeliveryDocumentType }}"
          PurchaseOrderDataSourceType: "{{ PurchaseOrderDataSourceType }}"
      ConnectionTestingMethod: "{{ ConnectionTestingMethod }}"
      EinvoiceDeliveryActivationDate: "{{ EinvoiceDeliveryActivationDate }}"
  - name: PurchaseOrderRetrievalEnabled
    value: {{ PurchaseOrderRetrievalEnabled }}
    description: |
      Indicates whether purchase order retrieval is enabled for this procurement portal preference. Set to true to enable PO retrieval, false to disable.
  - name: Contacts
    description: |
      List of contact information for portal administrators and technical contacts responsible for the e-invoice integration.
    value:
      - Name: "{{ Name }}"
        Email: "{{ Email }}"
  - name: ResourceTags
    description: |
      The tags to apply to this procurement portal preference resource. Each tag consists of a key and an optional value.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      A unique, case-sensitive identifier that you provide to ensure idempotency of the request.

`UPDATE` examples

update_procurement_portal_preference_status

This feature API is subject to changing at any time. For more information, see the Amazon Web Services Service Terms (Betas and Previews). Updates the status of a procurement portal preference, including the activation state of e-invoice delivery and purchase order retrieval features.

UPDATE aws.invoicing.procurement_portal_preferences
SET 
ProcurementPortalPreferenceArn = '{{ ProcurementPortalPreferenceArn }}',
EinvoiceDeliveryPreferenceStatus = '{{ EinvoiceDeliveryPreferenceStatus }}',
EinvoiceDeliveryPreferenceStatusReason = '{{ EinvoiceDeliveryPreferenceStatusReason }}',
PurchaseOrderRetrievalPreferenceStatus = '{{ PurchaseOrderRetrievalPreferenceStatus }}',
PurchaseOrderRetrievalPreferenceStatusReason = '{{ PurchaseOrderRetrievalPreferenceStatusReason }}',
ClientToken = '{{ ClientToken }}'
WHERE 
region = '{{ region }}' --required
AND ProcurementPortalPreferenceArn = '{{ ProcurementPortalPreferenceArn }}' --required
RETURNING
procurement_portal_preference_arn;

`REPLACE` examples

put_procurement_portal_preference

This feature API is subject to changing at any time. For more information, see the Amazon Web Services Service Terms (Betas and Previews). Updates an existing procurement portal preference configuration. This operation can modify settings for e-invoice delivery and purchase order retrieval.

REPLACE aws.invoicing.procurement_portal_preferences
SET 
ProcurementPortalPreferenceArn = '{{ ProcurementPortalPreferenceArn }}',
Selector = '{{ Selector }}',
ProcurementPortalSharedSecret = '{{ ProcurementPortalSharedSecret }}',
ProcurementPortalInstanceEndpoint = '{{ ProcurementPortalInstanceEndpoint }}',
TestEnvPreference = '{{ TestEnvPreference }}',
EinvoiceDeliveryEnabled = {{ EinvoiceDeliveryEnabled }},
EinvoiceDeliveryPreference = '{{ EinvoiceDeliveryPreference }}',
PurchaseOrderRetrievalEnabled = {{ PurchaseOrderRetrievalEnabled }},
Contacts = '{{ Contacts }}',
ClientToken = '{{ ClientToken }}'
WHERE 
region = '{{ region }}' --required
AND ProcurementPortalPreferenceArn = '{{ ProcurementPortalPreferenceArn }}' --required
AND EinvoiceDeliveryEnabled = {{ EinvoiceDeliveryEnabled }} --required
AND PurchaseOrderRetrievalEnabled = {{ PurchaseOrderRetrievalEnabled }} --required
AND Contacts = '{{ Contacts }}' --required
RETURNING
procurement_portal_preference_arn;

`DELETE` examples

delete_procurement_portal_preference

This feature API is subject to changing at any time. For more information, see the Amazon Web Services Service Terms (Betas and Previews). Deletes an existing procurement portal preference. This action cannot be undone. Active e-invoice delivery and PO retrieval configurations will be terminated.

DELETE FROM aws.invoicing.procurement_portal_preferences
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

send_procurement_portal_validation
verify_procurement_portal_validation

This feature API is subject to changing at any time. For more information, see the Amazon Web Services Service Terms (Betas and Previews). Sends a validation request for a procurement portal preference. This operation initiates the validation process by issuing a validation code that confirms ownership and connectivity of the configured procurement portal endpoint. Use VerifyProcurementPortalValidation to submit the received code and complete validation.

EXEC aws.invoicing.procurement_portal_preferences.send_procurement_portal_validation 
@region='{{ region }}' --required 
@@json=
'{
"ProcurementPortalPreferenceArn": "{{ ProcurementPortalPreferenceArn }}", 
"ClientToken": "{{ ClientToken }}"
}'
;

This feature API is subject to changing at any time. For more information, see the Amazon Web Services Service Terms (Betas and Previews). Submits a validation code to complete the validation of a procurement portal preference. Use this operation after calling SendProcurementPortalValidation to confirm ownership and connectivity of the configured procurement portal endpoint.

EXEC aws.invoicing.procurement_portal_preferences.verify_procurement_portal_validation 
@region='{{ region }}' --required 
@@json=
'{
"ProcurementPortalPreferenceArn": "{{ ProcurementPortalPreferenceArn }}", 
"Code": "{{ Code }}", 
"ClientToken": "{{ ClientToken }}"
}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

REPLACE examples​

DELETE examples​

Lifecycle Methods​