Skip to main content
Documentation
Documentation
Adaptive Planning
Last Updated: 2023-06-23
Reference: Properties in Account JSON Import Payload

Reference: Properties in Account JSON Import Payload

Property value not present
 means the property is not in the payload or the value is null. Empty string is not considered not present.

Modeled Accounts Import

Property Name
Possible Values
Requirements
Default Value For Creating If Property Value Not Present
Default Value For Updating If Property Value Not Present
name
String.
Required for creating a new account.
N/A
The current name.
parent
The exact name or code of the parent account.
Optional.
The modeled sheet account group.
The current parent.
type
"Timespan" or "Initial Balance" or "Calculated" or "Assumption" or "Spread" or blank for the root account.
Required.
N/A
N/A
isCumulative
true or false.
Required to be true for cumulative accounts.
false
The current isCumulative.
isLink
false, we can't have linked accounts in modeled account admin.
Optional.
false
false
shortName
Alpha-numeric.
Optional.
No default.
The current shortName.
code
Alpha-numeric, underscores, no special characters or spaces.
Optional. Will use Name as Code if not present.
Name
The current code.
isPlanByDelta
true or false.
Required for cumulative accounts. Leave blank for periodic accounts.
false
Thre current isPlanByDelta
displayAs
"NUMBER" or "CURRENCY" or "PERCENT".
Optional.
"NUMBER"
The current displayAs.
decimalPrecision
Number 1-9 or -1
-1 means Currency's Precision.
Optional.
0
The current decimal precision.
exchangeRateType
"Monthly Average" or "End of Month" or the exact name of any other valid Exchange Rate Type.
Optional.
"Monthly Average" for periodic accounts and "End of Month" for cumulative accounts.
The current exchangeRateType.
formula
Valid formula.
Optional.
"0" for Calculated account, null for others.
The current formula.
description
Alpha-numeric.
Optional.
No default.
The current description.
dataPrivacy
"PRIVATE" or "CORPORATE_ROLLUP_PLAN" or "ALL_PLANS".
Optional.
"PRIVATE"
The current data privacy.
spreadTargetAccount
The account code defined within the modeled sheet.
Required for creating Spread account type.
null
The current spreadTargetAccount.
modeledSheetSpreadCode
The spread lookup defined in Data Entry Columns within the modeled sheet editor for this modeled sheet.
Required for creating Spread account type.
null
The current modeledSheetSpreadCode.
attributeValues
Attribute vlaues as defined for the attribute.
Optional
null
The current attributeValues.

Cube Accounts Import

Property Name
Possible Values
Requirements
Default Value for Creating if property value not present
Default Value for Updating if property value not present
name
String.
Required for creating a new account.
N/A
The current name
parent
The exact name or code of the parent account.
Optional.
The cube sheet account group
The current parent
type
"Standard", "Calculated", "Assumption", "Metric" and supported Cube entered account types.
Required if not group.
Required not present for group.
N/A
N/A
isCumulative
true or false.
Required to be true for cumulative accounts.
false
The current isCumulative
isLink
true or false.
Required for creating a link account.
false
The current isLink
shortName
Alpha-numeric.
Optional.
No default
The current shortName
code
Alpha-numeric, underscores, no special characters or spaces.
Optional. Will use Name as Code if not present.
Name
The current code
isPlanByDelta
true or false.
Required for cumulative accounts.
false
The current isPlanByDelta
isActualsByDelta
true or false.
Required for cumulative accounts.
false
The current isActualsByDelta
displayAs
"NUMBER" or "CURRENCY" or "PERCENT".
Optional.
"NUMBER"
The current displayAs
decimalPrecision
Number 1-9 or -1
-1 means Currency's Precision.
Optional.
0
The current decimalPrecision
exchangeRateType
"Monthly Average" or "End of Month" or the exact name of any other valid Exchange Rate Type.
Optional.
"Monthly Average" for periodic accounts and "End of Month" for cumulative accounts.
The current exchangeRateType
formula
Valid formula.
Optional.
"0" for Calculated account, null for others
The current formula
description
Alpha-numeric.
Optional.
No default.
The current description
dataPrivacy
"PRIVATE" or "CORPORATE_ROLLUP_PLAN" or "ALL_PLANS"
Optional.
"PRIVATE"
The current data privacy
attributeValues
Attribute values as defined for the attribute.
Optional.
null
The current attributeValues
timeRollupType
"SUM", "LAST", "AVERAGE", "WEIGHTED_AVERAGE".
Optional.
Inherits parent account's timeRollupType, or if the account doesn't have a parent account, defaults to Sum
The current timeRollupType
timeWeightAccount
The code of the time rollup weight account.
Required if you entered "WEIGHTED_AVERAGE" for the Time Rollup column.
null
The current timeWeightAccount
levelDimRollupType
"SUM" or "NONBLANK_AVERAGE" or "WEIGHTED_AVERAGE" or "TEXT".
Optional.
Inherits parent account's levelDimRollupType, or if the account doesn't have a parent account, defaults to Sum
The current levelDimRollupType
levelDimWeightAccount
The code of the level/dimension rollup weight account.
Required if you entered "WEIGHTED_AVERAGE" for the Level/Dimension Rollup column. Otherwise, leave blank.
null
The current timeWeightAccount
levelDimRollupText
Any text.
Required if you entered "Text" for the Level/Dimension Rollup column.
null
The current levelDimRollupText
startExpanded
true or false.
Optional.
true
The current startExpanded
actualsOverlay
"ENABLE_ACTUALS" or "SHOW_PLAN".
Optional.
"ENABLE_ACTUALS"
The current actualsOverlay
suppressZeros
true or false.
Optional.
true
The current suppressZeros
dataEntryType
"Standard" or "Cube".
Optional.
null
The current dataEntryType
linkedAccountMappings
List of LinkedAccountMapping.
Required for link account.
N/A
N/A