TestService Class

Contains methods for configuring and determining current configuration of Accounting Seed in a testing context. The purpose of this class is to facilitate writing unit tests for integrations to Accounting Seed.

Note: This class and methods can only be used in a test context.

TestService Methods

The following are methods for TestService. All methods are static.

disableAutoPostSourceDocuments()

Disables auto posting for certain source documents in a testing context. The Cash Receipt, Billing Cash Receipt, AP Disbursement, and Amortization Entry Accounting Seed objects can be configured to auto post when created.

If Orders and Inventory is installed the Sales Order Inventory Movement, Purchase Order Inventory Movement, Manufacturing Inventory Movement, Inbound Inventory Movement and the Outbound Inventory Movement custom objects auto post when created. Auto posting is enabled by default.

Return Value

• Type: ServiceResult

Usage

The following example calls the method:

AcctSeed.ServiceResult sr = AcctSeed.TestService.disableAutoPostSourceDocuments();

enableAutoPostSourceDocuments()

Enables auto posting for certain source documents in a testing context. The Cash Receipt, Billing Cash Receipt, AP Disbursement, and Amortization Entry Accounting Seed objects can be configured to auto post when created.

If Orders and Inventory is installed the Sales Order Inventory Movement, Purchase Order Inventory Movement, Manufacturing Inventory Movement, Inbound Inventory Movement and the Outbound Inventory Movement custom objects auto post when created. Auto posting is enabled by default.

Return Value

• Type: ServiceResult

Usage

The following example calls the method:

AcctSeed.ServiceResult sr = AcctSeed.TestService.enableAutoPostSourceDocuments();

enableAvalaraVATReporting()

Enables functionality associated with the Accounting Seed Avalara VAT Reporting integration extension package in a testing context. This method should only be used if the Accounting Seed Avalara VAT Reporting integration extension package is installed.

Return Value

• Type: ServiceResult

Usage

The following example calls the method:

AcctSeed.ServiceResult sr = AcctSeed.TestService.enableAvalaraVATReporting();

enableMultiCurrency()

Enables Accounting Seed multi-currency functionality in a testing context. The org must have Salesforce advanced multi-currency enabled and configured to use this method.

Return Value

• Type: ServiceResult

Usage

The following example calls the method:

AcctSeed.ServiceResult sr = AcctSeed.TestService.enableMultiCurrency();

getInventoryValuation()

Returns the inventory valuation method used by Accounting Seed to calculate cost of goods sold in a testing context. The supported inventory valuation methods are standard cost and average cost.

Inventory valuation is supported only if the Accounting Seed Orders and Inventory extension package is installed.

Return Value

• Type: ServiceResult

Usage

The following example calls the method:

AcctSeed.ServiceResult sr = AcctSeed.TestService.getInventoryValuation();

getLedgerLimit()

Returns the number of allowed transactional ledgers in a testing context.

Return Value

• Type: ServiceResult

Usage

The following example calls the method:

AcctSeed.ServiceResult sr = AcctSeed.TestService.getLedgerLimit();

isAvalaraVATReportingEnabled()

Returns whether Accounting Seed Avalara VAT Reporting has been enabled in a testing context.

Return Value

• Type: ServiceResult

Usage

The following example calls the method:

AcctSeed.ServiceResult sr = AcctSeed.TestService.isAvalaraVATReportingEnabled();

setLedgerLimit(Integer newLedgerLimit)

Sets the number of transactional ledgers allowed in the application in a testing context.

Parameters

• newLedgerLimit – Type: Integer
  The number of transactional ledgers allowable in the application.

Return Value

• Type: ServiceResult

Usage

The following example calls the method:

AcctSeed.ServiceResult sr = AcctSeed.TestService.setLedgerLimit(10);

getOrgDefaultLedgerId()

Returns the default organization ledger ID in a testing context. The default organization ledger is the ledger used when users create source document records, such as Billing, Payable, and Journal Entry. The default ledger can be set on a user-by-user basis by setting a user active ledger using the setUserActiveLedgerId(Id ledgerId) method.

Return Value

• Type: ServiceResult

Usage

The following example calls the method:

AcctSeed.ServiceResult sr = AcctSeed.TestService.getOrgDefaultLedgerId();

setOrgDefaultLedgerId(Id ledgerId)

Sets the default organization ledger ID in a testing context. The default organization ledger is the ledger used when users create source document records, such as Billing, Payable, and Journal Entry. The default ledger can be set on a user-by-user basis by setting a user active ledger using the setUserActiveLedgerId(Id ledgerId) method.

Parameters

• ledgerId – Type: Id
  The ID of the ledger to set as the default organization ledger.

Return Value

• Type: ServiceResult

Usage

The following example calls the method:

AcctSeed.ServiceResult sr = AcctSeed.TestService.setOrgDefaultLedgerId();

setupTestData()

