BenefitUtilizationSummaries interface

Interface representing a BenefitUtilizationSummaries.

Methods

listByBillingAccountId(string, BenefitUtilizationSummariesListByBillingAccountIdOptionalParams)

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

listByBillingProfileId(string, string, BenefitUtilizationSummariesListByBillingProfileIdOptionalParams)

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

listBySavingsPlanId(string, string, BenefitUtilizationSummariesListBySavingsPlanIdOptionalParams)

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

listBySavingsPlanOrder(string, BenefitUtilizationSummariesListBySavingsPlanOrderOptionalParams)

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

Method Details

listByBillingAccountId(string, BenefitUtilizationSummariesListByBillingAccountIdOptionalParams)

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

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

Parameters

billingAccountId

string

Billing account ID

Returns

listByBillingProfileId(string, string, BenefitUtilizationSummariesListByBillingProfileIdOptionalParams)

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

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

Parameters

billingAccountId

string

Billing account ID

billingProfileId

string

Billing profile ID.

Returns

listBySavingsPlanId(string, string, BenefitUtilizationSummariesListBySavingsPlanIdOptionalParams)

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

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

Parameters

savingsPlanOrderId

string

Savings plan order ID.

savingsPlanId

string

Savings plan ID.

Returns

listBySavingsPlanOrder(string, BenefitUtilizationSummariesListBySavingsPlanOrderOptionalParams)

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

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

Parameters

savingsPlanOrderId

string

Savings plan order ID.

Returns