@simplyhomes/sos-sdk/dist/generated/src/models/V4LeasingsCreateLeasingBodyDto.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 { SoSLeasingEntityType } from './SoSLeasingEntityType';
import type { SoSLeasingEntityTerm } from './SoSLeasingEntityTerm';
import type { SoSLeasingEntityStatus } from './SoSLeasingEntityStatus';
/**
 *
 * @export
 * @interface V4LeasingsCreateLeasingBodyDto
 */
export interface V4LeasingsCreateLeasingBodyDto {
    /**
     * Unit ID reference - every leasing must be associated with a specific unit
     * @type {number}
     * @memberof V4LeasingsCreateLeasingBodyDto
     */
    unitId: number;
    /**
     * Current status of the leasing
     * @type {SoSLeasingEntityStatus}
     * @memberof V4LeasingsCreateLeasingBodyDto
     */
    status?: SoSLeasingEntityStatus;
    /**
     * Type of leasing agreement
     * @type {SoSLeasingEntityType}
     * @memberof V4LeasingsCreateLeasingBodyDto
     */
    type?: SoSLeasingEntityType;
    /**
     * Additional notes about the leasing
     * @type {string}
     * @memberof V4LeasingsCreateLeasingBodyDto
     */
    notes?: string;
    /**
     * Lease term type
     * @type {SoSLeasingEntityTerm}
     * @memberof V4LeasingsCreateLeasingBodyDto
     */
    term?: SoSLeasingEntityTerm;
    /**
     * Date when lease was signed by tenant
     * @type {Date}
     * @memberof V4LeasingsCreateLeasingBodyDto
     */
    signedByTenantDate?: string;
    /**
     * Lease start date
     * @type {Date}
     * @memberof V4LeasingsCreateLeasingBodyDto
     */
    startDate?: string;
    /**
     * Date when tenant moved in
     * @type {Date}
     * @memberof V4LeasingsCreateLeasingBodyDto
     */
    moveInDate?: string;
    /**
     * Lease end date
     * @type {Date}
     * @memberof V4LeasingsCreateLeasingBodyDto
     */
    leaseEndDate?: string;
    /**
     * Renewal date for the lease
     * @type {Date}
     * @memberof V4LeasingsCreateLeasingBodyDto
     */
    renewalDate?: string;
    /**
     * Security deposit amount
     * @type {number}
     * @memberof V4LeasingsCreateLeasingBodyDto
     */
    securityDeposit?: number;
    /**
     * Monthly payment amount from tenant
     * @type {number}
     * @memberof V4LeasingsCreateLeasingBodyDto
     */
    tenantPaymentAmount?: number;
    /**
     * Monthly payment amount from housing authority
     * @type {number}
     * @memberof V4LeasingsCreateLeasingBodyDto
     */
    housingAuthorityAmount?: number;
    /**
     * Additional payment amount
     * @type {number}
     * @memberof V4LeasingsCreateLeasingBodyDto
     */
    additionalPaymentAmount?: number;
    /**
     * Notes about additional payments
     * @type {string}
     * @memberof V4LeasingsCreateLeasingBodyDto
     */
    additionalPaymentNotes?: string;
}
/**
 * Check if a given object implements the V4LeasingsCreateLeasingBodyDto interface.
 */
export declare function instanceOfV4LeasingsCreateLeasingBodyDto(value: object): value is V4LeasingsCreateLeasingBodyDto;
export declare function V4LeasingsCreateLeasingBodyDtoFromJSON(json: any): V4LeasingsCreateLeasingBodyDto;
export declare function V4LeasingsCreateLeasingBodyDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): V4LeasingsCreateLeasingBodyDto;
export declare function V4LeasingsCreateLeasingBodyDtoToJSON(json: any): V4LeasingsCreateLeasingBodyDto;
export declare function V4LeasingsCreateLeasingBodyDtoToJSONTyped(value?: V4LeasingsCreateLeasingBodyDto | null, ignoreDiscriminator?: boolean): any;
//# sourceMappingURL=V4LeasingsCreateLeasingBodyDto.d.ts.map