Budget & forecast
Set up funding accounts and financial hierarchies, view and plan budget allocations, and forecast spend.
This area has 4 groups and 37 tools, 12 of them currently available.
- Groups are the unit of access. An admin enables tool groups on a client registration, and a tool appears in an agent's tool list only when its group is enabled. See Tool Groups.
- Needs. Enabling a group also enables every group it needs. Each group below lists them.
- Read-only groups are intended for look-up access without the ability to change data.
- Visibility is not authorization. Every tool call executes as the authenticated user, and a visible tool can still return an authorization error. See the MCP Tool Permission Map.
- Destructive tools are labelled as such. They delete or irreversibly overwrite data, and will not act unless the call sets both
confirmedandconfirmedDestructivetotrue. - Not currently available tools are registered but are not offered in any tool list at this time.
- Activity and Project labels vary by tenant. Where this page says Activity or Project, your tenant's own configured terminology is substituted at runtime.
Groups in this area
| Group | Access | Needs | Tools |
|---|---|---|---|
| Set Up Funding Accounts & Hierarchies | Can change data | None | 8 |
| View Budgets | Read-only | None | 14 |
| Plan Budget Allocations | Can change data | View Budgets, Set Up Funding Accounts & Hierarchies, View Activities, View Programs, Look Up PM Reference Data | 7 |
| Forecast Spend | Can change data | View Activities, View Programs, Look Up PM Reference Data | 8 |
Set Up Funding Accounts & Hierarchies
Can change data · 8 tools · Group ID set-up-funding
Needs: no other groups.
| Tool | What it does |
|---|---|
create_financial_hierarchy | Creates a new financial hierarchy in Aprimo Marketing Operations. |
create_funding_account | Creates a new funding account in Aprimo Marketing Operations (this is the entity the UI calls "Budget", not Budget Allocation -- see create_budget_allocation for that unrelated resource). |
get_financial_hierarchy | Returns a single financial hierarchy by its integer ID in Aprimo Marketing Operations. |
get_financial_hierarchy_node | Returns the full node tree for a financial hierarchy in Aprimo Marketing Operations. |
get_funding_account | Returns a single funding account by its integer ID in Aprimo Marketing Operations -- this is the entity the UI calls "Budget", not Budget Allocation (see get_budget_allocation for that unrelated resource, which uses GUID ids, not integers). |
get_funding_account_summary | Returns the summary data (e.g. rolled-up totals) for a funding account by its integer ID in Aprimo Marketing Operations -- this is the entity the UI calls "Budget", not Budget Allocation (see get_budget_allocation for that unrelated resource). |
update_financial_hierarchy | Updates an existing financial hierarchy by its integer ID in Aprimo Marketing Operations. |
update_funding_account | Updates an existing funding account by its integer ID in Aprimo Marketing Operations (this is the entity the UI calls "Budget", not Budget Allocation -- see update_budget_allocation for that unrelated resource). |
create_financial_hierarchy
Creates a new financial hierarchy in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the created financial hierarchy.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
body | string | Yes | JSON object with the new financial hierarchy's data (PM wire names). |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload. |
Returns:
| Field | Type | Description |
|---|---|---|
financialHierarchyId | integer | |
description | string (optional) | |
rootNodeId | integer (optional) | |
unusedNodeId | integer (optional) | |
showUnused | integer (optional) | |
modifiedDate | string (ISO 8601) (optional) | |
modifiedUser | integer (optional) | |
fiscialYearId | integer (optional) | Bound to the wire's fiscialYearId -- reproduced verbatim; this is PM's own spelling, not a typo introduced here. |
status | integer (optional) | |
encodedTitleId | integer (optional) | |
encodedTitle | string (optional) | Bound to the wire's encodedTitle -- the hierarchy's real, required display title. |
accessList | array of PmAccessListEntry (optional) | |
accessList[].objectId | integer | |
accessList[].userId | integer | |
accessList[].hasEditRight | integer | |
users | array of PmFinancialHierarchyUserLink (optional) | |
users[].financialHierarchyId | integer | |
users[].userId | integer | |
fundingAccounts | array of PmFinancialHierarchyFundingAccountLink (optional) | |
fundingAccounts[].financialHierarchyNodeId | integer | |
fundingAccounts[].fundingAccountId | integer | |
raw | object (optional) | The complete wire object, verbatim. See . |
create_funding_account
Creates a new funding account in Aprimo Marketing Operations (this is the entity the UI calls "Budget", not Budget Allocation -- see create_budget_allocation for that unrelated resource). Requires confirmed=true after showing the user the exact payload. Returns the created funding account.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
body | string | Yes | JSON object with the new funding account's data (PM wire names). |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload. |
Returns:
| Field | Type | Description |
|---|---|---|
fundingAccountId | integer | |
fundingAccountPrefix | string (optional) | |
fundingAccountType | integer (optional) | |
title | string (optional) | |
displayTitle | string (optional) | |
description | string (optional) | |
status | integer (optional) | The funding account's status; PM enum, exposed as its raw int. |
source | integer (optional) | |
administrator | integer (optional) | |
financeGroupClassification | integer (optional) | |
fundingAccountContact | integer (optional) | |
fiscalYear | integer (optional) | |
modifiedDate | string (ISO 8601) (optional) | |
modifiedUser | integer (optional) | |
budgetedCurrency | integer (optional) | |
creator | integer (optional) | |
createdDate | string (ISO 8601) (optional) | |
exchangeRate | integer (optional) | |
financialHierarchies | array of integer (optional) | Ids of the financial hierarchies this funding account participates in. |
budgets | array of PmFundingAccountBudget (optional) | |
budgets[].fundingAccountId | integer | |
budgets[].fiscalPeriodId | integer | |
budgets[].enteredAmount | number (optional) | |
accessList | array of PmAccessListEntry (optional) | |
accessList[].objectId | integer | |
accessList[].userId | integer | |
accessList[].hasEditRight | integer | |
extendedAttributes | array of PmExtendedAttribute (optional) | |
extendedAttributes[].eaId | integer | |
extendedAttributes[].skipDCTSave | boolean | |
extendedAttributes[].eaValue | object (optional) | |
extendedAttributes[].attributeName | string (optional) | |
multipleValueExtendedAttributes | array of PmMultipleValueExtendedAttribute (optional) | |
multipleValueExtendedAttributes[].parentId | integer | |
multipleValueExtendedAttributes[].extAttributeId | integer | |
multipleValueExtendedAttributes[].encodedListItemId | integer | |
multipleValueExtendedAttributes[].attributeName | string (optional) | |
raw | object (optional) | The complete wire object, verbatim. See . |
get_financial_hierarchy
Returns a single financial hierarchy by its integer ID in Aprimo Marketing Operations. Not one of its nodes (use get_financial_hierarchy_node for that).
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
financialHierarchyId | string | Yes | The financial hierarchy's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
financialHierarchyId | integer | |
description | string (optional) | |
rootNodeId | integer (optional) | |
unusedNodeId | integer (optional) | |
showUnused | integer (optional) | |
modifiedDate | string (ISO 8601) (optional) | |
modifiedUser | integer (optional) | |
fiscialYearId | integer (optional) | Bound to the wire's fiscialYearId -- reproduced verbatim; this is PM's own spelling, not a typo introduced here. |
status | integer (optional) | |
encodedTitleId | integer (optional) | |
encodedTitle | string (optional) | Bound to the wire's encodedTitle -- the hierarchy's real, required display title. |
accessList | array of PmAccessListEntry (optional) | |
accessList[].objectId | integer | |
accessList[].userId | integer | |
accessList[].hasEditRight | integer | |
users | array of PmFinancialHierarchyUserLink (optional) | |
users[].financialHierarchyId | integer | |
users[].userId | integer | |
fundingAccounts | array of PmFinancialHierarchyFundingAccountLink (optional) | |
fundingAccounts[].financialHierarchyNodeId | integer | |
fundingAccounts[].fundingAccountId | integer | |
raw | object (optional) | The complete wire object, verbatim. See . |
get_financial_hierarchy_node
Returns the full node tree for a financial hierarchy in Aprimo Marketing Operations. Important: the ID is the financial hierarchy's own integer ID (the same ID used by get_financial_hierarchy) -- not an individual node's ID; there is no way to fetch a single node by its own ID. This always returns every node in that hierarchy's tree.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
financialHierarchyId | string | Yes | The financial hierarchy's own integer ID (not a node ID) -- the same ID get_financial_hierarchy accepts. |
Returns:
| Field | Type | Description |
|---|---|---|
financialHierarchyId | integer | |
nodes | array of FinancialHierarchyBranch (optional) | |
nodes[].financialHierarchyNodeId | integer | |
nodes[].financialHierarchyId | integer | |
nodes[].encodedTitleId | integer (optional) | |
nodes[].title | string (optional) | The node's real, required display title. |
nodes[].parentId | integer (optional) | |
nodes[].terminalNode | integer (optional) | |
nodes[].topDownBudgetAllocated | number (optional) | |
nodes[].topDownBudgetAttainment | number (optional) | |
nodes[].childNodes | array of FinancialHierarchyBranch (optional) | |
nodes[].childSequence | array of PmFinancialHierarchyChildSequenceEntry (optional) | |
nodes[].childSequence[].financialHierarchyNodeId | integer | |
nodes[].childSequence[].childNodeId | integer | |
nodes[].childSequence[].sequence | integer | |
nodes[].fundingAccounts | array of PmFinancialHierarchyFundingAccountLink (optional) | |
nodes[].fundingAccounts[].financialHierarchyNodeId | integer | |
nodes[].fundingAccounts[].fundingAccountId | integer | |
accessList | array of PmAccessListEntry (optional) | |
accessList[].objectId | integer | |
accessList[].userId | integer | |
accessList[].hasEditRight | integer | |
raw | object (optional) | The complete wire object, verbatim. See . |
get_funding_account
Returns a single funding account by its integer ID in Aprimo Marketing Operations -- this is the entity the UI calls "Budget", not Budget Allocation (see get_budget_allocation for that unrelated resource, which uses GUID ids, not integers). Not its own summary either (use get_funding_account_summary for that).
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fundingAccountId | string | Yes | The funding account's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
fundingAccountId | integer | |
fundingAccountPrefix | string (optional) | |
fundingAccountType | integer (optional) | |
title | string (optional) | |
displayTitle | string (optional) | |
description | string (optional) | |
status | integer (optional) | The funding account's status; PM enum, exposed as its raw int. |
source | integer (optional) | |
administrator | integer (optional) | |
financeGroupClassification | integer (optional) | |
fundingAccountContact | integer (optional) | |
fiscalYear | integer (optional) | |
modifiedDate | string (ISO 8601) (optional) | |
modifiedUser | integer (optional) | |
budgetedCurrency | integer (optional) | |
creator | integer (optional) | |
createdDate | string (ISO 8601) (optional) | |
exchangeRate | integer (optional) | |
financialHierarchies | array of integer (optional) | Ids of the financial hierarchies this funding account participates in. |
budgets | array of PmFundingAccountBudget (optional) | |
budgets[].fundingAccountId | integer | |
budgets[].fiscalPeriodId | integer | |
budgets[].enteredAmount | number (optional) | |
accessList | array of PmAccessListEntry (optional) | |
accessList[].objectId | integer | |
accessList[].userId | integer | |
accessList[].hasEditRight | integer | |
extendedAttributes | array of PmExtendedAttribute (optional) | |
extendedAttributes[].eaId | integer | |
extendedAttributes[].skipDCTSave | boolean | |
extendedAttributes[].eaValue | object (optional) | |
extendedAttributes[].attributeName | string (optional) | |
multipleValueExtendedAttributes | array of PmMultipleValueExtendedAttribute (optional) | |
multipleValueExtendedAttributes[].parentId | integer | |
multipleValueExtendedAttributes[].extAttributeId | integer | |
multipleValueExtendedAttributes[].encodedListItemId | integer | |
multipleValueExtendedAttributes[].attributeName | string (optional) | |
raw | object (optional) | The complete wire object, verbatim. See . |
get_funding_account_summary
Returns the summary data (e.g. rolled-up totals) for a funding account by its integer ID in Aprimo Marketing Operations -- this is the entity the UI calls "Budget", not Budget Allocation (see get_budget_allocation for that unrelated resource). Use get_funding_account for the account's own fields.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fundingAccountId | string | Yes | The funding account's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
budget | number (optional) | |
inBound | number (optional) | |
outBound | number (optional) | |
adjustedBudget | number (optional) | |
pending | number (optional) | |
paid | number (optional) | |
availableBudget | number (optional) | |
outstanding | number (optional) | |
uncommittedBudget | number (optional) | |
forecastAmount | number (optional) | |
totalCommit | number (optional) | |
closedCommit | number (optional) | |
outstandingCommit | number (optional) | |
raw | object (optional) | The complete wire object, verbatim. |
update_financial_hierarchy
Updates an existing financial hierarchy by its integer ID in Aprimo Marketing Operations. Only include the fields you intend to change (partial update; omitted fields are left as-is). Requires confirmed=true after showing the user the exact changes. Returns the updated financial hierarchy.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
financialHierarchyId | string | Yes | The financial hierarchy's integer ID. |
body | string | Yes | JSON object with the fields to change (PM wire names). Omit fields you don't want to modify. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change. |
Returns:
| Field | Type | Description |
|---|---|---|
financialHierarchyId | integer | |
description | string (optional) | |
rootNodeId | integer (optional) | |
unusedNodeId | integer (optional) | |
showUnused | integer (optional) | |
modifiedDate | string (ISO 8601) (optional) | |
modifiedUser | integer (optional) | |
fiscialYearId | integer (optional) | Bound to the wire's fiscialYearId -- reproduced verbatim; this is PM's own spelling, not a typo introduced here. |
status | integer (optional) | |
encodedTitleId | integer (optional) | |
encodedTitle | string (optional) | Bound to the wire's encodedTitle -- the hierarchy's real, required display title. |
accessList | array of PmAccessListEntry (optional) | |
accessList[].objectId | integer | |
accessList[].userId | integer | |
accessList[].hasEditRight | integer | |
users | array of PmFinancialHierarchyUserLink (optional) | |
users[].financialHierarchyId | integer | |
users[].userId | integer | |
fundingAccounts | array of PmFinancialHierarchyFundingAccountLink (optional) | |
fundingAccounts[].financialHierarchyNodeId | integer | |
fundingAccounts[].fundingAccountId | integer | |
raw | object (optional) | The complete wire object, verbatim. See . |
update_funding_account
Updates an existing funding account by its integer ID in Aprimo Marketing Operations (this is the entity the UI calls "Budget", not Budget Allocation -- see update_budget_allocation for that unrelated resource). Only include the fields you intend to change (partial update; omitted fields are left as-is). Requires confirmed=true after showing the user the exact changes. Returns the updated funding account.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fundingAccountId | string | Yes | The funding account's integer ID. |
body | string | Yes | JSON object with the fields to change (PM wire names). Omit fields you don't want to modify. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change. |
Returns:
| Field | Type | Description |
|---|---|---|
fundingAccountId | integer | |
fundingAccountPrefix | string (optional) | |
fundingAccountType | integer (optional) | |
title | string (optional) | |
displayTitle | string (optional) | |
description | string (optional) | |
status | integer (optional) | The funding account's status; PM enum, exposed as its raw int. |
source | integer (optional) | |
administrator | integer (optional) | |
financeGroupClassification | integer (optional) | |
fundingAccountContact | integer (optional) | |
fiscalYear | integer (optional) | |
modifiedDate | string (ISO 8601) (optional) | |
modifiedUser | integer (optional) | |
budgetedCurrency | integer (optional) | |
creator | integer (optional) | |
createdDate | string (ISO 8601) (optional) | |
exchangeRate | integer (optional) | |
financialHierarchies | array of integer (optional) | Ids of the financial hierarchies this funding account participates in. |
budgets | array of PmFundingAccountBudget (optional) | |
budgets[].fundingAccountId | integer | |
budgets[].fiscalPeriodId | integer | |
budgets[].enteredAmount | number (optional) | |
accessList | array of PmAccessListEntry (optional) | |
accessList[].objectId | integer | |
accessList[].userId | integer | |
accessList[].hasEditRight | integer | |
extendedAttributes | array of PmExtendedAttribute (optional) | |
extendedAttributes[].eaId | integer | |
extendedAttributes[].skipDCTSave | boolean | |
extendedAttributes[].eaValue | object (optional) | |
extendedAttributes[].attributeName | string (optional) | |
multipleValueExtendedAttributes | array of PmMultipleValueExtendedAttribute (optional) | |
multipleValueExtendedAttributes[].parentId | integer | |
multipleValueExtendedAttributes[].extAttributeId | integer | |
multipleValueExtendedAttributes[].encodedListItemId | integer | |
multipleValueExtendedAttributes[].attributeName | string (optional) | |
raw | object (optional) | The complete wire object, verbatim. See . |
View Budgets
Read-only · 14 tools (0 currently available) · Group ID view-budgets
Needs: no other groups.
| Tool | What it does |
|---|---|
export_budget_allocation | Not currently available. Exports a budget allocation to Excel in Aprimo Marketing Operations and returns a SAS download URL (Budget Allocation, not a Funding Account). |
get_budget_allocation | Not currently available. Returns a single budget allocation by its ID (a GUID string, e.g. "554f2a18-cf54-441b-9893-a6165b3f41ee") in Aprimo Marketing Operations. |
get_budget_allocation_forecast | Not currently available. Returns forecast spend for a budget allocation by its ID (a GUID string, not an integer) in Aprimo Marketing Operations (Budget Allocation, not a Funding Account). |
get_budget_allocation_spend | Not currently available. Returns current spend for a budget allocation by its ID (a GUID string, not an integer) in Aprimo Marketing Operations (Budget Allocation, not a Funding Account). |
get_budget_template_hierarchy | Not currently available. Returns a budget template structure derived from the specified Aprimo financial hierarchy, in Aprimo Marketing Operations. |
list_budget_allocation_activity_types | Not currently available. Lists budget allocation activity types configured in Aprimo Marketing Operations (Budget Allocation, not a Funding Account). |
list_budget_allocation_currencies | Not currently available. Lists currencies available for budget allocations in Aprimo Marketing Operations (Budget Allocation, not a Funding Account). |
list_budget_allocation_financial_groups | Not currently available. Lists external financial groups budget allocations can be activated against, in Aprimo Marketing Operations (Budget Allocation, not a Funding Account). |
list_budget_allocation_metrics | Not currently available. Lists budget allocation metrics available in Aprimo Marketing Operations (Budget Allocation, not a Funding Account). |
list_budget_allocation_programs | Not currently available. Lists programs available for budget allocations in Aprimo Marketing Operations (Budget Allocation, not a Funding Account). |
list_budget_allocation_types | Not currently available. Lists budget allocation types configured in Aprimo Marketing Operations (Budget Allocation, not a Funding Account). |
list_budget_allocation_versions | Not currently available. Lists the versions of a budget allocation by its parent budget allocation's ID (a GUID string, not an integer) in Aprimo Marketing Operations (Budget Allocation, not a Funding Account). |
list_budget_allocations | Not currently available. Lists budget allocations in Aprimo Marketing Operations, paged and unfiltered. |
list_budget_templates | Not currently available. Lists budget templates for the caller's organization in Aprimo Marketing Operations, paged and unfiltered. |
export_budget_allocation
Not currently available
Exports a budget allocation to Excel in Aprimo Marketing Operations and returns a SAS download URL (Budget Allocation, not a Funding Account). No resource is created or changed by this call.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
budgetId | string | Yes | The budget's ID (a GUID string, not an integer) to export. |
options | string | No | Optional JSON object with export options PM expects. Omit or pass "{}" for defaults. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
get_budget_allocation
Not currently available
Returns a single budget allocation by its ID (a GUID string, e.g. "554f2a18-cf54-441b-9893-a6165b3f41ee") in Aprimo Marketing Operations. This is Budget Allocation, not a Funding Account (see get_funding_account for that). Not its own sub-resources either: use get_budget_allocation_forecast or get_budget_allocation_spend for those.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
budgetId | string | Yes | The budget's ID (a GUID string, not an integer). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
name | string (optional) | |
raw | object (optional) | The complete wire object, verbatim, for full fidelity beyond the defensively-extracted fields above. |
get_budget_allocation_forecast
Not currently available
Returns forecast spend for a budget allocation by its ID (a GUID string, not an integer) in Aprimo Marketing Operations (Budget Allocation, not a Funding Account).
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
budgetId | string | Yes | The budget's ID (a GUID string, not an integer). |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
get_budget_allocation_spend
Not currently available
Returns current spend for a budget allocation by its ID (a GUID string, not an integer) in Aprimo Marketing Operations (Budget Allocation, not a Funding Account).
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
budgetId | string | Yes | The budget's ID (a GUID string, not an integer). |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
get_budget_template_hierarchy
Not currently available
Returns a budget template structure derived from the specified Aprimo financial hierarchy, in Aprimo Marketing Operations.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
hierarchyId | string | Yes | The financial hierarchy's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
list_budget_allocation_activity_types
Not currently available
Lists budget allocation activity types configured in Aprimo Marketing Operations (Budget Allocation, not a Funding Account).
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters: none.
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
list_budget_allocation_currencies
Not currently available
Lists currencies available for budget allocations in Aprimo Marketing Operations (Budget Allocation, not a Funding Account).
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters: none.
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
list_budget_allocation_financial_groups
Not currently available
Lists external financial groups budget allocations can be activated against, in Aprimo Marketing Operations (Budget Allocation, not a Funding Account).
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters: none.
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
list_budget_allocation_metrics
Not currently available
Lists budget allocation metrics available in Aprimo Marketing Operations (Budget Allocation, not a Funding Account).
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters: none.
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
list_budget_allocation_programs
Not currently available
Lists programs available for budget allocations in Aprimo Marketing Operations (Budget Allocation, not a Funding Account).
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters: none.
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
list_budget_allocation_types
Not currently available
Lists budget allocation types configured in Aprimo Marketing Operations (Budget Allocation, not a Funding Account).
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters: none.
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
list_budget_allocation_versions
Not currently available
Lists the versions of a budget allocation by its parent budget allocation's ID (a GUID string, not an integer) in Aprimo Marketing Operations (Budget Allocation, not a Funding Account).
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
parentId | string | Yes | The parent budget's ID (a GUID string, not an integer). |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
list_budget_allocations
Not currently available
Lists budget allocations in Aprimo Marketing Operations, paged and unfiltered. Note: this is Budget Allocation, not a Funding Account (the entity the PM UI calls "Budget" -- see get_funding_account/create_funding_account for that).
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sortField | string | No | Optional field name to sort by. Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of BudgetProjection | The items returned in this response. |
items[].id | string (optional) | |
items[].name | string (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim, for full fidelity beyond the defensively-extracted fields above. |
list_budget_templates
Not currently available
Lists budget templates for the caller's organization in Aprimo Marketing Operations, paged and unfiltered.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sortField | string | No | Optional field name to sort by. Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of BudgetTemplateProjection | The items returned in this response. |
items[].id | string (optional) | |
items[].name | string (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim, for full fidelity beyond the defensively-extracted fields above. |
Plan Budget Allocations
Can change data · 7 tools (0 currently available) · Group ID plan-budget-allocations
Needs: View Budgets, Set Up Funding Accounts & Hierarchies, View Activities, View Programs, Look Up PM Reference Data
| Tool | What it does |
|---|---|
activate_budget_allocation | Not currently available. Activates a budget allocation against an external financial group in Aprimo Marketing Operations (Budget Allocation, not a Funding Account -- unrelated to activating/funding a Funding Account). |
create_budget_allocation | Not currently available. Creates a new budget allocation in Aprimo Marketing Operations (Budget Allocation, not a Funding Account -- see create_funding_account for that). |
create_budget_template | Not currently available. Creates a new budget template for the caller's organization in Aprimo Marketing Operations. |
delete_budget_allocation | Not currently available. Destructive. Permanently deletes a budget allocation by its ID (a GUID string, not an integer) in Aprimo Marketing Operations (Budget Allocation, not a Funding Account -- there is no delete tool for Funding Accounts). |
update_budget_allocation | Not currently available. Updates an existing budget allocation in Aprimo Marketing Operations (Budget Allocation, not a Funding Account -- see update_funding_account for that). |
update_budget_template | Not currently available. Updates an existing budget template in Aprimo Marketing Operations. |
upload_budget_allocation_document | Not currently available. Uploads a base64-encoded document to a budget allocation in Aprimo Marketing Operations (Budget Allocation, not a Funding Account). |
activate_budget_allocation
Not currently available
Activates a budget allocation against an external financial group in Aprimo Marketing Operations (Budget Allocation, not a Funding Account -- unrelated to activating/funding a Funding Account). Requires confirmed=true after showing the user the exact payload (including the target group).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
body | string | Yes | JSON object with the activation payload PM expects (e.g. the budget id, organizationId, and year -- PM wire names). |
groupId | string | Yes | The target external Finance Group's ID. Required by PM as part of the activation request -- without it, activation fails with "Finance group header is missing or invalid." Discover valid ids via list_budget_allocation_financial_groups. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the activation. |
Returns:
| Field | Type | Description |
|---|---|---|
action | string | |
succeeded | boolean | |
raw | object (optional) | The complete wire response, verbatim, since the real response shape is unverified. |
create_budget_allocation
Not currently available
Creates a new budget allocation in Aprimo Marketing Operations (Budget Allocation, not a Funding Account -- see create_funding_account for that). Requires confirmed=true after showing the user the exact payload. Returns the created budget allocation.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
body | string | Yes | JSON object with the new budget's data (PM wire names). |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
name | string (optional) | |
raw | object (optional) | The complete wire object, verbatim, for full fidelity beyond the defensively-extracted fields above. |
create_budget_template
Not currently available
Creates a new budget template for the caller's organization in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the created budget template.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
body | string | Yes | JSON object with the new budget template's data (PM wire names). |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
name | string (optional) | |
raw | object (optional) | The complete wire object, verbatim, for full fidelity beyond the defensively-extracted fields above. |
delete_budget_allocation
Destructive · Not currently available
Permanently deletes a budget allocation by its ID (a GUID string, not an integer) in Aprimo Marketing Operations (Budget Allocation, not a Funding Account -- there is no delete tool for Funding Accounts). This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact budget allocation with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
budgetId | string | Yes | The budget's ID (a GUID string, not an integer) to delete. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — deleting a budget is permanent and cannot be undone. Set only after stating the exact budget to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | A GUID string, not an integer -- see 's remarks. |
deleted | boolean |
This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.
update_budget_allocation
Not currently available
Updates an existing budget allocation in Aprimo Marketing Operations (Budget Allocation, not a Funding Account -- see update_funding_account for that). The budget allocation's own id must be included inside the body (PM's update route takes no id path segment). Requires confirmed=true after showing the user the exact changes. Returns the updated budget allocation.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
body | string | Yes | JSON object with the full budget data, including its id (PM wire names). |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
name | string (optional) | |
raw | object (optional) | The complete wire object, verbatim, for full fidelity beyond the defensively-extracted fields above. |
update_budget_template
Not currently available
Updates an existing budget template in Aprimo Marketing Operations. The template's own id must be included inside the body (PM's update route takes no id path segment). Requires confirmed=true after showing the user the exact changes. Returns the updated budget template.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
body | string | Yes | JSON object with the full budget template data, including its id (PM wire names). |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
name | string (optional) | |
raw | object (optional) | The complete wire object, verbatim, for full fidelity beyond the defensively-extracted fields above. |
upload_budget_allocation_document
Not currently available
Uploads a base64-encoded document to a budget allocation in Aprimo Marketing Operations (Budget Allocation, not a Funding Account). Returns a SAS URL for the uploaded document. Requires confirmed=true after showing the user the exact payload.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
body | string | Yes | JSON object with the document payload PM expects (e.g. the budget id, file name, and base64-encoded content -- PM wire names). |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the upload. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
Forecast Spend
Can change data · 8 tools (4 currently available) · Group ID forecast-spend
Needs: View Activities, View Programs, Look Up PM Reference Data
| Tool | What it does |
|---|---|
approve_forecast | Destructive. Approves a proposed forecast review for an activity in Aprimo Marketing Operations. |
get_activity_forecast | Returns a single activity forecast by its integer ID in Aprimo Marketing Operations. |
get_activity_forecasts | Returns the approved forecasts aggregate for one activity (by the activity's integer ID) in Aprimo Marketing Operations. |
get_activity_proposal_forecasts | Not currently available. Returns the forecasts aggregate for one activity proposal (by the activity proposal's integer ID) in Aprimo Marketing Operations. |
get_activity_proposed_forecasts | Returns the proposed (not-yet-approved) forecasts aggregate for one activity (by the activity's integer ID) in Aprimo Marketing Operations. |
reject_forecast | Not currently available. Destructive. Rejects a proposed forecast review for an activity in Aprimo Marketing Operations. |
update_activity_forecasts | Not currently available. Updates the forecasts for an activity (by the activity's integer ID) in Aprimo Marketing Operations. |
update_activity_proposal_forecasts | Not currently available. Updates the forecasts for an activity proposal (by the activity proposal's integer ID) in Aprimo Marketing Operations. |
approve_forecast
Destructive
Approves a proposed forecast review for an activity in Aprimo Marketing Operations. This is a state change. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact activity and forecast review with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
activityId | string | Yes | The activity's integer ID. |
forecastReviewId | string | Yes | The forecast review's integer ID to approve. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — approving a forecast review changes its state. Set only after stating the exact activity and forecast review to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
activityId | integer | |
forecastReviewId | integer | |
action | string (optional) | The state-change action performed: "approve" or "reject". |
succeeded | boolean |
This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.
get_activity_forecast
Returns a single activity forecast by its integer ID in Aprimo Marketing Operations.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
forecastId | string | Yes | The forecast's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
activityForecastId | integer | |
serviceId | integer (optional) | |
activityId | integer (optional) | |
description | string (optional) | |
units | number (optional) | |
cost | number (optional) | |
expCatId | integer (optional) | |
fiscalYearId | integer (optional) | |
fiscalPeriodId | integer (optional) | |
exchangeRateId | integer (optional) | |
supplierId | integer (optional) | |
modifiedDate | string (ISO 8601) (optional) | |
modifiedUser | integer (optional) | |
status | integer (optional) | The forecast's approval status; PM enum, exposed as its raw int. |
extendedAttributes | array of PmExtendedAttribute (optional) | |
extendedAttributes[].eaId | integer | |
extendedAttributes[].skipDCTSave | boolean | |
extendedAttributes[].eaValue | object (optional) | |
extendedAttributes[].attributeName | string (optional) | |
raw | object (optional) | The complete wire object, verbatim. See . |
get_activity_forecasts
Returns the approved forecasts aggregate for one activity (by the activity's integer ID) in Aprimo Marketing Operations. Use get_activity_proposed_forecasts for forecasts still awaiting approval.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
activityId | string | Yes | The activity's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
activityId | integer | |
hasPendingForecasts | boolean (optional) | |
forecasts | array of ForecastProjection (optional) | |
forecasts[].activityForecastId | integer | |
forecasts[].serviceId | integer (optional) | |
forecasts[].activityId | integer (optional) | |
forecasts[].description | string (optional) | |
forecasts[].units | number (optional) | |
forecasts[].cost | number (optional) | |
forecasts[].expCatId | integer (optional) | |
forecasts[].fiscalYearId | integer (optional) | |
forecasts[].fiscalPeriodId | integer (optional) | |
forecasts[].exchangeRateId | integer (optional) | |
forecasts[].supplierId | integer (optional) | |
forecasts[].modifiedDate | string (ISO 8601) (optional) | |
forecasts[].modifiedUser | integer (optional) | |
forecasts[].status | integer (optional) | The forecast's approval status; PM enum, exposed as its raw int. |
forecasts[].extendedAttributes | array of PmExtendedAttribute (optional) | |
forecasts[].extendedAttributes[].eaId | integer | |
forecasts[].extendedAttributes[].skipDCTSave | boolean | |
forecasts[].extendedAttributes[].eaValue | object (optional) | |
forecasts[].extendedAttributes[].attributeName | string (optional) | |
forecasts[].raw | object (optional) | The complete wire object, verbatim. See . |
raw | object (optional) | The complete wire object, verbatim. |
get_activity_proposal_forecasts
Not currently available
Returns the forecasts aggregate for one activity proposal (by the activity proposal's integer ID) in Aprimo Marketing Operations.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
activityProposalId | string | Yes | The activity proposal's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
activityProposalId | integer | |
forecasts | array of PmProposalForecastItem (optional) | |
forecasts[].proposalForecastId | integer | |
forecasts[].serviceId | integer (optional) | |
forecasts[].proposalId | integer (optional) | |
forecasts[].description | string (optional) | |
forecasts[].units | number (optional) | |
forecasts[].cost | number (optional) | |
forecasts[].expCatId | integer (optional) | |
forecasts[].fiscalYearId | integer (optional) | |
forecasts[].fiscalPeriodId | integer (optional) | |
forecasts[].exchangeRateId | integer (optional) | |
forecasts[].supplierId | integer (optional) | |
forecasts[].extendedAttributes | array of PmExtendedAttribute (optional) | |
forecasts[].extendedAttributes[].eaId | integer | |
forecasts[].extendedAttributes[].skipDCTSave | boolean | |
forecasts[].extendedAttributes[].eaValue | object (optional) | |
forecasts[].extendedAttributes[].attributeName | string (optional) | |
raw | object (optional) | The complete wire object, verbatim. |
get_activity_proposed_forecasts
Returns the proposed (not-yet-approved) forecasts aggregate for one activity (by the activity's integer ID) in Aprimo Marketing Operations. Use get_activity_forecasts for already-approved forecasts.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
activityId | string | Yes | The activity's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
activityId | integer | |
hasPendingForecasts | boolean (optional) | |
forecasts | array of ForecastProjection (optional) | |
forecasts[].activityForecastId | integer | |
forecasts[].serviceId | integer (optional) | |
forecasts[].activityId | integer (optional) | |
forecasts[].description | string (optional) | |
forecasts[].units | number (optional) | |
forecasts[].cost | number (optional) | |
forecasts[].expCatId | integer (optional) | |
forecasts[].fiscalYearId | integer (optional) | |
forecasts[].fiscalPeriodId | integer (optional) | |
forecasts[].exchangeRateId | integer (optional) | |
forecasts[].supplierId | integer (optional) | |
forecasts[].modifiedDate | string (ISO 8601) (optional) | |
forecasts[].modifiedUser | integer (optional) | |
forecasts[].status | integer (optional) | The forecast's approval status; PM enum, exposed as its raw int. |
forecasts[].extendedAttributes | array of PmExtendedAttribute (optional) | |
forecasts[].extendedAttributes[].eaId | integer | |
forecasts[].extendedAttributes[].skipDCTSave | boolean | |
forecasts[].extendedAttributes[].eaValue | object (optional) | |
forecasts[].extendedAttributes[].attributeName | string (optional) | |
forecasts[].raw | object (optional) | The complete wire object, verbatim. See . |
raw | object (optional) | The complete wire object, verbatim. |
reject_forecast
Destructive · Not currently available
Rejects a proposed forecast review for an activity in Aprimo Marketing Operations. This is a state change. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact activity and forecast review with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
activityId | string | Yes | The activity's integer ID. |
forecastReviewId | string | Yes | The forecast review's integer ID to reject. |
body | string | Yes | JSON object with the rejection details PM expects. A comments field is required -- confirmed live against the tenant: an empty "{}" body 400s with "Rejection Comments are Required" rather than proceeding with no comment. Always collect a rejection reason/comment from the user and pass it as e.g. {"comments":"..."}. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — rejecting a forecast review changes its state. Set only after stating the exact activity and forecast review to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
activityId | integer | |
forecastReviewId | integer | |
action | string (optional) | The state-change action performed: "approve" or "reject". |
succeeded | boolean |
This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.
update_activity_forecasts
Not currently available
Updates the forecasts for an activity (by the activity's integer ID) in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the updated forecasts aggregate.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
activityId | string | Yes | The activity's integer ID. |
body | string | Yes | JSON object with the forecast data to save (PM wire names). |
processObjectAsynchronously | boolean | No | If true, PM processes the forecast data asynchronously and returns a processing-object link instead of the finished result. Default false (synchronous). |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload. |
Returns:
| Field | Type | Description |
|---|---|---|
activityId | integer | |
hasPendingForecasts | boolean (optional) | |
forecasts | array of ForecastProjection (optional) | |
forecasts[].activityForecastId | integer | |
forecasts[].serviceId | integer (optional) | |
forecasts[].activityId | integer (optional) | |
forecasts[].description | string (optional) | |
forecasts[].units | number (optional) | |
forecasts[].cost | number (optional) | |
forecasts[].expCatId | integer (optional) | |
forecasts[].fiscalYearId | integer (optional) | |
forecasts[].fiscalPeriodId | integer (optional) | |
forecasts[].exchangeRateId | integer (optional) | |
forecasts[].supplierId | integer (optional) | |
forecasts[].modifiedDate | string (ISO 8601) (optional) | |
forecasts[].modifiedUser | integer (optional) | |
forecasts[].status | integer (optional) | The forecast's approval status; PM enum, exposed as its raw int. |
forecasts[].extendedAttributes | array of PmExtendedAttribute (optional) | |
forecasts[].extendedAttributes[].eaId | integer | |
forecasts[].extendedAttributes[].skipDCTSave | boolean | |
forecasts[].extendedAttributes[].eaValue | object (optional) | |
forecasts[].extendedAttributes[].attributeName | string (optional) | |
forecasts[].raw | object (optional) | The complete wire object, verbatim. See . |
raw | object (optional) | The complete wire object, verbatim. |
update_activity_proposal_forecasts
Not currently available
Updates the forecasts for an activity proposal (by the activity proposal's integer ID) in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the updated forecasts aggregate.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
activityProposalId | string | Yes | The activity proposal's integer ID. |
body | string | Yes | JSON object with the forecast data to save (PM wire names). |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload. |
Returns:
| Field | Type | Description |
|---|---|---|
activityProposalId | integer | |
forecasts | array of PmProposalForecastItem (optional) | |
forecasts[].proposalForecastId | integer | |
forecasts[].serviceId | integer (optional) | |
forecasts[].proposalId | integer (optional) | |
forecasts[].description | string (optional) | |
forecasts[].units | number (optional) | |
forecasts[].cost | number (optional) | |
forecasts[].expCatId | integer (optional) | |
forecasts[].fiscalYearId | integer (optional) | |
forecasts[].fiscalPeriodId | integer (optional) | |
forecasts[].exchangeRateId | integer (optional) | |
forecasts[].supplierId | integer (optional) | |
forecasts[].extendedAttributes | array of PmExtendedAttribute (optional) | |
forecasts[].extendedAttributes[].eaId | integer | |
forecasts[].extendedAttributes[].skipDCTSave | boolean | |
forecasts[].extendedAttributes[].eaValue | object (optional) | |
forecasts[].extendedAttributes[].attributeName | string (optional) | |
raw | object (optional) | The complete wire object, verbatim. |