Documentation
    Preparing search index...

    Interface Account<T, S>

    interface Account<T extends AccountType, S extends ObjectStatus = ObjectStatus> {
        assignTo: (
            parties: Partial<AccountParties>,
        ) => Promise<false | ApiError>;
        createdAtTimestamp: number;
        creatorUserId?: string;
        id: string;
        isBeingAssigned: boolean;
        isDeleted: boolean;
        isUpdatingPartnerCommissionPercentage: boolean;
        lastModifiedTimestamp: number;
        objectType: T;
        organizationId: string;
        parties: AccountParties;
        partnerCommissionPercentage: number | null;
        status: S;
        tenantId: string;
        tenantName?: string;
        updatePartnerCommissionPercentage: (
            partnerCommissionPercentage: number,
        ) => Promise<false | ApiError>;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index
    assignTo: (parties: Partial<AccountParties>) => Promise<false | ApiError>

    Assigns the account to the given parties.

    Type Declaration

    createdAtTimestamp: number
    creatorUserId?: string
    id: string
    isBeingAssigned: boolean
    isDeleted: boolean
    isUpdatingPartnerCommissionPercentage: boolean
    lastModifiedTimestamp: number
    objectType: T
    organizationId: string
    partnerCommissionPercentage: number | null
    status: S
    tenantId: string
    tenantName?: string
    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.