Models API Reference¶

BaseModel¶

Base class for all data models.

class BaseModel:
    rec_id: Optional[int]

Pool¶

Represents a mortgage pool.

class Pool(BaseModel):
    Account: Optional[str]
    Name: Optional[str]
    InceptionDate: Optional[datetime]
    LastEvaluation: Optional[datetime]
    SysTimeStamp: Optional[datetime]
    OtherAssets: List[OtherAsset]
    OtherLiabilities: List[OtherLiability]

OtherAsset¶

Represents an asset in a pool.

class OtherAsset(BaseModel):
    Description: Optional[str]
    Value: Optional[float]
    DateLastEvaluated: Optional[datetime]

OtherLiability¶

Represents a liability in a pool.

class OtherLiability(BaseModel):
    Description: Optional[str]
    Amount: Optional[float]
    MaturityDate: Optional[datetime]
    PaymentNextDue: Optional[datetime]

Response Models¶

BaseResponse¶

class BaseResponse:
    status: Optional[int]
    message: Optional[str]
    data: Any

PoolResponse¶

class PoolResponse(BaseResponse):
    pool: Optional[Pool]

PoolsResponse¶

class PoolsResponse(BaseResponse):
    pools: List[Pool]