# This file was auto-generated by Fern from our API Definition.

import typing

import pydantic
import typing_extensions
from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
from ...core.serialization import FieldMetadata
from ...types.contacts_response import ContactsResponse
from .transfer_out_detail_vendor_billing_data import TransferOutDetailVendorBillingData


class TransferOutDetailVendor(UniversalBaseModel):
    """
    Vendor information for an outbound transfer detail.
    """

    vendor_number: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="VendorNumber")] = (
        pydantic.Field(default=None)
    )
    """
    The vendor's unique number.
    """

    name_1: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="Name1")] = pydantic.Field(
        default=None
    )
    """
    Primary name of the vendor.
    """

    name_2: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="Name2")] = pydantic.Field(
        default=None
    )
    """
    Secondary name of the vendor.
    """

    ein: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="EIN")] = pydantic.Field(default=None)
    """
    Employer Identification Number.
    """

    phone: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="Phone")] = pydantic.Field(
        default=None
    )
    """
    Vendor's phone number.
    """

    email: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="Email")] = pydantic.Field(
        default=None
    )
    """
    Vendor's email address.
    """

    remit_email: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="RemitEmail")] = pydantic.Field(
        default=None
    )
    """
    Email for remittance notifications.
    """

    address_1: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="Address1")] = pydantic.Field(
        default=None
    )
    """
    Primary address line.
    """

    address_2: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="Address2")] = pydantic.Field(
        default=None
    )
    """
    Secondary address line.
    """

    city: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="City")] = pydantic.Field(default=None)
    """
    City of the vendor.
    """

    state: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="State")] = pydantic.Field(
        default=None
    )
    """
    State of the vendor.
    """

    zip: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="Zip")] = pydantic.Field(default=None)
    """
    ZIP code of the vendor.
    """

    country: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="Country")] = pydantic.Field(
        default=None
    )
    """
    Country of the vendor.
    """

    mcc: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="Mcc")] = pydantic.Field(default=None)
    """
    Merchant Category Code.
    """

    location_code: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="LocationCode")] = (
        pydantic.Field(default=None)
    )
    """
    Location code for the vendor.
    """

    contacts: typing_extensions.Annotated[
        typing.Optional[typing.List[ContactsResponse]], FieldMetadata(alias="Contacts")
    ] = pydantic.Field(default=None)
    """
    List of contacts for the vendor.
    """

    billing_data: typing_extensions.Annotated[
        typing.Optional[TransferOutDetailVendorBillingData], FieldMetadata(alias="BillingData")
    ] = pydantic.Field(default=None)
    """
    Billing data for the vendor.
    """

    payment_method: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="PaymentMethod")] = (
        pydantic.Field(default=None)
    )
    """
    Preferred payment method.
    """

    vendor_status: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="VendorStatus")] = (
        pydantic.Field(default=None)
    )
    """
    Status of the vendor.
    """

    vendor_id: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="VendorId")] = pydantic.Field(
        default=None
    )
    """
    Unique identifier for the vendor.
    """

    enrollment_status: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="EnrollmentStatus")] = (
        pydantic.Field(default=None)
    )
    """
    Enrollment status of the vendor.
    """

    summary: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="Summary")] = pydantic.Field(
        default=None
    )
    """
    Summary information about the vendor.
    """

    paypoint_legalname: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="PaypointLegalname")] = (
        pydantic.Field(default=None)
    )
    """
    Legal name of the paypoint.
    """

    paypoint_id: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="PaypointId")] = pydantic.Field(
        default=None
    )
    """
    ID of the paypoint.
    """

    paypoint_dbaname: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="PaypointDbaname")] = (
        pydantic.Field(default=None)
    )
    """
    DBA name of the paypoint.
    """

    paypoint_entryname: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="PaypointEntryname")] = (
        pydantic.Field(default=None)
    )
    """
    Entry name of the paypoint.
    """

    parent_org_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="ParentOrgName")] = (
        pydantic.Field(default=None)
    )
    """
    Name of the parent organization.
    """

    parent_org_id: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="ParentOrgId")] = (
        pydantic.Field(default=None)
    )
    """
    ID of the parent organization.
    """

    created_date: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="CreatedDate")] = (
        pydantic.Field(default=None)
    )
    """
    Date the vendor was created.
    """

    last_updated: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="LastUpdated")] = (
        pydantic.Field(default=None)
    )
    """
    Date the vendor was last updated.
    """

    remit_address_1: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="remitAddress1")] = (
        pydantic.Field(default=None)
    )
    """
    Primary remittance address line.
    """

    remit_address_2: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="remitAddress2")] = (
        pydantic.Field(default=None)
    )
    """
    Secondary remittance address line.
    """

    remit_city: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="remitCity")] = pydantic.Field(
        default=None
    )
    """
    Remittance city.
    """

    remit_state: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="remitState")] = pydantic.Field(
        default=None
    )
    """
    Remittance state.
    """

    remit_zip: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="remitZip")] = pydantic.Field(
        default=None
    )
    """
    Remittance ZIP code.
    """

    remit_country: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="remitCountry")] = (
        pydantic.Field(default=None)
    )
    """
    Remittance country.
    """

    payee_name_1: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="payeeName1")] = pydantic.Field(
        default=None
    )
    """
    Primary payee name.
    """

    payee_name_2: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="payeeName2")] = pydantic.Field(
        default=None
    )
    """
    Secondary payee name.
    """

    custom_field_1: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="customField1")] = (
        pydantic.Field(default=None)
    )
    """
    Custom field 1.
    """

    custom_field_2: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="customField2")] = (
        pydantic.Field(default=None)
    )
    """
    Custom field 2.
    """

    customer_vendor_account: typing_extensions.Annotated[
        typing.Optional[str], FieldMetadata(alias="customerVendorAccount")
    ] = pydantic.Field(default=None)
    """
    Customer vendor account number.
    """

    internal_reference_id: typing_extensions.Annotated[
        typing.Optional[int], FieldMetadata(alias="InternalReferenceId")
    ] = pydantic.Field(default=None)
    """
    Internal reference ID.
    """

    additional_data: typing_extensions.Annotated[
        typing.Optional[typing.Dict[str, typing.Any]], FieldMetadata(alias="additionalData")
    ] = pydantic.Field(default=None)
    """
    Additional data for the vendor.
    """

    external_paypoint_id: typing_extensions.Annotated[
        typing.Optional[str], FieldMetadata(alias="externalPaypointID")
    ] = pydantic.Field(default=None)
    """
    External paypoint ID.
    """

    stored_methods: typing_extensions.Annotated[
        typing.Optional[typing.List[typing.Any]], FieldMetadata(alias="StoredMethods")
    ] = pydantic.Field(default=None)
    """
    Stored payment methods for the vendor.
    """

    if IS_PYDANTIC_V2:
        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
    else:

        class Config:
            frozen = True
            smart_union = True
            extra = pydantic.Extra.allow
