ListProcurementPortalPreferencesResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-billing-and-cost-management/json-schema/amazon-billing-and-cost-management-list-procurement-portal-preferences-response-schema.json",
  "title": "ListProcurementPortalPreferencesResponse",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-billing-and-cost-management-procurement-portal-preference-api-openapi.yml#/components/schemas/ListProcurementPortalPreferencesResponse",
  "type": "object",
  "properties": {
    "ProcurementPortalPreferences": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ProcurementPortalPreferenceSummary"
      },
      "description": "The list of procurement portal preferences associated with the Amazon Web Services account."
    },
    "NextToken": {
      "type": "string",
      "description": "The token to use to retrieve the next set of results, or null if there are no more results."
    }
  },
  "$defs": {
    "ProcurementPortalPreferenceSelector": {
      "type": "object",
      "properties": {
        "InvoiceUnitArns": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The Amazon Resource Name (ARN) of invoice unit identifiers to which this preference applies."
        },
        "SellerOfRecords": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The list of seller of record IDs to which this preference applies."
        }
      }
    },
    "ProcurementPortalPreferenceSummary": {
      "type": "object",
      "properties": {
        "AwsAccountId": {
          "type": "string",
          "description": "The Amazon Web Services account ID associated with this procurement portal preference summary."
        },
        "ProcurementPortalPreferenceArn": {
          "type": "string",
          "description": "The Amazon Resource Name (ARN) of the procurement portal preference."
        },
        "ProcurementPortalName": {
          "type": "string",
          "enum": [
            "SAP_BUSINESS_NETWORK",
            "COUPA"
          ],
          "description": "The name of the procurement portal."
        },
        "BuyerDomain": {
          "type": "string",
          "enum": [
            "NetworkID"
          ],
          "description": "The domain identifier for the buyer in the procurement portal."
        },
        "BuyerIdentifier": {
          "type": "string",
          "description": "The unique identifier for the buyer in the procurement portal."
        },
        "SupplierDomain": {
          "type": "string",
          "enum": [
            "NetworkID"
          ],
          "description": "The domain identifier for the supplier in the procurement portal."
        },
        "SupplierIdentifier": {
          "type": "string",
          "description": "The unique identifier for the supplier in the procurement portal."
        },
        "Selector": {
          "$ref": "#/$defs/ProcurementPortalPreferenceSelector"
        },
        "EinvoiceDeliveryEnabled": {
          "type": "boolean",
          "description": "Indicates whether e-invoice delivery is enabled for this procurement portal preference."
        },
        "PurchaseOrderRetrievalEnabled": {
          "type": "boolean",
          "description": "Indicates whether purchase order retrieval is enabled for this procurement portal preference."
        },
        "MarketplacePunchOutEnabled": {
          "type": "boolean",
          "description": "Indicates whether Marketplace PunchOut is enabled for this procurement portal preference. Defaults to false."
        },
        "EinvoiceDeliveryPreferenceStatus": {
          "type": "string",
          "enum": [
            "PENDING_VERIFICATION",
            "VALIDATED",
            "TEST_INITIALIZED",
            "TEST_INITIALIZATION_FAILED",
            "TEST_FAILED",
            "ACTIVE",
            "SUSPENDED"
          ],
          "description": "The current status of the e-invoice delivery preference in this summary."
        },
        "EinvoiceDeliveryPreferenceStatusReason": {
          "type": "string",
          "description": "The reason for the current e-invoice delivery preference status in this summary."
        },
        "PurchaseOrderRetrievalPreferenceStatus": {
          "type": "string",
          "enum": [
            "PENDING_VERIFICATION",
            "VALIDATED",
            "TEST_INITIALIZED",
            "TEST_INITIALIZATION_FAILED",
            "TEST_FAILED",
            "ACTIVE",
            "SUSPENDED"
          ],
          "description": "The current status of the purchase order retrieval preference in this summary."
        },
        "PurchaseOrderRetrievalPreferenceStatusReason": {
          "type": "string",
          "description": "The reason for the current purchase order retrieval preference status in this summary."
        },
        "Version": {
          "type": "integer",
          "description": "The version number of the procurement portal preference configuration in this summary."
        },
        "CreateDate": {
          "type": "string",
          "description": "The date and time when the procurement portal preference was created."
        },
        "LastUpdateDate": {
          "type": "string",
          "description": "The date and time when the procurement portal preference was last updated."
        }
      },
      "required": [
        "AwsAccountId",
        "ProcurementPortalPreferenceArn",
        "ProcurementPortalName",
        "BuyerDomain",
        "BuyerIdentifier",
        "SupplierDomain",
        "SupplierIdentifier",
        "EinvoiceDeliveryEnabled",
        "PurchaseOrderRetrievalEnabled",
        "Version",
        "CreateDate",
        "LastUpdateDate"
      ]
    }
  }
}