Documentation
    Preparing search index...

    Interface Policy

    interface Policy {
        activeEndorsementApplicationId: string | null;
        addAdditionalInsureds: (
            names: string[],
            effectiveDate?: Date,
        ) => Promise<false | ApiError>;
        annualizedPremium: number;
        applicationFieldValues: ApplicationFieldValues;
        applicationId: string;
        assignTo: (parties: Partial<AccountParties>) => Promise<false | ApiError>;
        billingMode: QUOTES_BILLING_MODE;
        cancel: (
            transactionReason: POLICY_TRANSACTION_REASON,
            effectiveDate?: Date,
        ) => Promise<false | ApiError>;
        classCodeId: string;
        coverages: PolicyCoverage[];
        createdAtTimestamp: number;
        creatorUserId?: string;
        discardingTransactionId: string | null;
        discardTransaction: (
            transaction: PolicyTransaction,
        ) => Promise<false | ApiError>;
        documents: PolicyDocument[];
        endDate: Date;
        endorse: () => Promise<string | ApiError>;
        externalPolicyNumbers: string[];
        grossPremium: number;
        id: string;
        insured: {
            businessName: string | null;
            email: string | null;
            id: string | null;
            mailingAddress: string | null;
            name: string | null;
            phoneNumber: string | null;
        };
        isBeingAssigned: boolean;
        isCancelling: boolean;
        isDeleted: boolean;
        isEndorsing: boolean;
        isLinkingExternalPolicy: boolean;
        isReinstating: boolean;
        isUpdatingInsuredEmail: boolean;
        isUpdatingPartnerCommissionPercentage: boolean;
        isUploadingDocument: boolean;
        lastModifiedTimestamp: number;
        linkExternalPolicy: (
            externalPolicy: ExternalPolicy,
        ) => Promise<false | ApiError>;
        objectType: POLICY;
        organizationId: string;
        parties: AccountParties;
        partnerCommissionPercentage: number | null;
        paymentMode: QUOTES_PAYMENT_MODE | null;
        policyNumber: string;
        productBundleId: string;
        reinstate: (waiverOfNoKnownLossFile: File) => Promise<false | ApiError>;
        removeAdditionalInsured: (name: string) => Promise<false | ApiError>;
        removingAdditionalInsuredName: string | null;
        renewal: PolicyRenewalData | null;
        renewalNumber: number;
        renewalStatus: POLICY_RENEWAL_STATUS;
        startDate: Date;
        status: POLICY_STATUS;
        tenantId: string;
        tenantName?: string;
        transactions: PolicyTransaction[];
        type: POLICY_TYPE;
        updateInsuredEmail: (insuredEmail: string) => Promise<false | ApiError>;
        updatePartnerCommissionPercentage: (
            partnerCommissionPercentage: number,
        ) => Promise<false | ApiError>;
        uploadDocument: (
            type: POLICY_DOCUMENT_TYPE,
            file: File,
        ) => Promise<string | ApiError>;
    }

    Hierarchy (View Summary)

    Index
    activeEndorsementApplicationId addAdditionalInsureds annualizedPremium applicationFieldValues applicationId assignTo billingMode cancel classCodeId coverages createdAtTimestamp creatorUserId? discardingTransactionId discardTransaction documents endDate endorse externalPolicyNumbers grossPremium id insured isBeingAssigned isCancelling isDeleted isEndorsing isLinkingExternalPolicy isReinstating isUpdatingInsuredEmail isUpdatingPartnerCommissionPercentage isUploadingDocument lastModifiedTimestamp linkExternalPolicy objectType organizationId parties partnerCommissionPercentage paymentMode policyNumber productBundleId reinstate removeAdditionalInsured removingAdditionalInsuredName renewal renewalNumber renewalStatus startDate status tenantId tenantName? transactions type updateInsuredEmail updatePartnerCommissionPercentage uploadDocument
    activeEndorsementApplicationId: string | null
    addAdditionalInsureds: (
        names: string[],
        effectiveDate?: Date,
    ) => Promise<false | ApiError>

    Adds additional insureds under the given names to the policy.

    Type Declaration

      • (names: string[], effectiveDate?: Date): Promise<false | ApiError>

      • Parameters

        • names: string[]
        • OptionaleffectiveDate: Date

        Returns Promise<false | ApiError>

        ApiError if error occurred.

    annualizedPremium: number
    applicationFieldValues: ApplicationFieldValues
    applicationId: string
    assignTo: (parties: Partial<AccountParties>) => Promise<false | ApiError>

    Assigns the account to the given parties.

    Type Declaration

    billingMode: QUOTES_BILLING_MODE
    cancel: (
        transactionReason: POLICY_TRANSACTION_REASON,
        effectiveDate?: Date,
    ) => Promise<false | ApiError>

    Submits the policy for cancellation based on the given transaction reason.

    Type Declaration

    classCodeId: string
    coverages: PolicyCoverage[]
    createdAtTimestamp: number
    creatorUserId?: string
    discardingTransactionId: string | null
    discardTransaction: (
        transaction: PolicyTransaction,
    ) => Promise<false | ApiError>

    Discards the given transaction.

    Type Declaration

    documents: PolicyDocument[]
    endDate: Date
    endorse: () => Promise<string | ApiError>

    Returns the ID of an endorsement application for the policy.

    Type Declaration

    externalPolicyNumbers: string[]
    grossPremium: number
    id: string
    insured: {
        businessName: string | null;
        email: string | null;
        id: string | null;
        mailingAddress: string | null;
        name: string | null;
        phoneNumber: string | null;
    }
    isBeingAssigned: boolean
    isCancelling: boolean
    isDeleted: boolean
    isEndorsing: boolean
    isLinkingExternalPolicy: boolean
    isReinstating: boolean
    isUpdatingInsuredEmail: boolean
    isUpdatingPartnerCommissionPercentage: boolean
    isUploadingDocument: boolean
    lastModifiedTimestamp: number
    linkExternalPolicy: (
        externalPolicy: ExternalPolicy,
    ) => Promise<false | ApiError>

    Links the given ExternalPolicy to the policy.

    Type Declaration

    objectType: POLICY
    organizationId: string
    parties: AccountParties
    partnerCommissionPercentage: number | null
    paymentMode: QUOTES_PAYMENT_MODE | null
    policyNumber: string
    productBundleId: string
    reinstate: (waiverOfNoKnownLossFile: File) => Promise<false | ApiError>

    Uploads the given Waiver of No Known Loss and submits the policy for reinstatement.

    Type Declaration

      • (waiverOfNoKnownLossFile: File): Promise<false | ApiError>

      • Parameters

        • waiverOfNoKnownLossFile: File

        Returns Promise<false | ApiError>

        ApiError if error occurred.

    removeAdditionalInsured: (name: string) => Promise<false | ApiError>

    Removes the additional insured with the given name from the policy.

    Type Declaration

      • (name: string): Promise<false | ApiError>

      • Parameters

        • name: string

        Returns Promise<false | ApiError>

        ApiError if error occurred.

    removingAdditionalInsuredName: string | null
    renewal: PolicyRenewalData | null
    renewalNumber: number
    renewalStatus: POLICY_RENEWAL_STATUS
    startDate: Date
    status: POLICY_STATUS
    tenantId: string
    tenantName?: string
    transactions: PolicyTransaction[]
    type: POLICY_TYPE
    updateInsuredEmail: (insuredEmail: string) => Promise<false | ApiError>

    Updates the insured email of the policy.

    Type Declaration

      • (insuredEmail: string): Promise<false | ApiError>

      • Parameters

        • insuredEmail: string

        Returns Promise<false | ApiError>

        ApiError if error occurred.

    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.

    uploadDocument: (
        type: POLICY_DOCUMENT_TYPE,
        file: File,
    ) => Promise<string | ApiError>

    Uploads and returns a document ID for the given File, associating it with the policy.

    Type Declaration

    Settings
    Member Visibility

    On This Page
    Properties