Invoicing / Paginator / ListProcurementPortalPreferences

ListProcurementPortalPreferences

class Invoicing.Paginator.ListProcurementPortalPreferences

paginator = client.get_paginator('list_procurement_portal_preferences')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Invoicing.Client.list_procurement_portal_preferences().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

• MaxItems (integer) –

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• PageSize (integer) –

  The size of each page.

• StartingToken (string) –

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'ProcurementPortalPreferences': [
        {
            'AwsAccountId': 'string',
            'ProcurementPortalPreferenceArn': 'string',
            'ProcurementPortalName': 'SAP_BUSINESS_NETWORK'|'COUPA',
            'BuyerDomain': 'NetworkID',
            'BuyerIdentifier': 'string',
            'SupplierDomain': 'NetworkID',
            'SupplierIdentifier': 'string',
            'Selector': {
                'InvoiceUnitArns': [
                    'string',
                ],
                'SellerOfRecords': [
                    'string',
                ]
            },
            'EinvoiceDeliveryEnabled': True|False,
            'PurchaseOrderRetrievalEnabled': True|False,
            'EinvoiceDeliveryPreferenceStatus': 'PENDING_VERIFICATION'|'TEST_INITIALIZED'|'TEST_INITIALIZATION_FAILED'|'TEST_FAILED'|'ACTIVE'|'SUSPENDED',
            'EinvoiceDeliveryPreferenceStatusReason': 'string',
            'PurchaseOrderRetrievalPreferenceStatus': 'PENDING_VERIFICATION'|'TEST_INITIALIZED'|'TEST_INITIALIZATION_FAILED'|'TEST_FAILED'|'ACTIVE'|'SUSPENDED',
            'PurchaseOrderRetrievalPreferenceStatusReason': 'string',
            'Version': 123,
            'CreateDate': datetime(2015, 1, 1),
            'LastUpdateDate': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • ProcurementPortalPreferences (list) –

    The list of procurement portal preferences associated with the Amazon Web Services account.

    • (dict) –

      Provides a summary of a procurement portal preference, including key identifiers and status information.

      • AwsAccountId (string) –

        The Amazon Web Services account ID associated with this procurement portal preference summary.

      • ProcurementPortalPreferenceArn (string) –

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

      • ProcurementPortalName (string) –

        The name of the procurement portal.

      • BuyerDomain (string) –

        The domain identifier for the buyer in the procurement portal.

      • BuyerIdentifier (string) –

        The unique identifier for the buyer in the procurement portal.

      • SupplierDomain (string) –

        The domain identifier for the supplier in the procurement portal.

      • SupplierIdentifier (string) –

        The unique identifier for the supplier in the procurement portal.

      • 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) –

      • EinvoiceDeliveryEnabled (boolean) –

        Indicates whether e-invoice delivery is enabled for this procurement portal preference.

      • PurchaseOrderRetrievalEnabled (boolean) –

        Indicates whether purchase order retrieval is enabled for this procurement portal preference.

      • EinvoiceDeliveryPreferenceStatus (string) –

        The current status of the e-invoice delivery preference in this summary.

      • EinvoiceDeliveryPreferenceStatusReason (string) –

        The reason for the current e-invoice delivery preference status in this summary.

      • PurchaseOrderRetrievalPreferenceStatus (string) –

        The current status of the purchase order retrieval preference in this summary.

      • PurchaseOrderRetrievalPreferenceStatusReason (string) –

        The reason for the current purchase order retrieval preference status in this summary.

      • Version (integer) –

        The version number of the procurement portal preference configuration in this summary.

      • CreateDate (datetime) –

        The date and time when the procurement portal preference was created.

      • LastUpdateDate (datetime) –

        The date and time when the procurement portal preference was last updated.