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

File Suffix and Directory Location 

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

Version 

Introduced in API version 58.0.

Fields 

accountingModelConfig 

  • Type: string
  • Required: Yes
  • Description: Required.

isForAllocationType 

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

isForPaymentType 

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

isForTransactionType 

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

isProtected 

  • Type: boolean

  • Required: No

  • Description: Indicates whether this component is protected (true) or not protected (false).

    Default value is false.

mappingBehavior 

  • Type: MappingBehaviorType (enumeration of type string)
  • Required: Yes
  • Description: Required.

masterLabel 

  • Type: string
  • Required: Yes
  • Description: Required.

sourceField 

  • Type: string
  • Required: No
  • Description: The API name of the field on the source object that is mapped to the target field.

targetField 

  • Type: string
  • Required: Yes
  • Description: Required.

Declarative Metadata Sample Definition 

The following is an example of an AccountingFieldMapping component.

1<?xml version="1.0" encoding="UTF-8"?>
2<AccountingFieldMapping xmlns="http://soap.sforce.com/2006/04/metadata">
3	<accountingModelConfig>ModelConfigOne</accountingModelConfig>
4	<fullName>FieldMappingOne</fullName>
5	<masterLabel>FieldMappingOne</masterLabel>
6	<isForAllocationType>true</isForAllocationType>
7	<isForPaymentType>true</isForPaymentType>
8	<isForTransactionType>true</isForTransactionType>
9	<mappingBehavior>PointInTime</mappingBehavior>
10	<sourceField>TransactionJournal.MappingTargetOne__c</sourceField>
11	<targetField>MappingTargetOne__c</targetField>
12	<isProtected>false</isProtected>
13</AccountingFieldMapping>

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