AccountingModelConfig

Represents the mapping of the financial data model to a logical data model and configuration for the generation of Transaction Journal records.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

AccountingModelConfig components have the suffix .accountingModelConfig and are stored in the accountingModelConfigs folder.

Version

AccountingModelConfig components are available in API version 57.0 and later.

Fields

Field Name Description
accountingType
Field Type
AccountingType (enumeration of type string)
Description

Required.

Determines whether the accounting set generates revenue or expense type transaction journal records.

Valid values are:

  • Expense
  • Revenue
defaultAccrualAccountCode
Field Type
string
Description
The code for your accounting system's default accrual account.
defaultWriteOffAccountCode
Field Type
string
Description
Represents the name of your account for written off payments.
earliestCreatedDate
Field Type
dateTime
Description

Required.

The date used to filter source records for processing. The Accounting Subledger only considers records created on or after this date.
expectedCashFlowGrouping
Field Type
ExpectedCashFlowGrouping (enumeration of type string)
Description
Determines whether Accounting Subledger groups transaction journal records by fund account or by a combination of fund account and due date.

Changing this setting doesn't impact existing records; it only affects records created or reversed afterward.

Note

Valid values are:

  • GroupByFundAccount
  • GroupByFundAndDueDate
financeBook
Field Type
string
Description
Reserved for internal use.
internalMappingDetails
Field Type
string
Description

Required.

Represents the structure of your financial data in JSON format.
isActive
Field Type
boolean
Description

Required.

Indicates whether only records that are true are processed when the Subledger Job runs.
isGroupedByFundAccount
Field Type
boolean
Description
Reserved for internal use.
isUsed
Field Type
boolean
Description

Required.

Indicates whether the Accounting Model has been used or activated at least once (true) or not (false).

If the value is set to true, you can’t select another object for the object model or change the number of objects associated with that Accounting Model.

Note

jobFilterCriteria
Field Type
string
Description
Reserved for internal use.
masterLabel
Field Type
string
Description

Required.

A user-friendly name for AccountingModelConfig, which is defined when the AccountingModelConfig is created.
paidCashFlowGrouping
Field Type
PaidCashFlowGrouping (enumeration of type string)
Description
Determines the level of detail for generated transaction journal records.

Valid values are:

  • GroupByFundAccount—Accounting Subledger splits all transaction journal records into fund accounts. Secondary records are created for payment type records but not for transaction type records.
  • GroupBySummary—Accounting Subledger only splits credits for revenue and debits for expenses by fund accounts.
recordTypeFilter
Field Type
string
Description
Specify the record type IDs from the primary object to be processed. This field is case-sensitive.

If no record type is specified in the filter, all records are processed.

Note

runOrder
Field Type
int
Description
Determines the load order sequence of the multiple Accounting Model. The lower number runs first. For example, load order 1 runs before load order 2.

Declarative Metadata Sample Definition

The following is an example of an AccountingModelConfig component.

<?xml version="1.0" encoding="UTF-8"?>
<AccountingModelConfig
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<fullName>ModelConfigOne</fullName>
	<masterLabel>ModelConfigOne</masterLabel>
	<defaultAccrualAccountCode>abc</defaultAccrualAccountCode>
	<defaultWriteOffAccountCode>abc</defaultWriteOffAccountCode>
	<isUsed>false</isUsed>
	<isActive>false</isActive>
	<runOrder>123</runOrder>
	<recordTypeFilter>abcabc</recordTypeFilter>
	<earliestCreatedDate>2021-12-01T00:00:00.000Z</earliestCreatedDate>
	<internalMappingDetails>abcabc</internalMappingDetails>
	<accountingType>Revenue</accountingType>
	<expectedCashFlowGrouping>GroupByFundAccount</expectedCashFlowGrouping>
	<paidCashFlowGrouping>GroupBySummary</paidCashFlowGrouping>
</AccountingModelConfig>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package
	xmlns="http://soap.sforce.com/2006/04/​metadata">
	<types>
		<members>ModelConfigOne</members>
		<name>AccountingModelConfig</name>
	</types>
	<version>57.0</version>
</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.