Documentation
    Preparing search index...

    Interface Application

    interface Application {
        approvedQuotes: Quote[];
        assignTo: (parties: Partial<AccountParties>) => Promise<false | ApiError>;
        bind: (useSavedPaymentMethod?: boolean) => Promise<string | ApiError>;
        canGenerateQuotes: boolean;
        canPremiumFinanceQuotes: boolean;
        createdAtTimestamp: number;
        creatorUserId?: string;
        declinedQuotes: Quote[];
        delete: () => Promise<false | ApiError>;
        exposures: ApplicationExposure[];
        generateQuotes: () => Promise<false | ApiError>;
        getQuotesPacketFileUrl: () => Promise<string | ApiError>;
        id: string;
        isBeingAssigned: boolean;
        isBinding: boolean;
        isDeleted: boolean;
        isGeneratingQuotes: boolean;
        isLoadingQuotesPacketFileUrl: boolean;
        isLoadingSpecPolicyDocument: boolean;
        isQuotesPurchaseLocked: boolean;
        isUpdating: boolean;
        isUpdatingPartnerCommissionPercentage: boolean;
        lastModifiedTimestamp: number;
        lead: ApplicationLead;
        loadSpecPolicyDocument: (regenerate?: boolean) => Promise<false | ApiError>;
        objectType: APPLICATION;
        organizationId: string;
        pageIndex: number;
        pages: ApplicationPage[];
        parties: AccountParties;
        partnerCommissionPercentage: number | null;
        policyNumber: string;
        questions: ApplicationQuestion[];
        quotes: Quote[];
        quotesAnnualizedPremium: number | null;
        quotesBillingMode: QUOTES_BILLING_MODE;
        quotesGrossTaxesAndFees: number | null;
        quotesPaymentData: QuotesPaymentData | null;
        quotesPaymentDataMap: QuotesPaymentDataMap;
        quotesPaymentMode: QUOTES_PAYMENT_MODE;
        quotesPremiumFinanceEstimate: QuotesPremiumFinanceEstimate | null;
        renewingPolicy: PolicyRenewalData | null;
        responses: ApplicationResponses;
        setPageIndex: (pageIndex: number) => void;
        setQuotesBillingMode: (billingMode: QUOTES_BILLING_MODE) => void;
        setQuotesPaymentMode: (paymentMode: QUOTES_PAYMENT_MODE) => void;
        setStep: (step: APPLICATION_STEP) => void;
        specPolicyDocument: ApplicationSpecPolicyDocument | null;
        status: APPLICATION_STATUS;
        step: APPLICATION_STEP;
        tenantId: string;
        tenantName?: string;
        type: APPLICATION_TYPE;
        unlockQuotesPurchase: () => Promise<false | ApiError>;
        update: (updates: ApplicationUpdates) => Promise<false | ApiError>;
        updatePartnerCommissionPercentage: (
            partnerCommissionPercentage: number,
        ) => Promise<false | ApiError>;
    }

    Hierarchy (View Summary)

    Index
    approvedQuotes assignTo bind canGenerateQuotes canPremiumFinanceQuotes createdAtTimestamp creatorUserId? declinedQuotes delete exposures generateQuotes getQuotesPacketFileUrl id isBeingAssigned isBinding isDeleted isGeneratingQuotes isLoadingQuotesPacketFileUrl isLoadingSpecPolicyDocument isQuotesPurchaseLocked isUpdating isUpdatingPartnerCommissionPercentage lastModifiedTimestamp lead loadSpecPolicyDocument objectType organizationId pageIndex pages parties partnerCommissionPercentage policyNumber questions quotes quotesAnnualizedPremium quotesBillingMode quotesGrossTaxesAndFees quotesPaymentData quotesPaymentDataMap quotesPaymentMode quotesPremiumFinanceEstimate renewingPolicy responses setPageIndex setQuotesBillingMode setQuotesPaymentMode setStep specPolicyDocument status step tenantId tenantName? type unlockQuotesPurchase update updatePartnerCommissionPercentage
    approvedQuotes: Quote[]
    assignTo: (parties: Partial<AccountParties>) => Promise<false | ApiError>

    Assigns the account to the given parties.

    Type Declaration

    bind: (useSavedPaymentMethod?: boolean) => Promise<string | ApiError>

    Binds the application and returns its policy number, loading QuotesPaymentData if direct billing.

    Type Declaration

      • (useSavedPaymentMethod?: boolean): Promise<string | ApiError>

      • Parameters

        • OptionaluseSavedPaymentMethod: boolean

        Returns Promise<string | ApiError>

        ApiError if error occurred.

    canGenerateQuotes: boolean
    canPremiumFinanceQuotes: boolean
    createdAtTimestamp: number
    creatorUserId?: string
    declinedQuotes: Quote[]
    delete: () => Promise<false | ApiError>

    Deletes the application and if a renewal, marks its corresponding Policy for non-renewal.

    Type Declaration

    exposures: ApplicationExposure[]
    generateQuotes: () => Promise<false | ApiError>

    Submits the application for approval to generate new quotes.

    Type Declaration

    getQuotesPacketFileUrl: () => Promise<string | ApiError>

    Returns the packet file URL for the application's quotes.

    Type Declaration

    id: string
    isBeingAssigned: boolean
    isBinding: boolean
    isDeleted: boolean
    isGeneratingQuotes: boolean
    isLoadingQuotesPacketFileUrl: boolean
    isLoadingSpecPolicyDocument: boolean
    isQuotesPurchaseLocked: boolean
    isUpdating: boolean
    isUpdatingPartnerCommissionPercentage: boolean
    lastModifiedTimestamp: number
    lead: ApplicationLead
    loadSpecPolicyDocument: (regenerate?: boolean) => Promise<false | ApiError>

    Loads a "spec" policy document to the application, generating a new one when regenerate is set or the application already has one loaded.

    Type Declaration

      • (regenerate?: boolean): Promise<false | ApiError>

      • Parameters

        • Optionalregenerate: boolean

        Returns Promise<false | ApiError>

        ApiError if error occurred.

    objectType: APPLICATION
    organizationId: string
    pageIndex: number
    pages: ApplicationPage[]
    parties: AccountParties
    partnerCommissionPercentage: number | null
    policyNumber: string
    questions: ApplicationQuestion[]
    quotes: Quote[]
    quotesAnnualizedPremium: number | null
    quotesBillingMode: QUOTES_BILLING_MODE
    quotesGrossTaxesAndFees: number | null
    quotesPaymentData: QuotesPaymentData | null
    quotesPaymentDataMap: QuotesPaymentDataMap
    quotesPaymentMode: QUOTES_PAYMENT_MODE
    quotesPremiumFinanceEstimate: QuotesPremiumFinanceEstimate | null
    renewingPolicy: PolicyRenewalData | null
    responses: ApplicationResponses
    setPageIndex: (pageIndex: number) => void

    Sets the ApplicationPage index of the application.

    setQuotesBillingMode: (billingMode: QUOTES_BILLING_MODE) => void
    setQuotesPaymentMode: (paymentMode: QUOTES_PAYMENT_MODE) => void
    setStep: (step: APPLICATION_STEP) => void

    Sets the APPLICATION_STEP of the application.

    specPolicyDocument: ApplicationSpecPolicyDocument | null
    status: APPLICATION_STATUS
    step: APPLICATION_STEP
    tenantId: string
    tenantName?: string
    type: APPLICATION_TYPE
    unlockQuotesPurchase: () => Promise<false | ApiError>

    Unlocks the application's quotes for purchase when their premium exceeds the configured auto-lock limit.

    Type Declaration

    update: (updates: ApplicationUpdates) => Promise<false | ApiError>

    Applies the given updates to the application.

    Type Declaration

    updatePartnerCommissionPercentage: (
        partnerCommissionPercentage: number,
    ) => Promise<false | ApiError>

    Updates the partner commission percentage on the account.

    Type Declaration

      • (partnerCommissionPercentage: number): Promise<false | ApiError>

      • Parameters

        • partnerCommissionPercentage: number

        Returns Promise<false | ApiError>

        ApiError if error occurred.

    Settings
    Member Visibility

    On This Page
    Properties
    approvedQuotesassignTobindcanGenerateQuotescanPremiumFinanceQuotescreatedAtTimestampcreatorUserIddeclinedQuotesdeleteexposuresgenerateQuotesgetQuotesPacketFileUrlidisBeingAssignedisBindingisDeletedisGeneratingQuotesisLoadingQuotesPacketFileUrlisLoadingSpecPolicyDocumentisQuotesPurchaseLockedisUpdatingisUpdatingPartnerCommissionPercentagelastModifiedTimestampleadloadSpecPolicyDocumentobjectTypeorganizationIdpageIndexpagespartiespartnerCommissionPercentagepolicyNumberquestionsquotesquotesAnnualizedPremiumquotesBillingModequotesGrossTaxesAndFeesquotesPaymentDataquotesPaymentDataMapquotesPaymentModequotesPremiumFinanceEstimaterenewingPolicyresponsessetPageIndexsetQuotesBillingModesetQuotesPaymentModesetStepspecPolicyDocumentstatussteptenantIdtenantNametypeunlockQuotesPurchaseupdateupdatePartnerCommissionPercentage