Skip to main content

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.

How to read this page
  • 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 confirmed and confirmedDestructive to true.
  • 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​

GroupAccessNeedsTools
Manage SuppliersCan change dataNone6
Commit SpendCan change dataManage Suppliers, View Activities11
Process InvoicesCan change dataCommit Spend, Manage Suppliers12
Post Journal VouchersCan change dataSet Up Funding Accounts & Hierarchies11

Manage Suppliers​

Can change data · 6 tools · Group ID manage-suppliers

Needs: no other groups.

ToolWhat it does
create_supplierCreates a new supplier in Aprimo Marketing Operations.
delete_supplierDestructive. Permanently deletes a supplier by its integer ID in Aprimo Marketing Operations.
get_supplierReturns a single supplier by its integer ID in Aprimo Marketing Operations.
list_suppliersLists suppliers in Aprimo Marketing Operations, paged and unfiltered.
search_suppliersSearches suppliers in Aprimo Marketing Operations by name, paged.
update_supplierUpdates 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:

ParameterTypeRequiredDescription
bodystringYesJSON object with the new supplier's data (PM wire names).
confirmedbooleanNoMust 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:

FieldTypeDescription
supplierIdinteger
namestring (optional)
preferredinteger (optional)
activeFlaginteger (optional)
supplierTypeIdinteger (optional)
notificationTypeIdinteger (optional)
supplierNumberstring (optional)
urlstring (optional)
descriptionstring (optional)
addressLine1string (optional)
addressLine2string (optional)
addressLine3string (optional)
citystring (optional)
statestring (optional)
zipstring (optional)
countrystring (optional)
phonestring (optional)
faxNumberstring (optional)
emailstring (optional)
modifiedUserinteger (optional)
modifiedDatestring (optional)
rawobject (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:

ParameterTypeRequiredDescription
supplierIdstringNoThe supplier's integer ID to delete. Provide either supplierId or name, not both.
namestringNoThe supplier's name. Provide either supplierId or name, not both.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
idinteger
deletedboolean
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


get_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:

ParameterTypeRequiredDescription
supplierIdstringNoThe supplier's integer ID. Provide either supplierId or name, not both.
namestringNoThe supplier's name. Provide either supplierId or name, not both.

Returns:

FieldTypeDescription
supplierIdinteger
namestring (optional)
preferredinteger (optional)
activeFlaginteger (optional)
supplierTypeIdinteger (optional)
notificationTypeIdinteger (optional)
supplierNumberstring (optional)
urlstring (optional)
descriptionstring (optional)
addressLine1string (optional)
addressLine2string (optional)
addressLine3string (optional)
citystring (optional)
statestring (optional)
zipstring (optional)
countrystring (optional)
phonestring (optional)
faxNumberstring (optional)
emailstring (optional)
modifiedUserinteger (optional)
modifiedDatestring (optional)
rawobject (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:

ParameterTypeRequiredDescription
limitintegerNoMaximum number of results to return (1–50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).
sortFieldstringNoOptional field name to sort by. Omit for default ordering.
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of SupplierProjectionThe items returned in this response.
items[].supplierIdinteger
items[].namestring (optional)
items[].preferredinteger (optional)
items[].activeFlaginteger (optional)
items[].supplierTypeIdinteger (optional)
items[].notificationTypeIdinteger (optional)
items[].supplierNumberstring (optional)
items[].urlstring (optional)
items[].descriptionstring (optional)
items[].addressLine1string (optional)
items[].addressLine2string (optional)
items[].addressLine3string (optional)
items[].citystring (optional)
items[].statestring (optional)
items[].zipstring (optional)
items[].countrystring (optional)
items[].phonestring (optional)
items[].faxNumberstring (optional)
items[].emailstring (optional)
items[].modifiedUserinteger (optional)
items[].modifiedDatestring (optional)
items[].rawobject (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:

ParameterTypeRequiredDescription
nameFilterstringNoOptional case-insensitive substring filter on the supplier's name. Omit to match all suppliers.
limitintegerNoMaximum number of results to return (1–50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).
sortFieldstringNoOptional field name to sort by. Omit for default ordering.
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of SupplierProjectionThe items returned in this response.
items[].supplierIdinteger
items[].namestring (optional)
items[].preferredinteger (optional)
items[].activeFlaginteger (optional)
items[].supplierTypeIdinteger (optional)
items[].notificationTypeIdinteger (optional)
items[].supplierNumberstring (optional)
items[].urlstring (optional)
items[].descriptionstring (optional)
items[].addressLine1string (optional)
items[].addressLine2string (optional)
items[].addressLine3string (optional)
items[].citystring (optional)
items[].statestring (optional)
items[].zipstring (optional)
items[].countrystring (optional)
items[].phonestring (optional)
items[].faxNumberstring (optional)
items[].emailstring (optional)
items[].modifiedUserinteger (optional)
items[].modifiedDatestring (optional)
items[].rawobject (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:

ParameterTypeRequiredDescription
supplierIdstringNoThe supplier's integer ID. Provide either supplierId or name, not both.
namestringNoThe supplier's name. Provide either supplierId or name, not both.
bodystringNoJSON object with the fields to change (PM wire names). Omit fields you don't want to modify.
confirmedbooleanNoMust 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:

FieldTypeDescription
supplierIdinteger
namestring (optional)
preferredinteger (optional)
activeFlaginteger (optional)
supplierTypeIdinteger (optional)
notificationTypeIdinteger (optional)
supplierNumberstring (optional)
urlstring (optional)
descriptionstring (optional)
addressLine1string (optional)
addressLine2string (optional)
addressLine3string (optional)
citystring (optional)
statestring (optional)
zipstring (optional)
countrystring (optional)
phonestring (optional)
faxNumberstring (optional)
emailstring (optional)
modifiedUserinteger (optional)
modifiedDatestring (optional)
rawobject (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

ToolWhat it does
approve_commitmentNot currently available. Destructive. Approves a commitment that is pending approval in Aprimo Marketing Operations.
cancel_commitmentDestructive. Cancels a commitment in Aprimo Marketing Operations.
create_commitmentCreates a new commitment in Aprimo Marketing Operations.
delete_commitmentDestructive. Permanently deletes a commitment by its integer ID in Aprimo Marketing Operations.
get_commitmentReturns a single commitment by its integer ID in Aprimo Marketing Operations.
list_commitmentsLists commitments in Aprimo Marketing Operations, paged and unfiltered.
reject_commitmentNot currently available. Destructive. Rejects a commitment that is pending approval in Aprimo Marketing Operations.
retrieve_commitmentDestructive. Pulls a submitted commitment back to draft status in Aprimo Marketing Operations (undoes a submission).
search_commitmentsSearches commitments in Aprimo Marketing Operations that match a query, paged.
submit_commitmentDestructive. Submits a commitment for approval in Aprimo Marketing Operations.
update_commitmentUpdates 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:

ParameterTypeRequiredDescription
commitmentIdstringYesThe commitment's integer ID to approve.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
commitmentIdinteger
actionstring (optional)The state-change action performed: "retrieve", "submit", "cancel", "reject", or "approve".
succeededboolean
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


cancel_commitment​

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:

ParameterTypeRequiredDescription
commitmentIdstringYesThe commitment's integer ID to cancel.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
commitmentIdinteger
actionstring (optional)The state-change action performed: "retrieve", "submit", "cancel", "reject", or "approve".
succeededboolean
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


create_commitment​

Creates a new commitment in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the created commitment.

Parameters:

ParameterTypeRequiredDescription
bodystringYesJSON object with the new commitment's data (PM wire names).
confirmedbooleanNoMust 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:

FieldTypeDescription
committedIdinteger
supplierIdinteger (optional)
purchaseOrderNumberstring (optional)
closedinteger (optional)
descriptionstring (optional)Bound to the wire's description -- CommittedFund has no dedicated name field.
currencyCodeinteger (optional)
enteredValuenumber (optional)
ownerIdinteger (optional)
modifiedUserinteger (optional)
modifiedDatestring (ISO 8601) (optional)
creatorIdinteger (optional)
createdDatestring (ISO 8601) (optional)
commitmentTypeIdinteger (optional)
reviewedDatestring (ISO 8601) (optional)
reviewedByinteger (optional)
pooledinteger (optional)
contactIdinteger (optional)
commitmentStatusinteger (optional)The commitment's workflow status (draft/submitted/approved/etc; PM enum, exposed as its raw int).
financeGroupIdinteger (optional)
totalPendingInvoicenumber (optional)
baseTotalPendingInvoicenumber (optional)
totalPaidInvoicenumber (optional)
baseTotalPaidInvoicenumber (optional)
totalPendingAndPaidInvoicenumber (optional)
totalAmountnumber (optional)
baseTotalAmountnumber (optional)
totalOutstandingnumber (optional)
baseTotalOutstandingnumber (optional)
proposedTotalAmountnumber (optional)
proposedBaseTotalAmountnumber (optional)
commitmentItemsarray of PmCommitmentItem (optional)
commitmentItems[].committedItemIdinteger
commitmentItems[].committedIdinteger
commitmentItems[].activityIdinteger (optional)
commitmentItems[].descriptionstring (optional)
commitmentItems[].expenseCategoryIdinteger (optional)
commitmentItems[].exchangeRateIdinteger (optional)
commitmentItems[].closedinteger (optional)
commitmentItems[].fiscalYearIdinteger (optional)
commitmentItems[].fiscalPeriodIdinteger (optional)
commitmentItems[].quantitynumber (optional)
commitmentItems[].pricenumber (optional)
commitmentItems[].totalnumber (optional)
commitmentItems[].extendedAttributesarray of PmExtendedAttribute (optional)
commitmentItems[].extendedAttributes[].eaIdinteger
commitmentItems[].extendedAttributes[].skipDCTSaveboolean
commitmentItems[].extendedAttributes[].eaValueobject (optional)
commitmentItems[].extendedAttributes[].attributeNamestring (optional)
proposedCommitmentItemsarray of PmCommitmentItem (optional)
proposedCommitmentItems[].committedItemIdinteger
proposedCommitmentItems[].committedIdinteger
proposedCommitmentItems[].activityIdinteger (optional)
proposedCommitmentItems[].descriptionstring (optional)
proposedCommitmentItems[].expenseCategoryIdinteger (optional)
proposedCommitmentItems[].exchangeRateIdinteger (optional)
proposedCommitmentItems[].closedinteger (optional)
proposedCommitmentItems[].fiscalYearIdinteger (optional)
proposedCommitmentItems[].fiscalPeriodIdinteger (optional)
proposedCommitmentItems[].quantitynumber (optional)
proposedCommitmentItems[].pricenumber (optional)
proposedCommitmentItems[].totalnumber (optional)
proposedCommitmentItems[].extendedAttributesarray of PmExtendedAttribute (optional)
proposedCommitmentItems[].extendedAttributes[].eaIdinteger
proposedCommitmentItems[].extendedAttributes[].skipDCTSaveboolean
proposedCommitmentItems[].extendedAttributes[].eaValueobject (optional)
proposedCommitmentItems[].extendedAttributes[].attributeNamestring (optional)
extendedAttributesarray of PmExtendedAttribute (optional)
extendedAttributes[].eaIdinteger
extendedAttributes[].skipDCTSaveboolean
extendedAttributes[].eaValueobject (optional)
extendedAttributes[].attributeNamestring (optional)
multipleValueExtendedAttributesarray of PmMultipleValueExtendedAttribute (optional)
multipleValueExtendedAttributes[].parentIdinteger
multipleValueExtendedAttributes[].extAttributeIdinteger
multipleValueExtendedAttributes[].encodedListItemIdinteger
multipleValueExtendedAttributes[].attributeNamestring (optional)
rawobject (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:

ParameterTypeRequiredDescription
commitmentIdstringYesThe commitment's integer ID to delete.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
idinteger
deletedboolean
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


get_commitment​

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:

ParameterTypeRequiredDescription
commitmentIdstringYesThe commitment's integer ID.

Returns:

FieldTypeDescription
committedIdinteger
supplierIdinteger (optional)
purchaseOrderNumberstring (optional)
closedinteger (optional)
descriptionstring (optional)Bound to the wire's description -- CommittedFund has no dedicated name field.
currencyCodeinteger (optional)
enteredValuenumber (optional)
ownerIdinteger (optional)
modifiedUserinteger (optional)
modifiedDatestring (ISO 8601) (optional)
creatorIdinteger (optional)
createdDatestring (ISO 8601) (optional)
commitmentTypeIdinteger (optional)
reviewedDatestring (ISO 8601) (optional)
reviewedByinteger (optional)
pooledinteger (optional)
contactIdinteger (optional)
commitmentStatusinteger (optional)The commitment's workflow status (draft/submitted/approved/etc; PM enum, exposed as its raw int).
financeGroupIdinteger (optional)
totalPendingInvoicenumber (optional)
baseTotalPendingInvoicenumber (optional)
totalPaidInvoicenumber (optional)
baseTotalPaidInvoicenumber (optional)
totalPendingAndPaidInvoicenumber (optional)
totalAmountnumber (optional)
baseTotalAmountnumber (optional)
totalOutstandingnumber (optional)
baseTotalOutstandingnumber (optional)
proposedTotalAmountnumber (optional)
proposedBaseTotalAmountnumber (optional)
commitmentItemsarray of PmCommitmentItem (optional)
commitmentItems[].committedItemIdinteger
commitmentItems[].committedIdinteger
commitmentItems[].activityIdinteger (optional)
commitmentItems[].descriptionstring (optional)
commitmentItems[].expenseCategoryIdinteger (optional)
commitmentItems[].exchangeRateIdinteger (optional)
commitmentItems[].closedinteger (optional)
commitmentItems[].fiscalYearIdinteger (optional)
commitmentItems[].fiscalPeriodIdinteger (optional)
commitmentItems[].quantitynumber (optional)
commitmentItems[].pricenumber (optional)
commitmentItems[].totalnumber (optional)
commitmentItems[].extendedAttributesarray of PmExtendedAttribute (optional)
commitmentItems[].extendedAttributes[].eaIdinteger
commitmentItems[].extendedAttributes[].skipDCTSaveboolean
commitmentItems[].extendedAttributes[].eaValueobject (optional)
commitmentItems[].extendedAttributes[].attributeNamestring (optional)
proposedCommitmentItemsarray of PmCommitmentItem (optional)
proposedCommitmentItems[].committedItemIdinteger
proposedCommitmentItems[].committedIdinteger
proposedCommitmentItems[].activityIdinteger (optional)
proposedCommitmentItems[].descriptionstring (optional)
proposedCommitmentItems[].expenseCategoryIdinteger (optional)
proposedCommitmentItems[].exchangeRateIdinteger (optional)
proposedCommitmentItems[].closedinteger (optional)
proposedCommitmentItems[].fiscalYearIdinteger (optional)
proposedCommitmentItems[].fiscalPeriodIdinteger (optional)
proposedCommitmentItems[].quantitynumber (optional)
proposedCommitmentItems[].pricenumber (optional)
proposedCommitmentItems[].totalnumber (optional)
proposedCommitmentItems[].extendedAttributesarray of PmExtendedAttribute (optional)
proposedCommitmentItems[].extendedAttributes[].eaIdinteger
proposedCommitmentItems[].extendedAttributes[].skipDCTSaveboolean
proposedCommitmentItems[].extendedAttributes[].eaValueobject (optional)
proposedCommitmentItems[].extendedAttributes[].attributeNamestring (optional)
extendedAttributesarray of PmExtendedAttribute (optional)
extendedAttributes[].eaIdinteger
extendedAttributes[].skipDCTSaveboolean
extendedAttributes[].eaValueobject (optional)
extendedAttributes[].attributeNamestring (optional)
multipleValueExtendedAttributesarray of PmMultipleValueExtendedAttribute (optional)
multipleValueExtendedAttributes[].parentIdinteger
multipleValueExtendedAttributes[].extAttributeIdinteger
multipleValueExtendedAttributes[].encodedListItemIdinteger
multipleValueExtendedAttributes[].attributeNamestring (optional)
rawobject (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:

ParameterTypeRequiredDescription
limitintegerNoMaximum number of results to return (1–50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).
sortFieldstringNoOptional field name to sort by. Omit for default ordering.
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of CommittedFundProjectionThe items returned in this response.
items[].committedIdinteger
items[].supplierIdinteger (optional)
items[].purchaseOrderNumberstring (optional)
items[].closedinteger (optional)
items[].descriptionstring (optional)Bound to the wire's description -- CommittedFund has no dedicated name field.
items[].currencyCodeinteger (optional)
items[].enteredValuenumber (optional)
items[].ownerIdinteger (optional)
items[].modifiedUserinteger (optional)
items[].modifiedDatestring (ISO 8601) (optional)
items[].creatorIdinteger (optional)
items[].createdDatestring (ISO 8601) (optional)
items[].commitmentTypeIdinteger (optional)
items[].reviewedDatestring (ISO 8601) (optional)
items[].reviewedByinteger (optional)
items[].pooledinteger (optional)
items[].contactIdinteger (optional)
items[].commitmentStatusinteger (optional)The commitment's workflow status (draft/submitted/approved/etc; PM enum, exposed as its raw int).
items[].financeGroupIdinteger (optional)
items[].totalPendingInvoicenumber (optional)
items[].baseTotalPendingInvoicenumber (optional)
items[].totalPaidInvoicenumber (optional)
items[].baseTotalPaidInvoicenumber (optional)
items[].totalPendingAndPaidInvoicenumber (optional)
items[].totalAmountnumber (optional)
items[].baseTotalAmountnumber (optional)
items[].totalOutstandingnumber (optional)
items[].baseTotalOutstandingnumber (optional)
items[].proposedTotalAmountnumber (optional)
items[].proposedBaseTotalAmountnumber (optional)
items[].commitmentItemsarray of PmCommitmentItem (optional)
items[].commitmentItems[].committedItemIdinteger
items[].commitmentItems[].committedIdinteger
items[].commitmentItems[].activityIdinteger (optional)
items[].commitmentItems[].descriptionstring (optional)
items[].commitmentItems[].expenseCategoryIdinteger (optional)
items[].commitmentItems[].exchangeRateIdinteger (optional)
items[].commitmentItems[].closedinteger (optional)
items[].commitmentItems[].fiscalYearIdinteger (optional)
items[].commitmentItems[].fiscalPeriodIdinteger (optional)
items[].commitmentItems[].quantitynumber (optional)
items[].commitmentItems[].pricenumber (optional)
items[].commitmentItems[].totalnumber (optional)
items[].commitmentItems[].extendedAttributesarray of PmExtendedAttribute (optional)
items[].proposedCommitmentItemsarray of PmCommitmentItem (optional)
items[].proposedCommitmentItems[].committedItemIdinteger
items[].proposedCommitmentItems[].committedIdinteger
items[].proposedCommitmentItems[].activityIdinteger (optional)
items[].proposedCommitmentItems[].descriptionstring (optional)
items[].proposedCommitmentItems[].expenseCategoryIdinteger (optional)
items[].proposedCommitmentItems[].exchangeRateIdinteger (optional)
items[].proposedCommitmentItems[].closedinteger (optional)
items[].proposedCommitmentItems[].fiscalYearIdinteger (optional)
items[].proposedCommitmentItems[].fiscalPeriodIdinteger (optional)
items[].proposedCommitmentItems[].quantitynumber (optional)
items[].proposedCommitmentItems[].pricenumber (optional)
items[].proposedCommitmentItems[].totalnumber (optional)
items[].proposedCommitmentItems[].extendedAttributesarray of PmExtendedAttribute (optional)
items[].extendedAttributesarray of PmExtendedAttribute (optional)
items[].extendedAttributes[].eaIdinteger
items[].extendedAttributes[].skipDCTSaveboolean
items[].extendedAttributes[].eaValueobject (optional)
items[].extendedAttributes[].attributeNamestring (optional)
items[].multipleValueExtendedAttributesarray of PmMultipleValueExtendedAttribute (optional)
items[].multipleValueExtendedAttributes[].parentIdinteger
items[].multipleValueExtendedAttributes[].extAttributeIdinteger
items[].multipleValueExtendedAttributes[].encodedListItemIdinteger
items[].multipleValueExtendedAttributes[].attributeNamestring (optional)
items[].rawobject (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:

ParameterTypeRequiredDescription
commitmentIdstringYesThe commitment's integer ID to reject.
bodystringYesJSON 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).
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
commitmentIdinteger
actionstring (optional)The state-change action performed: "retrieve", "submit", "cancel", "reject", or "approve".
succeededboolean
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


retrieve_commitment​

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:

ParameterTypeRequiredDescription
commitmentIdstringYesThe commitment's integer ID to retrieve back to draft.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
commitmentIdinteger
actionstring (optional)The state-change action performed: "retrieve", "submit", "cancel", "reject", or "approve".
succeededboolean
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


search_commitments​

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:

ParameterTypeRequiredDescription
querystringNoJSON object with the query (PM's operator-tree DSL, e.g. {"equals":{"FieldName":"Status","FieldValue":1}}). Omit or pass "{}" to match all commitments.
limitintegerNoMaximum number of results to return (1–50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).
sortFieldstringNoOptional field name to sort by. Omit for default ordering.
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of CommittedFundProjectionThe items returned in this response.
items[].committedIdinteger
items[].supplierIdinteger (optional)
items[].purchaseOrderNumberstring (optional)
items[].closedinteger (optional)
items[].descriptionstring (optional)Bound to the wire's description -- CommittedFund has no dedicated name field.
items[].currencyCodeinteger (optional)
items[].enteredValuenumber (optional)
items[].ownerIdinteger (optional)
items[].modifiedUserinteger (optional)
items[].modifiedDatestring (ISO 8601) (optional)
items[].creatorIdinteger (optional)
items[].createdDatestring (ISO 8601) (optional)
items[].commitmentTypeIdinteger (optional)
items[].reviewedDatestring (ISO 8601) (optional)
items[].reviewedByinteger (optional)
items[].pooledinteger (optional)
items[].contactIdinteger (optional)
items[].commitmentStatusinteger (optional)The commitment's workflow status (draft/submitted/approved/etc; PM enum, exposed as its raw int).
items[].financeGroupIdinteger (optional)
items[].totalPendingInvoicenumber (optional)
items[].baseTotalPendingInvoicenumber (optional)
items[].totalPaidInvoicenumber (optional)
items[].baseTotalPaidInvoicenumber (optional)
items[].totalPendingAndPaidInvoicenumber (optional)
items[].totalAmountnumber (optional)
items[].baseTotalAmountnumber (optional)
items[].totalOutstandingnumber (optional)
items[].baseTotalOutstandingnumber (optional)
items[].proposedTotalAmountnumber (optional)
items[].proposedBaseTotalAmountnumber (optional)
items[].commitmentItemsarray of PmCommitmentItem (optional)
items[].commitmentItems[].committedItemIdinteger
items[].commitmentItems[].committedIdinteger
items[].commitmentItems[].activityIdinteger (optional)
items[].commitmentItems[].descriptionstring (optional)
items[].commitmentItems[].expenseCategoryIdinteger (optional)
items[].commitmentItems[].exchangeRateIdinteger (optional)
items[].commitmentItems[].closedinteger (optional)
items[].commitmentItems[].fiscalYearIdinteger (optional)
items[].commitmentItems[].fiscalPeriodIdinteger (optional)
items[].commitmentItems[].quantitynumber (optional)
items[].commitmentItems[].pricenumber (optional)
items[].commitmentItems[].totalnumber (optional)
items[].commitmentItems[].extendedAttributesarray of PmExtendedAttribute (optional)
items[].proposedCommitmentItemsarray of PmCommitmentItem (optional)
items[].proposedCommitmentItems[].committedItemIdinteger
items[].proposedCommitmentItems[].committedIdinteger
items[].proposedCommitmentItems[].activityIdinteger (optional)
items[].proposedCommitmentItems[].descriptionstring (optional)
items[].proposedCommitmentItems[].expenseCategoryIdinteger (optional)
items[].proposedCommitmentItems[].exchangeRateIdinteger (optional)
items[].proposedCommitmentItems[].closedinteger (optional)
items[].proposedCommitmentItems[].fiscalYearIdinteger (optional)
items[].proposedCommitmentItems[].fiscalPeriodIdinteger (optional)
items[].proposedCommitmentItems[].quantitynumber (optional)
items[].proposedCommitmentItems[].pricenumber (optional)
items[].proposedCommitmentItems[].totalnumber (optional)
items[].proposedCommitmentItems[].extendedAttributesarray of PmExtendedAttribute (optional)
items[].extendedAttributesarray of PmExtendedAttribute (optional)
items[].extendedAttributes[].eaIdinteger
items[].extendedAttributes[].skipDCTSaveboolean
items[].extendedAttributes[].eaValueobject (optional)
items[].extendedAttributes[].attributeNamestring (optional)
items[].multipleValueExtendedAttributesarray of PmMultipleValueExtendedAttribute (optional)
items[].multipleValueExtendedAttributes[].parentIdinteger
items[].multipleValueExtendedAttributes[].extAttributeIdinteger
items[].multipleValueExtendedAttributes[].encodedListItemIdinteger
items[].multipleValueExtendedAttributes[].attributeNamestring (optional)
items[].rawobject (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:

ParameterTypeRequiredDescription
commitmentIdstringYesThe commitment's integer ID to submit.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
commitmentIdinteger
actionstring (optional)The state-change action performed: "retrieve", "submit", "cancel", "reject", or "approve".
succeededboolean
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


update_commitment​

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:

ParameterTypeRequiredDescription
commitmentIdstringYesThe commitment's integer ID.
bodystringYesJSON object with the fields to change (PM wire names). Omit fields you don't want to modify.
confirmedbooleanNoMust 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:

FieldTypeDescription
committedIdinteger
supplierIdinteger (optional)
purchaseOrderNumberstring (optional)
closedinteger (optional)
descriptionstring (optional)Bound to the wire's description -- CommittedFund has no dedicated name field.
currencyCodeinteger (optional)
enteredValuenumber (optional)
ownerIdinteger (optional)
modifiedUserinteger (optional)
modifiedDatestring (ISO 8601) (optional)
creatorIdinteger (optional)
createdDatestring (ISO 8601) (optional)
commitmentTypeIdinteger (optional)
reviewedDatestring (ISO 8601) (optional)
reviewedByinteger (optional)
pooledinteger (optional)
contactIdinteger (optional)
commitmentStatusinteger (optional)The commitment's workflow status (draft/submitted/approved/etc; PM enum, exposed as its raw int).
financeGroupIdinteger (optional)
totalPendingInvoicenumber (optional)
baseTotalPendingInvoicenumber (optional)
totalPaidInvoicenumber (optional)
baseTotalPaidInvoicenumber (optional)
totalPendingAndPaidInvoicenumber (optional)
totalAmountnumber (optional)
baseTotalAmountnumber (optional)
totalOutstandingnumber (optional)
baseTotalOutstandingnumber (optional)
proposedTotalAmountnumber (optional)
proposedBaseTotalAmountnumber (optional)
commitmentItemsarray of PmCommitmentItem (optional)
commitmentItems[].committedItemIdinteger
commitmentItems[].committedIdinteger
commitmentItems[].activityIdinteger (optional)
commitmentItems[].descriptionstring (optional)
commitmentItems[].expenseCategoryIdinteger (optional)
commitmentItems[].exchangeRateIdinteger (optional)
commitmentItems[].closedinteger (optional)
commitmentItems[].fiscalYearIdinteger (optional)
commitmentItems[].fiscalPeriodIdinteger (optional)
commitmentItems[].quantitynumber (optional)
commitmentItems[].pricenumber (optional)
commitmentItems[].totalnumber (optional)
commitmentItems[].extendedAttributesarray of PmExtendedAttribute (optional)
commitmentItems[].extendedAttributes[].eaIdinteger
commitmentItems[].extendedAttributes[].skipDCTSaveboolean
commitmentItems[].extendedAttributes[].eaValueobject (optional)
commitmentItems[].extendedAttributes[].attributeNamestring (optional)
proposedCommitmentItemsarray of PmCommitmentItem (optional)
proposedCommitmentItems[].committedItemIdinteger
proposedCommitmentItems[].committedIdinteger
proposedCommitmentItems[].activityIdinteger (optional)
proposedCommitmentItems[].descriptionstring (optional)
proposedCommitmentItems[].expenseCategoryIdinteger (optional)
proposedCommitmentItems[].exchangeRateIdinteger (optional)
proposedCommitmentItems[].closedinteger (optional)
proposedCommitmentItems[].fiscalYearIdinteger (optional)
proposedCommitmentItems[].fiscalPeriodIdinteger (optional)
proposedCommitmentItems[].quantitynumber (optional)
proposedCommitmentItems[].pricenumber (optional)
proposedCommitmentItems[].totalnumber (optional)
proposedCommitmentItems[].extendedAttributesarray of PmExtendedAttribute (optional)
proposedCommitmentItems[].extendedAttributes[].eaIdinteger
proposedCommitmentItems[].extendedAttributes[].skipDCTSaveboolean
proposedCommitmentItems[].extendedAttributes[].eaValueobject (optional)
proposedCommitmentItems[].extendedAttributes[].attributeNamestring (optional)
extendedAttributesarray of PmExtendedAttribute (optional)
extendedAttributes[].eaIdinteger
extendedAttributes[].skipDCTSaveboolean
extendedAttributes[].eaValueobject (optional)
extendedAttributes[].attributeNamestring (optional)
multipleValueExtendedAttributesarray of PmMultipleValueExtendedAttribute (optional)
multipleValueExtendedAttributes[].parentIdinteger
multipleValueExtendedAttributes[].extAttributeIdinteger
multipleValueExtendedAttributes[].encodedListItemIdinteger
multipleValueExtendedAttributes[].attributeNamestring (optional)
rawobject (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

ToolWhat it does
approve_invoiceNot currently available. Destructive. Approves an invoice that is pending approval in Aprimo Marketing Operations.
cancel_invoiceDestructive. Cancels an invoice in Aprimo Marketing Operations.
create_invoiceNot currently available. Creates a new invoice in Aprimo Marketing Operations.
delete_invoiceDestructive. Permanently deletes an invoice by its integer ID in Aprimo Marketing Operations.
get_invoiceReturns a single invoice by its integer ID in Aprimo Marketing Operations.
list_invoicesNot currently available. Lists invoices in Aprimo Marketing Operations, paged and unfiltered.
mark_invoice_sentDestructive. Marks an invoice as sent in Aprimo Marketing Operations.
reject_invoiceNot currently available. Destructive. Rejects an invoice that is pending approval in Aprimo Marketing Operations.
retrieve_invoiceDestructive. Pulls a submitted invoice back to draft status in Aprimo Marketing Operations (undoes a submission).
search_invoicesSearches invoices in Aprimo Marketing Operations that match a query, paged.
submit_invoiceDestructive. Submits an invoice for approval in Aprimo Marketing Operations.
update_invoiceUpdates 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:

ParameterTypeRequiredDescription
invoiceIdstringYesThe invoice's integer ID to approve.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
invoiceIdinteger
actionstring (optional)The state-change action performed: "retrieve", "sent", "submit", "cancel", "reject", or "approve".
succeededboolean
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


cancel_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:

ParameterTypeRequiredDescription
invoiceIdstringYesThe invoice's integer ID to cancel.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
invoiceIdinteger
actionstring (optional)The state-change action performed: "retrieve", "sent", "submit", "cancel", "reject", or "approve".
succeededboolean
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


create_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:

ParameterTypeRequiredDescription
bodystringYesJSON object with the new invoice's data (PM wire names).
confirmedbooleanNoMust 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:

FieldTypeDescription
invoiceIdinteger
supplierIdinteger (optional)
commitmentFundIdinteger (optional)
paidDatestring (ISO 8601) (optional)
currencyCodeinteger (optional)
totalInvoicenumber (optional)
baseTotalInvoicenumber (optional)
dateReceivedstring (ISO 8601) (optional)
dateDuestring (ISO 8601) (optional)
modifiedDatestring (ISO 8601) (optional)
invoiceNumberstring (optional)Bound to the wire's invoiceNumber -- Invoice has no dedicated description/name field.
modifiedUserinteger (optional)
reviewedByinteger (optional)
financeGroupIdinteger (optional)
reviewedDatestring (ISO 8601) (optional)
invoiceTypeIdinteger (optional)
pooledinteger (optional)
contactIdinteger (optional)
netinteger (optional)
statusinteger (optional)The invoice's workflow status; PM enum, exposed as its raw int.
creatorinteger (optional)
invoiceDatestring (ISO 8601) (optional)
fiscalYearIdinteger (optional)
exchangeRateIdinteger (optional)
ownerIdinteger (optional)
invoiceItemsarray of PmInvoiceItem (optional)
invoiceItems[].itemIdinteger
invoiceItems[].activityIdinteger (optional)
invoiceItems[].descriptionstring (optional)
invoiceItems[].invoiceIdinteger (optional)
invoiceItems[].quantitynumber (optional)
invoiceItems[].pricenumber (optional)
invoiceItems[].expCatIdinteger (optional)
invoiceItems[].fundingAcctIdinteger (optional)
invoiceItems[].committedFundItemIdinteger (optional)
invoiceItems[].totalnumber (optional)
invoiceItems[].extendedAttributesarray of PmExtendedAttribute (optional)
invoiceItems[].extendedAttributes[].eaIdinteger
invoiceItems[].extendedAttributes[].skipDCTSaveboolean
invoiceItems[].extendedAttributes[].eaValueobject (optional)
invoiceItems[].extendedAttributes[].attributeNamestring (optional)
sourceContentItemIdstring (optional)DAM content item id (GUID) for the invoice PDF imported via Content Coach; write-once.
extendedAttributesarray of PmExtendedAttribute (optional)
extendedAttributes[].eaIdinteger
extendedAttributes[].skipDCTSaveboolean
extendedAttributes[].eaValueobject (optional)
extendedAttributes[].attributeNamestring (optional)
multipleValueExtendedAttributesarray of PmMultipleValueExtendedAttribute (optional)
multipleValueExtendedAttributes[].parentIdinteger
multipleValueExtendedAttributes[].extAttributeIdinteger
multipleValueExtendedAttributes[].encodedListItemIdinteger
multipleValueExtendedAttributes[].attributeNamestring (optional)
rawobject (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:

ParameterTypeRequiredDescription
invoiceIdstringYesThe invoice's integer ID to delete.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
idinteger
deletedboolean
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


get_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:

ParameterTypeRequiredDescription
invoiceIdstringYesThe invoice's integer ID.

Returns:

FieldTypeDescription
invoiceIdinteger
supplierIdinteger (optional)
commitmentFundIdinteger (optional)
paidDatestring (ISO 8601) (optional)
currencyCodeinteger (optional)
totalInvoicenumber (optional)
baseTotalInvoicenumber (optional)
dateReceivedstring (ISO 8601) (optional)
dateDuestring (ISO 8601) (optional)
modifiedDatestring (ISO 8601) (optional)
invoiceNumberstring (optional)Bound to the wire's invoiceNumber -- Invoice has no dedicated description/name field.
modifiedUserinteger (optional)
reviewedByinteger (optional)
financeGroupIdinteger (optional)
reviewedDatestring (ISO 8601) (optional)
invoiceTypeIdinteger (optional)
pooledinteger (optional)
contactIdinteger (optional)
netinteger (optional)
statusinteger (optional)The invoice's workflow status; PM enum, exposed as its raw int.
creatorinteger (optional)
invoiceDatestring (ISO 8601) (optional)
fiscalYearIdinteger (optional)
exchangeRateIdinteger (optional)
ownerIdinteger (optional)
invoiceItemsarray of PmInvoiceItem (optional)
invoiceItems[].itemIdinteger
invoiceItems[].activityIdinteger (optional)
invoiceItems[].descriptionstring (optional)
invoiceItems[].invoiceIdinteger (optional)
invoiceItems[].quantitynumber (optional)
invoiceItems[].pricenumber (optional)
invoiceItems[].expCatIdinteger (optional)
invoiceItems[].fundingAcctIdinteger (optional)
invoiceItems[].committedFundItemIdinteger (optional)
invoiceItems[].totalnumber (optional)
invoiceItems[].extendedAttributesarray of PmExtendedAttribute (optional)
invoiceItems[].extendedAttributes[].eaIdinteger
invoiceItems[].extendedAttributes[].skipDCTSaveboolean
invoiceItems[].extendedAttributes[].eaValueobject (optional)
invoiceItems[].extendedAttributes[].attributeNamestring (optional)
sourceContentItemIdstring (optional)DAM content item id (GUID) for the invoice PDF imported via Content Coach; write-once.
extendedAttributesarray of PmExtendedAttribute (optional)
extendedAttributes[].eaIdinteger
extendedAttributes[].skipDCTSaveboolean
extendedAttributes[].eaValueobject (optional)
extendedAttributes[].attributeNamestring (optional)
multipleValueExtendedAttributesarray of PmMultipleValueExtendedAttribute (optional)
multipleValueExtendedAttributes[].parentIdinteger
multipleValueExtendedAttributes[].extAttributeIdinteger
multipleValueExtendedAttributes[].encodedListItemIdinteger
multipleValueExtendedAttributes[].attributeNamestring (optional)
rawobject (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:

ParameterTypeRequiredDescription
limitintegerNoMaximum number of results to return (1–50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).
sortFieldstringNoOptional field name to sort by. Omit for default ordering.
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of InvoiceProjectionThe items returned in this response.
items[].invoiceIdinteger
items[].supplierIdinteger (optional)
items[].commitmentFundIdinteger (optional)
items[].paidDatestring (ISO 8601) (optional)
items[].currencyCodeinteger (optional)
items[].totalInvoicenumber (optional)
items[].baseTotalInvoicenumber (optional)
items[].dateReceivedstring (ISO 8601) (optional)
items[].dateDuestring (ISO 8601) (optional)
items[].modifiedDatestring (ISO 8601) (optional)
items[].invoiceNumberstring (optional)Bound to the wire's invoiceNumber -- Invoice has no dedicated description/name field.
items[].modifiedUserinteger (optional)
items[].reviewedByinteger (optional)
items[].financeGroupIdinteger (optional)
items[].reviewedDatestring (ISO 8601) (optional)
items[].invoiceTypeIdinteger (optional)
items[].pooledinteger (optional)
items[].contactIdinteger (optional)
items[].netinteger (optional)
items[].statusinteger (optional)The invoice's workflow status; PM enum, exposed as its raw int.
items[].creatorinteger (optional)
items[].invoiceDatestring (ISO 8601) (optional)
items[].fiscalYearIdinteger (optional)
items[].exchangeRateIdinteger (optional)
items[].ownerIdinteger (optional)
items[].invoiceItemsarray of PmInvoiceItem (optional)
items[].invoiceItems[].itemIdinteger
items[].invoiceItems[].activityIdinteger (optional)
items[].invoiceItems[].descriptionstring (optional)
items[].invoiceItems[].invoiceIdinteger (optional)
items[].invoiceItems[].quantitynumber (optional)
items[].invoiceItems[].pricenumber (optional)
items[].invoiceItems[].expCatIdinteger (optional)
items[].invoiceItems[].fundingAcctIdinteger (optional)
items[].invoiceItems[].committedFundItemIdinteger (optional)
items[].invoiceItems[].totalnumber (optional)
items[].invoiceItems[].extendedAttributesarray of PmExtendedAttribute (optional)
items[].sourceContentItemIdstring (optional)DAM content item id (GUID) for the invoice PDF imported via Content Coach; write-once.
items[].extendedAttributesarray of PmExtendedAttribute (optional)
items[].extendedAttributes[].eaIdinteger
items[].extendedAttributes[].skipDCTSaveboolean
items[].extendedAttributes[].eaValueobject (optional)
items[].extendedAttributes[].attributeNamestring (optional)
items[].multipleValueExtendedAttributesarray of PmMultipleValueExtendedAttribute (optional)
items[].multipleValueExtendedAttributes[].parentIdinteger
items[].multipleValueExtendedAttributes[].extAttributeIdinteger
items[].multipleValueExtendedAttributes[].encodedListItemIdinteger
items[].multipleValueExtendedAttributes[].attributeNamestring (optional)
items[].rawobject (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:

ParameterTypeRequiredDescription
invoiceIdstringYesThe invoice's integer ID to mark as sent.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
invoiceIdinteger
actionstring (optional)The state-change action performed: "retrieve", "sent", "submit", "cancel", "reject", or "approve".
succeededboolean
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


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:

ParameterTypeRequiredDescription
invoiceIdstringYesThe invoice's integer ID to reject.
bodystringYesJSON 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.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
invoiceIdinteger
actionstring (optional)The state-change action performed: "retrieve", "sent", "submit", "cancel", "reject", or "approve".
succeededboolean
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


retrieve_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:

ParameterTypeRequiredDescription
invoiceIdstringYesThe invoice's integer ID to retrieve back to draft.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
invoiceIdinteger
actionstring (optional)The state-change action performed: "retrieve", "sent", "submit", "cancel", "reject", or "approve".
succeededboolean
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


search_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:

ParameterTypeRequiredDescription
querystringNoJSON object with the query (PM's operator-tree DSL, e.g. {"equals":{"FieldName":"Status","FieldValue":1}}). Omit or pass "{}" to match all invoices.
limitintegerNoMaximum number of results to return (1–50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).
sortFieldstringNoOptional field name to sort by. Omit for default ordering.
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of InvoiceProjectionThe items returned in this response.
items[].invoiceIdinteger
items[].supplierIdinteger (optional)
items[].commitmentFundIdinteger (optional)
items[].paidDatestring (ISO 8601) (optional)
items[].currencyCodeinteger (optional)
items[].totalInvoicenumber (optional)
items[].baseTotalInvoicenumber (optional)
items[].dateReceivedstring (ISO 8601) (optional)
items[].dateDuestring (ISO 8601) (optional)
items[].modifiedDatestring (ISO 8601) (optional)
items[].invoiceNumberstring (optional)Bound to the wire's invoiceNumber -- Invoice has no dedicated description/name field.
items[].modifiedUserinteger (optional)
items[].reviewedByinteger (optional)
items[].financeGroupIdinteger (optional)
items[].reviewedDatestring (ISO 8601) (optional)
items[].invoiceTypeIdinteger (optional)
items[].pooledinteger (optional)
items[].contactIdinteger (optional)
items[].netinteger (optional)
items[].statusinteger (optional)The invoice's workflow status; PM enum, exposed as its raw int.
items[].creatorinteger (optional)
items[].invoiceDatestring (ISO 8601) (optional)
items[].fiscalYearIdinteger (optional)
items[].exchangeRateIdinteger (optional)
items[].ownerIdinteger (optional)
items[].invoiceItemsarray of PmInvoiceItem (optional)
items[].invoiceItems[].itemIdinteger
items[].invoiceItems[].activityIdinteger (optional)
items[].invoiceItems[].descriptionstring (optional)
items[].invoiceItems[].invoiceIdinteger (optional)
items[].invoiceItems[].quantitynumber (optional)
items[].invoiceItems[].pricenumber (optional)
items[].invoiceItems[].expCatIdinteger (optional)
items[].invoiceItems[].fundingAcctIdinteger (optional)
items[].invoiceItems[].committedFundItemIdinteger (optional)
items[].invoiceItems[].totalnumber (optional)
items[].invoiceItems[].extendedAttributesarray of PmExtendedAttribute (optional)
items[].sourceContentItemIdstring (optional)DAM content item id (GUID) for the invoice PDF imported via Content Coach; write-once.
items[].extendedAttributesarray of PmExtendedAttribute (optional)
items[].extendedAttributes[].eaIdinteger
items[].extendedAttributes[].skipDCTSaveboolean
items[].extendedAttributes[].eaValueobject (optional)
items[].extendedAttributes[].attributeNamestring (optional)
items[].multipleValueExtendedAttributesarray of PmMultipleValueExtendedAttribute (optional)
items[].multipleValueExtendedAttributes[].parentIdinteger
items[].multipleValueExtendedAttributes[].extAttributeIdinteger
items[].multipleValueExtendedAttributes[].encodedListItemIdinteger
items[].multipleValueExtendedAttributes[].attributeNamestring (optional)
items[].rawobject (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:

ParameterTypeRequiredDescription
invoiceIdstringYesThe invoice's integer ID to submit.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
invoiceIdinteger
actionstring (optional)The state-change action performed: "retrieve", "sent", "submit", "cancel", "reject", or "approve".
succeededboolean
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


update_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:

ParameterTypeRequiredDescription
invoiceIdstringYesThe invoice's integer ID.
bodystringYesJSON object with the fields to change (PM wire names). Omit fields you don't want to modify.
confirmedbooleanNoMust 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:

FieldTypeDescription
invoiceIdinteger
supplierIdinteger (optional)
commitmentFundIdinteger (optional)
paidDatestring (ISO 8601) (optional)
currencyCodeinteger (optional)
totalInvoicenumber (optional)
baseTotalInvoicenumber (optional)
dateReceivedstring (ISO 8601) (optional)
dateDuestring (ISO 8601) (optional)
modifiedDatestring (ISO 8601) (optional)
invoiceNumberstring (optional)Bound to the wire's invoiceNumber -- Invoice has no dedicated description/name field.
modifiedUserinteger (optional)
reviewedByinteger (optional)
financeGroupIdinteger (optional)
reviewedDatestring (ISO 8601) (optional)
invoiceTypeIdinteger (optional)
pooledinteger (optional)
contactIdinteger (optional)
netinteger (optional)
statusinteger (optional)The invoice's workflow status; PM enum, exposed as its raw int.
creatorinteger (optional)
invoiceDatestring (ISO 8601) (optional)
fiscalYearIdinteger (optional)
exchangeRateIdinteger (optional)
ownerIdinteger (optional)
invoiceItemsarray of PmInvoiceItem (optional)
invoiceItems[].itemIdinteger
invoiceItems[].activityIdinteger (optional)
invoiceItems[].descriptionstring (optional)
invoiceItems[].invoiceIdinteger (optional)
invoiceItems[].quantitynumber (optional)
invoiceItems[].pricenumber (optional)
invoiceItems[].expCatIdinteger (optional)
invoiceItems[].fundingAcctIdinteger (optional)
invoiceItems[].committedFundItemIdinteger (optional)
invoiceItems[].totalnumber (optional)
invoiceItems[].extendedAttributesarray of PmExtendedAttribute (optional)
invoiceItems[].extendedAttributes[].eaIdinteger
invoiceItems[].extendedAttributes[].skipDCTSaveboolean
invoiceItems[].extendedAttributes[].eaValueobject (optional)
invoiceItems[].extendedAttributes[].attributeNamestring (optional)
sourceContentItemIdstring (optional)DAM content item id (GUID) for the invoice PDF imported via Content Coach; write-once.
extendedAttributesarray of PmExtendedAttribute (optional)
extendedAttributes[].eaIdinteger
extendedAttributes[].skipDCTSaveboolean
extendedAttributes[].eaValueobject (optional)
extendedAttributes[].attributeNamestring (optional)
multipleValueExtendedAttributesarray of PmMultipleValueExtendedAttribute (optional)
multipleValueExtendedAttributes[].parentIdinteger
multipleValueExtendedAttributes[].extAttributeIdinteger
multipleValueExtendedAttributes[].encodedListItemIdinteger
multipleValueExtendedAttributes[].attributeNamestring (optional)
rawobject (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

ToolWhat it does
cancel_journal_voucherDestructive. Cancels a journal voucher in Aprimo Marketing Operations.
create_journal_voucherCreates a new journal voucher in Aprimo Marketing Operations.
delete_journal_voucherDestructive. Permanently deletes a journal voucher by its integer ID in Aprimo Marketing Operations.
get_journal_voucherReturns a single journal voucher by its integer ID in Aprimo Marketing Operations.
list_journal_vouchersLists journal vouchers in Aprimo Marketing Operations, paged and unfiltered.
mark_journal_voucher_sentNot currently available. Destructive. Marks a journal voucher as sent in Aprimo Marketing Operations.
reconcile_journal_voucherDestructive. Reconciles a journal voucher in Aprimo Marketing Operations.
reject_journal_voucherNot currently available. Destructive. Rejects a journal voucher that is pending approval in Aprimo Marketing Operations.
search_journal_vouchersSearches journal vouchers in Aprimo Marketing Operations that match a query, paged.
submit_journal_voucherDestructive. Submits a journal voucher for approval in Aprimo Marketing Operations.
update_journal_voucherUpdates 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:

ParameterTypeRequiredDescription
journalVoucherIdstringYesThe journal voucher's integer ID to cancel.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
journalVoucherIdinteger
actionstring (optional)The state-change action performed: "sent", "cancel", "submit", "reconcile", or "reject".
succeededboolean
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


create_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:

ParameterTypeRequiredDescription
bodystringYesJSON object with the new journal voucher's data (PM wire names).
confirmedbooleanNoMust 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:

FieldTypeDescription
journalVoucherIdinteger
namestring (optional)Always null -- JournalVoucher has no name-like field on the wire. See the class remarks.
invoiceIdinteger (optional)
committedFundIdinteger (optional)
supplierIdinteger (optional)
contactIdinteger (optional)
journalVoucherDatestring (ISO 8601) (optional)
creatorIdinteger (optional)
currencyCodeinteger (optional)
fiscalYearIdinteger (optional)
journalVoucherStatusinteger (optional)The journal voucher's workflow status; PM enum, exposed as its raw int.
postedDatestring (ISO 8601) (optional)
sendToGlIntegrationinteger (optional)
modifiedUserinteger (optional)
modifiedDatestring (ISO 8601) (optional)
exchangeRateIdinteger (optional)
multipleActivitiesinteger (optional)
glOverriddeninteger (optional)
journalVoucherTypeIdinteger (optional)
jvTotalnumber (optional)
baseTotalJvnumber (optional)
financeGroupIdinteger (optional)
journalVoucherItemsarray of PmJournalVoucherItem (optional)
journalVoucherItems[].jvItemIdinteger
journalVoucherItems[].journalVoucherIdinteger
journalVoucherItems[].committedFundItemIdinteger (optional)
journalVoucherItems[].descriptionstring (optional)
journalVoucherItems[].quantitynumber (optional)
journalVoucherItems[].pricenumber (optional)
journalVoucherItems[].activityIdinteger (optional)
journalVoucherItems[].expCatIdinteger (optional)
journalVoucherItems[].fundingAcctIdinteger (optional)
journalVoucherItems[].itemIdinteger (optional)
journalVoucherItems[].totalnumber (optional)
journalVoucherItems[].extendedAttributesarray of PmExtendedAttribute (optional)
journalVoucherItems[].extendedAttributes[].eaIdinteger
journalVoucherItems[].extendedAttributes[].skipDCTSaveboolean
journalVoucherItems[].extendedAttributes[].eaValueobject (optional)
journalVoucherItems[].extendedAttributes[].attributeNamestring (optional)
extendedAttributesarray of PmExtendedAttribute (optional)
extendedAttributes[].eaIdinteger
extendedAttributes[].skipDCTSaveboolean
extendedAttributes[].eaValueobject (optional)
extendedAttributes[].attributeNamestring (optional)
multipleValueExtendedAttributesarray of PmMultipleValueExtendedAttribute (optional)
multipleValueExtendedAttributes[].parentIdinteger
multipleValueExtendedAttributes[].extAttributeIdinteger
multipleValueExtendedAttributes[].encodedListItemIdinteger
multipleValueExtendedAttributes[].attributeNamestring (optional)
rawobject (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:

ParameterTypeRequiredDescription
journalVoucherIdstringYesThe journal voucher's integer ID to delete.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
idinteger
deletedboolean
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


get_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:

ParameterTypeRequiredDescription
journalVoucherIdstringYesThe journal voucher's integer ID.

Returns:

FieldTypeDescription
journalVoucherIdinteger
namestring (optional)Always null -- JournalVoucher has no name-like field on the wire. See the class remarks.
invoiceIdinteger (optional)
committedFundIdinteger (optional)
supplierIdinteger (optional)
contactIdinteger (optional)
journalVoucherDatestring (ISO 8601) (optional)
creatorIdinteger (optional)
currencyCodeinteger (optional)
fiscalYearIdinteger (optional)
journalVoucherStatusinteger (optional)The journal voucher's workflow status; PM enum, exposed as its raw int.
postedDatestring (ISO 8601) (optional)
sendToGlIntegrationinteger (optional)
modifiedUserinteger (optional)
modifiedDatestring (ISO 8601) (optional)
exchangeRateIdinteger (optional)
multipleActivitiesinteger (optional)
glOverriddeninteger (optional)
journalVoucherTypeIdinteger (optional)
jvTotalnumber (optional)
baseTotalJvnumber (optional)
financeGroupIdinteger (optional)
journalVoucherItemsarray of PmJournalVoucherItem (optional)
journalVoucherItems[].jvItemIdinteger
journalVoucherItems[].journalVoucherIdinteger
journalVoucherItems[].committedFundItemIdinteger (optional)
journalVoucherItems[].descriptionstring (optional)
journalVoucherItems[].quantitynumber (optional)
journalVoucherItems[].pricenumber (optional)
journalVoucherItems[].activityIdinteger (optional)
journalVoucherItems[].expCatIdinteger (optional)
journalVoucherItems[].fundingAcctIdinteger (optional)
journalVoucherItems[].itemIdinteger (optional)
journalVoucherItems[].totalnumber (optional)
journalVoucherItems[].extendedAttributesarray of PmExtendedAttribute (optional)
journalVoucherItems[].extendedAttributes[].eaIdinteger
journalVoucherItems[].extendedAttributes[].skipDCTSaveboolean
journalVoucherItems[].extendedAttributes[].eaValueobject (optional)
journalVoucherItems[].extendedAttributes[].attributeNamestring (optional)
extendedAttributesarray of PmExtendedAttribute (optional)
extendedAttributes[].eaIdinteger
extendedAttributes[].skipDCTSaveboolean
extendedAttributes[].eaValueobject (optional)
extendedAttributes[].attributeNamestring (optional)
multipleValueExtendedAttributesarray of PmMultipleValueExtendedAttribute (optional)
multipleValueExtendedAttributes[].parentIdinteger
multipleValueExtendedAttributes[].extAttributeIdinteger
multipleValueExtendedAttributes[].encodedListItemIdinteger
multipleValueExtendedAttributes[].attributeNamestring (optional)
rawobject (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:

ParameterTypeRequiredDescription
limitintegerNoMaximum number of results to return (1–50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).
sortFieldstringNoOptional field name to sort by. Omit for default ordering.
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of JournalVoucherProjectionThe items returned in this response.
items[].journalVoucherIdinteger
items[].namestring (optional)Always null -- JournalVoucher has no name-like field on the wire. See the class remarks.
items[].invoiceIdinteger (optional)
items[].committedFundIdinteger (optional)
items[].supplierIdinteger (optional)
items[].contactIdinteger (optional)
items[].journalVoucherDatestring (ISO 8601) (optional)
items[].creatorIdinteger (optional)
items[].currencyCodeinteger (optional)
items[].fiscalYearIdinteger (optional)
items[].journalVoucherStatusinteger (optional)The journal voucher's workflow status; PM enum, exposed as its raw int.
items[].postedDatestring (ISO 8601) (optional)
items[].sendToGlIntegrationinteger (optional)
items[].modifiedUserinteger (optional)
items[].modifiedDatestring (ISO 8601) (optional)
items[].exchangeRateIdinteger (optional)
items[].multipleActivitiesinteger (optional)
items[].glOverriddeninteger (optional)
items[].journalVoucherTypeIdinteger (optional)
items[].jvTotalnumber (optional)
items[].baseTotalJvnumber (optional)
items[].financeGroupIdinteger (optional)
items[].journalVoucherItemsarray of PmJournalVoucherItem (optional)
items[].journalVoucherItems[].jvItemIdinteger
items[].journalVoucherItems[].journalVoucherIdinteger
items[].journalVoucherItems[].committedFundItemIdinteger (optional)
items[].journalVoucherItems[].descriptionstring (optional)
items[].journalVoucherItems[].quantitynumber (optional)
items[].journalVoucherItems[].pricenumber (optional)
items[].journalVoucherItems[].activityIdinteger (optional)
items[].journalVoucherItems[].expCatIdinteger (optional)
items[].journalVoucherItems[].fundingAcctIdinteger (optional)
items[].journalVoucherItems[].itemIdinteger (optional)
items[].journalVoucherItems[].totalnumber (optional)
items[].journalVoucherItems[].extendedAttributesarray of PmExtendedAttribute (optional)
items[].extendedAttributesarray of PmExtendedAttribute (optional)
items[].extendedAttributes[].eaIdinteger
items[].extendedAttributes[].skipDCTSaveboolean
items[].extendedAttributes[].eaValueobject (optional)
items[].extendedAttributes[].attributeNamestring (optional)
items[].multipleValueExtendedAttributesarray of PmMultipleValueExtendedAttribute (optional)
items[].multipleValueExtendedAttributes[].parentIdinteger
items[].multipleValueExtendedAttributes[].extAttributeIdinteger
items[].multipleValueExtendedAttributes[].encodedListItemIdinteger
items[].multipleValueExtendedAttributes[].attributeNamestring (optional)
items[].rawobject (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:

ParameterTypeRequiredDescription
journalVoucherIdstringYesThe journal voucher's integer ID to mark as sent.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
journalVoucherIdinteger
actionstring (optional)The state-change action performed: "sent", "cancel", "submit", "reconcile", or "reject".
succeededboolean
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


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:

ParameterTypeRequiredDescription
journalVoucherIdstringYesThe journal voucher's integer ID to reconcile.
bodystringYesJSON object with the reconciliation details PM expects. Pass "{}" if none apply.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
journalVoucherIdinteger
actionstring (optional)The state-change action performed: "sent", "cancel", "submit", "reconcile", or "reject".
succeededboolean
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


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:

ParameterTypeRequiredDescription
journalVoucherIdstringYesThe journal voucher's integer ID to reject.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
journalVoucherIdinteger
actionstring (optional)The state-change action performed: "sent", "cancel", "submit", "reconcile", or "reject".
succeededboolean
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


search_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:

ParameterTypeRequiredDescription
querystringNoJSON object with the query (PM's operator-tree DSL, e.g. {"equals":{"FieldName":"Status","FieldValue":1}}). Omit or pass "{}" to match all journal vouchers.
limitintegerNoMaximum number of results to return (1–50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).
sortFieldstringNoOptional field name to sort by. Omit for default ordering.
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of JournalVoucherProjectionThe items returned in this response.
items[].journalVoucherIdinteger
items[].namestring (optional)Always null -- JournalVoucher has no name-like field on the wire. See the class remarks.
items[].invoiceIdinteger (optional)
items[].committedFundIdinteger (optional)
items[].supplierIdinteger (optional)
items[].contactIdinteger (optional)
items[].journalVoucherDatestring (ISO 8601) (optional)
items[].creatorIdinteger (optional)
items[].currencyCodeinteger (optional)
items[].fiscalYearIdinteger (optional)
items[].journalVoucherStatusinteger (optional)The journal voucher's workflow status; PM enum, exposed as its raw int.
items[].postedDatestring (ISO 8601) (optional)
items[].sendToGlIntegrationinteger (optional)
items[].modifiedUserinteger (optional)
items[].modifiedDatestring (ISO 8601) (optional)
items[].exchangeRateIdinteger (optional)
items[].multipleActivitiesinteger (optional)
items[].glOverriddeninteger (optional)
items[].journalVoucherTypeIdinteger (optional)
items[].jvTotalnumber (optional)
items[].baseTotalJvnumber (optional)
items[].financeGroupIdinteger (optional)
items[].journalVoucherItemsarray of PmJournalVoucherItem (optional)
items[].journalVoucherItems[].jvItemIdinteger
items[].journalVoucherItems[].journalVoucherIdinteger
items[].journalVoucherItems[].committedFundItemIdinteger (optional)
items[].journalVoucherItems[].descriptionstring (optional)
items[].journalVoucherItems[].quantitynumber (optional)
items[].journalVoucherItems[].pricenumber (optional)
items[].journalVoucherItems[].activityIdinteger (optional)
items[].journalVoucherItems[].expCatIdinteger (optional)
items[].journalVoucherItems[].fundingAcctIdinteger (optional)
items[].journalVoucherItems[].itemIdinteger (optional)
items[].journalVoucherItems[].totalnumber (optional)
items[].journalVoucherItems[].extendedAttributesarray of PmExtendedAttribute (optional)
items[].extendedAttributesarray of PmExtendedAttribute (optional)
items[].extendedAttributes[].eaIdinteger
items[].extendedAttributes[].skipDCTSaveboolean
items[].extendedAttributes[].eaValueobject (optional)
items[].extendedAttributes[].attributeNamestring (optional)
items[].multipleValueExtendedAttributesarray of PmMultipleValueExtendedAttribute (optional)
items[].multipleValueExtendedAttributes[].parentIdinteger
items[].multipleValueExtendedAttributes[].extAttributeIdinteger
items[].multipleValueExtendedAttributes[].encodedListItemIdinteger
items[].multipleValueExtendedAttributes[].attributeNamestring (optional)
items[].rawobject (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:

ParameterTypeRequiredDescription
journalVoucherIdstringYesThe journal voucher's integer ID to submit.
bodystringYesJSON object with the submission details PM expects. Pass "{}" if none apply.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
journalVoucherIdinteger
actionstring (optional)The state-change action performed: "sent", "cancel", "submit", "reconcile", or "reject".
succeededboolean
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


update_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:

ParameterTypeRequiredDescription
journalVoucherIdstringYesThe journal voucher's integer ID.
bodystringYesJSON object with the fields to change (PM wire names). Omit fields you don't want to modify.
confirmedbooleanNoMust 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:

FieldTypeDescription
journalVoucherIdinteger
namestring (optional)Always null -- JournalVoucher has no name-like field on the wire. See the class remarks.
invoiceIdinteger (optional)
committedFundIdinteger (optional)
supplierIdinteger (optional)
contactIdinteger (optional)
journalVoucherDatestring (ISO 8601) (optional)
creatorIdinteger (optional)
currencyCodeinteger (optional)
fiscalYearIdinteger (optional)
journalVoucherStatusinteger (optional)The journal voucher's workflow status; PM enum, exposed as its raw int.
postedDatestring (ISO 8601) (optional)
sendToGlIntegrationinteger (optional)
modifiedUserinteger (optional)
modifiedDatestring (ISO 8601) (optional)
exchangeRateIdinteger (optional)
multipleActivitiesinteger (optional)
glOverriddeninteger (optional)
journalVoucherTypeIdinteger (optional)
jvTotalnumber (optional)
baseTotalJvnumber (optional)
financeGroupIdinteger (optional)
journalVoucherItemsarray of PmJournalVoucherItem (optional)
journalVoucherItems[].jvItemIdinteger
journalVoucherItems[].journalVoucherIdinteger
journalVoucherItems[].committedFundItemIdinteger (optional)
journalVoucherItems[].descriptionstring (optional)
journalVoucherItems[].quantitynumber (optional)
journalVoucherItems[].pricenumber (optional)
journalVoucherItems[].activityIdinteger (optional)
journalVoucherItems[].expCatIdinteger (optional)
journalVoucherItems[].fundingAcctIdinteger (optional)
journalVoucherItems[].itemIdinteger (optional)
journalVoucherItems[].totalnumber (optional)
journalVoucherItems[].extendedAttributesarray of PmExtendedAttribute (optional)
journalVoucherItems[].extendedAttributes[].eaIdinteger
journalVoucherItems[].extendedAttributes[].skipDCTSaveboolean
journalVoucherItems[].extendedAttributes[].eaValueobject (optional)
journalVoucherItems[].extendedAttributes[].attributeNamestring (optional)
extendedAttributesarray of PmExtendedAttribute (optional)
extendedAttributes[].eaIdinteger
extendedAttributes[].skipDCTSaveboolean
extendedAttributes[].eaValueobject (optional)
extendedAttributes[].attributeNamestring (optional)
multipleValueExtendedAttributesarray of PmMultipleValueExtendedAttribute (optional)
multipleValueExtendedAttributes[].parentIdinteger
multipleValueExtendedAttributes[].extAttributeIdinteger
multipleValueExtendedAttributes[].encodedListItemIdinteger
multipleValueExtendedAttributes[].attributeNamestring (optional)
rawobject (optional)The complete wire object, verbatim. See .