@simplyhomes/sos-sdk/dist/generated/src/models/SoSPropertyEntityBase.d.ts

TypeScript SDK for Simply Homes SoS API v4

/**
 * API v4
 * Swagger documentation for API v4
 *
 * The version of the OpenAPI document: 4.0
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { SoSPropertyEntityGeocodingData } from './SoSPropertyEntityGeocodingData';
import type { SoSPropertyEntityUnderwritingModel } from './SoSPropertyEntityUnderwritingModel';
import type { SoSPropertyEntityUnderwritingModelsCalculated } from './SoSPropertyEntityUnderwritingModelsCalculated';
import type { SoSPropertyEntityAttomAllEventDetailData } from './SoSPropertyEntityAttomAllEventDetailData';
import type { SoSPropertyEntityUnderwritingModelsMaxPrice } from './SoSPropertyEntityUnderwritingModelsMaxPrice';
/**
 *
 * @export
 * @interface SoSPropertyEntityBase
 */
export interface SoSPropertyEntityBase {
    /**
     * Unique property identifier
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    pid: string;
    /**
     * When the property was created
     * @type {Date}
     * @memberof SoSPropertyEntityBase
     */
    createdAt?: string;
    /**
     * Google Places ID for the property location
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    placeId?: string;
    /**
     * Full address on one line
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    addressOneLine: string;
    /**
     * State abbreviation
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    state?: string;
    /**
     * County name
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    countyName?: string;
    /**
     * City name
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    city?: string;
    /**
     * Geocoding data from Google APIs
     * @type {SoSPropertyEntityGeocodingData}
     * @memberof SoSPropertyEntityBase
     */
    geocodingData?: SoSPropertyEntityGeocodingData;
    /**
     * Detailed property data from ATTOM Data
     * @type {SoSPropertyEntityAttomAllEventDetailData}
     * @memberof SoSPropertyEntityBase
     */
    attomAllEventDetailData?: SoSPropertyEntityAttomAllEventDetailData;
    /**
     * ZIP/postal code
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    zip?: string;
    /**
     * Square footage of the property
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    sqft?: number;
    /**
     * Year the property was built
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    yearBuilt?: number;
    /**
     * Property price
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    price?: number;
    /**
     * Street view image upload ID
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    streetviewIu?: string;
    /**
     * Market ID
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    marketId?: number;
    /**
     * County ID reference
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    countyId?: string;
    /**
     * School zone ID reference
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    schoolzoneId?: string;
    /**
     * Neighborhood ID reference
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    neighborhoodId?: string;
    /**
     * ATTOM Automated Valuation Model value
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    attomAvm?: number;
    /**
     * Census tract tier classification
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    tractTier?: string;
    /**
     * Housing authority ID reference
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    housingAuthorityId?: number;
    /**
     * Type of property (single-family, multi-family, etc.)
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    propertyType?: string;
    /**
     * Latitude coordinate
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    lat?: number;
    /**
     * Longitude coordinate
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    lng?: number;
    /**
     * Geometric coordinates (PostGIS geometry)
     * @type {object}
     * @memberof SoSPropertyEntityBase
     */
    coordinates?: object;
    /**
     * Gross monthly rent
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    grossRent?: number;
    /**
     * Final gross monthly rent after overrides
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    grossRentFinal?: number;
    /**
     * Manual override for gross rent
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    grossRentOverride?: number;
    /**
     * Monthly property tax
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    taxMonthly?: number;
    /**
     * Last year tax amount from ATTOM data
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    attomLastYearTax?: number;
    /**
     * Target purchase price for the property
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    targetPurchasePrice?: number;
    /**
     * Number of units in the property
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    unitCount?: number;
    /**
     * Current status of the property
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    status?: string;
    /**
     * List of underwriting models for the property
     * @type {Array<SoSPropertyEntityUnderwritingModel>}
     * @memberof SoSPropertyEntityBase
     */
    underwritingModels?: Array<SoSPropertyEntityUnderwritingModel>;
    /**
     * Calculated values from underwriting models
     * @type {Array<SoSPropertyEntityUnderwritingModelsCalculated>}
     * @memberof SoSPropertyEntityBase
     */
    underwritingModelsCalculated?: Array<SoSPropertyEntityUnderwritingModelsCalculated>;
    /**
     * Property snapshots for historical data
     * @type {Array<object>}
     * @memberof SoSPropertyEntityBase
     */
    snapshots?: Array<object>;
    /**
     * Maximum price calculations for underwriting models
     * @type {Array<SoSPropertyEntityUnderwritingModelsMaxPrice>}
     * @memberof SoSPropertyEntityBase
     */
    underwritingModelsMaxPrices?: Array<SoSPropertyEntityUnderwritingModelsMaxPrice>;
    /**
     * CompanyCam project URL
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    companycamUrl?: string;
    /**
     * Property access details and instructions
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    accessDetails?: string;
    /**
     * Organization ID that owns this property
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    oid?: number;
    /**
     * Lender ID reference
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    lenderId?: number;
    /**
     * Source ID where this property was found
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    sourceId?: number;
    /**
     * Original price from the source
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    sourcePrice?: number;
    /**
     * Creation date of the associated source
     * @type {Date}
     * @memberof SoSPropertyEntityBase
     */
    sourceCreatedAt?: string;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    targetPurchasePriceOverride?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    targetPurchasePriceFinal?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    simplyAcquisitionFee?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    simplyAcquisitionFeeOverride?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    simplyAcquisitionFeeFinal?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    titleInsurance?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    titleInsuranceOverride?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    titleInsuranceFinal?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    transferTax?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    transferTaxOverride?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    transferTaxFinal?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    titleCompanyId?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    estimatedGrossHud?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    additionalOwnershipReserve?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    totalOwnerReserves?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    pmOnboardingTotal?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    pmReserveTotal?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    ownerId?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    estimatedAcquisitionCost?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    renovationCost?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    allIn?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    propertyManagerId?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    pmFeesPercentageOverride?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    pmFeesMonthly?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    assetManagerId?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    amFeesPercentageOverride?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    vacancyMonthly?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    repairAndMaintenanceMonthly?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    insuranceMonthly?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    noiMonthly?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    noiAnnually?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    capRate?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    amFeesMonthly?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    attomArv?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    arvUplift?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    maxPriceCapRate?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    maxPriceArvUplift?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    maxPriceCapRateTries?: number;
    /**
     *
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    characteristicsWaterSupply?: string;
    /**
     *
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    characteristicsSewageType?: string;
    /**
     *
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    characteristicsDrainType?: string;
    /**
     *
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    characteristicsConstruction?: string;
    /**
     *
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    characteristicsFoundation?: string;
    /**
     *
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    characteristicsSiding?: string;
    /**
     *
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    characteristicsRoofType?: string;
    /**
     *
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    characteristicsRoofAge?: string;
    /**
     *
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    characteristicsStories?: string;
    /**
     *
     * @type {boolean}
     * @memberof SoSPropertyEntityBase
     */
    featureHasAttic?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof SoSPropertyEntityBase
     */
    featureHasDeck?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof SoSPropertyEntityBase
     */
    featureHasPatio?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof SoSPropertyEntityBase
     */
    featureHasCommonSpace?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof SoSPropertyEntityBase
     */
    featureHasYard?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof SoSPropertyEntityBase
     */
    featureHasElevator?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof SoSPropertyEntityBase
     */
    featureHasBasement?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof SoSPropertyEntityBase
     */
    featureHasCommonLaundry?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof SoSPropertyEntityBase
     */
    featureHasGarage?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof SoSPropertyEntityBase
     */
    featureHasGate?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof SoSPropertyEntityBase
     */
    featureHasExteriorStairs?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof SoSPropertyEntityBase
     */
    featureHasPool?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof SoSPropertyEntityBase
     */
    featureHasPorch?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof SoSPropertyEntityBase
     */
    featureHasSidewalk?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof SoSPropertyEntityBase
     */
    featureHasDriveway?: boolean;
    /**
     *
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    maxPriceArvUpliftTries?: string;
    /**
     *
     * @type {boolean}
     * @memberof SoSPropertyEntityBase
     */
    pgcalcMaxPrices?: boolean;
    /**
     *
     * @type {object}
     * @memberof SoSPropertyEntityBase
     */
    dataVerification?: object;
    /**
     *
     * @type {Array<string>}
     * @memberof SoSPropertyEntityBase
     */
    reasons?: Array<string>;
    /**
     *
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    rejectDetail?: string;
    /**
     *
     * @type {Array<number>}
     * @memberof SoSPropertyEntityBase
     */
    scopeOfWork?: Array<number>;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    utilitiesSimplyPayingMonthly?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    pmFeesMonthlyOverride?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    pmFeesMonthlyFinal?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    amFeesMonthlyOverride?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    amFeesMonthlyFinal?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    vacancyMonthlyOverride?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    vacancyMonthlyFinal?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    repairAndMaintenanceMonthlyOverride?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    repairAndMaintenanceMonthlyFinal?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    insuranceMonthlyOverride?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    insuranceMonthlyFinal?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    taxMonthlyOverride?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    taxMonthlyFinal?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    utilitiesSimplyPayingMonthlyOverride?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    utilitiesSimplyPayingMonthlyFinal?: number;
    /**
     *
     * @type {boolean}
     * @memberof SoSPropertyEntityBase
     */
    pgcalcUnderwritingModels?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof SoSPropertyEntityBase
     */
    locked?: boolean;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    estimatedRenovationCost?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    estimatedRenovationCostOverride?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    estimatedRenovationCostFinal?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    estimatedRenovationManagementFee?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    closingCost?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    closingCostOverride?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    closingCostFinal?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    totalOwnerReservesOverride?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    totalOwnerReservesFinal?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    pmOnboardingTotalOverride?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    pmOnboardingTotalFinal?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    pmReserveTotalOverride?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    pmReserveTotalFinal?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    estimatedAcquisitionCostOverride?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    estimatedAcquisitionCostFinal?: number;
    /**
     *
     * @type {boolean}
     * @memberof SoSPropertyEntityBase
     */
    underwritingHcvApplicable?: boolean;
    /**
     *
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    addressLineOne?: string;
    /**
     *
     * @type {Date}
     * @memberof SoSPropertyEntityBase
     */
    underwritingApprovedDate?: string;
    /**
     *
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    underwritingApprovedBy?: string;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    insuranceProviderId?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    insuranceCost?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    accessDetailsOwnerId?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    postPurchaseCost?: number;
    /**
     *
     * @type {number}
     * @memberof SoSPropertyEntityBase
     */
    stories?: number;
    /**
     *
     * @type {Array<number>}
     * @memberof SoSPropertyEntityBase
     */
    files?: Array<number>;
    /**
     *
     * @type {boolean}
     * @memberof SoSPropertyEntityBase
     */
    debtPurchaseWithBridgeLoan?: boolean;
    /**
     *
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    debtStrategy?: string;
    /**
     *
     * @type {boolean}
     * @memberof SoSPropertyEntityBase
     */
    floodZone?: boolean;
    /**
     *
     * @type {string}
     * @memberof SoSPropertyEntityBase
     */
    placeholderOfferType?: string;
}
/**
 * Check if a given object implements the SoSPropertyEntityBase interface.
 */
export declare function instanceOfSoSPropertyEntityBase(value: object): value is SoSPropertyEntityBase;
export declare function SoSPropertyEntityBaseFromJSON(json: any): SoSPropertyEntityBase;
export declare function SoSPropertyEntityBaseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SoSPropertyEntityBase;
export declare function SoSPropertyEntityBaseToJSON(json: any): SoSPropertyEntityBase;
export declare function SoSPropertyEntityBaseToJSONTyped(value?: SoSPropertyEntityBase | null, ignoreDiscriminator?: boolean): any;
//# sourceMappingURL=SoSPropertyEntityBase.d.ts.map