The transmission envelope that encompases all transactions included in the file. This is the root element of the file.
The ENVELOPE header. Contains information about the parties involved in the transmission, and the contents of the file.
The identifier for the sending party. The ID is an agreed upon standard between the two parties.
The identifier for the receiving party. The ID is an agreed upon standard between the two parties.
The number of transactions expected in the file. To be used to confirm that the file is complete as the sending party understands it.
Optional flag to indicate whether the file is a test file.
The root element of a transaction. Contains all data and metadata regarding a transaction. The SCHEMA_VERSION should be set for all transactions to ensure compliance amongst all parties.
The header denotes handling information about the data package(s) stored in the request or response elements. The information describes the execution of the data package, as well as routing and parties involved with the package.
Date that the transaction should be invoked and the data processed.
Date and time the transaction was created.
ADD -> Add to the Collections included. Uses the primary keys for the Collections involved. If an attempt is made to add a Collection using primary keys already in use, an error is returned. | MODIFY -> Replaces members of the Collections included. Uses the primary key for the Collection. If a new primary key value is included then a new member is added to the Collection. | DELETE -> Delete members of the Collections included. Uses the primary key for the Collection. If an attempt is made to delete a member where the primary key is not in the Collection, then an error is returned.
Transaction_ID captures the external Transaction ID for each party that handles the transaction.
Contains the routing 'map' of which parties need to take part in the transaction and the order their interaction occurs.
Describes each step of the routing map. Many transactions will only include one record in this node, with an order of 1.
Provides a routing log, which stores a record for each party that handles the transaction.
Stores a record for each party interaction on the transaction. Each party should store their send or receive date and time, once they receive the packet. This history can be reconciled against the planned routing steps to ensure that the transaction workflow was successful.
The type of transaction that this represents. For example, a Product Definition.
The REQUEST element contains the data neccessary for the request. This data comes from the sending party to be analyzed and used by the receiving party.
When used in an IDS collection this is the ID by which the IDS collection's parent data element is referenced (linked). When used as a subelement of *_LINK element this represents the ID of the referenced data element. When used as a subelement of *_LINK element this represents the ID of the referenced data element.
Defines a business unit within the distributor. This might be a unit that contains users, such as a firm, or a group that contains other business units. (Commonly used for reporting purposes)
Defines the collection of users that will be using the system.
Flag indicating whether this user account is active or not.
User's TIN or SSN
The user's logon id. Should include letters and at least one number. (i.e. user6)
The user's logon password. Passwords should be at least 8 characters long, and include at least one of the following: letter, number and punctuation (i.e. 4pa$$word)
The User's Last Name
The User's First Name
The User's middle initial
The salutation of the user. Should not include any punctuation.
Name suffix of the user. Should not include any punctuation.
The email address of the user. Should be in Internet email format: mailbox@domain.com
The phone number of the user.
The user's licenses, by type and state.
The User's appointment rights.
Defines the roles available to a user.
Description of user role.
Defines the user, role, business unit linkages. At the current time AnnuityNet only supports a single role and business unit per user. If one wants to assign multiple roles and/or business units to an individual, then this individual has to appear twice in the USERS collection with different logins.
The business unit the user will report to.
The ID of the user that is being mapped to the business unit.
The User Role of the user, as they are mapped to the business unit.
Indicates which products, riders, plans, service programs, and funds are available to a business unit.
Each child element is used as a pass filter. That is, a particular product, plan, rider, service program, fund combination is available to a particular Business Unit in a particular state if this combination is available in the Distributor Definition xml and the Product Definition xml as well as being available in each of the children elements of this element.
Is this a required or optional
Defines the possible transaction routing methods to be used by the business units. Each transaction routing can include parameters that need to be filled out for that routing type. This element also exists in the Distributor Definition xml which is the preferred source of this information.
The name of this transaction routing.
Formats in which transaction requests may be recieved
A collection of parameters and values that are neccessary for the transaction routing. For instance, an NSCC routing would require a NSCC ID. In this scope, the distributor defines the possible parameters for each routing type, and will fill in the values in the similar structure within the OPERATING_PROFILES element.
The name of the parameter
Links the defined operating profiles to the business units they apply to.
These operating profiles must be restrictions of the operating profiles corresponding to the same product in the Distributor Definition xml.
Defines a set of possible commission options, transaction types, and money forms available to the business unit. Also, the netting option and transaction routing that the for each transaction type.
Contact information.
Contact name.
Contact phone number.
Contact e-mail address.
Defines the reporting hierarchy. AnnuityNet only supports a single hierarchy -- that is, each business unit can have at most one parent.
Link to the business unit that will hold the child business unit.
The link to the business unit that resides within the parent.
Accounts to be reported on.
The name of the account.
The name of the owner of the account
The ABA number for the account.
The account number.
The usage of the account.
If the exception flag is on, then the state list includes all states, EXCEPT the associated (list) of state(s)
Details of State and State approval for selling a product in a specific state
Two digit state code
Date state approval become effective
Date state approval expires
Variable sales can only be made when the rep or firm is both FIXED and VARIABLE licensed in the state.
Indicates whether the license is for fixed or variable annuities.
The status of this appointment.
Flag indicating whether the appointment includes New Business transactions.
Flag indicating whether the appointment includes Commisions.
Writing company and lines of business.
Indicates whether the business unit is active or not.
Indicates whether the business unit is active or not.
The name of the business unit.
Level in the reporting hierarchy. Common values are Branch, Region, Distributor, Field Office, etc.
The tax identification number
Links to the Distributor contacts for the Business Unit in the case of questions or problems.
The purpose for which the contact should be used.
The netting option to be used.
Links available commission options to the profile.
Commission options available
Describes the transaction types and money forms allowed in this profile.
The types of transaction being allowed.
The possible money sources (forms) approved for transfers or transactions into this product.
The collection of filled in parameters for this transaction routing. For example, this would specify the NSCC number, for a NSCC transaction routing.
The name of the parameter. Should match the name of the parameter as defined in the TRANSACTION_ROUTING structure.
The value of this parameter for the profile.
Product availability by state.
This references a REQUEST/PRODUCTS/PRODUCT element.
States in which this product is available for sale
Plan availability for products by state.
This references a REQUEST/PRODUCTS/PRODUCT element.
This references a REQUEST/PLANS/PLAN.
A carrier may use either the PRODUCTS_RIDERS or the PRODUCTS_PLANS_RIDERS elements, but not both.
This references a REQUEST/PRODUCTS/PRODUCT element.
This references a REQUEST/RIDERS/RIDER.
This references a RIDERS/RIDER/CONFIGURATIONS/CONFIGURATION element.
A carrier may use either the PRODUCTS_RIDERS or the PRODUCTS_PLANS_RIDERS elements, but not both.
This references a REQUEST/PRODUCTS/PRODUCT element.
Plans for which (list) of rider(s) is available
This references a REQUEST/PLANS/PLAN.
This references a REQUEST/RIDERS/RIDER.
This references a RIDERS/RIDER/CONFIGURATIONS/CONFIGURATION element.
A carrier may use either the PRODUCTS_SERVICE_PROGRAMS or the PRODUCTS_PLANS_SERVICE_PROGRAMS elements, but not both.
This references a REQUEST/PRODUCTS/PRODUCT element.
This references a REQUEST/SERVICE_PROGRAMS/SERVICE_PROGRAM element.
This references a SERVICE_PROGRAMS/SERVICE_PROGRAM/OPTIONS/OPTION element.
This references a SERVICE_PROGRAMS/SERVICE_PROGRAM/CONFIGURATIONS/CONFIGURATION element.
A carrier may use either the PRODUCTS_SERVICE_PROGRAMS or the PRODUCTS_PLANS_SERVICE_PROGRAMS elements, but not both.
This references a REQUEST/PRODUCTS/PRODUCT element.
This references a REQUEST/PLANS/PLAN.
This references a REQUEST/SERVICE_PROGRAMS/SERVICE_PROGRAM element.
This references a SERVICE_PROGRAMS/SERVICE_PROGRAM/OPTIONS/OPTION element.
This references a SERVICE_PROGRAMS/SERVICE_PROGRAM/CONFIGURATIONS/CONFIGURATION element.
Investment Option availability for products by state
This references a REQUEST/PRODUCTS/PRODUCT element.
This references a an INVESTMENT_OPTION element.