Invoicing / Client / list_procurement_portals

list_procurement_portals

Invoicing.Client.list_procurement_portals(**kwargs)

Returns the Amazon Web Services-supported procurement portals for e-invoice delivery and purchase order retrieval. Each entry includes the portal identifier, name, and default feature configurations, which define the supported document and attachment types. For faster, more reliable responses, use pagination.

See also: AWS API Documentation

Request Syntax

response = client.list_procurement_portals(
    NextToken='string',
    MaxResults=123
)
Parameters:

  • NextToken (string) – The token for the next set of results. You received this token from a previous call.

  • MaxResults (integer) – The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. Default is 100.

Return type:

dict

Returns:

Response Syntax

{
    'ProcurementPortals': [
        {
            'PortalIdentifier': 'string',
            'PortalName': 'SAP_BUSINESS_NETWORK'|'COUPA',
            'PortalDisplayName': 'string',
            'DefaultFeatureConfigurations': {
                'InvoiceConfiguration': {
                    'DocumentTypes': [
                        'AWS_CLOUD_INVOICE'|'AWS_CLOUD_CREDIT_MEMO'|'AWS_MARKETPLACE_INVOICE'|'AWS_MARKETPLACE_CREDIT_MEMO'|'AWS_REQUEST_FOR_PAYMENT',
                    ],
                    'AttachmentTypes': [
                        'INVOICE_PDF'|'RFP_PDF',
                    ]
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ProcurementPortals (list) –

      The list of procurement portals available for configuration.

      • (dict) –

        Contains metadata for a procurement portal, including the portal identifier, name, and default feature configurations.

        • PortalIdentifier (string) –

          The unique identifier of the procurement portal.

        • PortalName (string) –

          The name of the procurement portal.

        • PortalDisplayName (string) –

          The display name of the procurement portal.

        • DefaultFeatureConfigurations (dict) –

          The default feature configurations for the procurement portal.

          • InvoiceConfiguration (dict) –

            The invoice configuration settings for the procurement portal.

            • DocumentTypes (list) –

              The e-invoice document types supported by the procurement portal.

              • (string) –

            • AttachmentTypes (list) –

              The attachment types supported by the procurement portal for e-invoice delivery.

              • (string) –

    • NextToken (string) –

      The token to use to retrieve the next set of results, or null if there are no more results.

Exceptions

  • Invoicing.Client.exceptions.ValidationException

  • Invoicing.Client.exceptions.InternalServerException

  • Invoicing.Client.exceptions.ThrottlingException

  • Invoicing.Client.exceptions.AccessDeniedException