Configures setup data in a testing context. This includes Accounting Period, GL Account, Accounting Settings, and Ledger records. This is the base data needed to facilitate implementing unit tests in Accounting Seed.

Return Value

• Type: ServiceResult

data property of the ServiceResult instance will contain serialized test data collections mapped by the following keys:

• accountingPeriods
• glAccounts
• billingFormats
• ledgers
• accountingSettings

Usage

The following example creates the test data and reads each collection:

AcctSeed.ServiceResult sr = AcctSeed.TestService.setupTestData();

//Deserialize test data
Map<String, List<SObject>> testData =
(Map<String, List<SObject>>) JSON.deserializeStrict(sr.data, Map<String, List<SObject>>.class);

//Get Accounting Periods
List<AcctSeed__Accounting_Period__c> accountingPeriods = (List<AcctSeed__Accounting_Period__c>) testData.get('accountingPeriods');
//Get GL Accounts
List<AcctSeed__GL_Account__c> glAccounts = (List<AcctSeed__GL_Account__c>) testData.get('glAccounts');
//Get Billing Formats (PDF Formats)
List<AcctSeed__Billing_Format__c> billingFormats = (List<AcctSeed__Billing_Format__c>) testData.get('billingFormats');
//Get Ledgers
List<AcctSeed__Ledger__c> ledgers = (List<AcctSeed__Ledger__c>) testData.get('ledgers');
//Get Accounting Settings
List<AcctSeed__Accounting_Settings__c> = (List<AcctSeed__Accounting_Settings__c>) testData.get('accountingSettings');

setupTestData(Boolean isBaseInitNeeded, Boolean createStandardObjectData, Boolean includeStandardFieldPerms)

Parameters

• isBaseInitNeeded – Type: Boolean
  • true – the base test data will be created
  • false – the base test data creation will be skipped if the test data exists already
• createStandardObjectData – Type: Boolean
  • true – create Accounts, Contacts and Opportunities records as part of the base test data set
• includeStandardFieldPerms – Type: Boolean
  • true – Add additional permissions for the following fields on Opportunity and OpportunityLineItem objects:
    • Opportunity.Amount
    • Opportunity.Account
    • OpportunityLineItem.ServiceDate
    • OpportunityLineItem.Description
    • OpportunityLineItem.Discount
    • OpportunityLineItem.ListPrice
    • OpportunityLineItem.Subtotal
    • OpportunityLineItem.TotalPrice

Configures setup data in a testing context. This includes Accounting Period, GL Account, Accounting Settings, and Ledger records. This is the base data needed to facilitate implementing unit tests in Accounting Seed.

Return Value

• Type: ServiceResult

data property of the ServiceResult instance will contain serialized test data collections mapped by the following keys:

• accountingPeriods
• glAccounts
• billingFormats
• ledgers
• accountingSettings
• If createStandardObjectData is set to true, additional data will be available by the following keys:
  • accounts
  • contacts
  • opportunities

Usage

The following example creates the test data, including standard object data, and reads each collection:

AcctSeed.ServiceResult sr = AcctSeed.TestService.setupTestData(true, true, true);

//Deserialize test data
Map<String, List<SObject>> testData =
(Map<String, List<SObject>>) JSON.deserializeStrict(sr.data, Map<String, List<SObject>>.class);

