Skip to content

ProcurementPortalPreference

Source code in docs_src/capo_invoicing/types/procurement_portal_preference.py
class ProcurementPortalPreference(TypedDict, closed=True):
    aws_account_id: "capo_invoicing.types.account_id_string.AccountIdString"
    """<p>The Amazon Web Services account ID associated with this procurement portal preference.</p>"""
    procurement_portal_preference_arn: "capo_invoicing.types.procurement_portal_preference_arn_string.ProcurementPortalPreferenceArnString"
    """<p>The Amazon Resource Name (ARN) of the procurement portal preference.</p>"""
    procurement_portal_name: (
        "capo_invoicing.types.procurement_portal_name.ProcurementPortalName"
    )
    """<p>The name of the procurement portal.</p>"""
    buyer_domain: "capo_invoicing.types.buyer_domain.BuyerDomain"
    """<p>The domain identifier for the buyer in the procurement portal.</p>"""
    buyer_identifier: (
        "capo_invoicing.types.basic_string_without_space.BasicStringWithoutSpace"
    )
    """<p>The unique identifier for the buyer in the procurement portal.</p>"""
    supplier_domain: "capo_invoicing.types.supplier_domain.SupplierDomain"
    """<p>The domain identifier for the supplier in the procurement portal.</p>"""
    supplier_identifier: (
        "capo_invoicing.types.basic_string_without_space.BasicStringWithoutSpace"
    )
    """<p>The unique identifier for the supplier in the procurement portal.</p>"""
    selector: NotRequired[
        "capo_invoicing.types.procurement_portal_preference_selector.ProcurementPortalPreferenceSelector"
    ]
    procurement_portal_shared_secret: NotRequired[
        "capo_invoicing.types.basic_string_without_space.BasicStringWithoutSpace"
    ]
    """<p>The shared secret or authentication credential used for secure communication with the procurement portal.</p>"""
    procurement_portal_instance_endpoint: NotRequired[
        "capo_invoicing.types.basic_string_without_space.BasicStringWithoutSpace"
    ]
    """<p>The endpoint URL where e-invoices are delivered to the procurement portal.</p>"""
    purchase_order_retrieval_endpoint: NotRequired[
        "capo_invoicing.types.basic_string_without_space.BasicStringWithoutSpace"
    ]
    """<p>The endpoint URL used for retrieving purchase orders from the procurement portal.</p>"""
    test_env_preference: NotRequired[
        "capo_invoicing.types.test_env_preference.TestEnvPreference"
    ]
    """<p>Configuration on settings for the test environment of the procurement portal.</p>"""
    einvoice_delivery_enabled: "bool"
    """<p>Indicates whether e-invoice delivery is enabled for this procurement portal preference.</p>"""
    einvoice_delivery_preference: NotRequired[
        "capo_invoicing.types.einvoice_delivery_preference.EinvoiceDeliveryPreference"
    ]
    """<p>The e-invoice delivery configuration including document types, attachment types, and customization settings.</p>"""
    purchase_order_retrieval_enabled: "bool"
    """<p>Indicates whether purchase order retrieval is enabled for this procurement portal preference.</p>"""
    marketplace_punch_out_enabled: NotRequired["bool"]
    """<p>Indicates whether Marketplace PunchOut is enabled for this procurement portal preference. Defaults to <code>false</code>.</p>"""
    marketplace_punch_out_preference: NotRequired[
        "capo_invoicing.types.marketplace_punch_out_preference.MarketplacePunchOutPreference"
    ]
    """<p>The Marketplace PunchOut configuration for this procurement portal preference. This is present when <code>MarketplacePunchOutEnabled</code> is <code>true</code>.</p>"""
    contacts: NotRequired["capo_invoicing.types.contacts.Contacts"]
    """<p>List of contact information for portal administrators and technical contacts.</p>"""
    einvoice_delivery_preference_status: NotRequired[
        "capo_invoicing.types.procurement_portal_preference_status.ProcurementPortalPreferenceStatus"
    ]
    """<p>The current status of the e-invoice delivery preference.</p>"""
    einvoice_delivery_preference_status_reason: NotRequired[
        "capo_invoicing.types.basic_string.BasicString"
    ]
    """<p>The reason for the current e-invoice delivery preference status.</p>"""
    purchase_order_retrieval_preference_status: NotRequired[
        "capo_invoicing.types.procurement_portal_preference_status.ProcurementPortalPreferenceStatus"
    ]
    """<p>The current status of the purchase order retrieval preference.</p>"""
    purchase_order_retrieval_preference_status_reason: NotRequired[
        "capo_invoicing.types.basic_string.BasicString"
    ]
    """<p>The reason for the current purchase order retrieval preference status.</p>"""
    version: "int"
    """<p>The version number of the procurement portal preference configuration.</p>"""
    create_date: "datetime.datetime"
    """<p>The date and time when the procurement portal preference was created.</p>"""
    last_update_date: "datetime.datetime"
    """<p>The date and time when the procurement portal preference was last updated.</p>"""

