Commit & pay
Manage suppliers, commit spend, process invoices, and post journal vouchers.
This area has 4 groups and 40 tools, 32 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 |
|---|---|---|---|
| Manage Suppliers | Can change data | None | 6 |
| Commit Spend | Can change data | Manage Suppliers, View Activities | 11 |
| Process Invoices | Can change data | Commit Spend, Manage Suppliers | 12 |
| Post Journal Vouchers | Can change data | Set Up Funding Accounts & Hierarchies | 11 |
Manage Suppliers
Can change data · 6 tools · Group ID manage-suppliers
Needs: no other groups.
| Tool | What it does |
|---|---|
create_supplier | Creates a new supplier in Aprimo Marketing Operations. |
delete_supplier | Destructive. Permanently deletes a supplier by its integer ID in Aprimo Marketing Operations. |
get_supplier | Returns a single supplier by its integer ID in Aprimo Marketing Operations. |
list_suppliers | Lists suppliers in Aprimo Marketing Operations, paged and unfiltered. |
search_suppliers | Searches suppliers in Aprimo Marketing Operations by name, paged. |
update_supplier | Updates an existing supplier by its integer ID in Aprimo Marketing Operations. |
create_supplier
Creates a new supplier in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the created supplier.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
body | string | Yes | JSON object with the new supplier'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 |
|---|---|---|
supplierId | integer | |
name | string (optional) | |
preferred | integer (optional) | |
activeFlag | integer (optional) | |
supplierTypeId | integer (optional) | |
notificationTypeId | integer (optional) | |
supplierNumber | string (optional) | |
url | string (optional) | |
description | string (optional) | |
addressLine1 | string (optional) | |
addressLine2 | string (optional) | |
addressLine3 | string (optional) | |
city | string (optional) | |
state | string (optional) | |
zip | string (optional) | |
country | string (optional) | |
phone | string (optional) | |
faxNumber | string (optional) | |
email | string (optional) | |
modifiedUser | integer (optional) | |
modifiedDate | string (optional) | |
raw | object (optional) | The complete wire object, verbatim (set by the mapper). See the class remarks. |
delete_supplier
Destructive
Permanently deletes a supplier by its integer ID in Aprimo Marketing Operations. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact supplier with the user. Alternatively, identify the supplier by name instead of supplierId.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
supplierId | string | No | The supplier's integer ID to delete. Provide either supplierId or name, not both. |
name | string | No | The supplier's name. Provide either supplierId or name, not both. |
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 supplier is permanent and cannot be undone. Set only after stating the exact supplier to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
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.
get_supplier
Returns a single supplier by its integer ID in Aprimo Marketing Operations.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Alternatively, identify the supplier by name instead of supplierId.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
supplierId | string | No | The supplier's integer ID. Provide either supplierId or name, not both. |
name | string | No | The supplier's name. Provide either supplierId or name, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
supplierId | integer | |
name | string (optional) | |
preferred | integer (optional) | |
activeFlag | integer (optional) | |
supplierTypeId | integer (optional) | |
notificationTypeId | integer (optional) | |
supplierNumber | string (optional) | |
url | string (optional) | |
description | string (optional) | |
addressLine1 | string (optional) | |
addressLine2 | string (optional) | |
addressLine3 | string (optional) | |
city | string (optional) | |
state | string (optional) | |
zip | string (optional) | |
country | string (optional) | |
phone | string (optional) | |
faxNumber | string (optional) | |
email | string (optional) | |
modifiedUser | integer (optional) | |
modifiedDate | string (optional) | |
raw | object (optional) | The complete wire object, verbatim (set by the mapper). See the class remarks. |
list_suppliers
Lists suppliers in Aprimo Marketing Operations, paged and unfiltered. Use search_suppliers when you need to filter by name; use this to browse.
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 SupplierProjection | The items returned in this response. |
items[].supplierId | integer | |
items[].name | string (optional) | |
items[].preferred | integer (optional) | |
items[].activeFlag | integer (optional) | |
items[].supplierTypeId | integer (optional) | |
items[].notificationTypeId | integer (optional) | |
items[].supplierNumber | string (optional) | |
items[].url | string (optional) | |
items[].description | string (optional) | |
items[].addressLine1 | string (optional) | |
items[].addressLine2 | string (optional) | |
items[].addressLine3 | string (optional) | |
items[].city | string (optional) | |
items[].state | string (optional) | |
items[].zip | string (optional) | |
items[].country | string (optional) | |
items[].phone | string (optional) | |
items[].faxNumber | string (optional) | |
items[].email | string (optional) | |
items[].modifiedUser | integer (optional) | |
items[].modifiedDate | string (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim (set by the mapper). See the class remarks. |
search_suppliers
Searches suppliers in Aprimo Marketing Operations by name, paged.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
nameFilter | string | No | Optional case-insensitive substring filter on the supplier's name. Omit to match all suppliers. |
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 SupplierProjection | The items returned in this response. |
items[].supplierId | integer | |
items[].name | string (optional) | |
items[].preferred | integer (optional) | |
items[].activeFlag | integer (optional) | |
items[].supplierTypeId | integer (optional) | |
items[].notificationTypeId | integer (optional) | |
items[].supplierNumber | string (optional) | |
items[].url | string (optional) | |
items[].description | string (optional) | |
items[].addressLine1 | string (optional) | |
items[].addressLine2 | string (optional) | |
items[].addressLine3 | string (optional) | |
items[].city | string (optional) | |
items[].state | string (optional) | |
items[].zip | string (optional) | |
items[].country | string (optional) | |
items[].phone | string (optional) | |
items[].faxNumber | string (optional) | |
items[].email | string (optional) | |
items[].modifiedUser | integer (optional) | |
items[].modifiedDate | string (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim (set by the mapper). See the class remarks. |
update_supplier
Updates an existing supplier 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 supplier. Alternatively, identify the supplier by name instead of supplierId.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
supplierId | string | No | The supplier's integer ID. Provide either supplierId or name, not both. |
name | string | No | The supplier's name. Provide either supplierId or name, not both. |
body | string | No | 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 |
|---|---|---|
supplierId | integer | |
name | string (optional) | |
preferred | integer (optional) | |
activeFlag | integer (optional) | |
supplierTypeId | integer (optional) | |
notificationTypeId | integer (optional) | |
supplierNumber | string (optional) | |
url | string (optional) | |
description | string (optional) | |
addressLine1 | string (optional) | |
addressLine2 | string (optional) | |
addressLine3 | string (optional) | |
city | string (optional) | |
state | string (optional) | |
zip | string (optional) | |
country | string (optional) | |
phone | string (optional) | |
faxNumber | string (optional) | |
email | string (optional) | |
modifiedUser | integer (optional) | |
modifiedDate | string (optional) | |
raw | object (optional) | The complete wire object, verbatim (set by the mapper). See the class remarks. |
Commit Spend
Can change data · 11 tools (9 currently available) · Group ID commit-spend
Needs: Manage Suppliers, View Activities
| Tool | What it does |
|---|---|
approve_commitment | Not currently available. Destructive. Approves a commitment that is pending approval in Aprimo Marketing Operations. |
cancel_commitment | Destructive. Cancels a commitment in Aprimo Marketing Operations. |
create_commitment | Creates a new commitment in Aprimo Marketing Operations. |
delete_commitment | Destructive. Permanently deletes a commitment by its integer ID in Aprimo Marketing Operations. |
get_commitment | Returns a single commitment by its integer ID in Aprimo Marketing Operations. |
list_commitments | Lists commitments in Aprimo Marketing Operations, paged and unfiltered. |
reject_commitment | Not currently available. Destructive. Rejects a commitment that is pending approval in Aprimo Marketing Operations. |
retrieve_commitment | Destructive. Pulls a submitted commitment back to draft status in Aprimo Marketing Operations (undoes a submission). |
search_commitments | Searches commitments in Aprimo Marketing Operations that match a query, paged. |
submit_commitment | Destructive. Submits a commitment for approval in Aprimo Marketing Operations. |
update_commitment | Updates an existing commitment by its integer ID in Aprimo Marketing Operations. |
approve_commitment
Destructive · Not currently available
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 |
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
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 |
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
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). |
delete_commitment
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 |
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
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). |
list_commitments
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
Destructive · Not currently available
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 |
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
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 |
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
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
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 |
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
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). |
Process Invoices
Can change data · 12 tools (8 currently available) · Group ID process-invoices
Needs: Commit Spend, Manage Suppliers
| Tool | What it does |
|---|---|
approve_invoice | Not currently available. Destructive. Approves an invoice that is pending approval in Aprimo Marketing Operations. |
cancel_invoice | Destructive. Cancels an invoice in Aprimo Marketing Operations. |
create_invoice | Not currently available. Creates a new invoice in Aprimo Marketing Operations. |
delete_invoice | Destructive. Permanently deletes an invoice by its integer ID in Aprimo Marketing Operations. |
get_invoice | Returns a single invoice by its integer ID in Aprimo Marketing Operations. |
list_invoices | Not currently available. Lists invoices in Aprimo Marketing Operations, paged and unfiltered. |
mark_invoice_sent | Destructive. Marks an invoice as sent in Aprimo Marketing Operations. |
reject_invoice | Not currently available. Destructive. Rejects an invoice that is pending approval in Aprimo Marketing Operations. |
retrieve_invoice | Destructive. Pulls a submitted invoice back to draft status in Aprimo Marketing Operations (undoes a submission). |
search_invoices | Searches invoices in Aprimo Marketing Operations that match a query, paged. |
submit_invoice | Destructive. Submits an invoice for approval in Aprimo Marketing Operations. |
update_invoice | Updates an existing invoice by its integer ID in Aprimo Marketing Operations. |
approve_invoice
Destructive · Not currently available
Approves an invoice 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 invoice with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
invoiceId | string | Yes | The invoice'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 an invoice changes its state. Set only after stating the exact invoice to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
invoiceId | integer | |
action | string (optional) | The state-change action performed: "retrieve", "sent", "submit", "cancel", "reject", or "approve". |
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.
cancel_invoice
Destructive
Cancels an invoice in Aprimo Marketing Operations. This is a state change that terminates the invoice's workflow. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact invoice with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
invoiceId | string | Yes | The invoice'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 an invoice changes its state. Set only after stating the exact invoice to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
invoiceId | integer | |
action | string (optional) | The state-change action performed: "retrieve", "sent", "submit", "cancel", "reject", or "approve". |
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.
create_invoice
Not currently available
Creates a new invoice in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the created invoice.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
body | string | Yes | JSON object with the new invoice'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 |
|---|---|---|
invoiceId | integer | |
supplierId | integer (optional) | |
commitmentFundId | integer (optional) | |
paidDate | string (ISO 8601) (optional) | |
currencyCode | integer (optional) | |
totalInvoice | number (optional) | |
baseTotalInvoice | number (optional) | |
dateReceived | string (ISO 8601) (optional) | |
dateDue | string (ISO 8601) (optional) | |
modifiedDate | string (ISO 8601) (optional) | |
invoiceNumber | string (optional) | Bound to the wire's invoiceNumber -- Invoice has no dedicated description/name field. |
modifiedUser | integer (optional) | |
reviewedBy | integer (optional) | |
financeGroupId | integer (optional) | |
reviewedDate | string (ISO 8601) (optional) | |
invoiceTypeId | integer (optional) | |
pooled | integer (optional) | |
contactId | integer (optional) | |
net | integer (optional) | |
status | integer (optional) | The invoice's workflow status; PM enum, exposed as its raw int. |
creator | integer (optional) | |
invoiceDate | string (ISO 8601) (optional) | |
fiscalYearId | integer (optional) | |
exchangeRateId | integer (optional) | |
ownerId | integer (optional) | |
invoiceItems | array of PmInvoiceItem (optional) | |
invoiceItems[].itemId | integer | |
invoiceItems[].activityId | integer (optional) | |
invoiceItems[].description | string (optional) | |
invoiceItems[].invoiceId | integer (optional) | |
invoiceItems[].quantity | number (optional) | |
invoiceItems[].price | number (optional) | |
invoiceItems[].expCatId | integer (optional) | |
invoiceItems[].fundingAcctId | integer (optional) | |
invoiceItems[].committedFundItemId | integer (optional) | |
invoiceItems[].total | number (optional) | |
invoiceItems[].extendedAttributes | array of PmExtendedAttribute (optional) | |
invoiceItems[].extendedAttributes[].eaId | integer | |
invoiceItems[].extendedAttributes[].skipDCTSave | boolean | |
invoiceItems[].extendedAttributes[].eaValue | object (optional) | |
invoiceItems[].extendedAttributes[].attributeName | string (optional) | |
sourceContentItemId | string (optional) | DAM content item id (GUID) for the invoice PDF imported via Content Coach; write-once. |
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_invoice
Destructive
Permanently deletes an invoice by its integer ID in Aprimo Marketing Operations. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact invoice with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
invoiceId | string | Yes | The invoice'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 an invoice is permanent and cannot be undone. Set only after stating the exact invoice to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
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.
get_invoice
Returns a single invoice 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 |
|---|---|---|---|
invoiceId | string | Yes | The invoice's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
invoiceId | integer | |
supplierId | integer (optional) | |
commitmentFundId | integer (optional) | |
paidDate | string (ISO 8601) (optional) | |
currencyCode | integer (optional) | |
totalInvoice | number (optional) | |
baseTotalInvoice | number (optional) | |
dateReceived | string (ISO 8601) (optional) | |
dateDue | string (ISO 8601) (optional) | |
modifiedDate | string (ISO 8601) (optional) | |
invoiceNumber | string (optional) | Bound to the wire's invoiceNumber -- Invoice has no dedicated description/name field. |
modifiedUser | integer (optional) | |
reviewedBy | integer (optional) | |
financeGroupId | integer (optional) | |
reviewedDate | string (ISO 8601) (optional) | |
invoiceTypeId | integer (optional) | |
pooled | integer (optional) | |
contactId | integer (optional) | |
net | integer (optional) | |
status | integer (optional) | The invoice's workflow status; PM enum, exposed as its raw int. |
creator | integer (optional) | |
invoiceDate | string (ISO 8601) (optional) | |
fiscalYearId | integer (optional) | |
exchangeRateId | integer (optional) | |
ownerId | integer (optional) | |
invoiceItems | array of PmInvoiceItem (optional) | |
invoiceItems[].itemId | integer | |
invoiceItems[].activityId | integer (optional) | |
invoiceItems[].description | string (optional) | |
invoiceItems[].invoiceId | integer (optional) | |
invoiceItems[].quantity | number (optional) | |
invoiceItems[].price | number (optional) | |
invoiceItems[].expCatId | integer (optional) | |
invoiceItems[].fundingAcctId | integer (optional) | |
invoiceItems[].committedFundItemId | integer (optional) | |
invoiceItems[].total | number (optional) | |
invoiceItems[].extendedAttributes | array of PmExtendedAttribute (optional) | |
invoiceItems[].extendedAttributes[].eaId | integer | |
invoiceItems[].extendedAttributes[].skipDCTSave | boolean | |
invoiceItems[].extendedAttributes[].eaValue | object (optional) | |
invoiceItems[].extendedAttributes[].attributeName | string (optional) | |
sourceContentItemId | string (optional) | DAM content item id (GUID) for the invoice PDF imported via Content Coach; write-once. |
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 . |
list_invoices
Not currently available
Lists invoices in Aprimo Marketing Operations, paged and unfiltered. Use search_invoices 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 InvoiceProjection | The items returned in this response. |
items[].invoiceId | integer | |
items[].supplierId | integer (optional) | |
items[].commitmentFundId | integer (optional) | |
items[].paidDate | string (ISO 8601) (optional) | |
items[].currencyCode | integer (optional) | |
items[].totalInvoice | number (optional) | |
items[].baseTotalInvoice | number (optional) | |
items[].dateReceived | string (ISO 8601) (optional) | |
items[].dateDue | string (ISO 8601) (optional) | |
items[].modifiedDate | string (ISO 8601) (optional) | |
items[].invoiceNumber | string (optional) | Bound to the wire's invoiceNumber -- Invoice has no dedicated description/name field. |
items[].modifiedUser | integer (optional) | |
items[].reviewedBy | integer (optional) | |
items[].financeGroupId | integer (optional) | |
items[].reviewedDate | string (ISO 8601) (optional) | |
items[].invoiceTypeId | integer (optional) | |
items[].pooled | integer (optional) | |
items[].contactId | integer (optional) | |
items[].net | integer (optional) | |
items[].status | integer (optional) | The invoice's workflow status; PM enum, exposed as its raw int. |
items[].creator | integer (optional) | |
items[].invoiceDate | string (ISO 8601) (optional) | |
items[].fiscalYearId | integer (optional) | |
items[].exchangeRateId | integer (optional) | |
items[].ownerId | integer (optional) | |
items[].invoiceItems | array of PmInvoiceItem (optional) | |
items[].invoiceItems[].itemId | integer | |
items[].invoiceItems[].activityId | integer (optional) | |
items[].invoiceItems[].description | string (optional) | |
items[].invoiceItems[].invoiceId | integer (optional) | |
items[].invoiceItems[].quantity | number (optional) | |
items[].invoiceItems[].price | number (optional) | |
items[].invoiceItems[].expCatId | integer (optional) | |
items[].invoiceItems[].fundingAcctId | integer (optional) | |
items[].invoiceItems[].committedFundItemId | integer (optional) | |
items[].invoiceItems[].total | number (optional) | |
items[].invoiceItems[].extendedAttributes | array of PmExtendedAttribute (optional) | |
items[].sourceContentItemId | string (optional) | DAM content item id (GUID) for the invoice PDF imported via Content Coach; write-once. |
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. See . |
mark_invoice_sent
Destructive
Marks an invoice as sent in Aprimo Marketing Operations. This is a state change. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact invoice with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
invoiceId | string | Yes | The invoice's integer ID to mark as sent. |
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) — marking an invoice as sent changes its state. Set only after stating the exact invoice to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
invoiceId | integer | |
action | string (optional) | The state-change action performed: "retrieve", "sent", "submit", "cancel", "reject", or "approve". |
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.
reject_invoice
Destructive · Not currently available
Rejects an invoice 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 invoice with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
invoiceId | string | Yes | The invoice's integer ID to reject. |
body | string | Yes | JSON object with the rejection details. PM requires a non-empty "comments" field, e.g. {"comments":"Duplicate"} -- there is no optional/no-op body for this action. |
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 an invoice changes its state. Set only after stating the exact invoice to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
invoiceId | integer | |
action | string (optional) | The state-change action performed: "retrieve", "sent", "submit", "cancel", "reject", or "approve". |
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.
retrieve_invoice
Destructive
Pulls a submitted invoice 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 invoice with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
invoiceId | string | Yes | The invoice'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 an invoice changes its state. Set only after stating the exact invoice to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
invoiceId | integer | |
action | string (optional) | The state-change action performed: "retrieve", "sent", "submit", "cancel", "reject", or "approve". |
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.
search_invoices
Searches invoices 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 invoices. |
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 InvoiceProjection | The items returned in this response. |
items[].invoiceId | integer | |
items[].supplierId | integer (optional) | |
items[].commitmentFundId | integer (optional) | |
items[].paidDate | string (ISO 8601) (optional) | |
items[].currencyCode | integer (optional) | |
items[].totalInvoice | number (optional) | |
items[].baseTotalInvoice | number (optional) | |
items[].dateReceived | string (ISO 8601) (optional) | |
items[].dateDue | string (ISO 8601) (optional) | |
items[].modifiedDate | string (ISO 8601) (optional) | |
items[].invoiceNumber | string (optional) | Bound to the wire's invoiceNumber -- Invoice has no dedicated description/name field. |
items[].modifiedUser | integer (optional) | |
items[].reviewedBy | integer (optional) | |
items[].financeGroupId | integer (optional) | |
items[].reviewedDate | string (ISO 8601) (optional) | |
items[].invoiceTypeId | integer (optional) | |
items[].pooled | integer (optional) | |
items[].contactId | integer (optional) | |
items[].net | integer (optional) | |
items[].status | integer (optional) | The invoice's workflow status; PM enum, exposed as its raw int. |
items[].creator | integer (optional) | |
items[].invoiceDate | string (ISO 8601) (optional) | |
items[].fiscalYearId | integer (optional) | |
items[].exchangeRateId | integer (optional) | |
items[].ownerId | integer (optional) | |
items[].invoiceItems | array of PmInvoiceItem (optional) | |
items[].invoiceItems[].itemId | integer | |
items[].invoiceItems[].activityId | integer (optional) | |
items[].invoiceItems[].description | string (optional) | |
items[].invoiceItems[].invoiceId | integer (optional) | |
items[].invoiceItems[].quantity | number (optional) | |
items[].invoiceItems[].price | number (optional) | |
items[].invoiceItems[].expCatId | integer (optional) | |
items[].invoiceItems[].fundingAcctId | integer (optional) | |
items[].invoiceItems[].committedFundItemId | integer (optional) | |
items[].invoiceItems[].total | number (optional) | |
items[].invoiceItems[].extendedAttributes | array of PmExtendedAttribute (optional) | |
items[].sourceContentItemId | string (optional) | DAM content item id (GUID) for the invoice PDF imported via Content Coach; write-once. |
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. See . |
submit_invoice
Destructive
Submits an invoice 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 invoice with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
invoiceId | string | Yes | The invoice'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 an invoice changes its state. Set only after stating the exact invoice to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
invoiceId | integer | |
action | string (optional) | The state-change action performed: "retrieve", "sent", "submit", "cancel", "reject", or "approve". |
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_invoice
Updates an existing invoice 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 invoice.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
invoiceId | string | Yes | The invoice'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 |
|---|---|---|
invoiceId | integer | |
supplierId | integer (optional) | |
commitmentFundId | integer (optional) | |
paidDate | string (ISO 8601) (optional) | |
currencyCode | integer (optional) | |
totalInvoice | number (optional) | |
baseTotalInvoice | number (optional) | |
dateReceived | string (ISO 8601) (optional) | |
dateDue | string (ISO 8601) (optional) | |
modifiedDate | string (ISO 8601) (optional) | |
invoiceNumber | string (optional) | Bound to the wire's invoiceNumber -- Invoice has no dedicated description/name field. |
modifiedUser | integer (optional) | |
reviewedBy | integer (optional) | |
financeGroupId | integer (optional) | |
reviewedDate | string (ISO 8601) (optional) | |
invoiceTypeId | integer (optional) | |
pooled | integer (optional) | |
contactId | integer (optional) | |
net | integer (optional) | |
status | integer (optional) | The invoice's workflow status; PM enum, exposed as its raw int. |
creator | integer (optional) | |
invoiceDate | string (ISO 8601) (optional) | |
fiscalYearId | integer (optional) | |
exchangeRateId | integer (optional) | |
ownerId | integer (optional) | |
invoiceItems | array of PmInvoiceItem (optional) | |
invoiceItems[].itemId | integer | |
invoiceItems[].activityId | integer (optional) | |
invoiceItems[].description | string (optional) | |
invoiceItems[].invoiceId | integer (optional) | |
invoiceItems[].quantity | number (optional) | |
invoiceItems[].price | number (optional) | |
invoiceItems[].expCatId | integer (optional) | |
invoiceItems[].fundingAcctId | integer (optional) | |
invoiceItems[].committedFundItemId | integer (optional) | |
invoiceItems[].total | number (optional) | |
invoiceItems[].extendedAttributes | array of PmExtendedAttribute (optional) | |
invoiceItems[].extendedAttributes[].eaId | integer | |
invoiceItems[].extendedAttributes[].skipDCTSave | boolean | |
invoiceItems[].extendedAttributes[].eaValue | object (optional) | |
invoiceItems[].extendedAttributes[].attributeName | string (optional) | |
sourceContentItemId | string (optional) | DAM content item id (GUID) for the invoice PDF imported via Content Coach; write-once. |
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 . |
Post Journal Vouchers
Can change data · 11 tools (9 currently available) · Group ID post-journal-vouchers
Needs: Set Up Funding Accounts & Hierarchies
| Tool | What it does |
|---|---|
cancel_journal_voucher | Destructive. Cancels a journal voucher in Aprimo Marketing Operations. |
create_journal_voucher | Creates a new journal voucher in Aprimo Marketing Operations. |
delete_journal_voucher | Destructive. Permanently deletes a journal voucher by its integer ID in Aprimo Marketing Operations. |
get_journal_voucher | Returns a single journal voucher by its integer ID in Aprimo Marketing Operations. |
list_journal_vouchers | Lists journal vouchers in Aprimo Marketing Operations, paged and unfiltered. |
mark_journal_voucher_sent | Not currently available. Destructive. Marks a journal voucher as sent in Aprimo Marketing Operations. |
reconcile_journal_voucher | Destructive. Reconciles a journal voucher in Aprimo Marketing Operations. |
reject_journal_voucher | Not currently available. Destructive. Rejects a journal voucher that is pending approval in Aprimo Marketing Operations. |
search_journal_vouchers | Searches journal vouchers in Aprimo Marketing Operations that match a query, paged. |
submit_journal_voucher | Destructive. Submits a journal voucher for approval in Aprimo Marketing Operations. |
update_journal_voucher | Updates an existing journal voucher by its integer ID in Aprimo Marketing Operations. |
cancel_journal_voucher
Destructive
Cancels a journal voucher in Aprimo Marketing Operations. This is a state change that terminates the journal voucher's workflow. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact journal voucher with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
journalVoucherId | string | Yes | The journal voucher'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 journal voucher changes its state. Set only after stating the exact journal voucher to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
journalVoucherId | integer | |
action | string (optional) | The state-change action performed: "sent", "cancel", "submit", "reconcile", 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.
create_journal_voucher
Creates a new journal voucher in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the created journal voucher.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
body | string | Yes | JSON object with the new journal voucher'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 |
|---|---|---|
journalVoucherId | integer | |
name | string (optional) | Always null -- JournalVoucher has no name-like field on the wire. See the class remarks. |
invoiceId | integer (optional) | |
committedFundId | integer (optional) | |
supplierId | integer (optional) | |
contactId | integer (optional) | |
journalVoucherDate | string (ISO 8601) (optional) | |
creatorId | integer (optional) | |
currencyCode | integer (optional) | |
fiscalYearId | integer (optional) | |
journalVoucherStatus | integer (optional) | The journal voucher's workflow status; PM enum, exposed as its raw int. |
postedDate | string (ISO 8601) (optional) | |
sendToGlIntegration | integer (optional) | |
modifiedUser | integer (optional) | |
modifiedDate | string (ISO 8601) (optional) | |
exchangeRateId | integer (optional) | |
multipleActivities | integer (optional) | |
glOverridden | integer (optional) | |
journalVoucherTypeId | integer (optional) | |
jvTotal | number (optional) | |
baseTotalJv | number (optional) | |
financeGroupId | integer (optional) | |
journalVoucherItems | array of PmJournalVoucherItem (optional) | |
journalVoucherItems[].jvItemId | integer | |
journalVoucherItems[].journalVoucherId | integer | |
journalVoucherItems[].committedFundItemId | integer (optional) | |
journalVoucherItems[].description | string (optional) | |
journalVoucherItems[].quantity | number (optional) | |
journalVoucherItems[].price | number (optional) | |
journalVoucherItems[].activityId | integer (optional) | |
journalVoucherItems[].expCatId | integer (optional) | |
journalVoucherItems[].fundingAcctId | integer (optional) | |
journalVoucherItems[].itemId | integer (optional) | |
journalVoucherItems[].total | number (optional) | |
journalVoucherItems[].extendedAttributes | array of PmExtendedAttribute (optional) | |
journalVoucherItems[].extendedAttributes[].eaId | integer | |
journalVoucherItems[].extendedAttributes[].skipDCTSave | boolean | |
journalVoucherItems[].extendedAttributes[].eaValue | object (optional) | |
journalVoucherItems[].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. See . |
delete_journal_voucher
Destructive
Permanently deletes a journal voucher by its integer ID in Aprimo Marketing Operations. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact journal voucher with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
journalVoucherId | string | Yes | The journal voucher'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 journal voucher is permanent and cannot be undone. Set only after stating the exact journal voucher to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
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.
get_journal_voucher
Returns a single journal voucher 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 |
|---|---|---|---|
journalVoucherId | string | Yes | The journal voucher's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
journalVoucherId | integer | |
name | string (optional) | Always null -- JournalVoucher has no name-like field on the wire. See the class remarks. |
invoiceId | integer (optional) | |
committedFundId | integer (optional) | |
supplierId | integer (optional) | |
contactId | integer (optional) | |
journalVoucherDate | string (ISO 8601) (optional) | |
creatorId | integer (optional) | |
currencyCode | integer (optional) | |
fiscalYearId | integer (optional) | |
journalVoucherStatus | integer (optional) | The journal voucher's workflow status; PM enum, exposed as its raw int. |
postedDate | string (ISO 8601) (optional) | |
sendToGlIntegration | integer (optional) | |
modifiedUser | integer (optional) | |
modifiedDate | string (ISO 8601) (optional) | |
exchangeRateId | integer (optional) | |
multipleActivities | integer (optional) | |
glOverridden | integer (optional) | |
journalVoucherTypeId | integer (optional) | |
jvTotal | number (optional) | |
baseTotalJv | number (optional) | |
financeGroupId | integer (optional) | |
journalVoucherItems | array of PmJournalVoucherItem (optional) | |
journalVoucherItems[].jvItemId | integer | |
journalVoucherItems[].journalVoucherId | integer | |
journalVoucherItems[].committedFundItemId | integer (optional) | |
journalVoucherItems[].description | string (optional) | |
journalVoucherItems[].quantity | number (optional) | |
journalVoucherItems[].price | number (optional) | |
journalVoucherItems[].activityId | integer (optional) | |
journalVoucherItems[].expCatId | integer (optional) | |
journalVoucherItems[].fundingAcctId | integer (optional) | |
journalVoucherItems[].itemId | integer (optional) | |
journalVoucherItems[].total | number (optional) | |
journalVoucherItems[].extendedAttributes | array of PmExtendedAttribute (optional) | |
journalVoucherItems[].extendedAttributes[].eaId | integer | |
journalVoucherItems[].extendedAttributes[].skipDCTSave | boolean | |
journalVoucherItems[].extendedAttributes[].eaValue | object (optional) | |
journalVoucherItems[].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. See . |
list_journal_vouchers
Lists journal vouchers in Aprimo Marketing Operations, paged and unfiltered. Use search_journal_vouchers 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 JournalVoucherProjection | The items returned in this response. |
items[].journalVoucherId | integer | |
items[].name | string (optional) | Always null -- JournalVoucher has no name-like field on the wire. See the class remarks. |
items[].invoiceId | integer (optional) | |
items[].committedFundId | integer (optional) | |
items[].supplierId | integer (optional) | |
items[].contactId | integer (optional) | |
items[].journalVoucherDate | string (ISO 8601) (optional) | |
items[].creatorId | integer (optional) | |
items[].currencyCode | integer (optional) | |
items[].fiscalYearId | integer (optional) | |
items[].journalVoucherStatus | integer (optional) | The journal voucher's workflow status; PM enum, exposed as its raw int. |
items[].postedDate | string (ISO 8601) (optional) | |
items[].sendToGlIntegration | integer (optional) | |
items[].modifiedUser | integer (optional) | |
items[].modifiedDate | string (ISO 8601) (optional) | |
items[].exchangeRateId | integer (optional) | |
items[].multipleActivities | integer (optional) | |
items[].glOverridden | integer (optional) | |
items[].journalVoucherTypeId | integer (optional) | |
items[].jvTotal | number (optional) | |
items[].baseTotalJv | number (optional) | |
items[].financeGroupId | integer (optional) | |
items[].journalVoucherItems | array of PmJournalVoucherItem (optional) | |
items[].journalVoucherItems[].jvItemId | integer | |
items[].journalVoucherItems[].journalVoucherId | integer | |
items[].journalVoucherItems[].committedFundItemId | integer (optional) | |
items[].journalVoucherItems[].description | string (optional) | |
items[].journalVoucherItems[].quantity | number (optional) | |
items[].journalVoucherItems[].price | number (optional) | |
items[].journalVoucherItems[].activityId | integer (optional) | |
items[].journalVoucherItems[].expCatId | integer (optional) | |
items[].journalVoucherItems[].fundingAcctId | integer (optional) | |
items[].journalVoucherItems[].itemId | integer (optional) | |
items[].journalVoucherItems[].total | number (optional) | |
items[].journalVoucherItems[].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. See . |
mark_journal_voucher_sent
Destructive · Not currently available
Marks a journal voucher as sent in Aprimo Marketing Operations. This is a state change. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact journal voucher with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
journalVoucherId | string | Yes | The journal voucher's integer ID to mark as sent. |
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) — marking a journal voucher as sent changes its state. Set only after stating the exact journal voucher to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
journalVoucherId | integer | |
action | string (optional) | The state-change action performed: "sent", "cancel", "submit", "reconcile", 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.
reconcile_journal_voucher
Destructive
Reconciles a journal voucher in Aprimo Marketing Operations. This is a state change. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact journal voucher with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
journalVoucherId | string | Yes | The journal voucher's integer ID to reconcile. |
body | string | Yes | JSON object with the reconciliation details PM expects. Pass "{}" if none apply. |
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) — reconciling a journal voucher changes its state. Set only after stating the exact journal voucher to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
journalVoucherId | integer | |
action | string (optional) | The state-change action performed: "sent", "cancel", "submit", "reconcile", 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.
reject_journal_voucher
Destructive · Not currently available
Rejects a journal voucher 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 journal voucher with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
journalVoucherId | string | Yes | The journal voucher's integer ID to reject. |
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 journal voucher changes its state. Set only after stating the exact journal voucher to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
journalVoucherId | integer | |
action | string (optional) | The state-change action performed: "sent", "cancel", "submit", "reconcile", 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.
search_journal_vouchers
Searches journal vouchers 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 journal vouchers. |
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 JournalVoucherProjection | The items returned in this response. |
items[].journalVoucherId | integer | |
items[].name | string (optional) | Always null -- JournalVoucher has no name-like field on the wire. See the class remarks. |
items[].invoiceId | integer (optional) | |
items[].committedFundId | integer (optional) | |
items[].supplierId | integer (optional) | |
items[].contactId | integer (optional) | |
items[].journalVoucherDate | string (ISO 8601) (optional) | |
items[].creatorId | integer (optional) | |
items[].currencyCode | integer (optional) | |
items[].fiscalYearId | integer (optional) | |
items[].journalVoucherStatus | integer (optional) | The journal voucher's workflow status; PM enum, exposed as its raw int. |
items[].postedDate | string (ISO 8601) (optional) | |
items[].sendToGlIntegration | integer (optional) | |
items[].modifiedUser | integer (optional) | |
items[].modifiedDate | string (ISO 8601) (optional) | |
items[].exchangeRateId | integer (optional) | |
items[].multipleActivities | integer (optional) | |
items[].glOverridden | integer (optional) | |
items[].journalVoucherTypeId | integer (optional) | |
items[].jvTotal | number (optional) | |
items[].baseTotalJv | number (optional) | |
items[].financeGroupId | integer (optional) | |
items[].journalVoucherItems | array of PmJournalVoucherItem (optional) | |
items[].journalVoucherItems[].jvItemId | integer | |
items[].journalVoucherItems[].journalVoucherId | integer | |
items[].journalVoucherItems[].committedFundItemId | integer (optional) | |
items[].journalVoucherItems[].description | string (optional) | |
items[].journalVoucherItems[].quantity | number (optional) | |
items[].journalVoucherItems[].price | number (optional) | |
items[].journalVoucherItems[].activityId | integer (optional) | |
items[].journalVoucherItems[].expCatId | integer (optional) | |
items[].journalVoucherItems[].fundingAcctId | integer (optional) | |
items[].journalVoucherItems[].itemId | integer (optional) | |
items[].journalVoucherItems[].total | number (optional) | |
items[].journalVoucherItems[].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. See . |
submit_journal_voucher
Destructive
Submits a journal voucher 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 journal voucher with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
journalVoucherId | string | Yes | The journal voucher's integer ID to submit. |
body | string | Yes | JSON object with the submission details PM expects. Pass "{}" if none apply. |
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 journal voucher changes its state. Set only after stating the exact journal voucher to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
journalVoucherId | integer | |
action | string (optional) | The state-change action performed: "sent", "cancel", "submit", "reconcile", 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_journal_voucher
Updates an existing journal voucher 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 journal voucher.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
journalVoucherId | string | Yes | The journal voucher'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 |
|---|---|---|
journalVoucherId | integer | |
name | string (optional) | Always null -- JournalVoucher has no name-like field on the wire. See the class remarks. |
invoiceId | integer (optional) | |
committedFundId | integer (optional) | |
supplierId | integer (optional) | |
contactId | integer (optional) | |
journalVoucherDate | string (ISO 8601) (optional) | |
creatorId | integer (optional) | |
currencyCode | integer (optional) | |
fiscalYearId | integer (optional) | |
journalVoucherStatus | integer (optional) | The journal voucher's workflow status; PM enum, exposed as its raw int. |
postedDate | string (ISO 8601) (optional) | |
sendToGlIntegration | integer (optional) | |
modifiedUser | integer (optional) | |
modifiedDate | string (ISO 8601) (optional) | |
exchangeRateId | integer (optional) | |
multipleActivities | integer (optional) | |
glOverridden | integer (optional) | |
journalVoucherTypeId | integer (optional) | |
jvTotal | number (optional) | |
baseTotalJv | number (optional) | |
financeGroupId | integer (optional) | |
journalVoucherItems | array of PmJournalVoucherItem (optional) | |
journalVoucherItems[].jvItemId | integer | |
journalVoucherItems[].journalVoucherId | integer | |
journalVoucherItems[].committedFundItemId | integer (optional) | |
journalVoucherItems[].description | string (optional) | |
journalVoucherItems[].quantity | number (optional) | |
journalVoucherItems[].price | number (optional) | |
journalVoucherItems[].activityId | integer (optional) | |
journalVoucherItems[].expCatId | integer (optional) | |
journalVoucherItems[].fundingAcctId | integer (optional) | |
journalVoucherItems[].itemId | integer (optional) | |
journalVoucherItems[].total | number (optional) | |
journalVoucherItems[].extendedAttributes | array of PmExtendedAttribute (optional) | |
journalVoucherItems[].extendedAttributes[].eaId | integer | |
journalVoucherItems[].extendedAttributes[].skipDCTSave | boolean | |
journalVoucherItems[].extendedAttributes[].eaValue | object (optional) | |
journalVoucherItems[].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. See . |