Invoicing / Client / put_procurement_portal_preference

put_procurement_portal_preference

Invoicing.Client.put_procurement_portal_preference(**kwargs)

Updates an existing procurement portal preference configuration. This operation can modify settings for e-invoice delivery and purchase order retrieval.

See also: AWS API Documentation

Request Syntax

response = client.put_procurement_portal_preference(
    ProcurementPortalPreferenceArn='string',
    Selector={
        'InvoiceUnitArns': [
            'string',
        ],
        'SellerOfRecords': [
            'string',
        ]
    },
    ProcurementPortalSharedSecret='string',
    ProcurementPortalInstanceEndpoint='string',
    TestEnvPreference={
        'BuyerDomain': 'NetworkID',
        'BuyerIdentifier': 'string',
        'SupplierDomain': 'NetworkID',
        'SupplierIdentifier': 'string',
        'ProcurementPortalSharedSecret': 'string',
        'ProcurementPortalInstanceEndpoint': 'string'
    },
    EinvoiceDeliveryEnabled=True|False,
    EinvoiceDeliveryPreference={
        'EinvoiceDeliveryDocumentTypes': [
            'AWS_CLOUD_INVOICE'|'AWS_CLOUD_CREDIT_MEMO'|'AWS_MARKETPLACE_INVOICE'|'AWS_MARKETPLACE_CREDIT_MEMO'|'AWS_REQUEST_FOR_PAYMENT',
        ],
        'EinvoiceDeliveryAttachmentTypes': [
            'INVOICE_PDF'|'RFP_PDF',
        ],
        'Protocol': 'CXML',
        'PurchaseOrderDataSources': [
            {
                'EinvoiceDeliveryDocumentType': 'AWS_CLOUD_INVOICE'|'AWS_CLOUD_CREDIT_MEMO'|'AWS_MARKETPLACE_INVOICE'|'AWS_MARKETPLACE_CREDIT_MEMO'|'AWS_REQUEST_FOR_PAYMENT',
                'PurchaseOrderDataSourceType': 'ASSOCIATED_PURCHASE_ORDER_REQUIRED'|'PURCHASE_ORDER_NOT_REQUIRED'
            },
        ],
        'ConnectionTestingMethod': 'PROD_ENV_DOLLAR_TEST'|'TEST_ENV_REPLAY_TEST',
        'EinvoiceDeliveryActivationDate': datetime(2015, 1, 1)
    },
    PurchaseOrderRetrievalEnabled=True|False,
    Contacts=[
        {
            'Name': 'string',
            'Email': 'string'
        },
    ]
)

Parameters:

• ProcurementPortalPreferenceArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the procurement portal preference to update.

• Selector (dict) –

  Specifies criteria for selecting which invoices should be processed using a particular procurement portal preference.

  • InvoiceUnitArns (list) –

    The Amazon Resource Name (ARN) of invoice unit identifiers to which this preference applies.

    • (string) –

  • SellerOfRecords (list) –

    The list of seller of record IDs to which this preference applies.

    • (string) –

• ProcurementPortalSharedSecret (string) – The updated shared secret or authentication credential for the procurement portal. This value must be encrypted at rest.

• ProcurementPortalInstanceEndpoint (string) – The updated endpoint URL where e-invoices will be delivered to the procurement portal. Must be a valid HTTPS URL.

• TestEnvPreference (dict) –

  Updated configuration settings for the test environment of the procurement portal.

  • BuyerDomain (string) – [REQUIRED]

    The domain identifier to use for the buyer in the test environment.

  • BuyerIdentifier (string) – [REQUIRED]

    The unique identifier to use for the buyer in the test environment.

  • SupplierDomain (string) – [REQUIRED]

    The domain identifier to use for the supplier in the test environment.

  • SupplierIdentifier (string) – [REQUIRED]

    The unique identifier to use for the supplier in the test environment.

  • ProcurementPortalSharedSecret (string) –

    The shared secret or authentication credential to use for secure communication in the test environment.

  • ProcurementPortalInstanceEndpoint (string) –

    The endpoint URL where e-invoices will be delivered in the test environment.

• EinvoiceDeliveryEnabled (boolean) –

  [REQUIRED]

  Updated flag indicating whether e-invoice delivery is enabled for this procurement portal preference.

• EinvoiceDeliveryPreference (dict) –

  Updated e-invoice delivery configuration including document types, attachment types, and customization settings for the portal.

  • EinvoiceDeliveryDocumentTypes (list) – [REQUIRED]

    The types of e-invoice documents to be delivered.

    • (string) –

  • EinvoiceDeliveryAttachmentTypes (list) –

    The types of attachments to include with the e-invoice delivery.

    • (string) –

  • Protocol (string) – [REQUIRED]

    The communication protocol to use for e-invoice delivery.

  • PurchaseOrderDataSources (list) – [REQUIRED]

    The sources of purchase order data to use for e-invoice generation and delivery.

    • (dict) –

      Specifies the source configuration for retrieving purchase order data.

      • EinvoiceDeliveryDocumentType (string) –

        The type of e-invoice document that requires purchase order data.

      • PurchaseOrderDataSourceType (string) –

        The type of source for purchase order data.

  • ConnectionTestingMethod (string) – [REQUIRED]

    The method to use for testing the connection to the procurement portal.

  • EinvoiceDeliveryActivationDate (datetime) – [REQUIRED]

    The date when e-invoice delivery should be activated for this preference.

• PurchaseOrderRetrievalEnabled (boolean) –

  [REQUIRED]

  Updated flag indicating whether purchase order retrieval is enabled for this procurement portal preference.

• Contacts (list) –

  [REQUIRED]

  Updated list of contact information for portal administrators and technical contacts.

  • (dict) –

    Represents contact information for a person or role associated with the procurement portal preference.

    • Name (string) –

      The name of the contact person or role.

    • Email (string) –

      The email address of the contact person or role.

Return type:

dict

Returns:

Response Syntax

{
    'ProcurementPortalPreferenceArn': 'string'
}

Response Structure

• (dict) –

  • ProcurementPortalPreferenceArn (string) –

    The Amazon Resource Name (ARN) of the updated procurement portal preference.

Exceptions

• Invoicing.Client.exceptions.ResourceNotFoundException

• Invoicing.Client.exceptions.ConflictException

• Invoicing.Client.exceptions.ValidationException

• Invoicing.Client.exceptions.InternalServerException

• Invoicing.Client.exceptions.ServiceQuotaExceededException

• Invoicing.Client.exceptions.ThrottlingException

• Invoicing.Client.exceptions.AccessDeniedException