BenefitUtilizationSummariesOperations interface

Interface representing a BenefitUtilizationSummaries operations.

Properties

listByBillingAccountId

Lists savings plan utilization summaries for the enterprise agreement scope. Supported at grain values: 'Daily' and 'Monthly'.

listByBillingProfileId

Lists savings plan utilization summaries for billing profile. Supported at grain values: 'Daily' and 'Monthly'.

listBySavingsPlanId

Lists the savings plan utilization summaries for daily or monthly grain.

listBySavingsPlanOrder

Lists the savings plan utilization summaries for daily or monthly grain.

Property Details

listByBillingAccountId

Lists savings plan utilization summaries for the enterprise agreement scope. Supported at grain values: 'Daily' and 'Monthly'.

listByBillingAccountId: (billingAccountId: string, options?: BenefitUtilizationSummariesListByBillingAccountIdOptionalParams) => PagedAsyncIterableIterator<BenefitUtilizationSummaryUnion, BenefitUtilizationSummaryUnion[], PageSettings>

Property Value

(billingAccountId: string, options?: BenefitUtilizationSummariesListByBillingAccountIdOptionalParams) => PagedAsyncIterableIterator<BenefitUtilizationSummaryUnion, BenefitUtilizationSummaryUnion[], PageSettings>

listByBillingProfileId

Lists savings plan utilization summaries for billing profile. Supported at grain values: 'Daily' and 'Monthly'.

listByBillingProfileId: (billingAccountId: string, billingProfileId: string, options?: BenefitUtilizationSummariesListByBillingProfileIdOptionalParams) => PagedAsyncIterableIterator<BenefitUtilizationSummaryUnion, BenefitUtilizationSummaryUnion[], PageSettings>

Property Value

(billingAccountId: string, billingProfileId: string, options?: BenefitUtilizationSummariesListByBillingProfileIdOptionalParams) => PagedAsyncIterableIterator<BenefitUtilizationSummaryUnion, BenefitUtilizationSummaryUnion[], PageSettings>

listBySavingsPlanId

Lists the savings plan utilization summaries for daily or monthly grain.

listBySavingsPlanId: (savingsPlanOrderId: string, savingsPlanId: string, options?: BenefitUtilizationSummariesListBySavingsPlanIdOptionalParams) => PagedAsyncIterableIterator<BenefitUtilizationSummaryUnion, BenefitUtilizationSummaryUnion[], PageSettings>

Property Value

(savingsPlanOrderId: string, savingsPlanId: string, options?: BenefitUtilizationSummariesListBySavingsPlanIdOptionalParams) => PagedAsyncIterableIterator<BenefitUtilizationSummaryUnion, BenefitUtilizationSummaryUnion[], PageSettings>

listBySavingsPlanOrder

Lists the savings plan utilization summaries for daily or monthly grain.

listBySavingsPlanOrder: (savingsPlanOrderId: string, options?: BenefitUtilizationSummariesListBySavingsPlanOrderOptionalParams) => PagedAsyncIterableIterator<BenefitUtilizationSummaryUnion, BenefitUtilizationSummaryUnion[], PageSettings>

Property Value

(savingsPlanOrderId: string, options?: BenefitUtilizationSummariesListBySavingsPlanOrderOptionalParams) => PagedAsyncIterableIterator<BenefitUtilizationSummaryUnion, BenefitUtilizationSummaryUnion[], PageSettings>