//Get Accounting Periods
List<AcctSeed__Accounting_Period__c> accountingPeriods = (List<AcctSeed__Accounting_Period__c>) testData.get('accountingPeriods');
//Get GL Accounts
List<AcctSeed__GL_Account__c> glAccounts = (List<AcctSeed__GL_Account__c>) testData.get('glAccounts');
//Get Billing Formats (PDF Formats)
List<AcctSeed__Billing_Format__c> billingFormats = (List<AcctSeed__Billing_Format__c>) testData.get('billingFormats');
//Get Ledgers
List<AcctSeed__Ledger__c> ledgers = (List<AcctSeed__Ledger__c>) testData.get('ledgers');
//Get Accounting Settings
List<AcctSeed__Accounting_Settings__c> = (List<AcctSeed__Accounting_Settings__c>) testData.get('accountingSettings');
//Get Accounts, Contacts and Opportunities
List<Account> accounts = (List<Account>) testData.get('accounts);
List<Contact> contacts = (List<Contact) testData.get('contacts);
List<Opportunity> opportunities = (List<Opportunity>) testData.get('opportunities');

getUserActiveLedgerId()

Gets the active ledger for the current user in a testing context. The active ledger is the default ledger used when users create source document records, such as Billing, Payable, and Journal Entry.

Return Value

• Type: ServiceResult

Usage

The following example calls the method:

AcctSeed.ServiceResult sr = AcctSeed.TestService.getUserActiveLedgerId();

setUserActiveLedgerId(Id ledgerId)

Sets the active ledger for the current user in a testing context. The active ledger is the default ledger used when users create source document records, such as Billing, Payable, and Journal Entry.

Parameters

• ledgerId – Type: Id
  The ID of the ledger to set as the default for the active user.

Return Value

• Type: ServiceResult

Usage

The following example sets the Actual ledger as the active ledger:

Id ledgerId = [SELECT Id FROM AcctSeed__Ledger__c WHERE Name = 'Actual' LIMIT 1].Id;
AcctSeed.ServiceResult sr = AcctSeed.TestService.setUserActiveLedgerId(ledgerId);

mockFeatureParameterValue(String apiName, Object value)

Sets a mock value for a feature parameter in a testing context. This allows you to override feature parameter values during test execution to test different feature configurations without modifying org settings. Mocked values are only valid for the duration of the transaction. To test features that span multiple transactions such as batch jobs consider an alternative approach.

Parameters

• apiName – Type: String
  The API name of the feature parameter to mock. Available parameters:
  • Integer Parameters: AccountingPeriodTransactionLimit, AccountingVariableLimit, GLAccountLimit, APACHLimit, APCheckLimit, AutomationUserLicenseCount, LedgerLimit
  • Boolean Parameters: EnableDeleteArchivedSourceDocs, PaymentServicesEnabled, ConsolidationsEnabled, EnableFAnalytics, LargeDataVolumeMode, EnforceLicenseCompliance, FinancialReportsHubEnabled, AverageCostEnabled, ProductCostingEnabled, LineLevelPostEnabled, MultiCurrencyEnabled
  • Date Parameters: LastSyncDate
• value – Type: Object
  The mock value to set. Type must match the parameter's data type (Boolean, Integer, or Date).

Return Value

• Type: ServiceResult

Usage

The following example mocks a Boolean, an Integer and a Date parameter:

/ Setup test data first
AcctSeed.TestService.setupTestData();

// Mock a boolean parameter
AcctSeed.ServiceResult sr = AcctSeed.TestService.mockFeatureParameterValue('PaymentServicesEnabled', true);

// Mock an integer parameter
sr = AcctSeed.TestService.mockFeatureParameterValue('LedgerLimit', 999);

// Mock a date parameter
sr = AcctSeed.TestService.mockFeatureParameterValue('LastSyncDate', Date.newInstance(2024, 12, 25));

getFeatureParameterValue(String apiName)

Retrieves the current value of a feature parameter in a testing context. Returns the mocked value if one has been set, otherwise returns the actual feature parameter value.

Parameters

• apiName – Type: String
  The API name of the feature parameter to retrieve. Available parameters:
  • Integer Parameters: AccountingPeriodTransactionLimit, AccountingVariableLimit, GLAccountLimit, APACHLimit, APCheckLimit, AutomationUserLicenseCount, LedgerLimit
  • Boolean Parameters: EnableDeleteArchivedSourceDocs, PaymentServicesEnabled, ConsolidationsEnabled, EnableFAnalytics, LargeDataVolumeMode, EnforceLicenseCompliance, FinancialReportsHubEnabled, AverageCostEnabled, ProductCostingEnabled, LineLevelPostEnabled, MultiCurrencyEnabled
  • Date Parameters: LastSyncDate

Return Value

• Type: ServiceResult

The data property contains the feature parameter value as a string. Date values are formatted as YYYY-MM-DD.

Usage

The following example reads a Boolean, an Integer and a Date parameter:

// Setup test data first
AcctSeed.TestService.setupTestData();

// Get boolean value
AcctSeed.ServiceResult sr = AcctSeed.TestService.getFeatureParameterValue('PaymentServicesEnabled');
System.assertEquals('true', sr.data);

// Get integer value
sr = AcctSeed.TestService.getFeatureParameterValue('LedgerLimit');
System.assertEquals('999', sr.data);

// Get date value
sr = AcctSeed.TestService.getFeatureParameterValue('LastSyncDate');
System.assertEquals('2024-12-25', sr.data);

listFeatureParameters()

Returns a list of all available feature parameters that can be mocked in a testing context, along with their data types.

Return Value

• Type: ServiceResult

The data property contains a JSON string representing a Map<String, String> where keys are parameter names and values are data types ('Boolean', 'Integer', or 'Date').

Usage

The following example lists the feature parameters and checks for one of them:

// Setup test data first
AcctSeed.TestService.setupTestData();

// List all available feature parameters
AcctSeed.ServiceResult sr = AcctSeed.TestService.listFeatureParameters();

// Deserialize the parameter list
Map<String, String> featureParams = (Map<String, String>) JSON.deserialize(sr.data, Map<String, String>.class);

// Check if a specific parameter is available
if (featureParams.containsKey('PaymentServicesEnabled')) {
  String dataType = featureParams.get('PaymentServicesEnabled'); // Returns 'Boolean'
}