ProfitAndLossVsBudgetFinReptOptions Class

Options class to set Profit and Loss Vs Budget Financial Report parameter values for Accounting Seed Financial Reporter API methods.

This class extends FinancialReportOptions.

Properties

The following are properties of the ProfitAndLossVsBudgetFinReptOptions class, in addition to the properties from the extended abstract class FinancialReportOptions.

budgetLedger

The ID of the budget ledger being reported on.

Type: Id (AcctSeed__Ledger__c)

Required: True

showAllPeriods

Boolean flag to determine the periods shown.

Type: Boolean

Required: False

Methods

The following are the global methods for the ProfitAndLossVsBudgetFinReptOptions class.

global ProfitAndLossVsBudgetFinReptOptions()

Constructor.

Usage

The following example creates a Profit and Loss Vs Budget options instance:

AcctSeed.ProfitAndLossVsBudgetFinReptOptions options = new ProfitAndLossVsBudgetFinReptOptions();

Default Values

If not explicitly set, the properties are defaulted to the following values:

reportType

Default: FinancialReportOptions.FinancialReportType.PROFIT_AND_LOSS_VS_BUDGET

Required: True

startingAccountingPeriod

Default: The ID of the Accounting Period 12 months prior to the End Accounting Period.

Required: True

endingAccountingPeriod

Default: The ID of the current Accounting Period.

Required: True

budgetLedger

Default: The ID of the default Budget Ledger.

Required: True

includeSubType1

Default: True

Required: False

showAllPeriods

Default: False

Required: False