account.py

# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

from typing import TYPE_CHECKING, Dict, Optional
from datetime import date, datetime
from typing_extensions import Literal

from pydantic import Field as FieldInfo

from .._models import BaseModel

__all__ = ["Account", "Loan"]


class Loan(BaseModel):
    """The Account's loan-related information, if the Account is a loan account."""

    credit_limit: int
    """The maximum amount of money that can be borrowed on the Account."""

    grace_period_days: int
    """
    The number of days after the statement date that the Account can be past due
    before being considered delinquent.
    """

    maturity_date: Optional[date] = None
    """The date on which the loan matures."""

    statement_day_of_month: int
    """The day of the month on which the loan statement is generated."""

    statement_payment_type: Literal["balance", "interest_until_maturity"]
    """The type of payment for the loan.

    - `balance` - The borrower must pay the full balance of the loan at the end of
      the statement period.
    - `interest_until_maturity` - The borrower must pay the accrued interest at the
      end of the statement period.
    """


class Account(BaseModel):
    """Accounts are your bank accounts with Increase.

    They store money, receive transfers, and send payments. They earn interest and have depository insurance.
    """

    id: str
    """The Account identifier."""

    account_revenue_rate: Optional[str] = None
    """
    The account revenue rate currently being earned on the account, as a string
    containing a decimal number. For example, a 1% account revenue rate would be
    represented as "0.01". Account revenue is a type of non-interest income accrued
    on the account.
    """

    bank: Literal["core_bank", "first_internet_bank", "grasshopper_bank"]
    """The bank the Account is with.

    - `core_bank` - Core Bank
    - `first_internet_bank` - First Internet Bank of Indiana
    - `grasshopper_bank` - Grasshopper Bank
    """

    closed_at: Optional[datetime] = None
    """
    The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account
    was closed.
    """

    created_at: datetime
    """
    The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account
    was created.
    """

    currency: Literal["USD"]
    """
    The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Account
    currency.

    - `USD` - US Dollar (USD)
    """

    entity_id: str
    """The identifier for the Entity the Account belongs to."""

    funding: Literal["loan", "deposits"]
    """Whether the Account is funded by a loan or by deposits.

    - `loan` - An account funded by a loan. Before opening a loan account, contact
      support@increase.com to set up a loan program.
    - `deposits` - An account funded by deposits.
    """

    idempotency_key: Optional[str] = None
    """The idempotency key you chose for this object.

    This value is unique across Increase and is used to ensure that a request is
    only processed once. Learn more about
    [idempotency](https://increase.com/documentation/idempotency-keys).
    """

    informational_entity_id: Optional[str] = None
    """
    The identifier of an Entity that, while not owning the Account, is associated
    with its activity.
    """

    interest_accrued: str
    """
    The interest accrued but not yet paid, expressed as a string containing a
    floating-point value.
    """

    interest_accrued_at: Optional[date] = None
    """
    The latest [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which
    interest was accrued.
    """

    interest_rate: str
    """
    The interest rate currently being earned on the account, as a string containing
    a decimal number. For example, a 1% interest rate would be represented as
    "0.01".
    """

    loan: Optional[Loan] = None
    """The Account's loan-related information, if the Account is a loan account."""

    name: str
    """The name you choose for the Account."""

    program_id: str
    """
    The identifier of the Program determining the compliance and commercial terms of
    this Account.
    """

    status: Literal["closed", "open"]
    """The status of the Account.

    - `closed` - Closed Accounts on which no new activity can occur.
    - `open` - Open Accounts that are ready to use.
    """

    type: Literal["account"]
    """A constant representing the object's type.

    For this resource it will always be `account`.
    """

    if TYPE_CHECKING:
        # Some versions of Pydantic <2.8.0 have a bug and don’t allow assigning a
        # value to this field, so for compatibility we avoid doing it at runtime.
        __pydantic_extra__: Dict[str, object] = FieldInfo(init=False)  # pyright: ignore[reportIncompatibleVariableOverride]

        # Stub to indicate that arbitrary properties are accepted.
        # To access properties that are not valid identifiers you can use `getattr`, e.g.
        # `getattr(obj, '$type')`
        def __getattr__(self, attr: str) -> object: ...
    else:
        __pydantic_extra__: Dict[str, object]