Funds & Financial Hierarchy
Tools for committed funds and commitments, funding accounts, and the financial hierarchy that organises them.
This page covers 19 tools, all of them available on request rather than in the default tool list, and 6 destructive.
How to read this page
- Status — In the default tool list means the tool is one of the ~200 Aprimo advertises to every agent out of the box, so the agent discovers and calls it on its own. Available on request means the tool is registered and fully callable, but sits outside that default list — call it by name, or ask Aprimo to extend the list your tenant is served.
- Both statuses work identically when called. Status affects discovery, not capability or authorization.
- Visibility is not authorization. Every tool call executes as the authenticated user, and any tool can return an authorization error if that user lacks rights to the record, task, or file. 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. - Activity and Project labels vary by tenant. Where this page says Activity or Project, your tenant's own configured terminology is substituted at runtime.
Why isn't every tool in the default list?
Aprimo's MCP Server exposes far more tools than most MCP clients handle well — many degrade or truncate their tool list well below the full catalogue. Rather than let a client truncate arbitrarily, Aprimo advertises a curated set of roughly 200 tools covering the tasks customers most commonly automate. Everything outside that set remains fully supported and callable by name; it simply isn't offered up front. If your integration leans on a tool that is available on request, talk to your Aprimo Customer Success Manager about extending the advertised list for your tenant.
Tools at a Glance
| Tool | Status | What it does |
|---|---|---|
approve_commitment | On request | Destructive. Approves a commitment that is pending approval in Aprimo Marketing Operations. |
cancel_commitment | On request | Destructive. Cancels a commitment in Aprimo Marketing Operations. |
create_commitment | On request | Creates a new commitment in Aprimo Marketing Operations. |
create_financial_hierarchy | On request | Creates a new financial hierarchy in Aprimo Marketing Operations. |
create_funding_account | On request | 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). |
delete_commitment | On request | Destructive. Permanently deletes a commitment by its integer ID in Aprimo Marketing Operations. |
get_commitment | On request | Returns a single commitment by its integer ID in Aprimo Marketing Operations. |
get_financial_hierarchy | On request | Returns a single financial hierarchy by its integer ID in Aprimo Marketing Operations. |
get_financial_hierarchy_node | On request | Returns the full node tree for a financial hierarchy in Aprimo Marketing Operations. |
get_funding_account | On request | 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 | On request | 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). |
list_commitments | On request | Lists commitments in Aprimo Marketing Operations, paged and unfiltered. |
reject_commitment | On request | Destructive. Rejects a commitment that is pending approval in Aprimo Marketing Operations. |
retrieve_commitment | On request | Destructive. Pulls a submitted commitment back to draft status in Aprimo Marketing Operations (undoes a submission). |
search_commitments | On request | Searches commitments in Aprimo Marketing Operations that match a query, paged. |
submit_commitment | On request | Destructive. Submits a commitment for approval in Aprimo Marketing Operations. |
update_commitment | On request | Updates an existing commitment by its integer ID in Aprimo Marketing Operations. |
update_financial_hierarchy | On request | Updates an existing financial hierarchy by its integer ID in Aprimo Marketing Operations. |
update_funding_account | On request | 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). |
approve_commitment
Available on request · Destructive
Approves a commitment that is pending approval in Aprimo Marketing Operations. This is a state change. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact commitment with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
commitmentId | string | Yes | The commitment'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 commitment changes its state. Set only after stating the exact commitment to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
commitmentId | integer | |
action | string (optional) | The state-change action performed: "retrieve", "submit", "cancel", "reject", or "approve". |
succeeded | boolean |
Destructive operation
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.
cancel_commitment
Available on request · Destructive
Cancels a commitment in Aprimo Marketing Operations. This is a state change that terminates the commitment's workflow. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact commitment with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
commitmentId | string | Yes | The commitment's integer ID to cancel. |
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) — cancelling a commitment changes its state. Set only after stating the exact commitment to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
commitmentId | integer | |
action | string (optional) | The state-change action performed: "retrieve", "submit", "cancel", "reject", or "approve". |
succeeded | boolean |
Destructive operation
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.
create_commitment
Available on request
Creates a new commitment in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the created commitment.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
body | string | Yes | JSON object with the new commitment'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 |
|---|---|---|
committedId | integer | |
supplierId | integer (optional) | |
purchaseOrderNumber | string (optional) | |
closed | integer (optional) | |
description | string (optional) | Bound to the wire's description -- CommittedFund has no dedicated name field. |
currencyCode | integer (optional) | |
enteredValue | number (optional) | |
ownerId | integer (optional) | |
modifiedUser | integer (optional) | |
modifiedDate | string (ISO 8601) (optional) | |
creatorId | integer (optional) | |
createdDate | string (ISO 8601) (optional) | |
commitmentTypeId | integer (optional) | |
reviewedDate | string (ISO 8601) (optional) | |
reviewedBy | integer (optional) | |
pooled | integer (optional) | |
contactId | integer (optional) | |
commitmentStatus | integer (optional) | The commitment's workflow status (draft/submitted/approved/etc; PM enum, exposed as its raw int). |
financeGroupId | integer (optional) | |
totalPendingInvoice | number (optional) | |
baseTotalPendingInvoice | number (optional) | |
totalPaidInvoice | number (optional) | |
baseTotalPaidInvoice | number (optional) | |
totalPendingAndPaidInvoice | number (optional) | |
totalAmount | number (optional) | |
baseTotalAmount | number (optional) | |
totalOutstanding | number (optional) | |
baseTotalOutstanding | number (optional) | |
proposedTotalAmount | number (optional) | |
proposedBaseTotalAmount | number (optional) | |
commitmentItems | array of PmCommitmentItem (optional) | |
commitmentItems[].committedItemId | integer | |
commitmentItems[].committedId | integer | |
commitmentItems[].activityId | integer (optional) | |
commitmentItems[].description | string (optional) | |
commitmentItems[].expenseCategoryId | integer (optional) | |
commitmentItems[].exchangeRateId | integer (optional) | |
commitmentItems[].closed | integer (optional) | |
commitmentItems[].fiscalYearId | integer (optional) | |
commitmentItems[].fiscalPeriodId | integer (optional) | |
commitmentItems[].quantity | number (optional) | |
commitmentItems[].price | number (optional) | |
commitmentItems[].total | number (optional) | |
commitmentItems[].extendedAttributes | array of PmExtendedAttribute (optional) | |
commitmentItems[].extendedAttributes[].eaId | integer | |
commitmentItems[].extendedAttributes[].skipDCTSave | boolean | |
commitmentItems[].extendedAttributes[].eaValue | object (optional) | |
commitmentItems[].extendedAttributes[].attributeName | string (optional) | |
proposedCommitmentItems | array of PmCommitmentItem (optional) | |
proposedCommitmentItems[].committedItemId | integer | |
proposedCommitmentItems[].committedId | integer | |
proposedCommitmentItems[].activityId | integer (optional) | |
proposedCommitmentItems[].description | string (optional) | |
proposedCommitmentItems[].expenseCategoryId | integer (optional) | |
proposedCommitmentItems[].exchangeRateId | integer (optional) | |
proposedCommitmentItems[].closed | integer (optional) | |
proposedCommitmentItems[].fiscalYearId | integer (optional) | |
proposedCommitmentItems[].fiscalPeriodId | integer (optional) | |
proposedCommitmentItems[].quantity | number (optional) | |
proposedCommitmentItems[].price | number (optional) | |
proposedCommitmentItems[].total | number (optional) | |
proposedCommitmentItems[].extendedAttributes | array of PmExtendedAttribute (optional) | |
proposedCommitmentItems[].extendedAttributes[].eaId | integer | |
proposedCommitmentItems[].extendedAttributes[].skipDCTSave | boolean | |
proposedCommitmentItems[].extendedAttributes[].eaValue | object (optional) | |
proposedCommitmentItems[].extendedAttributes[].attributeName | string (optional) | |
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 (full-fidelity fallback for markdown rendering). |
create_financial_hierarchy
Available on request
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
Available on request
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 . |
delete_commitment
Available on request · Destructive
Permanently deletes a commitment by its integer ID in Aprimo Marketing Operations. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact commitment with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
commitmentId | string | Yes | The commitment's integer ID 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 commitment is permanent and cannot be undone. Set only after stating the exact commitment to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
deleted | boolean |
Destructive operation
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_commitment
Available on request
Returns a single commitment 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 |
|---|---|---|---|
commitmentId | string | Yes | The commitment's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
committedId | integer | |
supplierId | integer (optional) | |
purchaseOrderNumber | string (optional) | |
closed | integer (optional) | |
description | string (optional) | Bound to the wire's description -- CommittedFund has no dedicated name field. |
currencyCode | integer (optional) | |
enteredValue | number (optional) | |
ownerId | integer (optional) | |
modifiedUser | integer (optional) | |
modifiedDate | string (ISO 8601) (optional) | |
creatorId | integer (optional) | |
createdDate | string (ISO 8601) (optional) | |
commitmentTypeId | integer (optional) | |
reviewedDate | string (ISO 8601) (optional) | |
reviewedBy | integer (optional) | |
pooled | integer (optional) | |
contactId | integer (optional) | |
commitmentStatus | integer (optional) | The commitment's workflow status (draft/submitted/approved/etc; PM enum, exposed as its raw int). |
financeGroupId | integer (optional) | |
totalPendingInvoice | number (optional) | |
baseTotalPendingInvoice | number (optional) | |
totalPaidInvoice | number (optional) | |
baseTotalPaidInvoice | number (optional) | |
totalPendingAndPaidInvoice | number (optional) | |
totalAmount | number (optional) | |
baseTotalAmount | number (optional) | |
totalOutstanding | number (optional) | |
baseTotalOutstanding | number (optional) | |
proposedTotalAmount | number (optional) | |
proposedBaseTotalAmount | number (optional) | |
commitmentItems | array of PmCommitmentItem (optional) | |
commitmentItems[].committedItemId | integer | |
commitmentItems[].committedId | integer | |
commitmentItems[].activityId | integer (optional) | |
commitmentItems[].description | string (optional) | |
commitmentItems[].expenseCategoryId | integer (optional) | |
commitmentItems[].exchangeRateId | integer (optional) | |
commitmentItems[].closed | integer (optional) | |
commitmentItems[].fiscalYearId | integer (optional) | |
commitmentItems[].fiscalPeriodId | integer (optional) | |
commitmentItems[].quantity | number (optional) | |
commitmentItems[].price | number (optional) | |
commitmentItems[].total | number (optional) | |
commitmentItems[].extendedAttributes | array of PmExtendedAttribute (optional) | |
commitmentItems[].extendedAttributes[].eaId | integer | |
commitmentItems[].extendedAttributes[].skipDCTSave | boolean | |
commitmentItems[].extendedAttributes[].eaValue | object (optional) | |
commitmentItems[].extendedAttributes[].attributeName | string (optional) | |
proposedCommitmentItems | array of PmCommitmentItem (optional) | |
proposedCommitmentItems[].committedItemId | integer | |
proposedCommitmentItems[].committedId | integer | |
proposedCommitmentItems[].activityId | integer (optional) | |
proposedCommitmentItems[].description | string (optional) | |
proposedCommitmentItems[].expenseCategoryId | integer (optional) | |
proposedCommitmentItems[].exchangeRateId | integer (optional) | |
proposedCommitmentItems[].closed | integer (optional) | |
proposedCommitmentItems[].fiscalYearId | integer (optional) | |
proposedCommitmentItems[].fiscalPeriodId | integer (optional) | |
proposedCommitmentItems[].quantity | number (optional) | |
proposedCommitmentItems[].price | number (optional) | |
proposedCommitmentItems[].total | number (optional) | |
proposedCommitmentItems[].extendedAttributes | array of PmExtendedAttribute (optional) | |
proposedCommitmentItems[].extendedAttributes[].eaId | integer | |
proposedCommitmentItems[].extendedAttributes[].skipDCTSave | boolean | |
proposedCommitmentItems[].extendedAttributes[].eaValue | object (optional) | |
proposedCommitmentItems[].extendedAttributes[].attributeName | string (optional) | |
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 (full-fidelity fallback for markdown rendering). |
get_financial_hierarchy
Available on request
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
Available on request
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
Available on request
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
Available on request
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. |
list_commitments
Available on request
Lists commitments in Aprimo Marketing Operations, paged and unfiltered. Use search_commitments when you need to filter.
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 CommittedFundProjection | The items returned in this response. |
items[].committedId | integer | |
items[].supplierId | integer (optional) | |
items[].purchaseOrderNumber | string (optional) | |
items[].closed | integer (optional) | |
items[].description | string (optional) | Bound to the wire's description -- CommittedFund has no dedicated name field. |
items[].currencyCode | integer (optional) | |
items[].enteredValue | number (optional) | |
items[].ownerId | integer (optional) | |
items[].modifiedUser | integer (optional) | |
items[].modifiedDate | string (ISO 8601) (optional) | |
items[].creatorId | integer (optional) | |
items[].createdDate | string (ISO 8601) (optional) | |
items[].commitmentTypeId | integer (optional) | |
items[].reviewedDate | string (ISO 8601) (optional) | |
items[].reviewedBy | integer (optional) | |
items[].pooled | integer (optional) | |
items[].contactId | integer (optional) | |
items[].commitmentStatus | integer (optional) | The commitment's workflow status (draft/submitted/approved/etc; PM enum, exposed as its raw int). |
items[].financeGroupId | integer (optional) | |
items[].totalPendingInvoice | number (optional) | |
items[].baseTotalPendingInvoice | number (optional) | |
items[].totalPaidInvoice | number (optional) | |
items[].baseTotalPaidInvoice | number (optional) | |
items[].totalPendingAndPaidInvoice | number (optional) | |
items[].totalAmount | number (optional) | |
items[].baseTotalAmount | number (optional) | |
items[].totalOutstanding | number (optional) | |
items[].baseTotalOutstanding | number (optional) | |
items[].proposedTotalAmount | number (optional) | |
items[].proposedBaseTotalAmount | number (optional) | |
items[].commitmentItems | array of PmCommitmentItem (optional) | |
items[].commitmentItems[].committedItemId | integer | |
items[].commitmentItems[].committedId | integer | |
items[].commitmentItems[].activityId | integer (optional) | |
items[].commitmentItems[].description | string (optional) | |
items[].commitmentItems[].expenseCategoryId | integer (optional) | |
items[].commitmentItems[].exchangeRateId | integer (optional) | |
items[].commitmentItems[].closed | integer (optional) | |
items[].commitmentItems[].fiscalYearId | integer (optional) | |
items[].commitmentItems[].fiscalPeriodId | integer (optional) | |
items[].commitmentItems[].quantity | number (optional) | |
items[].commitmentItems[].price | number (optional) | |
items[].commitmentItems[].total | number (optional) | |
items[].commitmentItems[].extendedAttributes | array of PmExtendedAttribute (optional) | |
items[].proposedCommitmentItems | array of PmCommitmentItem (optional) | |
items[].proposedCommitmentItems[].committedItemId | integer | |
items[].proposedCommitmentItems[].committedId | integer | |
items[].proposedCommitmentItems[].activityId | integer (optional) | |
items[].proposedCommitmentItems[].description | string (optional) | |
items[].proposedCommitmentItems[].expenseCategoryId | integer (optional) | |
items[].proposedCommitmentItems[].exchangeRateId | integer (optional) | |
items[].proposedCommitmentItems[].closed | integer (optional) | |
items[].proposedCommitmentItems[].fiscalYearId | integer (optional) | |
items[].proposedCommitmentItems[].fiscalPeriodId | integer (optional) | |
items[].proposedCommitmentItems[].quantity | number (optional) | |
items[].proposedCommitmentItems[].price | number (optional) | |
items[].proposedCommitmentItems[].total | number (optional) | |
items[].proposedCommitmentItems[].extendedAttributes | array of PmExtendedAttribute (optional) | |
items[].extendedAttributes | array of PmExtendedAttribute (optional) | |
items[].extendedAttributes[].eaId | integer | |
items[].extendedAttributes[].skipDCTSave | boolean | |
items[].extendedAttributes[].eaValue | object (optional) | |
items[].extendedAttributes[].attributeName | string (optional) | |
items[].multipleValueExtendedAttributes | array of PmMultipleValueExtendedAttribute (optional) | |
items[].multipleValueExtendedAttributes[].parentId | integer | |
items[].multipleValueExtendedAttributes[].extAttributeId | integer | |
items[].multipleValueExtendedAttributes[].encodedListItemId | integer | |
items[].multipleValueExtendedAttributes[].attributeName | string (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim (full-fidelity fallback for markdown rendering). |
reject_commitment
Available on request · Destructive
Rejects a commitment that is pending approval in Aprimo Marketing Operations. This is a state change. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact commitment with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
commitmentId | string | Yes | The commitment's integer ID to reject. |
body | string | Yes | JSON object with the rejection details. PM requires a non-empty "comments" field, e.g. {"comments":"Over budget"} -- there is no optional/no-op body for this action (PM crashes with an opaque server error, not a clean validation message, if "comments" is omitted). |
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 commitment changes its state. Set only after stating the exact commitment to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
commitmentId | integer | |
action | string (optional) | The state-change action performed: "retrieve", "submit", "cancel", "reject", or "approve". |
succeeded | boolean |
Destructive operation
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.
retrieve_commitment
Available on request · Destructive
Pulls a submitted commitment back to draft status in Aprimo Marketing Operations (undoes a submission). This is a state change. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact commitment with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
commitmentId | string | Yes | The commitment's integer ID to retrieve back to draft. |
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) — retrieving a commitment changes its state. Set only after stating the exact commitment to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
commitmentId | integer | |
action | string (optional) | The state-change action performed: "retrieve", "submit", "cancel", "reject", or "approve". |
succeeded | boolean |
Destructive operation
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.
search_commitments
Available on request
Searches commitments in Aprimo Marketing Operations that match a query, paged.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | No | JSON object with the query (PM's operator-tree DSL, e.g. {"equals":{"FieldName":"Status","FieldValue":1}}). Omit or pass "{}" to match all commitments. |
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 CommittedFundProjection | The items returned in this response. |
items[].committedId | integer | |
items[].supplierId | integer (optional) | |
items[].purchaseOrderNumber | string (optional) | |
items[].closed | integer (optional) | |
items[].description | string (optional) | Bound to the wire's description -- CommittedFund has no dedicated name field. |
items[].currencyCode | integer (optional) | |
items[].enteredValue | number (optional) | |
items[].ownerId | integer (optional) | |
items[].modifiedUser | integer (optional) | |
items[].modifiedDate | string (ISO 8601) (optional) | |
items[].creatorId | integer (optional) | |
items[].createdDate | string (ISO 8601) (optional) | |
items[].commitmentTypeId | integer (optional) | |
items[].reviewedDate | string (ISO 8601) (optional) | |
items[].reviewedBy | integer (optional) | |
items[].pooled | integer (optional) | |
items[].contactId | integer (optional) | |
items[].commitmentStatus | integer (optional) | The commitment's workflow status (draft/submitted/approved/etc; PM enum, exposed as its raw int). |
items[].financeGroupId | integer (optional) | |
items[].totalPendingInvoice | number (optional) | |
items[].baseTotalPendingInvoice | number (optional) | |
items[].totalPaidInvoice | number (optional) | |
items[].baseTotalPaidInvoice | number (optional) | |
items[].totalPendingAndPaidInvoice | number (optional) | |
items[].totalAmount | number (optional) | |
items[].baseTotalAmount | number (optional) | |
items[].totalOutstanding | number (optional) | |
items[].baseTotalOutstanding | number (optional) | |
items[].proposedTotalAmount | number (optional) | |
items[].proposedBaseTotalAmount | number (optional) | |
items[].commitmentItems | array of PmCommitmentItem (optional) | |
items[].commitmentItems[].committedItemId | integer | |
items[].commitmentItems[].committedId | integer | |
items[].commitmentItems[].activityId | integer (optional) | |
items[].commitmentItems[].description | string (optional) | |
items[].commitmentItems[].expenseCategoryId | integer (optional) | |
items[].commitmentItems[].exchangeRateId | integer (optional) | |
items[].commitmentItems[].closed | integer (optional) | |
items[].commitmentItems[].fiscalYearId | integer (optional) | |
items[].commitmentItems[].fiscalPeriodId | integer (optional) | |
items[].commitmentItems[].quantity | number (optional) | |
items[].commitmentItems[].price | number (optional) | |
items[].commitmentItems[].total | number (optional) | |
items[].commitmentItems[].extendedAttributes | array of PmExtendedAttribute (optional) | |
items[].proposedCommitmentItems | array of PmCommitmentItem (optional) | |
items[].proposedCommitmentItems[].committedItemId | integer | |
items[].proposedCommitmentItems[].committedId | integer | |
items[].proposedCommitmentItems[].activityId | integer (optional) | |
items[].proposedCommitmentItems[].description | string (optional) | |
items[].proposedCommitmentItems[].expenseCategoryId | integer (optional) | |
items[].proposedCommitmentItems[].exchangeRateId | integer (optional) | |
items[].proposedCommitmentItems[].closed | integer (optional) | |
items[].proposedCommitmentItems[].fiscalYearId | integer (optional) | |
items[].proposedCommitmentItems[].fiscalPeriodId | integer (optional) | |
items[].proposedCommitmentItems[].quantity | number (optional) | |
items[].proposedCommitmentItems[].price | number (optional) | |
items[].proposedCommitmentItems[].total | number (optional) | |
items[].proposedCommitmentItems[].extendedAttributes | array of PmExtendedAttribute (optional) | |
items[].extendedAttributes | array of PmExtendedAttribute (optional) | |
items[].extendedAttributes[].eaId | integer | |
items[].extendedAttributes[].skipDCTSave | boolean | |
items[].extendedAttributes[].eaValue | object (optional) | |
items[].extendedAttributes[].attributeName | string (optional) | |
items[].multipleValueExtendedAttributes | array of PmMultipleValueExtendedAttribute (optional) | |
items[].multipleValueExtendedAttributes[].parentId | integer | |
items[].multipleValueExtendedAttributes[].extAttributeId | integer | |
items[].multipleValueExtendedAttributes[].encodedListItemId | integer | |
items[].multipleValueExtendedAttributes[].attributeName | string (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim (full-fidelity fallback for markdown rendering). |
submit_commitment
Available on request · Destructive
Submits a commitment for approval in Aprimo Marketing Operations. This is a state change that starts the approval workflow. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact commitment with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
commitmentId | string | Yes | The commitment's integer ID to submit. |
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) — submitting a commitment changes its state. Set only after stating the exact commitment to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
commitmentId | integer | |
action | string (optional) | The state-change action performed: "retrieve", "submit", "cancel", "reject", or "approve". |
succeeded | boolean |
Destructive operation
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_commitment
Available on request
Updates an existing commitment 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 commitment.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
commitmentId | string | Yes | The commitment'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 |
|---|---|---|
committedId | integer | |
supplierId | integer (optional) | |
purchaseOrderNumber | string (optional) | |
closed | integer (optional) | |
description | string (optional) | Bound to the wire's description -- CommittedFund has no dedicated name field. |
currencyCode | integer (optional) | |
enteredValue | number (optional) | |
ownerId | integer (optional) | |
modifiedUser | integer (optional) | |
modifiedDate | string (ISO 8601) (optional) | |
creatorId | integer (optional) | |
createdDate | string (ISO 8601) (optional) | |
commitmentTypeId | integer (optional) | |
reviewedDate | string (ISO 8601) (optional) | |
reviewedBy | integer (optional) | |
pooled | integer (optional) | |
contactId | integer (optional) | |
commitmentStatus | integer (optional) | The commitment's workflow status (draft/submitted/approved/etc; PM enum, exposed as its raw int). |
financeGroupId | integer (optional) | |
totalPendingInvoice | number (optional) | |
baseTotalPendingInvoice | number (optional) | |
totalPaidInvoice | number (optional) | |
baseTotalPaidInvoice | number (optional) | |
totalPendingAndPaidInvoice | number (optional) | |
totalAmount | number (optional) | |
baseTotalAmount | number (optional) | |
totalOutstanding | number (optional) | |
baseTotalOutstanding | number (optional) | |
proposedTotalAmount | number (optional) | |
proposedBaseTotalAmount | number (optional) | |
commitmentItems | array of PmCommitmentItem (optional) | |
commitmentItems[].committedItemId | integer | |
commitmentItems[].committedId | integer | |
commitmentItems[].activityId | integer (optional) | |
commitmentItems[].description | string (optional) | |
commitmentItems[].expenseCategoryId | integer (optional) | |
commitmentItems[].exchangeRateId | integer (optional) | |
commitmentItems[].closed | integer (optional) | |
commitmentItems[].fiscalYearId | integer (optional) | |
commitmentItems[].fiscalPeriodId | integer (optional) | |
commitmentItems[].quantity | number (optional) | |
commitmentItems[].price | number (optional) | |
commitmentItems[].total | number (optional) | |
commitmentItems[].extendedAttributes | array of PmExtendedAttribute (optional) | |
commitmentItems[].extendedAttributes[].eaId | integer | |
commitmentItems[].extendedAttributes[].skipDCTSave | boolean | |
commitmentItems[].extendedAttributes[].eaValue | object (optional) | |
commitmentItems[].extendedAttributes[].attributeName | string (optional) | |
proposedCommitmentItems | array of PmCommitmentItem (optional) | |
proposedCommitmentItems[].committedItemId | integer | |
proposedCommitmentItems[].committedId | integer | |
proposedCommitmentItems[].activityId | integer (optional) | |
proposedCommitmentItems[].description | string (optional) | |
proposedCommitmentItems[].expenseCategoryId | integer (optional) | |
proposedCommitmentItems[].exchangeRateId | integer (optional) | |
proposedCommitmentItems[].closed | integer (optional) | |
proposedCommitmentItems[].fiscalYearId | integer (optional) | |
proposedCommitmentItems[].fiscalPeriodId | integer (optional) | |
proposedCommitmentItems[].quantity | number (optional) | |
proposedCommitmentItems[].price | number (optional) | |
proposedCommitmentItems[].total | number (optional) | |
proposedCommitmentItems[].extendedAttributes | array of PmExtendedAttribute (optional) | |
proposedCommitmentItems[].extendedAttributes[].eaId | integer | |
proposedCommitmentItems[].extendedAttributes[].skipDCTSave | boolean | |
proposedCommitmentItems[].extendedAttributes[].eaValue | object (optional) | |
proposedCommitmentItems[].extendedAttributes[].attributeName | string (optional) | |
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 (full-fidelity fallback for markdown rendering). |
update_financial_hierarchy
Available on request
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
Available on request
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 . |
Related
- Aprimo MCP Server — configuration, connection details, and authentication
- MCP Tool Permission Map — the Aprimo permissions that make each tool visible to your agent
- REST API vs. MCP — choosing the right integration approach for your agent