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 Metadata and inherits its fields.

File Suffix and Directory Location 

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

Version 

Introduced in API version 57.0.

Fields 

accountingType 

  • Type: AccountingType (enumeration of type string)

  • Required: Yes

  • Description: Required.

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

  • Possible values:

    • Expense
    • Revenue

defaultAccrualAccountCode 

  • Type: string
  • Required: No
  • Description: The code for your accounting system’s default accrual account.

defaultWriteOffAccountCode 

  • Type: string
  • Required: No
  • Description: Represents the name of your account for written off payments.

earliestCreatedDate 

  • Type: dateTime

  • Required: Yes

  • Description: Required.

    The date used to filter source records for processing. The Accounting Subledger only considers records created on or after this date.

expectedCashFlowGrouping 

  • Type: ExpectedCashFlowGrouping (enumeration of type string)
  • Required: No
  • Description: Determines whether Accounting Subledger groups transaction journal records by fund account or by a combination of fund account and due date.
  • Possible values:
    • GroupByFundAccount
    • GroupByFundAndDueDate

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

Note

financeBook 

  • Type: string
  • Required: No
  • Description: Reserved for internal use.

internalMappingDetails 

  • Type: string

  • Required: Yes

  • Description: Required.

    Represents the structure of your financial data in JSON format.

isActive 

  • Type: boolean

  • Required: Yes

  • Description: Required.

    Indicates whether only records that are true are processed when the Subledger Job runs.

isGroupedByFundAccount 

  • Type: boolean
  • Required: No
  • Description: Reserved for internal use.

isUsed 

  • Type: boolean

  • Required: Yes

  • 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 

  • Type: string
  • Required: No
  • Description: Reserved for internal use.

masterLabel 

  • Type: string

  • Required: Yes

  • Description: Required.

    A user-friendly name for AccountingModelConfig, which is defined when the AccountingModelConfig is created.

paidCashFlowGrouping 

  • Type: PaidCashFlowGrouping (enumeration of type string)
  • Required: No
  • Description: Determines the level of detail for generated transaction journal records.
  • Possible values:
    • 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 

  • Type: string
  • Required: No
  • 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 

  • Type: int
  • Required: No
  • 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.

1<?xml version="1.0" encoding="UTF-8"?>
2<AccountingModelConfig
3	xmlns="http://soap.sforce.com/2006/04/metadata">
4	<fullName>ModelConfigOne</fullName>
5	<masterLabel>ModelConfigOne</masterLabel>
6	<defaultAccrualAccountCode>abc</defaultAccrualAccountCode>
7	<defaultWriteOffAccountCode>abc</defaultWriteOffAccountCode>
8	<isUsed>false</isUsed>
9	<isActive>false</isActive>
10	<runOrder>123</runOrder>
11	<recordTypeFilter>abcabc</recordTypeFilter>
12	<earliestCreatedDate>2021-12-01T00:00:00.000Z</earliestCreatedDate>
13	<internalMappingDetails>abcabc</internalMappingDetails>
14	<accountingType>Revenue</accountingType>
15	<expectedCashFlowGrouping>GroupByFundAccount</expectedCashFlowGrouping>
16	<paidCashFlowGrouping>GroupBySummary</paidCashFlowGrouping>
17</AccountingModelConfig>

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

1<?xml version="1.0" encoding="UTF-8"?>
2<Package
3	xmlns="http://soap.sforce.com/2006/04/​metadata">
4	<types>
5		<members>ModelConfigOne</members>
6		<name>AccountingModelConfig</name>
7	</types>
8	<version>57.0</version>
9</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.