Required fields for mapping
Map all required fields in the Workpapers NG add-in to avoid errors during Get/Set operations.
Fields marked with an asterisk (*) are required identifiers for Get/Set operations to succeed. If you don’t map all the required fields, an error will occur.
Identifier fields
The following fields are required identifiers. Map these fields based on your import scenario:
- Year*
- Always required.
- Entity Number*
- Always required. Case sensitive.
- EntityNumberEndOrDepth*
- Required when importing into multiple companies at a time.
- BinderGroup
- Required ifBinderNameis not mapped.
- BinderName*
- Required ifBinderGroupis not mapped.
- EntityType
- Required if theEntity Number,Entity Name, andBinder Namecombination is the same across different return types.
- EntityName
- Required if multiple entities share the sameEntity Number.
Required fields by import scenario
Single Binder Import:
Map the following fields:- Year
- Entity Number
- Binder Name
Binder Group (multi-company) Import:
Map the following fields:- Year
- Binder Group
- Entity Number
- EntityNumberEndOrDepth— map this field last.
ConsolidatedEntityName (multi-company) Import:
Map the following fields:- Year
- ConsolidatedEntityName
- BinderName- related to Consolidated Entity
- Entity Number
- EntityNumberEndOrDepth— map this field last.
Template fields
Custom templates for screens with
Interesting
fields and Group
fields have additional required fields for Get/Set. Any field mapped for Get/Set using
Add New
in the Organizer is an Interesting
field. The task pane identifies these fields with an asterisk. Map all _EndOrDepth*
fields to identify rows for import.Example:
To Get/Set the Foreign Partnership Form 8865 Item F, map both the Foreign Partnership Name
field and the Certain Other Partner Name
field.note
Additional information about the
EndOrDepth
element:
- Requirement
- Certain forms require theEndOrDepthelement when mapping group data.
- Purpose
- TheEndOrDepthelement defines the last member in a data group.
- Identification
- If a form requires theEndOrDepthelement, it appears in the XML Source pane.
- Naming convention
- These elements use a specific suffix at the end of the element name:*_EndOrDepth.
Examples
Binder Group:
Map Year
, BinderGroup
, EntityNumber
, and EntityNumber_EndOrDepth
. Follow these rules:- Don’t include multiple binders for an entity in the same Binder Group.
- Don’t include multiple return types in the same Binder Group.
- Don’t include entities with the sameEntity Numberin the same Binder Group.
- If the entity is not in the identified Binder Group, an error will occur.
Multi-Company Import:
Map Year
, EntityNumber*
, BinderName*
, and EntityNumber_EndOrDepth
in columnar or row format.Group Data Import:
Follow these steps when mapping group data:- EnterEntityNumber_EndOrDepthfor each row or column to import for the group.
- Define theGroup_EndOrDepthby row or column. Map this beforeEntityNumber_EndOrDepth.
- MapEntityNumber_EndOrDepthlast, before you selectGetorSet.