exportTransactionDefinition

Category	Metadata retrieval
Description	Returns the definition (available columns) of the transactions in the instance.
Permissions Required To Invoke	IMP (import data) or MANAGE_TX (manage the transaction field definition)
Parameters Required On Request	Credentials

This method's request contains only a credentials tag to identify and authorize the calling user. Once verified, the method returns an XML document describing the definition of a transaction in the instance.

Request Format


<?xml version="1.0" encoding="UTF-8"?>
<call method="exportTransactionDefinition" callerName="a string that identifies your client application">
 <credentials login="sampleuser@company.com" password="my_pwd"/>
</call>

credentials element
Tag Name		credentials
Description		All API calls must contain a single credentials element to identify the user invoking the API. The API call is then performed as this user (any audit trail or history of actions in the system will show that this user performed the action), and therefore the user must have the required permissions to per- form the action in order for the API call to succeed.
Attributes of the Element
Attribute Name	Required?	Value	Example
login	Y
password	Y	The password of the user invoking the API method.	my_password
locale	N	Specify the locale to be used to interpret incoming numbers and dates, and to for- mat outgoing numbers and dates (using the proper thousands separator, month names, and date formatting). The locale is also used to specify the language in which any system messages in the response should appear. If not specified, en_US (American English) is used.	fr_FR
instanceCode	N	If the user specified in the credentials has access to more than one instance of Adaptive Planning , this attribute can be used to specify that the user is intending to access an instance other than their default instance. If not specified, the user's default instance will be used. To determine the available instance codes, use the exportInstances API.	MYINSTANCE1
Contents of the Element
(none)

Response Format


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
<output>
   <transaction>
     <fields>
       <posting-date name="Posting Date"/>
       <type name="Transaction Type">
         <value id="178" name="Journal Entry"/>
         <value id="179" name="Purchase Order"/>
         <value id="177" name="Invoice"/>
         <value id="180" name="Transaction"/>
       </type>
       <accounts name="Account"/>
       <levels name="Plan"/>
       <dimension id="4" name="Product">
         <value id="48" name="B-2"/>
         <value id="47" name="B-1"/>
         <value id="14" name="A"/>
         <value id="15" name="B-Ste"/>
       </dimension>
       <text-selector id="4" name="Flavor">
         <value id="123" name="Chocolate"/>
         <value id="122" name="Vanilla"/>
       </text-selector>
       <text name="Description"/>
       <number name="Sales Tax"/>
       <date name="Due Date"/>
       <amount name="Transaction Amount"/>
     </fields>
   </transaction>
</output>
</response>

Each of the fields for a transaction is defined by one of these elements:

posting-date (one)

type (one)

accounts (one)

levels (one)

dimension (zero or more)

text-selector (zero or more)

text (zero or more)

number (zero or more)

date (zero or more)

amount (one)

transaction element
Tag Name		transaction
Attributes of the Element
Attribute Name	Required?	Value	Example
(none)
Contents of the Element
One fields element.

fields element
Tag Name		fields
Description		Container for all required and optional fields.
Attributes of the Element
Attribute Name	Required?	Value	Example
(none)
Contents of the Element
One element for each of the fields each transaction should have.

posting-date element
Tag Name		posting-date
Description		The required date the transaction was posted.
Attributes of the Element
Attribute Name	Required?	Value	Example
name	Y	Printed header of this field.	Posting Date
Contents of the Element
(none)

type element
Tag Name		type
Description		The required type of transaction
Attributes of the Element
Attribute Name	Required?	Value	Example
name	Y	Printed header of this field.	Transaction Type
Contents of the Element
One or more value elements.

accounts element
Tag Name		accounts
Description		The account this transaction belongs to. Account metadata, including the hierarchical structure, can be obtained by a call to exportAccounts.
Attributes of the Element
Attribute Name	Required?	Value	Example
name	Y	Printed header of this field.	Account
Contents of the Element
(none)

levels element
Tag Name		levels
Description		The level this transaction belongs to. Level metadata, including the hierarchical structure, can be obtained by a call to exportLevels.
Attributes of the Element
Attribute Name	Required?	Value	Example
name	Y	Printed header of this field.	level
Contents of the Element
(none)

dimension element
Tag Name		dimension
Description		A dimension assignable to a transaction. Complete dimension metadata, including its hierarchical structure, can be obtained by a separate call to exportDimensions.
Attributes of the Element
Attribute Name	Required?	Value	Example
id	Y	Internal numeric identifier for the dimension.	42
name	Y	Printed header of this field.	Product
Contents of the Element
One or more value elements.

text-selector element
Tag Name		text-selector
Description		Custom list of values defined to tag transactions.
Attributes of the Element
Attribute Name	Required?	Value	Example
id	Y	Internal numeric identifier for the text selector.	42
name	Y	Printed header of this field.	Flavor
Contents of the Element
One or more value elements.

value element
Tag Name		value
Description		One of the values defined for the enclosing type, dimension or text-selector.
Attributes of the Element
Attribute Name	Required?	Value	Example
id	Y	Internal numeric identifier for the value.	42
name	Y	Printed representation of the value.	Invoice
Contents of the Element
(none)

text element
Tag Name		text
Description		Generic text corresponding to a transaction.
Attributes of the Element
Attribute Name	Required?	Value	Example
name	Y	Printed header of this field.	Description
Contents of the Element
(none)

number element
Tag Name		number
Description		A generic number assigned to a transaction.
Attributes of the Element
Attribute Name	Required?	Value	Example
name	Y	Printed header of this field	Sales Tax
Contents of the Element
(none)

date element
Tag Name		date
Description		A generic date assigned to a transaction.
Attributes of the Element
Attribute Name	Required?	Value	Example
name	Y	Printed header of this field.	Due Date
Contents of the Element
(none)

amount element
Tag Name		amount
Description		The required monetary amount for a transaction.
Attributes of the Element
Attribute Name	Required?	Value	Example
name	Y	Printed header of this field.	Transaction Amount
Contents of the Element
(none)