aws_account_id instance-attribute

aws_account_id: AccountIdString

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

buyer_domain instance-attribute

buyer_domain: BuyerDomain

The domain identifier for the buyer in the procurement portal.

buyer_identifier instance-attribute

buyer_identifier: BasicStringWithoutSpace

The unique identifier for the buyer in the procurement portal.

contacts instance-attribute

contacts: NotRequired[Contacts]

List of contact information for portal administrators and technical contacts.

create_date instance-attribute

create_date: datetime

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

einvoice_delivery_enabled instance-attribute

einvoice_delivery_enabled: bool

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

einvoice_delivery_preference instance-attribute

einvoice_delivery_preference: NotRequired[EinvoiceDeliveryPreference]

The e-invoice delivery configuration including document types, attachment types, and customization settings.

einvoice_delivery_preference_status instance-attribute

einvoice_delivery_preference_status: NotRequired[ProcurementPortalPreferenceStatus]

The current status of the e-invoice delivery preference.

einvoice_delivery_preference_status_reason instance-attribute

einvoice_delivery_preference_status_reason: NotRequired[BasicString]

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

last_update_date instance-attribute

last_update_date: datetime

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

marketplace_punch_out_enabled instance-attribute

marketplace_punch_out_enabled: NotRequired[bool]

Indicates whether Marketplace PunchOut is enabled for this procurement portal preference. Defaults to false.

marketplace_punch_out_preference instance-attribute

marketplace_punch_out_preference: NotRequired[MarketplacePunchOutPreference]

The Marketplace PunchOut configuration for this procurement portal preference. This is present when MarketplacePunchOutEnabled is true.

procurement_portal_instance_endpoint instance-attribute

procurement_portal_instance_endpoint: NotRequired[BasicStringWithoutSpace]

The endpoint URL where e-invoices are delivered to the procurement portal.

procurement_portal_name instance-attribute

procurement_portal_name: ProcurementPortalName

The name of the procurement portal.

procurement_portal_preference_arn instance-attribute

procurement_portal_preference_arn: ProcurementPortalPreferenceArnString

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

procurement_portal_shared_secret instance-attribute

procurement_portal_shared_secret: NotRequired[BasicStringWithoutSpace]

The shared secret or authentication credential used for secure communication with the procurement portal.

purchase_order_retrieval_enabled instance-attribute

purchase_order_retrieval_enabled: bool

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

purchase_order_retrieval_endpoint instance-attribute

purchase_order_retrieval_endpoint: NotRequired[BasicStringWithoutSpace]

The endpoint URL used for retrieving purchase orders from the procurement portal.

purchase_order_retrieval_preference_status instance-attribute

purchase_order_retrieval_preference_status: NotRequired[
    ProcurementPortalPreferenceStatus
]

The current status of the purchase order retrieval preference.

purchase_order_retrieval_preference_status_reason instance-attribute

purchase_order_retrieval_preference_status_reason: NotRequired[BasicString]

The reason for the current purchase order retrieval preference status.

selector instance-attribute

selector: NotRequired[ProcurementPortalPreferenceSelector]

supplier_domain instance-attribute

supplier_domain: SupplierDomain

The domain identifier for the supplier in the procurement portal.

supplier_identifier instance-attribute

supplier_identifier: BasicStringWithoutSpace

The unique identifier for the supplier in the procurement portal.

test_env_preference instance-attribute

test_env_preference: NotRequired[TestEnvPreference]

Configuration on settings for the test environment of the procurement portal.

version instance-attribute

version: int

The version number of the procurement portal preference configuration.