exportAccounts
This API only supports user access rules in API v22 and above.
|
Category |
Metadata retrieval |
|
Description |
Returns metadata for the complete list of all accounts in the system, including all account types: Assumptions, Cube Accounts, Custom Accounts, GL Accounts, Metric Accounts, and Modeled Accounts. |
|
Permissions Required To Invoke |
None (must be valid credentials for the instance) |
|
Parameters Required On Request |
Credentials |
This method's request contains a credentials tag to identify and authorize the calling user and an ''include'' tag to indicate whether the response should include information about the importability of the accounts in a particular version. Once verified, the method returns an XML document describing the complete set of accounts in the system. Accounts are returned in a nested tree fashion, with one account tag enclosing another if the account represented by the enclosing tag is a parent of the enclosed account.
Request Format
<?xml version='1.0' encoding='UTF-8'?>
<call method="exportAccounts" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd"/>
<include versionName="sample version"/>
<sheet id="3" />
</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 perform the action in order for the API call to succeed. |
||
|
Attributes of the Element |
|||
|
Attribute Name |
Required? |
Value |
Example |
|
login |
Y |
The login name of the user invoking the API method. This user must have a role containing the permissions required for the method being invoked. |
sampleuser@company.com |
|
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 format 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 Insights, 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) |
|||
|
include element |
|||
|
Tag Name |
include |
||
|
Description |
Represents a set of flags indicating what aspects of the accounts' information should be included or excluded from the response. This element is optional: if not present, the API will return account information for all versions, and will not include the isImportable attribute. |
||
|
Attributes of the Element |
|||
|
Attribute Name |
Required? |
Value |
Example |
|
versionName Updated in API v18 |
N |
Indicates whether the response should include the isImportable attribute in the response for each account, indicating whether the account can accept imported data for the specified version. The default, if this element or its attribute is not present, is to not emit any isImportable attributes in the response. If both versionName and versionID attributes are specified on this element, the versionID is ignored. When specifying a version, the call will succeed only if the user has access to the version. |
Budget 2016 |
|
versionID Updated in API v18 |
N |
Same as versionName (above) except it takes an internal version ID number as a parameter. Indicates whether the response should include the isImportable attribute in the response for each account, indicating whether the account can accept imported data for the specified version. When specifying a version, the call will succeed only if the user has access to the version. |
102 |
| attributes | N | Indicates whether the response should include the attributes in the response for each account. | false |
| inaccessibleValues | N | Indicates whether the response should include values inaccessible to the current user. Defaults to false. Only users with the "Modeling" or "Import to all levels" permissions may set this option to true. | false |
|
Contents of the Element |
|||
|
(none) |
|||
|
sheet element |
|||
|
Tag Name |
sheet |
||
|
Description |
Represents a sheet in which only accounts available for that sheet should be included in the response. This element is optional: if not present, the API will return account information independent of a particular sheet. |
||
|
Attributes of the Element |
|||
|
Attribute Name |
Required? |
Value |
Example |
|
id |
Y |
The internal system ID number for the sheet. |
234 |
|
Contents of the Element |
|||
|
(none) |
|||
Response Format
<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<output>
<accounts seqNo="42">
<account id="2147483645" code="" name="GL Accounts" description="GL Accounts" timeStratum="" displayAs="NUMBER"
accountTypeCode="" decimalPrecision="0" isAssumption="0" suppressZeroes="1" isDefaultRoot="1" shortName=""
balanceType="" isLinked="0" owningSheetId="" isSystem="0" isIntercompany="0" isImportable="0" dataEntryType=""
planBy="" timeRollup="" timeWeightAcctId="" levelDimRollup="" levelDimWeightAcctId="" rollupText="" startExpanded="1"
hasSalaryDetail="" dataPrivacy="" isBreakbackEligible="" subType="" enableActuals="" isGroup="1">
<account id="1" code="Assets" name="Assets" description="Total Assets" timeStratum="month" displayAs="CURRENCY"
accountTypeCode="A" decimalPrecision="0" isAssumption="0" suppressZeroes="1" isDefaultRoot="1"
shortName="" exchangeRateType="E" balanceType="DEBIT" isLinked="0" owningSheetId=""
isSystem="0" isIntercompany="0" dataEntryType="" planBy="DELTA" timeRollup="LAST" timeWeightAcctId=""
levelDimRollup="SUM" levelDimWeightAcctId="" rollupText="" startExpanded="1" hasSalaryDetail=""
dataPrivacy="PRIVATE" isBreakbackEligible="" subType="CUMULATIVE" enableActuals="1" isGroup="0">
<account id="16" code="Current_Assets" name="Current Assets" description="current assets" timeStratum="month"
displayAs="CURRENCY" accountTypeCode="B" decimalPrecision="0" isAssumption="0" suppressZeroes="1"
isDefaultRoot="1" shortName="" exchangeRateType="E" balanceType="DEBIT" isLinked="0"
owningSheetId="" isSystem="0" isIntercompany="0" dataEntryType="" planBy="DELTA" timeRollup="LAST"
timeWeightAcctId="" levelDimRollup="SUM" levelDimWeightAcctId="" rollupText="" startExpanded="1"
hasSalaryDetail="" dataPrivacy="PRIVATE" isBreakbackEligible="" subType="CUMULATIVE" enableActuals="1"
isGroup="0">
<account id="51" code="70110" name="Bank Account" description="Wells Fargo account" timeStratum="month"
displayAs="CURRENCY" accountTypeCode="B" decimalPrecision="0" isAssumption="0" suppressZeroes="1"
isDefaultRoot="0" shortName="" exchangeRateType="E" balanceType="DEBIT" isLinked="0"
owningSheetId="" isSystem="0" isIntercompany="0" dataEntryType="STANDARD" planBy="BALANCE"
timeRollup="LAST" timeWeightAcctId="" levelDimRollup="SUM" levelDimWeightAcctId="" rollupText=""
startExpanded="" hasSalaryDetail="0" dataPrivacy="PRIVATE" isBreakbackEligible="" subType="CUMULATIVE"
enableActuals="1" isGroup="0">
<attributes>
<attribute name="SEC Reporting" value="Yes" />
<attribute name="GAAP Reporting" value="No" />
</attributes>
</account>
</account>
</account>
</account>
</accounts>
</output>
</response>
|
response element |
|||
|
Tag Name |
response |
||
|
Attributes of the Element |
|||
|
Attribute Name |
Required? |
Value |
Example |
|
success |
Y |
Either true or false, indicating whether the API call was successful or not. Even successful calls may contain warning messages in their response. |
true |
|
obsolete |
N |
If present on the response tag and set to true, this attribute indicates that the version of the method or API which is being invoked has become obsolete and is officially deprecated. While it continues to function at this time, it may cease functioning in a short while. Typically, this attribute is not present. |
false |
|
Contents of the Element |
|||
|
A single optional messages element, and exactly one required output element. |
|||
|
output element |
|
|
Tag Name |
output |
|
Attributes of the Element |
|
|
(none) |
|
|
Contents of the Element |
|
|
A single accounts element. This output wrapper is standard on all API responses and encloses the valid output of any successful API call. |
|
|
accounts element |
|||
|
Tag Name |
accounts |
||
|
Description |
Container for one or more account elements. |
||
|
Attributes of the Element |
|||
|
Attribute Name |
Required? |
Value |
Example |
|
seqNo Added in API v17 but reserved for future use. |
|||
|
Contents of the Element |
|||
|
One or more account elements. |
|||
|
account element |
|||||
|
Tag Name |
account |
||||
|
Description |
Represents a single account being returned in the response to an exportAccounts API call. If this element is directly within the enclosing accounts element of the response (that is, it is not enclosed within another account element), this account element represents a root account, an account that has no parent. |
||||
|
Attributes of the Element |
|||||
|
Attribute Name |
Required? |
Value |
Example |
||
|
name |
Y |
The name of the account, as it appears on reports and sheets. |
Current |
||
|
code |
Y |
The code of the account, as it appears when referenced in formulas. |
Cur_Assets |
||
|
id |
N |
The internal system ID number for the account. This can be used to identify accounts in other API calls, such as exportDimensionFamilies. |
16 |
||
|
accountTypeCode |
N |
The letter code corresponding to the data type of this account |
|||
|
Type Code |
Account Type |
Account Class |
|||
|
A |
Asset |
GL |
|||
|
B |
Current Asset |
GL |
|||
|
C |
Liability & Equity |
GL |
|||
|
CUBE |
Cube |
Cube |
|||
|
EN |
YTD Earnings/Loss |
GL |
|||
|
F |
Fixed Asset |
GL |
|||
|
G |
Cost of Goods Sold |
GL |
|||
|
I |
Income |
GL |
|||
|
J |
Non-Operating Income |
GL |
|||
|
K |
Cumulative Translation Adjustment |
System |
|||
|
L |
Liability |
GL |
|||
|
M |
Current Liability |
GL |
|||
|
MI |
Consolidation Percentages |
Predefined |
|||
|
MT |
Metric |
Metric |
|||
|
N |
Net Income |
GL |
|||
|
O |
Other Asset |
GL |
|||
|
Q |
Equity |
GL |
|||
|
R |
Long Term Asset |
GL |
|||
|
S |
Assumption |
Assumption |
|||
|
T |
Long Term Liability |
GL |
|||
|
W |
Modeled |
Modeled |
|||
|
X |
Expense |
GL |
|||
|
XR |
Exchange Rate |
Predefined |
|||
|
Y |
Non-Operating Expenses |
GL |
|||
|
Z |
Custom |
Custom |
|||
|
description |
N |
The textual description of the account, if any, as entered in Account Administration |
Total |
|
shortName |
N |
The short name for the account, if any, as entered in Account Administration |
CA |
|
timeStratum Supported in API v16 + |
N | The time stratum of the account, as the code of the time stratum. For Cube accounts, Modeled accounts, and cube-entered GL accounts, the time stratum is determined by the time stratum of their owning sheet. All other accounts use the default time stratum set within the Time Admin UI. | Month |
|
displayAs |
N |
The account's output display setting: NUMBER, CURRENCY, or PERCENT. Only provided for accounts that have a Display As property in Account Administration. |
NUMBER |
|
isAssumption |
N |
Either "0" or "1", indicating whether the account is an assumption. This is set to “1” for assumptions and exchange rate accounts. |
1 |
|
suppressZeroes |
N |
Flag indicating whether the account allows users to suppress zeroes on sheets or not. 0 is disallowed, 1 is allowed. Only provided for accounts which have a Suppress Zeroes property in Account Administration. |
1 |
|
isDefaultRoot |
N |
Either "0" or "1", indicating whether the account or account group is a default root. |
1 |
|
decimalPrecision |
N |
Number of decimal places to display for numbers in this account. Default is 0. The special value of 99 is used to indicate a Linked Account which inherits the decimal precision of its target. A value of -1 means the account is a currency account and uses the precision of whichever currency it is displaying. |
0 |
|
planBy |
N |
For Cumulative accounts, indicates whether the account is plan by balance (BALANCE) or plan by delta (DELTA). |
BALANCE |
|
exchangeRateType |
N |
Only present for accounts with displayAs="CURERENCY". Possible values: any of the exchange rate type codes present in the instance, as configured in Manage Currencies. "A"=Monthly Average, "E"=End of Month. |
E |
|
isImportable |
N |
Indicates whether the account is able to accept imported data. 0 means the account is not importable and 1 is importable. Only present if versionName or versionId is specified in the request. Note: isImportable only indicates that an account is available for import in the specified version, not that the user making the API call has the permission to import into the version or account. Use exportVersions to see which versions are available to the user for import. |
1 |
|
balanceType |
N |
Indicates the balance type of an account, DEBIT or CREDIT. This attribute is empty if the account does not have an associated balance type. Only GL accounts have a balance type. |
DEBIT |
|
dataEntryType |
N |
Indicates the data entry type of an account. Either STANDARD or CUBE. A blank value indicates that data entry type is not applicable to an account. For example, a linked account or a modeled account will have a blank data entry type. |
CUBE |
|
timeRollUp |
N |
Indicates how the account behaves when rolled up over a time period. Can be SUM, WEIGHTED_AVERAGE, LAST, or AVERAGE. This will be empty for account groups and metric accounts. |
SUM |
|
timeWeightAcctId |
N |
If this account has a timeRollup of WEIGHTED_AVERAGE, this will be the internal system id number of the account from where the weights are determined. This will be empty if no weight account exists or the account does not have a timeRollup of WEIGHTED_AVERAGE. |
133 |
|
hasSalaryDetail |
N |
Either 0 or 1 to indicate whether this account has splits that require the Access Salary Detail permission to be viewed. This will be empty if not applicable to this account. |
1 |
|
dataPrivacy |
N |
Indicates which levels the account's values are public on and able to be referenced in other levels when writing formulas. Can be PRIVATE so that the account's values are private, PUBLIC_TOP so that the account's values are public at only the top level, or PUBLIC_ALL so that the account's values are public at all levels. Assumptions do not have a dataPrivacy setting since they are always public. |
PRIVATE |
|
subType |
N |
Indicates whether the account is PERIODIC or CUMULATIVE. If an account is periodic, its value in a given time period equals the net activity for the time period. Examples include revenue and expense accounts. If an account is cumulative, its value equals the ending balance for a given time period. This is the prior time period’s value plus or minus any activity in the given time period. Balance sheet accounts are cumulative. This will be empty for account groups and metric accounts. |
PERIODIC |
|
startExpanded |
N |
This indicates whether an account and its children start out in an expanded state when first loading a sheet. This applies only for parent accounts. This will be empty for leaf accounts. |
1 |
|
isBreakbackEligible |
N |
Either 0 or 1 to indicate whether this account can be used in a breakback. This applies only to standard assumptions. This will be empty for other types of accounts. |
0 |
|
levelDimRollup |
N |
Indicates how the account behaves when rolled up along a level or dimension. Can be SUM, WEIGHTED_AVERAGE, TEXT, or NONBLANK_AVERAGE. This will be empty for account groups and metric accounts. |
NONBLANK_AVERAGE |
|
levelDimWeightAcctId |
N |
If this account has a levelDimRollup of WEIGHTED_AVERAGE, this will be the internal system id number of the account from where the weights are determined. This will be empty if no weight account exists or the account's levelDimRollup is not WEIGHTED_AVERAGE. |
118 |
|
rollupText |
N |
If this account has a levelDimRollup of TEXT, then this is the text string that will show up in the cell indicating the rolled up value of the account. |
None |
|
enableActuals |
N |
0 to show only plan data for the account. 1 to import actuals into the account. For linked accounts, 0 will show actuals only if the linked account has them, and 1 will enable actuals for the linked account. This will be empty for account groups and metric accounts. |
1 |
|
isGroup |
Y |
0 or 1 to indicate whether this is an account group or not. |
1 |
|
isIntercompany |
N |
0 or 1 to indicate whether this account is an intercompany account or not. |
1 |
|
formula Not available in API v18. |
N |
The formula for the account, if it has one. |
ACCT.Revenue - ACCT.Expenses |
|
isLinked |
N |
0 or 1 to indicate whether this account is a linked account or not. |
1 |
|
isSystem |
N |
0 or 1 to indicate whether this account is a system account or not. |
1 |
|
owningSheetId |
N |
For accounts that can be on modeled and cube sheets, the internal system id number of the sheet that this account is on. This will be empty if it is not such an account, or if it is such an account but is not currently assigned to a sheet. |
17 |
|
Contents of the Element |
|||
|
One nested account element for each direct child account of this account. |
|||
|
attributes element |
|||
|
Tag Name |
attributes |
||
|
Description |
Container for one or more attribute elements. |
||
|
Attributes of the Element |
|||
|
Attribute Name |
Required? |
Value |
Example |
|
(none) |
|||
|
Contents of the Element |
|||
|
One or more attribute elements. |
|||
|
attribute element |
|||
|
Tag Name |
attribute |
||
|
Description |
Represents a single non-blank account attribute mapping to which an account is associated. |
||
|
Attributes of the Element |
|||
|
Attribute Name |
Required? |
Value |
Example |
|
name |
Y |
The name of the account attribute |
SEC Reporting |
|
value |
Y |
The value of the account attribute associated with the account. |
Yes |
|
attributeID |
Y |
The internal system id number of the account attribute. |
10 |
|
valueID |
Y |
The internal system id number of the account attribute. |
108 |
|
Contents of the Element |
|||
|
none |
|||