AccountingFieldMapping

Represents the accounting field mappings to organize your data and bring it to ledger entry 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

AccountingFieldMapping components have the suffix .accountingFieldMapping and are stored in the accountingFieldMappings folder.

Version

AccountingFieldMapping components are available in API version 58.0 and later.

Fields

Field Name Description
accountingModelConfig
Field Type
string
Description
Required.
Record ID of the AccountingModelConfig record that the Field Mapping is associated with.
isForAllocationType
Field Type
boolean
Description
Reserved for internal use.
isForPaymentType
Field Type
boolean
Description
Reserved for internal use.
isForTransactionType
Field Type
boolean
Description
Reserved for internal use.
isProtected
Field Type
boolean
Description
Indicates whether this component is protected (true) or not protected (false).

Default value is false.

mappingBehavior
Field Type
MappingBehaviorType (enumeration of type string)
Description
Required.
Specifies how the target’s field data is mapped from the source field only when the journal entry is created. When set to CurrentValue, Subledger reverses and replaces journal entries whose value differs from the value in sourceField.

Valid values are:

  • CurrentValue
  • PointInTime
masterLabel
Field Type
string
Description
Required.
A user-friendly name for AccountingFieldMapping, which is defined when the AccountingFieldMapping is created.
sourceField
Field Type
string
Description
The API name of the field on the source object that is mapped to the target field.
targetField
Field Type
string
Description
Required.
The API name of the field on the Transaction Journal record for this mapping.

Declarative Metadata Sample Definition

The following is an example of an AccountingFieldMapping component.

<?xml version="1.0" encoding="UTF-8"?>
<AccountingFieldMapping xmlns="http://soap.sforce.com/2006/04/metadata">
	<accountingModelConfig>ModelConfigOne</accountingModelConfig>
	<fullName>FieldMappingOne</fullName>
	<masterLabel>FieldMappingOne</masterLabel>
	<isForAllocationType>true</isForAllocationType>
	<isForPaymentType>true</isForPaymentType>
	<isForTransactionType>true</isForTransactionType>
	<mappingBehavior>PointInTime</mappingBehavior>
	<sourceField>TransactionJournal.MappingTargetOne__c</sourceField>
	<targetField>MappingTargetOne__c</targetField>
	<isProtected>false</isProtected>
</AccountingFieldMapping>

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>FieldMappingOne</members>
		<name>AccountingFieldMapping</name>
	</types>
	<version>58.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.