Workday Adaptive Planning
App · 24 actions
Read and update your Workday Adaptive Planning budgets and forecasts: export and import plan and actuals data, keep levels and dimensions in step with other systems, and start workflows when a budget is submitted or approved, a version is locked or actuals come in.
Actions
| Action | What it does |
|---|---|
| Create dimension value | Add a value to a dimension, such as a new customer, product or project. |
| Create level | Add a level to the organization under another level, such as a new department or entity. |
| Erase data | Erase the numbers of GL or custom accounts in a version for a range of periods, at chosen levels or all of them. |
| Export data | Read numbers from a version for chosen accounts, levels and periods, optionally split by dimensions. |
| Export modeled sheet rows | Read every row of a modeled sheet, such as headcount or capital purchases, in a version, with every column. |
| Get level | Get one level with its currency, the level above it, its attributes and, for a plan version with workflow, its status. |
| Get publishing status | Whether admin publishing is on, and how many model changes are waiting to be published. |
| Import data | Write numbers into a version's GL, custom or assumption accounts. |
| Import modeled sheet rows | Add rows to a modeled sheet in a version, or update the rows that match a key column. |
| List accounts | List the chart of accounts in tree order: GL accounts, assumptions, custom, cube and modeled accounts and metrics, with each one's code and type. |
| List attributes | List the custom attributes accounts, levels and dimensions are tagged with, each with its values. |
| List currencies | List the currencies set up in the instance. |
| List dimensions | List custom dimensions, such as Department or Product, each with its values in tree order. |
| List groups | List the instance's user groups. |
| List instances | List the Adaptive Planning instances the connected user can open, with each one's code and main currency. |
| List levels | List the organization's levels (departments, entities, regions) in tree order with their currency, and, for a plan version with workflow, each level's status: in progress, submitted, rejected or approved. |
| List security events | List sign-ins, failed sign-ins, lockouts, password changes and other security events. |
| List sheets | List standard, modeled and cube sheets. |
| List time periods | List the calendar: its strata (month, quarter, year) and every period with the code imports and exports use, such as 01/2026. |
| List users | List the instance's users with their login, email, groups, last sign-in and whether they are locked out. |
| List versions | List plan and actuals versions with their type, whether they are locked, where planning starts and how far actuals are filled in, and name the default version. |
| Publish changes | Publish every model change waiting to be published, such as new levels or dimension values, when admin publishing is on. |
| Update dimension value | Rename a dimension value, or change its short name or description. |
| Update level | Rename a level, or change its short name or currency. |
Create dimension value
Add a value to a dimension, such as a new customer, product or project. It goes at the top of the dimension. Adaptive Planning can't delete values through its API.
Inputs
- Dimension
dimension_idtextRequired - The dimension, such as Department or Product.
- Name
nametextRequired - The new value's name.
- Short name
short_nametext - A short name for the value.
- Description
descriptiontext - A description of the value.
Outputs
dimension_valueobject- The new value
messageslist- Warnings or notes Adaptive Planning gave
Example output
{
"dimension_value": {
"description": "docs",
"dimension_id": 6,
"id": 44,
"name": "Documentation",
"short_name": "",
"status": "created"
},
"messages": []
}Create level
Add a level to the organization under another level, such as a new department or entity. Adaptive Planning can't delete levels through its API, so remove one by hand if needed.
Inputs
- Parent level
parent_level_idtextRequired - The level to add it under.
- Name
nametextRequired - The new level's name.
- Short name
short_nametext - A short name shown on sheets.
- Currency
currencytext - The level's currency, one set up in the instance.
Outputs
levelobject- The new level
messageslist- Warnings or notes Adaptive Planning gave
Example output
{
"level": {
"currency": "CAD",
"id": 166,
"name": "Canada",
"parent_id": 164,
"short_name": "CA",
"status": "created"
},
"messages": []
}Erase data
Erase the numbers of GL or custom accounts in a version for a range of periods, at chosen levels or all of them. Formulas stay. Needs the Erase Data permission.
Inputs
- Version
versiontextRequired - The version to erase from.
- Accounts
accountslistRequired - The accounts to erase, all GL or all custom. Groups don't erase the accounts under them: pick each account.
- From period
start_periodtextRequired - The first period to erase.
- To period
end_periodtextRequired - The last period to erase.
- Levels
levelslist - Only at these levels; a level's sublevels are not included. Leave empty for every level.
- Erase cell notes too
include_cell_notestrue/false - Turn on to also delete the notes on those cells.
Outputs
account_typetext- GL or CUSTOM
end_periodtext- The last period erased
messageslist- Warnings or notes Adaptive Planning gave
start_periodtext- The first period erased
versiontext- The version erased from
Example output
{
"account_type": "GL",
"end_period": "01/2026",
"messages": [
{
"key": "erase-actuals-facts-deleted",
"text": "4 facts deleted.",
"type": ""
}
],
"start_period": "01/2026",
"version": "Budget 2026"
}Export data
Read numbers from a version for chosen accounts, levels and periods, optionally split by dimensions. Gives a row per account and level with a number per period, the same as one cell per period, and their total.
Inputs
- Accounts
accountslistRequired - The accounts to read.
- From period
start_periodtextRequired - The first period to read.
- To period
end_periodtextRequired - The last period to read.
- Version
versiontext - The version to use, such as your budget or actuals. Leave empty for the instance's default version.
- Levels
levelslist - The levels to read. Leave empty for the top level.
- Include the levels under them
include_sublevelstrue/false - Turn on to include every level under the chosen levels too.
- Include the accounts under them
include_subaccountstrue/false - Turn on to include every account under the chosen accounts.
- Split by dimensions
split_by_dimensionslist - Give a row for each value of these dimensions.
- Only these dimension values
dimension_value_idslist - Only numbers tagged with these dimension values.
- Totals by
stratumtext - Add up the periods by this stratum, such as quarter or year. Leave empty for each period.
- Currency
currencytext - The currency to show amounts in. Defaults to the corporate currency.
- Include empty rows
include_zero_rowstrue/false - Turn on to include rows that are all zero or blank.
- Include rollup totals
include_rollupstrue/false - Turn on to include the totals of account groups and parent levels.
Outputs
cell_countnumber- How many cells
cellslist- One cell per row and period
columnslist- The columns Adaptive Planning gave
messageslist- Warnings or notes Adaptive Planning gave
periodslist- The period columns
row_countnumber- How many rows
rowslist- A row per account, level and dimension value
totalnumber- The sum of every number read
Example output
{
"cell_count": 1,
"cells": [
{
"account": "4000",
"account_name": "Product Revenue",
"amount": 1250.5,
"dimensions": {
"Department": "Engineering"
},
"level": "United States",
"level_code": "BC - 111",
"period": "01/2026"
}
],
"columns": [
"Account Name",
"Account Code",
"Level Code",
"Level Name",
"Department Name",
"01/2026"
],
"messages": [],
"periods": [
"01/2026"
],
"row_count": 1,
"rows": [
{
"account": "4000",
"account_name": "Product Revenue",
"dimensions": {
"Department": "Engineering"
},
"labels": {
"Account Code": "4000",
"Account Name": "Product Revenue",
"Department Name": "Engineering",
"Level Code": "BC - 111",
"Level Name": "United States"
},
"level": "United States",
"level_code": "BC - 111",
"values": {
"01/2026": 1250.5
}
}
],
"total": 1250.5
}Export modeled sheet rows
Read every row of a modeled sheet, such as headcount or capital purchases, in a version, with every column.
Inputs
- Modeled sheet
sheettextRequired - The modeled sheet, by name.
- Version
versiontext - The version to use, such as your budget or actuals. Leave empty for the instance's default version.
- User-assigned sheet
user_assignedtrue/false - Turn on if the sheet is assigned to users rather than levels. Most modeled sheets are assigned to levels.
- Levels
levelslist - Only rows of these levels. Leave empty for every level.
- Include the levels under them
include_sublevelstrue/false - Turn on to include every level under the chosen levels too.
- From period
start_periodtext - Only rows from this period.
- To period
end_periodtext - Only rows up to this period.
Outputs
columnslist- The sheet's columns
messageslist- Warnings or notes Adaptive Planning gave
row_countnumber- How many rows
rowslist- The rows, each by column name
versiontext- The version read
Example output
{
"columns": [
"InternalID",
"Level",
"Employee"
],
"messages": [],
"row_count": 1,
"rows": [
{
"Employee": "J. Doe",
"InternalID": "271",
"Level": "United States"
}
],
"version": "Budget 2026"
}Get level
Get one level with its currency, the level above it, its attributes and, for a plan version with workflow, its status.
Inputs
- Level
level_idtextRequired - The level. Pick one, or give its id.
- Version
versiontext - Give a version to see the level's workflow status there.
Outputs
levelobject- The level
Example output
{
"level": {
"attributes": [
{
"attribute_id": 20,
"name": "Region",
"value": "West",
"value_id": 170
}
],
"code": "BC - 111",
"currency": "USD",
"depth": 2,
"description": "",
"display_name": "",
"has_children": false,
"id": 165,
"is_elimination": false,
"is_importable": true,
"is_linked": false,
"name": "United States",
"parent_id": 164,
"parent_name": "Operations",
"publish_currency": "",
"short_name": "US",
"workflow_status": "S",
"workflow_status_label": "Submitted"
}
}Get publishing status
Whether admin publishing is on, and how many model changes are waiting to be published.
Inputs
None.
Outputs
admin_publishing_enabledtrue/false- True when model changes wait for someone to publish them
changes_to_publishnumber- How many changes are waiting
Example output
{
"admin_publishing_enabled": true,
"changes_to_publish": 2
}Import data
Write numbers into a version's GL, custom or assumption accounts. Each value names an account, level, period and amount, and optionally its dimension values; existing numbers in those cells are replaced.
Inputs
- Values
valueslistRequired - The numbers to write: a list of objects, each with account (code), level (id or name), period (code, such as 01/2026), amount, and optionally dimensions.
- Version
versiontext - The version to use, such as your budget or actuals. Leave empty for the instance's default version.
Outputs
messageslist- Warnings or notes Adaptive Planning gave
plan_or_actualstext- Plan or Actuals
rows_sentnumber- How many import rows were sent
values_sentnumber- How many values were sent
versiontext- The version written to
Example output
{
"messages": [
{
"key": "",
"text": "Rows imported: 1",
"type": "INFO"
}
],
"plan_or_actuals": "Plan",
"rows_sent": 1,
"values_sent": 1,
"version": "Budget 2026"
}Import modeled sheet rows
Add rows to a modeled sheet in a version, or update the rows that match a key column. Column names are the sheet's own, as its import template shows them.
Inputs
- Modeled sheet
sheettextRequired - The modeled sheet, by name.
- Rows
rowslistRequired - The rows: a list of objects, each mapping the sheet's column names to values, such as Level, Employee and Start Date.
- Version
versiontext - The version to use, such as your budget or actuals. Leave empty for the instance's default version.
- User-assigned sheet
user_assignedtrue/false - Turn on if the sheet is assigned to users rather than levels. Most modeled sheets are assigned to levels.
- How to import
modetext - Add the rows, or update existing ones. Defaults to adding.One of:
add(Add the rows (default)),update(Update rows that match the key column),update_or_add(Update rows that match the key column, add the rest),replace_levels(Replace the rows of the levels in the import). - Key column
key_columntext - To update rows: the column whose value is unique to each row, such as an employee id.Only when How to import is Update rows that match the key column or Update rows that match the key column, add the rest.
Outputs
messageslist- Warnings or notes Adaptive Planning gave
modetext- How the rows were imported
rows_sentnumber- How many rows were sent
sheettext- The sheet written to
versiontext- The version written to
Example output
{
"messages": [
{
"key": "",
"text": "Rows imported: 1",
"type": "INFO"
}
],
"mode": "add",
"rows_sent": 1,
"sheet": "Headcount",
"version": "Budget 2026"
}List accounts
List the chart of accounts in tree order: GL accounts, assumptions, custom, cube and modeled accounts and metrics, with each one's code and type.
Inputs
- Kind of account
account_kindtext - Only accounts of this kind. Leave empty for all.One of:
gl(GL accounts),assumption(Assumptions),custom(Custom accounts),cube(Cube accounts),modeled(Modeled accounts),metric(Metrics). - Include account groups
include_groupstrue/false - Turn off to leave out groups that only add up other accounts. On unless turned off.
Outputs
accountslist- The accounts, flat in tree order
countnumber- How many there are
Example output
{
"accounts": [
{
"account_type": "Income",
"account_type_code": "I",
"attributes": [],
"balance_type": "CREDIT",
"code": "4000",
"data_entry_type": "STANDARD",
"depth": 1,
"description": "",
"display_as": "CURRENCY",
"id": 120,
"is_assumption": false,
"is_group": false,
"is_intercompany": false,
"is_linked": false,
"is_system": false,
"kind": "gl",
"name": "Product Revenue",
"owning_sheet_id": null,
"parent_code": "Revenue",
"parent_id": 100,
"short_name": "",
"sub_type": "PERIODIC",
"time_rollup": "SUM",
"time_stratum": "month"
}
],
"count": 1
}List attributes
List the custom attributes accounts, levels and dimensions are tagged with, each with its values.
Inputs
- Kind of attribute
attribute_typetext - Only attributes of this kind. Leave empty for all.One of:
account(Account attributes),level(Level attributes),dimension(Dimension attributes).
Outputs
attributeslist- The attributes
countnumber- How many there are
Example output
{
"attributes": [
{
"auto_create": false,
"dimension_id": null,
"id": 13,
"keep_sorted": false,
"name": "AP Eligible",
"type": "account",
"value_count": 1,
"values": [
{
"code": "",
"depth": 0,
"description": "",
"display_name": "",
"id": 117,
"name": "Yes",
"parent_id": null
}
]
}
],
"count": 1
}List currencies
List the currencies set up in the instance.
Inputs
None.
Outputs
countnumber- How many there are
currencieslist- The currencies
Example output
{
"count": 1,
"currencies": [
{
"code": "USD",
"description": "United States of America, Dollars",
"id": 1,
"is_reporting_currency": true,
"precision": 2,
"user_defined": false
}
]
}List dimensions
List custom dimensions, such as Department or Product, each with its values in tree order.
Inputs
- Dimension
dimension_idtext - Only this dimension. Leave empty for all.
- Include values
include_valuestrue/false - Turn off to list the dimensions without their values.
Outputs
countnumber- How many there are
dimensionslist- The dimensions
Example output
{
"count": 1,
"dimensions": [
{
"auto_create": false,
"code": "",
"description": "",
"id": 6,
"is_list": false,
"keep_sorted": false,
"name": "Department",
"short_name": "",
"use_on_levels": true,
"value_count": 1,
"values": [
{
"attributes": [],
"code": "",
"depth": 0,
"description": "",
"display_name": "",
"id": 7,
"name": "Engineering",
"parent_id": null,
"properties": {},
"short_name": "Engr"
}
]
}
]
}List groups
List the instance's user groups. Needs a user with User Admin permission.
Inputs
None.
Outputs
countnumber- How many there are
groupslist- The groups
Example output
{
"count": 1,
"groups": [
{
"id": 1,
"is_global": true,
"name": "Finance",
"owner_id": null
}
]
}List instances
List the Adaptive Planning instances the connected user can open, with each one's code and main currency. The user's default comes first.
Inputs
None.
Outputs
countnumber- How many there are
instanceslist- The instances
Example output
{
"count": 1,
"instances": [
{
"code": "ACME1",
"is_default": true,
"name": "Acme Corp",
"products": "Planning",
"session_timeout": 60,
"system_currency": "USD",
"workday_environment": ""
}
]
}List levels
List the organization's levels (departments, entities, regions) in tree order with their currency, and, for a plan version with workflow, each level's status: in progress, submitted, rejected or approved.
Inputs
- Version
versiontext - Give a version to see each level's workflow status and whether you can import into it there. Leave empty to list levels only.
Outputs
countnumber- How many there are
levelslist- The levels, flat in tree order
Example output
{
"count": 1,
"levels": [
{
"attributes": [
{
"attribute_id": 20,
"name": "Region",
"value": "West",
"value_id": 170
}
],
"code": "BC - 111",
"currency": "USD",
"depth": 2,
"description": "",
"display_name": "",
"has_children": false,
"id": 165,
"is_elimination": false,
"is_importable": true,
"is_linked": false,
"name": "United States",
"parent_id": 164,
"parent_name": "Operations",
"publish_currency": "",
"short_name": "US",
"workflow_status": "S",
"workflow_status_label": "Submitted"
}
]
}List security events
List sign-ins, failed sign-ins, lockouts, password changes and other security events. Adaptive Planning keeps 30 days; with no dates it gives the last 24 hours. Needs an administrator.
Inputs
- From
date_fromdate and time - Only events at or after this time.
- Until
date_todate and time - Only events before this time.
- User
usertext - Only events of this user, by login.
- Kind of event
event_typetext - Only events of this kind. Leave empty for all.One of:
SUC(Successful sign-in),USC(Failed sign-in),ULO(Sign-out),LOK(User locked out),UOK(User unlocked),CRE(User created),DIS(User disabled),PWC(Password changed),CRD(Credentials changed),AUT(Sign-in settings changed),EXP(Session expired),TER(Session ended by an error).
Outputs
countnumber- How many there are
eventslist- The events
Example output
{
"count": 1,
"events": [
{
"action": "USC",
"action_label": "Failed sign-in",
"actor": "B9ADBCB81AA2F9BAE040307F02092C2E",
"context": "",
"interface": "UI",
"object": "",
"outcome": "failure",
"timestamp": "2026-11-12 16:02:11",
"version": "2026.2"
}
]
}List sheets
List standard, modeled and cube sheets.
Inputs
- Kind of sheet
sheet_typetext - Only sheets of this kind. Leave empty for all.One of:
standard(Standard sheets),modeled(Modeled sheets),cube(Cube sheets).
Outputs
countnumber- How many there are
sheetslist- The sheets
Example output
{
"count": 1,
"sheets": [
{
"code": "HC",
"description": "",
"id": 12,
"name": "Headcount",
"type": "modeled"
}
]
}List time periods
List the calendar: its strata (month, quarter, year) and every period with the code imports and exports use, such as 01/2026.
Inputs
- Version
versiontext - Only the periods of this version. Leave empty for the whole calendar.
- Only the smallest periods
leaf_onlytrue/false - Turn on for only the periods that take data, usually months.
Outputs
countnumber- How many there are
periodslist- The periods, flat in calendar order
stratalist- The time strata
Example output
{
"count": 1,
"periods": [
{
"code": "01/2026",
"end": "2026-02-01",
"id": 192001,
"is_leaf": true,
"label": "Jan-2026",
"parent_code": "Q1-2026",
"short_name": "Jan-2026",
"start": "",
"stratum": "month",
"stratum_id": 1
}
],
"strata": [
{
"code": "month",
"id": 1,
"in_use": true,
"is_default": true,
"label": "Month",
"parent_code": "qtr",
"short_name": "Mon"
}
]
}List users
List the instance's users with their login, email, groups, last sign-in and whether they are locked out. Needs a user with User Admin permission.
Inputs
- Search
searchtext - Only users whose name, login or email contains this.
Outputs
countnumber- How many there are
userslist- The users
Example output
{
"count": 1,
"users": [
{
"country": "US",
"created_date": "2026-06-26 07:56:00.0",
"email": "anna@example.com",
"failed_attempts": 0,
"group_ids": [
1,
101
],
"guid": "B9ADBCB81AA2F9BAE040307F02092C2E",
"id": 19,
"last_login": "2026-11-12 08:48:34.0",
"locked": false,
"login": "anna@example.com",
"name": "Anna Analyst",
"permission_set_ids": [
3
],
"position": "FP&A Manager",
"time_zone": "US/Pacific"
}
]
}List versions
List plan and actuals versions with their type, whether they are locked, where planning starts and how far actuals are filled in, and name the default version.
Inputs
- Kind of version
version_typetext - Only versions of this kind. Leave empty for all.One of:
PLANNING(Plan versions),ACTUALS(Actuals versions),JOURNAL_ENTRY(Journal entry versions),SCENARIO(What-if scenarios),VERSION_FOLDER(Folders). - Include what-if scenarios
include_scenariostrue/false - Turn on to include people's private what-if scenarios.
Outputs
countnumber- How many there are
default_versionobject- The instance's default version, or null
versionslist- The versions, flat in tree order
Example output
{
"count": 1,
"default_version": {
"completed_values_through": "",
"depth": 0,
"description": "Operating budget",
"enabled_for_workflow": true,
"end_plan": "2026",
"end_version": "",
"has_audit_trail": false,
"id": 3,
"is_default": true,
"is_importable": true,
"is_locked": false,
"is_predictive": false,
"is_virtual": false,
"lock_leading": "",
"name": "Budget 2026",
"parent_id": null,
"short_name": "B26",
"start_plan": "01/2026",
"start_version": "",
"type": "PLANNING"
},
"versions": [
{
"completed_values_through": "",
"depth": 0,
"description": "Operating budget",
"enabled_for_workflow": true,
"end_plan": "2026",
"end_version": "",
"has_audit_trail": false,
"id": 3,
"is_default": true,
"is_importable": true,
"is_locked": false,
"is_predictive": false,
"is_virtual": false,
"lock_leading": "",
"name": "Budget 2026",
"parent_id": null,
"short_name": "B26",
"start_plan": "01/2026",
"start_version": "",
"type": "PLANNING"
}
]
}Publish changes
Publish every model change waiting to be published, such as new levels or dimension values, when admin publishing is on. Needs the Publish Admin Changes permission.
Inputs
None.
Outputs
messageslist- Warnings or notes Adaptive Planning gave
published_countnumber- How many changes were published
Example output
{
"messages": [],
"published_count": 2
}Update dimension value
Rename a dimension value, or change its short name or description.
Inputs
- Dimension
dimension_idtextRequired - The dimension, such as Department or Product.
- Value
value_idtextRequired - The value to change.
- New name
nametext - The value's new name. Leave empty to keep it.
- Short name
short_nametext - A new short name.
- Description
descriptiontext - A new description.
Outputs
dimension_valueobject- The value as changed
messageslist- Warnings or notes Adaptive Planning gave
Example output
{
"dimension_value": {
"description": "docs",
"dimension_id": 6,
"id": 44,
"name": "Documentation",
"short_name": "",
"status": "updated"
},
"messages": []
}Update level
Rename a level, or change its short name or currency.
Inputs
- Level
level_idtextRequired - The level. Pick one, or give its id.
- New name
nametext - The level's new name.
- Short name
short_nametext - A new short name shown on sheets.
- Currency
currencytext - The level's currency, one set up in the instance.
Outputs
levelobject- The level as changed
messageslist- Warnings or notes Adaptive Planning gave
Example output
{
"level": {
"currency": "CAD",
"id": 166,
"name": "Canada",
"short_name": "CA",
"status": "updated"
},
"messages": []
}