Invoices & Journal Vouchers
Tools for invoices and journal vouchers — creating, approving, cancelling, and reading them and their line items.
This page covers 23 tools, all of them available on request rather than in the default tool list, and 13 destructive.
How to read this page
- Status — In the default tool list means the tool is one of the ~200 Aprimo advertises to every agent out of the box, so the agent discovers and calls it on its own. Available on request means the tool is registered and fully callable, but sits outside that default list — call it by name, or ask Aprimo to extend the list your tenant is served.
- Both statuses work identically when called. Status affects discovery, not capability or authorization.
- Visibility is not authorization. Every tool call executes as the authenticated user, and any tool can return an authorization error if that user lacks rights to the record, task, or file. See the MCP Tool Permission Map.
- Destructive tools are labelled as such. They delete or irreversibly overwrite data, and will not act unless the call sets both
confirmedandconfirmedDestructivetotrue. - Activity and Project labels vary by tenant. Where this page says Activity or Project, your tenant's own configured terminology is substituted at runtime.
Why isn't every tool in the default list?
Aprimo's MCP Server exposes far more tools than most MCP clients handle well — many degrade or truncate their tool list well below the full catalogue. Rather than let a client truncate arbitrarily, Aprimo advertises a curated set of roughly 200 tools covering the tasks customers most commonly automate. Everything outside that set remains fully supported and callable by name; it simply isn't offered up front. If your integration leans on a tool that is available on request, talk to your Aprimo Customer Success Manager about extending the advertised list for your tenant.
Tools at a Glance
| Tool | Status | What it does |
|---|---|---|
approve_invoice | On request | Destructive. Approves an invoice that is pending approval in Aprimo Marketing Operations. |
cancel_invoice | On request | Destructive. Cancels an invoice in Aprimo Marketing Operations. |
cancel_journal_voucher | On request | Destructive. Cancels a journal voucher in Aprimo Marketing Operations. |
create_invoice | On request | Creates a new invoice in Aprimo Marketing Operations. |
create_journal_voucher | On request | Creates a new journal voucher in Aprimo Marketing Operations. |
delete_invoice | On request | Destructive. Permanently deletes an invoice by its integer ID in Aprimo Marketing Operations. |
delete_journal_voucher | On request | Destructive. Permanently deletes a journal voucher by its integer ID in Aprimo Marketing Operations. |
get_invoice | On request | Returns a single invoice by its integer ID in Aprimo Marketing Operations. |
get_journal_voucher | On request | Returns a single journal voucher by its integer ID in Aprimo Marketing Operations. |
list_invoices | On request | Lists invoices in Aprimo Marketing Operations, paged and unfiltered. |
list_journal_vouchers | On request | Lists journal vouchers in Aprimo Marketing Operations, paged and unfiltered. |
mark_invoice_sent | On request | Destructive. Marks an invoice as sent in Aprimo Marketing Operations. |
mark_journal_voucher_sent | On request | Destructive. Marks a journal voucher as sent in Aprimo Marketing Operations. |
reconcile_journal_voucher | On request | Destructive. Reconciles a journal voucher in Aprimo Marketing Operations. |
reject_invoice | On request | Destructive. Rejects an invoice that is pending approval in Aprimo Marketing Operations. |
reject_journal_voucher | On request | Destructive. Rejects a journal voucher that is pending approval in Aprimo Marketing Operations. |
retrieve_invoice | On request | Destructive. Pulls a submitted invoice back to draft status in Aprimo Marketing Operations (undoes a submission). |
search_invoices | On request | Searches invoices in Aprimo Marketing Operations that match a query, paged. |
search_journal_vouchers | On request | Searches journal vouchers in Aprimo Marketing Operations that match a query, paged. |
submit_invoice | On request | Destructive. Submits an invoice for approval in Aprimo Marketing Operations. |
submit_journal_voucher | On request | Destructive. Submits a journal voucher for approval in Aprimo Marketing Operations. |
update_invoice | On request | Updates an existing invoice by its integer ID in Aprimo Marketing Operations. |
update_journal_voucher | On request | Updates an existing journal voucher by its integer ID in Aprimo Marketing Operations. |
approve_invoice
Available on request · Destructive
Approves an invoice that is pending approval in Aprimo Marketing Operations. This is a state change. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact invoice with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
invoiceId | string | Yes | The invoice's integer ID to approve. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — approving an invoice changes its state. Set only after stating the exact invoice to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
invoiceId | integer | |
action | string (optional) | The state-change action performed: "retrieve", "sent", "submit", "cancel", "reject", or "approve". |
succeeded | boolean |
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
Available on request · Destructive
Cancels an invoice in Aprimo Marketing Operations. This is a state change that terminates the invoice's workflow. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact invoice with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
invoiceId | string | Yes | The invoice's integer ID to cancel. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — cancelling an invoice changes its state. Set only after stating the exact invoice to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
invoiceId | integer | |
action | string (optional) | The state-change action performed: "retrieve", "sent", "submit", "cancel", "reject", or "approve". |
succeeded | boolean |
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_journal_voucher
Available on request · Destructive
Cancels a journal voucher in Aprimo Marketing Operations. This is a state change that terminates the journal voucher's workflow. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact journal voucher with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
journalVoucherId | string | Yes | The journal voucher's integer ID to cancel. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — cancelling a journal voucher changes its state. Set only after stating the exact journal voucher to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
journalVoucherId | integer | |
action | string (optional) | The state-change action performed: "sent", "cancel", "submit", "reconcile", or "reject". |
succeeded | boolean |
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
Available on request
Creates a new invoice in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the created invoice.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
body | string | Yes | JSON object with the new invoice's data (PM wire names). |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload. |
Returns:
| Field | Type | Description |
|---|---|---|
invoiceId | integer | |
supplierId | integer (optional) | |
commitmentFundId | integer (optional) | |
paidDate | string (ISO 8601) (optional) | |
currencyCode | integer (optional) | |
totalInvoice | number (optional) | |
baseTotalInvoice | number (optional) | |
dateReceived | string (ISO 8601) (optional) | |
dateDue | string (ISO 8601) (optional) | |
modifiedDate | string (ISO 8601) (optional) | |
invoiceNumber | string (optional) | Bound to the wire's invoiceNumber -- Invoice has no dedicated description/name field. |
modifiedUser | integer (optional) | |
reviewedBy | integer (optional) | |
financeGroupId | integer (optional) | |
reviewedDate | string (ISO 8601) (optional) | |
invoiceTypeId | integer (optional) | |
pooled | integer (optional) | |
contactId | integer (optional) | |
net | integer (optional) | |
status | integer (optional) | The invoice's workflow status; PM enum, exposed as its raw int. |
creator | integer (optional) | |
invoiceDate | string (ISO 8601) (optional) | |
fiscalYearId | integer (optional) | |
exchangeRateId | integer (optional) | |
ownerId | integer (optional) | |
invoiceItems | array of PmInvoiceItem (optional) | |
invoiceItems[].itemId | integer | |
invoiceItems[].activityId | integer (optional) | |
invoiceItems[].description | string (optional) | |
invoiceItems[].invoiceId | integer (optional) | |
invoiceItems[].quantity | number (optional) | |
invoiceItems[].price | number (optional) | |
invoiceItems[].expCatId | integer (optional) | |
invoiceItems[].fundingAcctId | integer (optional) | |
invoiceItems[].committedFundItemId | integer (optional) | |
invoiceItems[].total | number (optional) | |
invoiceItems[].extendedAttributes | array of PmExtendedAttribute (optional) | |
invoiceItems[].extendedAttributes[].eaId | integer | |
invoiceItems[].extendedAttributes[].skipDCTSave | boolean | |
invoiceItems[].extendedAttributes[].eaValue | object (optional) | |
invoiceItems[].extendedAttributes[].attributeName | string (optional) | |
sourceContentItemId | string (optional) | DAM content item id (GUID) for the invoice PDF imported via Content Coach; write-once. |
extendedAttributes | array of PmExtendedAttribute (optional) | |
extendedAttributes[].eaId | integer | |
extendedAttributes[].skipDCTSave | boolean | |
extendedAttributes[].eaValue | object (optional) | |
extendedAttributes[].attributeName | string (optional) | |
multipleValueExtendedAttributes | array of PmMultipleValueExtendedAttribute (optional) | |
multipleValueExtendedAttributes[].parentId | integer | |
multipleValueExtendedAttributes[].extAttributeId | integer | |
multipleValueExtendedAttributes[].encodedListItemId | integer | |
multipleValueExtendedAttributes[].attributeName | string (optional) | |
raw | object (optional) | The complete wire object, verbatim. See . |
create_journal_voucher
Available on request
Creates a new journal voucher in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the created journal voucher.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
body | string | Yes | JSON object with the new journal voucher's data (PM wire names). |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload. |
Returns:
| Field | Type | Description |
|---|---|---|
journalVoucherId | integer | |
name | string (optional) | Always null -- JournalVoucher has no name-like field on the wire. See the class remarks. |
invoiceId | integer (optional) | |
committedFundId | integer (optional) | |
supplierId | integer (optional) | |
contactId | integer (optional) | |
journalVoucherDate | string (ISO 8601) (optional) | |
creatorId | integer (optional) | |
currencyCode | integer (optional) | |
fiscalYearId | integer (optional) | |
journalVoucherStatus | integer (optional) | The journal voucher's workflow status; PM enum, exposed as its raw int. |
postedDate | string (ISO 8601) (optional) | |
sendToGlIntegration | integer (optional) | |
modifiedUser | integer (optional) | |
modifiedDate | string (ISO 8601) (optional) | |
exchangeRateId | integer (optional) | |
multipleActivities | integer (optional) | |
glOverridden | integer (optional) | |
journalVoucherTypeId | integer (optional) | |
jvTotal | number (optional) | |
baseTotalJv | number (optional) | |
financeGroupId | integer (optional) | |
journalVoucherItems | array of PmJournalVoucherItem (optional) | |
journalVoucherItems[].jvItemId | integer | |
journalVoucherItems[].journalVoucherId | integer | |
journalVoucherItems[].committedFundItemId | integer (optional) | |
journalVoucherItems[].description | string (optional) | |
journalVoucherItems[].quantity | number (optional) | |
journalVoucherItems[].price | number (optional) | |
journalVoucherItems[].activityId | integer (optional) | |
journalVoucherItems[].expCatId | integer (optional) | |
journalVoucherItems[].fundingAcctId | integer (optional) | |
journalVoucherItems[].itemId | integer (optional) | |
journalVoucherItems[].total | number (optional) | |
journalVoucherItems[].extendedAttributes | array of PmExtendedAttribute (optional) | |
journalVoucherItems[].extendedAttributes[].eaId | integer | |
journalVoucherItems[].extendedAttributes[].skipDCTSave | boolean | |
journalVoucherItems[].extendedAttributes[].eaValue | object (optional) | |
journalVoucherItems[].extendedAttributes[].attributeName | string (optional) | |
extendedAttributes | array of PmExtendedAttribute (optional) | |
extendedAttributes[].eaId | integer | |
extendedAttributes[].skipDCTSave | boolean | |
extendedAttributes[].eaValue | object (optional) | |
extendedAttributes[].attributeName | string (optional) | |
multipleValueExtendedAttributes | array of PmMultipleValueExtendedAttribute (optional) | |
multipleValueExtendedAttributes[].parentId | integer | |
multipleValueExtendedAttributes[].extAttributeId | integer | |
multipleValueExtendedAttributes[].encodedListItemId | integer | |
multipleValueExtendedAttributes[].attributeName | string (optional) | |
raw | object (optional) | The complete wire object, verbatim. See . |
delete_invoice
Available on request · Destructive
Permanently deletes an invoice by its integer ID in Aprimo Marketing Operations. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact invoice with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
invoiceId | string | Yes | The invoice's integer ID to delete. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — deleting an invoice is permanent and cannot be undone. Set only after stating the exact invoice to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
deleted | boolean |
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.
delete_journal_voucher
Available on request · Destructive
Permanently deletes a journal voucher by its integer ID in Aprimo Marketing Operations. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact journal voucher with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
journalVoucherId | string | Yes | The journal voucher's integer ID to delete. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — deleting a journal voucher is permanent and cannot be undone. Set only after stating the exact journal voucher to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
deleted | boolean |
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
Available on request
Returns a single invoice by its integer ID in Aprimo Marketing Operations.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
invoiceId | string | Yes | The invoice's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
invoiceId | integer | |
supplierId | integer (optional) | |
commitmentFundId | integer (optional) | |
paidDate | string (ISO 8601) (optional) | |
currencyCode | integer (optional) | |
totalInvoice | number (optional) | |
baseTotalInvoice | number (optional) | |
dateReceived | string (ISO 8601) (optional) | |
dateDue | string (ISO 8601) (optional) | |
modifiedDate | string (ISO 8601) (optional) | |
invoiceNumber | string (optional) | Bound to the wire's invoiceNumber -- Invoice has no dedicated description/name field. |
modifiedUser | integer (optional) | |
reviewedBy | integer (optional) | |
financeGroupId | integer (optional) | |
reviewedDate | string (ISO 8601) (optional) | |
invoiceTypeId | integer (optional) | |
pooled | integer (optional) | |
contactId | integer (optional) | |
net | integer (optional) | |
status | integer (optional) | The invoice's workflow status; PM enum, exposed as its raw int. |
creator | integer (optional) | |
invoiceDate | string (ISO 8601) (optional) | |
fiscalYearId | integer (optional) | |
exchangeRateId | integer (optional) | |
ownerId | integer (optional) | |
invoiceItems | array of PmInvoiceItem (optional) | |
invoiceItems[].itemId | integer | |
invoiceItems[].activityId | integer (optional) | |
invoiceItems[].description | string (optional) | |
invoiceItems[].invoiceId | integer (optional) | |
invoiceItems[].quantity | number (optional) | |
invoiceItems[].price | number (optional) | |
invoiceItems[].expCatId | integer (optional) | |
invoiceItems[].fundingAcctId | integer (optional) | |
invoiceItems[].committedFundItemId | integer (optional) | |
invoiceItems[].total | number (optional) | |
invoiceItems[].extendedAttributes | array of PmExtendedAttribute (optional) | |
invoiceItems[].extendedAttributes[].eaId | integer | |
invoiceItems[].extendedAttributes[].skipDCTSave | boolean | |
invoiceItems[].extendedAttributes[].eaValue | object (optional) | |
invoiceItems[].extendedAttributes[].attributeName | string (optional) | |
sourceContentItemId | string (optional) | DAM content item id (GUID) for the invoice PDF imported via Content Coach; write-once. |
extendedAttributes | array of PmExtendedAttribute (optional) | |
extendedAttributes[].eaId | integer | |
extendedAttributes[].skipDCTSave | boolean | |
extendedAttributes[].eaValue | object (optional) | |
extendedAttributes[].attributeName | string (optional) | |
multipleValueExtendedAttributes | array of PmMultipleValueExtendedAttribute (optional) | |
multipleValueExtendedAttributes[].parentId | integer | |
multipleValueExtendedAttributes[].extAttributeId | integer | |
multipleValueExtendedAttributes[].encodedListItemId | integer | |
multipleValueExtendedAttributes[].attributeName | string (optional) | |
raw | object (optional) | The complete wire object, verbatim. See . |
get_journal_voucher
Available on request
Returns a single journal voucher by its integer ID in Aprimo Marketing Operations.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
journalVoucherId | string | Yes | The journal voucher's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
journalVoucherId | integer | |
name | string (optional) | Always null -- JournalVoucher has no name-like field on the wire. See the class remarks. |
invoiceId | integer (optional) | |
committedFundId | integer (optional) | |
supplierId | integer (optional) | |
contactId | integer (optional) | |
journalVoucherDate | string (ISO 8601) (optional) | |
creatorId | integer (optional) | |
currencyCode | integer (optional) | |
fiscalYearId | integer (optional) | |
journalVoucherStatus | integer (optional) | The journal voucher's workflow status; PM enum, exposed as its raw int. |
postedDate | string (ISO 8601) (optional) | |
sendToGlIntegration | integer (optional) | |
modifiedUser | integer (optional) | |
modifiedDate | string (ISO 8601) (optional) | |
exchangeRateId | integer (optional) | |
multipleActivities | integer (optional) | |
glOverridden | integer (optional) | |
journalVoucherTypeId | integer (optional) | |
jvTotal | number (optional) | |
baseTotalJv | number (optional) | |
financeGroupId | integer (optional) | |
journalVoucherItems | array of PmJournalVoucherItem (optional) | |
journalVoucherItems[].jvItemId | integer | |
journalVoucherItems[].journalVoucherId | integer | |
journalVoucherItems[].committedFundItemId | integer (optional) | |
journalVoucherItems[].description | string (optional) | |
journalVoucherItems[].quantity | number (optional) | |
journalVoucherItems[].price | number (optional) | |
journalVoucherItems[].activityId | integer (optional) | |
journalVoucherItems[].expCatId | integer (optional) | |
journalVoucherItems[].fundingAcctId | integer (optional) | |
journalVoucherItems[].itemId | integer (optional) | |
journalVoucherItems[].total | number (optional) | |
journalVoucherItems[].extendedAttributes | array of PmExtendedAttribute (optional) | |
journalVoucherItems[].extendedAttributes[].eaId | integer | |
journalVoucherItems[].extendedAttributes[].skipDCTSave | boolean | |
journalVoucherItems[].extendedAttributes[].eaValue | object (optional) | |
journalVoucherItems[].extendedAttributes[].attributeName | string (optional) | |
extendedAttributes | array of PmExtendedAttribute (optional) | |
extendedAttributes[].eaId | integer | |
extendedAttributes[].skipDCTSave | boolean | |
extendedAttributes[].eaValue | object (optional) | |
extendedAttributes[].attributeName | string (optional) | |
multipleValueExtendedAttributes | array of PmMultipleValueExtendedAttribute (optional) | |
multipleValueExtendedAttributes[].parentId | integer | |
multipleValueExtendedAttributes[].extAttributeId | integer | |
multipleValueExtendedAttributes[].encodedListItemId | integer | |
multipleValueExtendedAttributes[].attributeName | string (optional) | |
raw | object (optional) | The complete wire object, verbatim. See . |
list_invoices
Available on request
Lists invoices in Aprimo Marketing Operations, paged and unfiltered. Use search_invoices when you need to filter.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sortField | string | No | Optional field name to sort by. Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of InvoiceProjection | The items returned in this response. |
items[].invoiceId | integer | |
items[].supplierId | integer (optional) | |
items[].commitmentFundId | integer (optional) | |
items[].paidDate | string (ISO 8601) (optional) | |
items[].currencyCode | integer (optional) | |
items[].totalInvoice | number (optional) | |
items[].baseTotalInvoice | number (optional) | |
items[].dateReceived | string (ISO 8601) (optional) | |
items[].dateDue | string (ISO 8601) (optional) | |
items[].modifiedDate | string (ISO 8601) (optional) | |
items[].invoiceNumber | string (optional) | Bound to the wire's invoiceNumber -- Invoice has no dedicated description/name field. |
items[].modifiedUser | integer (optional) | |
items[].reviewedBy | integer (optional) | |
items[].financeGroupId | integer (optional) | |
items[].reviewedDate | string (ISO 8601) (optional) | |
items[].invoiceTypeId | integer (optional) | |
items[].pooled | integer (optional) | |
items[].contactId | integer (optional) | |
items[].net | integer (optional) | |
items[].status | integer (optional) | The invoice's workflow status; PM enum, exposed as its raw int. |
items[].creator | integer (optional) | |
items[].invoiceDate | string (ISO 8601) (optional) | |
items[].fiscalYearId | integer (optional) | |
items[].exchangeRateId | integer (optional) | |
items[].ownerId | integer (optional) | |
items[].invoiceItems | array of PmInvoiceItem (optional) | |
items[].invoiceItems[].itemId | integer | |
items[].invoiceItems[].activityId | integer (optional) | |
items[].invoiceItems[].description | string (optional) | |
items[].invoiceItems[].invoiceId | integer (optional) | |
items[].invoiceItems[].quantity | number (optional) | |
items[].invoiceItems[].price | number (optional) | |
items[].invoiceItems[].expCatId | integer (optional) | |
items[].invoiceItems[].fundingAcctId | integer (optional) | |
items[].invoiceItems[].committedFundItemId | integer (optional) | |
items[].invoiceItems[].total | number (optional) | |
items[].invoiceItems[].extendedAttributes | array of PmExtendedAttribute (optional) | |
items[].sourceContentItemId | string (optional) | DAM content item id (GUID) for the invoice PDF imported via Content Coach; write-once. |
items[].extendedAttributes | array of PmExtendedAttribute (optional) | |
items[].extendedAttributes[].eaId | integer | |
items[].extendedAttributes[].skipDCTSave | boolean | |
items[].extendedAttributes[].eaValue | object (optional) | |
items[].extendedAttributes[].attributeName | string (optional) | |
items[].multipleValueExtendedAttributes | array of PmMultipleValueExtendedAttribute (optional) | |
items[].multipleValueExtendedAttributes[].parentId | integer | |
items[].multipleValueExtendedAttributes[].extAttributeId | integer | |
items[].multipleValueExtendedAttributes[].encodedListItemId | integer | |
items[].multipleValueExtendedAttributes[].attributeName | string (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim. See . |
list_journal_vouchers
Available on request
Lists journal vouchers in Aprimo Marketing Operations, paged and unfiltered. Use search_journal_vouchers when you need to filter.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sortField | string | No | Optional field name to sort by. Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of JournalVoucherProjection | The items returned in this response. |
items[].journalVoucherId | integer | |
items[].name | string (optional) | Always null -- JournalVoucher has no name-like field on the wire. See the class remarks. |
items[].invoiceId | integer (optional) | |
items[].committedFundId | integer (optional) | |
items[].supplierId | integer (optional) | |
items[].contactId | integer (optional) | |
items[].journalVoucherDate | string (ISO 8601) (optional) | |
items[].creatorId | integer (optional) | |
items[].currencyCode | integer (optional) | |
items[].fiscalYearId | integer (optional) | |
items[].journalVoucherStatus | integer (optional) | The journal voucher's workflow status; PM enum, exposed as its raw int. |
items[].postedDate | string (ISO 8601) (optional) | |
items[].sendToGlIntegration | integer (optional) | |
items[].modifiedUser | integer (optional) | |
items[].modifiedDate | string (ISO 8601) (optional) | |
items[].exchangeRateId | integer (optional) | |
items[].multipleActivities | integer (optional) | |
items[].glOverridden | integer (optional) | |
items[].journalVoucherTypeId | integer (optional) | |
items[].jvTotal | number (optional) | |
items[].baseTotalJv | number (optional) | |
items[].financeGroupId | integer (optional) | |
items[].journalVoucherItems | array of PmJournalVoucherItem (optional) | |
items[].journalVoucherItems[].jvItemId | integer | |
items[].journalVoucherItems[].journalVoucherId | integer | |
items[].journalVoucherItems[].committedFundItemId | integer (optional) | |
items[].journalVoucherItems[].description | string (optional) | |
items[].journalVoucherItems[].quantity | number (optional) | |
items[].journalVoucherItems[].price | number (optional) | |
items[].journalVoucherItems[].activityId | integer (optional) | |
items[].journalVoucherItems[].expCatId | integer (optional) | |
items[].journalVoucherItems[].fundingAcctId | integer (optional) | |
items[].journalVoucherItems[].itemId | integer (optional) | |
items[].journalVoucherItems[].total | number (optional) | |
items[].journalVoucherItems[].extendedAttributes | array of PmExtendedAttribute (optional) | |
items[].extendedAttributes | array of PmExtendedAttribute (optional) | |
items[].extendedAttributes[].eaId | integer | |
items[].extendedAttributes[].skipDCTSave | boolean | |
items[].extendedAttributes[].eaValue | object (optional) | |
items[].extendedAttributes[].attributeName | string (optional) | |
items[].multipleValueExtendedAttributes | array of PmMultipleValueExtendedAttribute (optional) | |
items[].multipleValueExtendedAttributes[].parentId | integer | |
items[].multipleValueExtendedAttributes[].extAttributeId | integer | |
items[].multipleValueExtendedAttributes[].encodedListItemId | integer | |
items[].multipleValueExtendedAttributes[].attributeName | string (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim. See . |
mark_invoice_sent
Available on request · Destructive
Marks an invoice as sent in Aprimo Marketing Operations. This is a state change. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact invoice with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
invoiceId | string | Yes | The invoice's integer ID to mark as sent. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — marking an invoice as sent changes its state. Set only after stating the exact invoice to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
invoiceId | integer | |
action | string (optional) | The state-change action performed: "retrieve", "sent", "submit", "cancel", "reject", or "approve". |
succeeded | boolean |
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.
mark_journal_voucher_sent
Available on request · Destructive
Marks a journal voucher as sent in Aprimo Marketing Operations. This is a state change. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact journal voucher with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
journalVoucherId | string | Yes | The journal voucher's integer ID to mark as sent. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — marking a journal voucher as sent changes its state. Set only after stating the exact journal voucher to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
journalVoucherId | integer | |
action | string (optional) | The state-change action performed: "sent", "cancel", "submit", "reconcile", or "reject". |
succeeded | boolean |
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
Available on request · Destructive
Reconciles a journal voucher in Aprimo Marketing Operations. This is a state change. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact journal voucher with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
journalVoucherId | string | Yes | The journal voucher's integer ID to reconcile. |
body | string | Yes | JSON object with the reconciliation details PM expects. Pass "{}" if none apply. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — reconciling a journal voucher changes its state. Set only after stating the exact journal voucher to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
journalVoucherId | integer | |
action | string (optional) | The state-change action performed: "sent", "cancel", "submit", "reconcile", or "reject". |
succeeded | boolean |
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
Available on request · Destructive
Rejects an invoice that is pending approval in Aprimo Marketing Operations. This is a state change. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact invoice with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
invoiceId | string | Yes | The invoice's integer ID to reject. |
body | string | Yes | JSON object with the rejection details. PM requires a non-empty "comments" field, e.g. {"comments":"Duplicate"} -- there is no optional/no-op body for this action. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — rejecting an invoice changes its state. Set only after stating the exact invoice to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
invoiceId | integer | |
action | string (optional) | The state-change action performed: "retrieve", "sent", "submit", "cancel", "reject", or "approve". |
succeeded | boolean |
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
Available on request · Destructive
Rejects a journal voucher that is pending approval in Aprimo Marketing Operations. This is a state change. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact journal voucher with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
journalVoucherId | string | Yes | The journal voucher's integer ID to reject. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — rejecting a journal voucher changes its state. Set only after stating the exact journal voucher to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
journalVoucherId | integer | |
action | string (optional) | The state-change action performed: "sent", "cancel", "submit", "reconcile", or "reject". |
succeeded | boolean |
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
Available on request · Destructive
Pulls a submitted invoice back to draft status in Aprimo Marketing Operations (undoes a submission). This is a state change. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact invoice with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
invoiceId | string | Yes | The invoice's integer ID to retrieve back to draft. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — retrieving an invoice changes its state. Set only after stating the exact invoice to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
invoiceId | integer | |
action | string (optional) | The state-change action performed: "retrieve", "sent", "submit", "cancel", "reject", or "approve". |
succeeded | boolean |
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
Available on request
Searches invoices in Aprimo Marketing Operations that match a query, paged.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | No | JSON object with the query (PM's operator-tree DSL, e.g. {"equals":{"FieldName":"Status","FieldValue":1}}). Omit or pass "{}" to match all invoices. |
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sortField | string | No | Optional field name to sort by. Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of InvoiceProjection | The items returned in this response. |
items[].invoiceId | integer | |
items[].supplierId | integer (optional) | |
items[].commitmentFundId | integer (optional) | |
items[].paidDate | string (ISO 8601) (optional) | |
items[].currencyCode | integer (optional) | |
items[].totalInvoice | number (optional) | |
items[].baseTotalInvoice | number (optional) | |
items[].dateReceived | string (ISO 8601) (optional) | |
items[].dateDue | string (ISO 8601) (optional) | |
items[].modifiedDate | string (ISO 8601) (optional) | |
items[].invoiceNumber | string (optional) | Bound to the wire's invoiceNumber -- Invoice has no dedicated description/name field. |
items[].modifiedUser | integer (optional) | |
items[].reviewedBy | integer (optional) | |
items[].financeGroupId | integer (optional) | |
items[].reviewedDate | string (ISO 8601) (optional) | |
items[].invoiceTypeId | integer (optional) | |
items[].pooled | integer (optional) | |
items[].contactId | integer (optional) | |
items[].net | integer (optional) | |
items[].status | integer (optional) | The invoice's workflow status; PM enum, exposed as its raw int. |
items[].creator | integer (optional) | |
items[].invoiceDate | string (ISO 8601) (optional) | |
items[].fiscalYearId | integer (optional) | |
items[].exchangeRateId | integer (optional) | |
items[].ownerId | integer (optional) | |
items[].invoiceItems | array of PmInvoiceItem (optional) | |
items[].invoiceItems[].itemId | integer | |
items[].invoiceItems[].activityId | integer (optional) | |
items[].invoiceItems[].description | string (optional) | |
items[].invoiceItems[].invoiceId | integer (optional) | |
items[].invoiceItems[].quantity | number (optional) | |
items[].invoiceItems[].price | number (optional) | |
items[].invoiceItems[].expCatId | integer (optional) | |
items[].invoiceItems[].fundingAcctId | integer (optional) | |
items[].invoiceItems[].committedFundItemId | integer (optional) | |
items[].invoiceItems[].total | number (optional) | |
items[].invoiceItems[].extendedAttributes | array of PmExtendedAttribute (optional) | |
items[].sourceContentItemId | string (optional) | DAM content item id (GUID) for the invoice PDF imported via Content Coach; write-once. |
items[].extendedAttributes | array of PmExtendedAttribute (optional) | |
items[].extendedAttributes[].eaId | integer | |
items[].extendedAttributes[].skipDCTSave | boolean | |
items[].extendedAttributes[].eaValue | object (optional) | |
items[].extendedAttributes[].attributeName | string (optional) | |
items[].multipleValueExtendedAttributes | array of PmMultipleValueExtendedAttribute (optional) | |
items[].multipleValueExtendedAttributes[].parentId | integer | |
items[].multipleValueExtendedAttributes[].extAttributeId | integer | |
items[].multipleValueExtendedAttributes[].encodedListItemId | integer | |
items[].multipleValueExtendedAttributes[].attributeName | string (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim. See . |
search_journal_vouchers
Available on request
Searches journal vouchers in Aprimo Marketing Operations that match a query, paged.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | No | JSON object with the query (PM's operator-tree DSL, e.g. {"equals":{"FieldName":"Status","FieldValue":1}}). Omit or pass "{}" to match all journal vouchers. |
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sortField | string | No | Optional field name to sort by. Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of JournalVoucherProjection | The items returned in this response. |
items[].journalVoucherId | integer | |
items[].name | string (optional) | Always null -- JournalVoucher has no name-like field on the wire. See the class remarks. |
items[].invoiceId | integer (optional) | |
items[].committedFundId | integer (optional) | |
items[].supplierId | integer (optional) | |
items[].contactId | integer (optional) | |
items[].journalVoucherDate | string (ISO 8601) (optional) | |
items[].creatorId | integer (optional) | |
items[].currencyCode | integer (optional) | |
items[].fiscalYearId | integer (optional) | |
items[].journalVoucherStatus | integer (optional) | The journal voucher's workflow status; PM enum, exposed as its raw int. |
items[].postedDate | string (ISO 8601) (optional) | |
items[].sendToGlIntegration | integer (optional) | |
items[].modifiedUser | integer (optional) | |
items[].modifiedDate | string (ISO 8601) (optional) | |
items[].exchangeRateId | integer (optional) | |
items[].multipleActivities | integer (optional) | |
items[].glOverridden | integer (optional) | |
items[].journalVoucherTypeId | integer (optional) | |
items[].jvTotal | number (optional) | |
items[].baseTotalJv | number (optional) | |
items[].financeGroupId | integer (optional) | |
items[].journalVoucherItems | array of PmJournalVoucherItem (optional) | |
items[].journalVoucherItems[].jvItemId | integer | |
items[].journalVoucherItems[].journalVoucherId | integer | |
items[].journalVoucherItems[].committedFundItemId | integer (optional) | |
items[].journalVoucherItems[].description | string (optional) | |
items[].journalVoucherItems[].quantity | number (optional) | |
items[].journalVoucherItems[].price | number (optional) | |
items[].journalVoucherItems[].activityId | integer (optional) | |
items[].journalVoucherItems[].expCatId | integer (optional) | |
items[].journalVoucherItems[].fundingAcctId | integer (optional) | |
items[].journalVoucherItems[].itemId | integer (optional) | |
items[].journalVoucherItems[].total | number (optional) | |
items[].journalVoucherItems[].extendedAttributes | array of PmExtendedAttribute (optional) | |
items[].extendedAttributes | array of PmExtendedAttribute (optional) | |
items[].extendedAttributes[].eaId | integer | |
items[].extendedAttributes[].skipDCTSave | boolean | |
items[].extendedAttributes[].eaValue | object (optional) | |
items[].extendedAttributes[].attributeName | string (optional) | |
items[].multipleValueExtendedAttributes | array of PmMultipleValueExtendedAttribute (optional) | |
items[].multipleValueExtendedAttributes[].parentId | integer | |
items[].multipleValueExtendedAttributes[].extAttributeId | integer | |
items[].multipleValueExtendedAttributes[].encodedListItemId | integer | |
items[].multipleValueExtendedAttributes[].attributeName | string (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim. See . |
submit_invoice
Available on request · Destructive
Submits an invoice for approval in Aprimo Marketing Operations. This is a state change that starts the approval workflow. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact invoice with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
invoiceId | string | Yes | The invoice's integer ID to submit. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — submitting an invoice changes its state. Set only after stating the exact invoice to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
invoiceId | integer | |
action | string (optional) | The state-change action performed: "retrieve", "sent", "submit", "cancel", "reject", or "approve". |
succeeded | boolean |
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.
submit_journal_voucher
Available on request · Destructive
Submits a journal voucher for approval in Aprimo Marketing Operations. This is a state change that starts the approval workflow. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact journal voucher with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
journalVoucherId | string | Yes | The journal voucher's integer ID to submit. |
body | string | Yes | JSON object with the submission details PM expects. Pass "{}" if none apply. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — submitting a journal voucher changes its state. Set only after stating the exact journal voucher to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
journalVoucherId | integer | |
action | string (optional) | The state-change action performed: "sent", "cancel", "submit", "reconcile", or "reject". |
succeeded | boolean |
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
Available on request
Updates an existing invoice by its integer ID in Aprimo Marketing Operations. Only include the fields you intend to change (partial update; omitted fields are left as-is). Requires confirmed=true after showing the user the exact changes. Returns the updated invoice.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
invoiceId | string | Yes | The invoice's integer ID. |
body | string | Yes | JSON object with the fields to change (PM wire names). Omit fields you don't want to modify. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change. |
Returns:
| Field | Type | Description |
|---|---|---|
invoiceId | integer | |
supplierId | integer (optional) | |
commitmentFundId | integer (optional) | |
paidDate | string (ISO 8601) (optional) | |
currencyCode | integer (optional) | |
totalInvoice | number (optional) | |
baseTotalInvoice | number (optional) | |
dateReceived | string (ISO 8601) (optional) | |
dateDue | string (ISO 8601) (optional) | |
modifiedDate | string (ISO 8601) (optional) | |
invoiceNumber | string (optional) | Bound to the wire's invoiceNumber -- Invoice has no dedicated description/name field. |
modifiedUser | integer (optional) | |
reviewedBy | integer (optional) | |
financeGroupId | integer (optional) | |
reviewedDate | string (ISO 8601) (optional) | |
invoiceTypeId | integer (optional) | |
pooled | integer (optional) | |
contactId | integer (optional) | |
net | integer (optional) | |
status | integer (optional) | The invoice's workflow status; PM enum, exposed as its raw int. |
creator | integer (optional) | |
invoiceDate | string (ISO 8601) (optional) | |
fiscalYearId | integer (optional) | |
exchangeRateId | integer (optional) | |
ownerId | integer (optional) | |
invoiceItems | array of PmInvoiceItem (optional) | |
invoiceItems[].itemId | integer | |
invoiceItems[].activityId | integer (optional) | |
invoiceItems[].description | string (optional) | |
invoiceItems[].invoiceId | integer (optional) | |
invoiceItems[].quantity | number (optional) | |
invoiceItems[].price | number (optional) | |
invoiceItems[].expCatId | integer (optional) | |
invoiceItems[].fundingAcctId | integer (optional) | |
invoiceItems[].committedFundItemId | integer (optional) | |
invoiceItems[].total | number (optional) | |
invoiceItems[].extendedAttributes | array of PmExtendedAttribute (optional) | |
invoiceItems[].extendedAttributes[].eaId | integer | |
invoiceItems[].extendedAttributes[].skipDCTSave | boolean | |
invoiceItems[].extendedAttributes[].eaValue | object (optional) | |
invoiceItems[].extendedAttributes[].attributeName | string (optional) | |
sourceContentItemId | string (optional) | DAM content item id (GUID) for the invoice PDF imported via Content Coach; write-once. |
extendedAttributes | array of PmExtendedAttribute (optional) | |
extendedAttributes[].eaId | integer | |
extendedAttributes[].skipDCTSave | boolean | |
extendedAttributes[].eaValue | object (optional) | |
extendedAttributes[].attributeName | string (optional) | |
multipleValueExtendedAttributes | array of PmMultipleValueExtendedAttribute (optional) | |
multipleValueExtendedAttributes[].parentId | integer | |
multipleValueExtendedAttributes[].extAttributeId | integer | |
multipleValueExtendedAttributes[].encodedListItemId | integer | |
multipleValueExtendedAttributes[].attributeName | string (optional) | |
raw | object (optional) | The complete wire object, verbatim. See . |
update_journal_voucher
Available on request
Updates an existing journal voucher by its integer ID in Aprimo Marketing Operations. Only include the fields you intend to change (partial update; omitted fields are left as-is). Requires confirmed=true after showing the user the exact changes. Returns the updated journal voucher.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
journalVoucherId | string | Yes | The journal voucher's integer ID. |
body | string | Yes | JSON object with the fields to change (PM wire names). Omit fields you don't want to modify. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change. |
Returns:
| Field | Type | Description |
|---|---|---|
journalVoucherId | integer | |
name | string (optional) | Always null -- JournalVoucher has no name-like field on the wire. See the class remarks. |
invoiceId | integer (optional) | |
committedFundId | integer (optional) | |
supplierId | integer (optional) | |
contactId | integer (optional) | |
journalVoucherDate | string (ISO 8601) (optional) | |
creatorId | integer (optional) | |
currencyCode | integer (optional) | |
fiscalYearId | integer (optional) | |
journalVoucherStatus | integer (optional) | The journal voucher's workflow status; PM enum, exposed as its raw int. |
postedDate | string (ISO 8601) (optional) | |
sendToGlIntegration | integer (optional) | |
modifiedUser | integer (optional) | |
modifiedDate | string (ISO 8601) (optional) | |
exchangeRateId | integer (optional) | |
multipleActivities | integer (optional) | |
glOverridden | integer (optional) | |
journalVoucherTypeId | integer (optional) | |
jvTotal | number (optional) | |
baseTotalJv | number (optional) | |
financeGroupId | integer (optional) | |
journalVoucherItems | array of PmJournalVoucherItem (optional) | |
journalVoucherItems[].jvItemId | integer | |
journalVoucherItems[].journalVoucherId | integer | |
journalVoucherItems[].committedFundItemId | integer (optional) | |
journalVoucherItems[].description | string (optional) | |
journalVoucherItems[].quantity | number (optional) | |
journalVoucherItems[].price | number (optional) | |
journalVoucherItems[].activityId | integer (optional) | |
journalVoucherItems[].expCatId | integer (optional) | |
journalVoucherItems[].fundingAcctId | integer (optional) | |
journalVoucherItems[].itemId | integer (optional) | |
journalVoucherItems[].total | number (optional) | |
journalVoucherItems[].extendedAttributes | array of PmExtendedAttribute (optional) | |
journalVoucherItems[].extendedAttributes[].eaId | integer | |
journalVoucherItems[].extendedAttributes[].skipDCTSave | boolean | |
journalVoucherItems[].extendedAttributes[].eaValue | object (optional) | |
journalVoucherItems[].extendedAttributes[].attributeName | string (optional) | |
extendedAttributes | array of PmExtendedAttribute (optional) | |
extendedAttributes[].eaId | integer | |
extendedAttributes[].skipDCTSave | boolean | |
extendedAttributes[].eaValue | object (optional) | |
extendedAttributes[].attributeName | string (optional) | |
multipleValueExtendedAttributes | array of PmMultipleValueExtendedAttribute (optional) | |
multipleValueExtendedAttributes[].parentId | integer | |
multipleValueExtendedAttributes[].extAttributeId | integer | |
multipleValueExtendedAttributes[].encodedListItemId | integer | |
multipleValueExtendedAttributes[].attributeName | string (optional) | |
raw | object (optional) | The complete wire object, verbatim. See . |
Related
- Aprimo MCP Server — configuration, connection details, and authentication
- MCP Tool Permission Map — the Aprimo permissions that make each tool visible to your agent
- REST API vs. MCP — choosing the right integration approach for your agent