Coupa

Learn how to use Coupa with Composio

Overview

SLUG: COUPA

Description

Coupa provides a comprehensive business spend management platform with procurement, invoicing, and expense capabilities.

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to openid,profile,email,login,offline_access,core.common.read,core.object_translations.read,core.user.read,core.user_group.read,core.integration.read,core.integration.write,core.approval.read,core.approval.write,core.requisition.read,core.requisition.write,core.purchase_order.read,core.purchase_order.write,core.order_header_confirmations.read,core.order_header_confirmations.write,core.item.read,core.catalog.read,core.uom.read,core.supplier.read,core.supplier_sites.read,core.invoice.read,core.invoice.write,core.invoice.create,core.payables.invoice.read,core.payables.invoice.write,core.pay.payments.read,core.expense.read,core.expense.write,core.business_entity.read,core.legal_entity.read,core.project.read,core.notifications_summary.read
full
stringRequired

Connecting to Coupa

Create an auth config

Use the dashboard to create an auth config for the Coupa toolkit. This allows you to connect multiple Coupa accounts to Composio for agents to use.

1

Select App

Navigate to Coupa.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Coupa Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1from composio import Composio
2
3# Replace these with your actual values
4coupa_auth_config_id = "ac_YOUR_COUPA_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/application
6
7composio = Composio()
8
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11 connection_request = composio.connected_accounts.initiate(
12 user_id=user_id,
13 auth_config_id=auth_config_id,
14 )
15
16 print(
17 f"Visit this URL to authenticate Coupa: {connection_request.redirect_url}"
18 )
19
20 # This will wait for the auth flow to be completed
21 connection_request.wait_for_connection(timeout=15)
22 return connection_request.id
23
24
25connection_id = authenticate_toolkit(user_id, coupa_auth_config_id)
26
27# You can also verify the connection status using:
28connected_account = composio.connected_accounts.get(connection_id)
29print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Coupa toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

Tool Name: Abandon Invoice

Description

Tool to abandon an invoice. Use when an invoice is invalid and needs to be abandoned. Invoice once abandoned cannot be reversed.

Action Parameters

additional_recipients
comment
id
integerRequired
reason_insight[code]
reason_insight[id]
send_to_supplier

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Account

Description

Tool to create a Coupa account. Use when you need to provision a new general ledger account with a specific chart-of-accounts type and code segments.

Action Parameters

account-type
account-type-id
active
Defaults to True
name
segment-1
segment-10
segment-11
segment-12
segment-13
segment-14
segment-15
segment-16
segment-17
segment-18
segment-19
segment-2
segment-20
segment-3
segment-4
segment-5
segment-6
segment-7
segment-8
segment-9

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Accounts

Description

Tool to list accounts from Coupa. Use when you need to retrieve account IDs and codes with optional filters and pagination.

Action Parameters

account-type-id
account-type[name]
active
code
fields
id
offset
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Recent Accounts

Description

Tool to retrieve recently accessed accounts from Coupa. Use when you need to view accounts that the user has recently interacted with.

Action Parameters

fields
limit
offset
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Account

Description

Tool to retrieve a specific account by ID. Use when you need detailed account information including segments, type, and status.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Account

Description

Tool to update an existing Coupa account. Use when you need to modify account information including account type, activation status, code segments, and display name.

Action Parameters

account-type
account-type-id
active
code
id
integerRequired
name
segment-1
segment-10
segment-11
segment-12
segment-13
segment-14
segment-15
segment-16
segment-17
segment-18
segment-19
segment-2
segment-20
segment-3
segment-4
segment-5
segment-6
segment-7
segment-8
segment-9

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Account Types

Description

Tool to list account types in Coupa. Use when you need account type IDs and names for account creation.

Action Parameters

active
dynamic_flag
fields
id
name[contains]
offset
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Account Type

Description

Tool to retrieve a specific account type by ID. Use when you need detailed information about a chart of accounts.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Account Validation Rule

Description

Tool to create account validation rules in Coupa. Use when setting up rules to manage chart of accounts validation with segment conditions.

Action Parameters

account-type
objectRequired
active
booleanRequired
description
stringRequired
error-message
stringRequired
name
stringRequired
segment-1-condition
segment-1-max
segment-1-min
segment-10-condition
segment-10-max
segment-10-min
segment-11-condition
segment-11-max
segment-11-min
segment-12-condition
segment-12-max
segment-12-min
segment-13-condition
segment-13-max
segment-13-min
segment-14-condition
segment-14-max
segment-14-min
segment-15-condition
segment-15-max
segment-15-min
segment-16-condition
segment-16-max
segment-16-min
segment-17-condition
segment-17-max
segment-17-min
segment-18-condition
segment-18-max
segment-18-min
segment-19-condition
segment-19-max
segment-19-min
segment-2-condition
segment-2-max
segment-2-min
segment-20-condition
segment-20-max
segment-20-min
segment-3-condition
segment-3-max
segment-3-min
segment-4-condition
segment-4-max
segment-4-min
segment-5-condition
segment-5-max
segment-5-min
segment-6-condition
segment-6-max
segment-6-min
segment-7-condition
segment-7-max
segment-7-min
segment-8-condition
segment-8-max
segment-8-min
segment-9-condition
segment-9-max
segment-9-min

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Account Validation Rule

Description

Tool to retrieve a specific account validation rule by ID. Use when you need detailed information about account validation rules including segment conditions and error messages.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Account Validation Rule

Description

Tool to update an existing account validation rule in Coupa. Use when you need to modify validation rule attributes after confirming the rule ID.

Action Parameters

account-type
active
description
error-message
id
integerRequired
name
payload
return_object
segment-1-condition
segment-1-max
segment-1-min
segment-10-condition
segment-10-max
segment-10-min
segment-11-condition
segment-11-max
segment-11-min
segment-12-condition
segment-12-max
segment-12-min
segment-13-condition
segment-13-max
segment-13-min
segment-14-condition
segment-14-max
segment-14-min
segment-15-condition
segment-15-max
segment-15-min
segment-16-condition
segment-16-max
segment-16-min
segment-17-condition
segment-17-max
segment-17-min
segment-18-condition
segment-18-max
segment-18-min
segment-19-condition
segment-19-max
segment-19-min
segment-2-condition
segment-2-max
segment-2-min
segment-20-condition
segment-20-max
segment-20-min
segment-3-condition
segment-3-max
segment-3-min
segment-4-condition
segment-4-max
segment-4-min
segment-5-condition
segment-5-max
segment-5-min
segment-6-condition
segment-6-max
segment-6-min
segment-7-condition
segment-7-max
segment-7-min
segment-8-condition
segment-8-max
segment-8-min
segment-9-condition
segment-9-max
segment-9-min

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add Comment to Requisition

Description

Tool to add a comment to a requisition. Use when you need to add notes, feedback, or mention users on an existing requisition.

Action Parameters

commentable-type
stringDefaults to RequisitionHeader
comments
stringRequired
id
integerRequired
reason-code
to-supplier

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add Comment to Expense Report

Description

Tool to add a comment to an expense report. Use when you need to add notes or feedback to an existing expense report.

Action Parameters

commentable-type
stringDefaults to ExpenseReport
comments
stringRequired
id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add Approver to Requisition

Description

Tool to manually add an approver (User or UserGroup) to a requisition approval chain. Use when you need to add a user or user group to the approval chain of a requisition at a specific position relative to the current approver.

Action Parameters

approver_id
integerRequired
current_approver_id
integerRequired
id
integerRequired
position
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add Approver To Invoice

Description

Tool to manually add an approver to an invoice. Use when you need to add a user or user group to the approval chain of an invoice at a specific position.

Action Parameters

approver_id
integerRequired
approver_type
stringRequired
current_approver_id
id
integerRequired
position
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add Approver to PO Change

Description

Tool to add an approver to a purchase order change after the current approver. Use when you need to manually add an approver to a pending PO change request in the approval chain.

Action Parameters

approver_id
integerRequired
approver_type
stringRequired
current_approver_id
id
integerRequired
position
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add File Attachment to Project

Description

Tool to add a file attachment to an existing project. Use when you need to upload and attach files (documents, images, PDFs, etc.) to projects in Coupa.

Action Parameters

attachment[file]
attachment[intent]
attachment[linked_to]
content_b64
filename
mimetype
project_id
integerRequired
x-coupa-api-user-login

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add File Attachment to Purchase Order

Description

Tool to add a file attachment to an existing purchase order. Use when you need to upload and attach files (documents, images, PDFs, etc.) to purchase orders in Coupa.

Action Parameters

attachment[file]
objectRequired
attachment[intent]
attachment[linked_to]
purchase_order_id
integerRequired
x-coupa-api-user-login

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add File Attachment to Purchase Order Line

Description

Tool to add a file attachment to a purchase order line. Use when you need to upload and attach files (documents, images, PDFs, etc.) to specific purchase order lines in Coupa.

Action Parameters

attachment[file]
attachment[intent]
content_b64
filename
mimetype
purchase_order_line_id
integerRequired
x-coupa-api-user-login

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add File Attachment to Requisition Line

Description

Tool to add a file attachment to a requisition line. Use when you need to upload and attach files (documents, images, PDFs, etc.) to requisition lines in Coupa.

Action Parameters

attachment[file]
attachment[intent]
attachment[linked_to]
content_b64
filename
mimetype
requisition_line_id
integerRequired
x-coupa-api-user-login

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add Attachment to Comment

Description

Tool to add a file attachment to an existing comment. Use when you need to upload and attach files to comments in Coupa.

Action Parameters

attachment[file]
attachment[intent]
attachment[linked_to]
comment_id
integerRequired
content_b64
filename
mimetype
x-coupa-api-user-login

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add COAs to Supplier Site

Description

Tool to add Chart of Accounts (COAs) to a specific supplier site. Use when you need to assign account types to a supplier site for transaction categorization and financial tracking.

Action Parameters

account-types
arrayRequired
business_role
fields
id
integerRequired
on_behalf_of
payload
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add Comment to Purchase Order

Description

Tool to add a comment to a purchase order. Use when you need to add notes, feedback, or mention users on an existing purchase order.

Action Parameters

commentable-type
stringDefaults to OrderHeader
comments
stringRequired
id
integerRequired
reason-code
to-supplier

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add Content Group to Contract

Description

Tool to add a content group (business group) to a contract. Use when you need to assign a content group to a contract for access control or visibility management.

Action Parameters

business_group_id
integerRequired
contract_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add Content Group to Supplier

Description

Tool to add a content group (business group) to a supplier. Use when you need to assign a content group to a supplier for access control or visibility management.

Action Parameters

business_group_id
integerRequired
supplier_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add Contract Approver

Description

Tool to manually add an approver to a contract. Use when you need to add a user or user group to the approval chain of a contract at a specific position.

Action Parameters

api_user_email
approver_id
integerRequired
approver_type
stringRequired
current_approver_id
id
integerRequired
on_behalf_of
position
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add Contract Term

Description

Tool to add a contract term to an existing contract. Use when creating pricing tiers or discount structures for contracts.

Action Parameters

contract-term-type
stringRequired
id
integerRequired
name
stringRequired
tier-1-disc-pct
tier-1-upper-bound
tier-10-disc-pct
tier-10-upper-bound
tier-11-disc-pct
tier-11-upper-bound
tier-12-disc-pct
tier-12-upper-bound
tier-13-disc-pct
tier-13-upper-bound
tier-14-disc-pct
tier-14-upper-bound
tier-15-disc-pct
tier-15-upper-bound
tier-16-disc-pct
tier-16-upper-bound
tier-17-disc-pct
tier-17-upper-bound
tier-18-disc-pct
tier-18-upper-bound
tier-19-disc-pct
tier-19-upper-bound
tier-2-disc-pct
tier-2-upper-bound
tier-20-disc-pct
tier-20-upper-bound
tier-3-disc-pct
tier-3-upper-bound
tier-4-disc-pct
tier-4-upper-bound
tier-5-disc-pct
tier-5-upper-bound
tier-6-disc-pct
tier-6-upper-bound
tier-7-disc-pct
tier-7-upper-bound
tier-8-disc-pct
tier-8-upper-bound
tier-9-disc-pct
tier-9-upper-bound
use-pct-discounts

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add Line w/ Allocations to External PO

Description

Tool to add a line with account allocations to an external purchase order. Use when you need to add line items with split billing across multiple accounts.

Action Parameters

id
integerRequired
order-lines
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Address

Description

Tool to create a new address in Coupa. Use when you need to create personal or supplier remit-to addresses with location details.

Action Parameters

active
Defaults to True
attention
business-group-name
city
stringRequired
country
objectRequired
external-src-name
external-src-ref
local-tax-number
location-code
name
stringRequired
postal-code
stringRequired
state
stringRequired
state-iso-code
street1
stringRequired
street2
street3
street4
vat-country
vat-number

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Addresses

Description

Tool to list addresses from Coupa. Use when you need paginated address records for processing.

Action Parameters

fields
offset
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Address by ID

Description

Tool to retrieve a single address by ID. Use when you need detailed address information after knowing the address ID.

Action Parameters

fields
id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add Content Group to SIM Record

Description

Tool to add a content group (business group) to a Supplier Information Management (SIM) record. Use when you need to assign a content group to a SIM record for access control or visibility management.

Action Parameters

business_group_id
integerRequired
sim_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add Content Group to Supplier Site

Description

Tool to add a content group (business group) to a supplier site. Use when you need to assign a content group to a supplier site for access control or visibility management.

Action Parameters

business_group_id
integerRequired
supplier_site_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add User To A Group

Description

Tool to add a user to a group by updating user group membership. Use when you need to assign a user to a specific group with defined owner and participant permissions.

Action Parameters

business_role
fields
membership_id
integerRequired
on_behalf_of
owner
booleanRequired
participant
booleanRequired
return_object
user-group-id
integerRequired
user-group-type
stringRequired
user-id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Announcements

Description

Tool to list all announcements from Coupa. Use when you need to retrieve multiple announcements with optional pagination and filters.

Action Parameters

fields
filters
limit
offset
order_by
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Announcement

Description

Tool to retrieve a specific announcement by ID from Coupa Mobile. Use when you need detailed information about an announcement.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Approve Approval

Description

Tool to approve a pending approval record. Use when you need to programmatically approve a pending approval by ID.

Action Parameters

api-user-id
id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Hold Approval

Description

Tool to place an approval on hold. Use when you need to pause approval workflow temporarily.

Action Parameters

api-user-id
id
integerRequired
note

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Approvals

Description

Tool to list approvals with optional pagination and filters. Use when you need to retrieve multiple approval records.

Action Parameters

fields
filters
limit
offset
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Reject Approval

Description

Tool to reject an approval. Use when you need to programmatically reject a pending approval by ID.

Action Parameters

id
integerRequired
note
reason

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Approval

Description

Tool to retrieve a single approval record. Use when you need detailed approval information by ID.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Budget Lines

Description

Tool to retrieve budget lines from Coupa. Use when you need to query budget line information associated with accounts and periods.

Action Parameters

fields
id
limit
offset
order_by
owner[lastname]
owner_is_approver
period[account-type][name]
period[is_open]
period[name]

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Business Groups

Description

Tool to list business groups (content groups) in Coupa. Use when you need IDs, names, and metadata of content groups for assignments.

Action Parameters

created-at[gt]
id
name[contains]
offset

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Business Group

Description

Tool to retrieve a specific business group (content group) by ID. Use when you need detailed information about a content group.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Accept Header Level Confirmation

Description

Tool to accept order header confirmations from suppliers. Use when a supplier has submitted a header level confirmation that is in pending_buyer_review status and you need to accept it.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Reject Header Level Confirmation

Description

Tool to reject order header confirmations from suppliers. Use when a supplier has submitted a header level confirmation that is in pending_buyer_review status and you need to reject it.

Action Parameters

comment
id
integerRequired
reason-insight-events

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Bypass All Invoice Approvals

Description

Tool to bypass all approvals for an invoice to enable rapid payment processing. Use when you need to skip the entire approval chain and get an invoice approved immediately. Note that the invoice must be in an approvable status (e.g., 'pending_approval'), not 'draft' status.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Bypass Current Invoice Approval

Description

Tool to skip the current approver and activate the next approver in the approval chain. Use when you need to bypass the current pending approver and move to the next approver. Note that the invoice must be in an approvable status (e.g., 'pending_approval'), not 'draft' status.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Cancel External PO

Description

Tool to cancel an external purchase order. Use when you need to cancel an externally-created PO that has not yet been fully processed or has related documents that need to be cleared first.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Cancel Purchase Order

Description

Tool to cancel a purchase order. Use when you need to void an active PO before issuance. Example: Cancel PO with ID 123.

Action Parameters

fields
id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Close/Soft Close External PO

Description

Tool to close or soft-close an external purchase order. Use when finalizing an external PO after confirming receipt or when business rules require closure.

Action Parameters

id
integerRequired
reason-insight-code
reason-insight-event-comment
reason-insight-id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Complete Contract

Description

Tool to complete a contract and transition it to legally binding status. Use when you need to mark a contract as completed and executed.

Action Parameters

api_user_email
api_user_id
api_user_login
business_role
fields
id
integerRequired
on_behalf_of
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Content Group

Description

Tool to create a new content group (business group) in Coupa. Use when you need to provision a new content group to restrict user access to objects in Coupa.

Action Parameters

description
name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Content Group

Description

Tool to update an existing content group (business group) in Coupa. Use when you need to modify the name or description of a content group after confirming the group ID exists.

Action Parameters

description
id
integerRequired
name
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add Attachment to Contract

Description

Tool to create an attachment on a contract. Use when attaching files, text, or URLs to contracts.

Action Parameters

attachment[file]
attachment[intent]
attachment[linked_to]
attachment[text]
attachment[type]
stringRequired
attachment[url]
contract_id
integerRequired
x-coupa-api-user-login

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Contracts

Description

Tool to list contracts. Use when you need contract IDs and metadata for subsequent actions, e.g., adding an approver.

Action Parameters

fields
filters
offset
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Contract

Description

Tool to update an existing contract in Coupa via PUT /api/contracts/:id. Use when you need to modify contract attributes such as status, dates, supplier, or financial terms. Only include fields that need to be changed.

Action Parameters

business_role
content-groups
contract-owner
contract-terms
contract-type
currency
default-on-unbacked-lines
department
description
end-date
execution-date
fields
id
integerRequired
legal-agreement-url
maximum-value
minimum-value
name
number
on_behalf_of
payload
payment-term
published-date
return_object
savings-pct
start-date
status
stop-spend-over-contract-value
supplier
supplier-account
supplier-can-invoice-directly
use-order-windows

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Contract Template

Description

Tool to delete a contract template. Use when you need to permanently remove a contract template by ID.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Tax Registration

Description

Tool to create a supplier tax registration in Coupa. Use when adding tax identification records for suppliers with required country and tax number. Requires supplier information with a primary address to exist before creating tax registration.

Action Parameters

active
country
objectRequired
local
number
stringRequired
supplier-information-address-id
supplier-information-id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Budget Line Adjustment

Description

Tool to create a budget line adjustment in Coupa. Use when you need to adjust the budget amount for an existing budget line by creating an adjustment record with the specified amount, currency, and related references.

Action Parameters

adjustment-amount
numberRequired
budget-period
budget-segment
budget_line_id
integerRequired
chart-of-accounts
currency
objectRequired
description

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create External Purchase Order

Description

Tool to create an external purchase order. Use when integrating external POs via Coupa API.

Action Parameters

classification
currency
order-lines
arrayRequired
payment-method
payment-term
po-number
stringRequired
ship-to-address
ship-to-attention
ship-to-user
shipping-term
supplier
objectRequired
supplier-site
transmission-emails
transmission-method-override
type
stringDefaults to ExternalOrderHeader

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create FX Rate

Description

Tool to create a new exchange rate (FX rate) between two currencies in Coupa. Use when you need to create one-way currency conversion rates. Note that this creates only a one-way rate; to enable bidirectional conversion, create a separate rate for the reverse direction.

Action Parameters

from-currency
objectRequired
rate
numberRequired
rate-date
stringRequired
to-currency
objectRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Integration Run

Description

Tool to create an integration run. Use when you need to initialize a new run for an integration before processing records.

Action Parameters

integration_code
integration_id
records-processed
start-time
total-records

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Invoice Against PO

Description

Tool to create an invoice against a purchase order. Use when you need to invoice for goods or services received against an existing PO by linking invoice lines to PO lines.

Action Parameters

comments
currency
objectRequired
discount-amount
handling-amount
internal-note
invoice-date
stringRequired
invoice-lines
arrayRequired
invoice-number
stringRequired
line-level-taxation
payment-term
shipping-amount
supplier
objectRequired
tax-amount

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create New Custom Object Instance

Description

Tool to create a new custom object instance in Coupa. Use when you need to add a new data record for a Custom Object with specific custom field values.

Action Parameters

custom-fields
objectRequired
customObjectId
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Payment Reconciliation Lines

Description

Tool to create payment reconciliation lines for a pay order in Coupa. Use when you need to record payment transactions against payable orders or invoices.

Action Parameters

adjustment-date
amount
amount-paid
stringRequired
category
stringRequired
note
notes
payable-id
integerRequired
payable-type
stringRequired
payment-date
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Payment Term

Description

Tool to create a payment term in Coupa. Use when you need to define new payment conditions including discount and net payment calculations for invoices and purchase orders.

Action Parameters

active
Defaults to True
code
stringRequired
days-for-discount-payment
integerRequired
days-for-net-payment
integerRequired
description
discount-cutoff-day
discount-due-day
discount-due-month
discount-rate
net-cutoff-day
net-due-day
net-due-month
type
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Project

Description

Tool to create a Coupa project. Use when you need to create a new project with specified name, start date, and end date.

Action Parameters

active
Defaults to True
additional-negotiated-savings
additional-planned-savings
additional-realized-savings
allow-users-to-view-member
commodity
completion-percentage
content-groups
description
display-date-range-warning
end-date
stringRequired
external-reference-number
mention-name
name
stringRequired
open
show-contracts-rollup-fields
show-sourcing-rollup-fields
show-suppliers-rollup-fields
start-date
stringRequired
status
users

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Req Assignment to User

Description

Tool to create a requisition assignment to a user. Use when you need to assign a user to a requisition for approval or buyer role.

Action Parameters

assignee-id
integerRequired
assignee-type
stringDefaults to User
requisition-id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Requisition Line Estimated Tax Line

Description

Tool to create an estimated tax line on a requisition line. Use when adding tax calculations to requisition line items. Requires the Chart of Account to have estimated taxes enabled.

Action Parameters

account
amount
description
rate
req_line_id
integerRequired
tax-code
taxable-amount

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Requisition Lines - Multiple Estimated Tax Lines

Description

Tool to update a requisition line with multiple estimated tax lines. Use when you need to add or update estimated taxes on a requisition line. Note that the Chart of Account must have estimated taxes enabled for this operation to succeed.

Action Parameters

description
estimated-tax-lines
payload
quantity
req_line_id
integerRequired
total
unit-price

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Risk Aware Feed for Supplier

Description

Tool to create a Risk Aware feed for a supplier to load GRC (governance, risk, and compliance) data. Use when loading risk metrics for a specific supplier. Note: Each supplier can only have one Risk Aware feed, and the API cannot be used when the supplier status is 'evaluating'.

Action Parameters

number-field-01
number-field-02
number-field-03
number-field-04
number-field-05
number-field-06
number-field-07
number-field-08
number-field-09
number-field-10
supplier
objectRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Shell SIM Record

Description

Tool to create a shell SIM (Supplier Information Management) record against an existing supplier before importing legacy suppliers. Use when you need to create a pre-approved SIM record with exported flag set to true.

Action Parameters

exported
booleanDefaults to True
status
stringDefaults to approved
supplier
objectRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create SIM Site Using SIM ID in POST URL

Description

Tool to create a supplier information site under a specific supplier information record. Use when you need to create a new supplier site with detailed configuration including code, name, PO methods, and cXML settings.

Action Parameters

active
addresses
allow-change-requests
buyer-hold
code
stringRequired
contacts
content-groups
cxml-domain
cxml-http-username
cxml-identity
cxml-protocol
cxml-secret
cxml-ssl-version
cxml-supplier-domain
cxml-supplier-identity
cxml-url
default-locale
disable-cert-verify
name
stringRequired
po-change-method
po-email
po-method
supplier_information_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create SIM Site using SIM ID in Payload

Description

Tool to create a supplier information site using SIM ID in the payload. Use when you need to add a new site location for an existing supplier information record in Coupa's SIM module.

Action Parameters

active
addresses
allow-change-requests
buyer-hold
code
stringRequired
contacts
content-groups
cxml-domain
cxml-http-username
cxml-identity
cxml-protocol
cxml-secret
cxml-ssl-version
cxml-supplier-domain
cxml-supplier-identity
cxml-url
default-locale
disable-cert-verify
name
stringRequired
payment-term
po-change-method
po-email
po-method
shipping-term
supplier-information-id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Supplier Remit-To Address

Description

Tool to create a remit-to address for a supplier. Use when you need to add a new remit-to address to an existing supplier in Coupa.

Action Parameters

active
booleanRequired
city
stringRequired
company-registration-number
country
objectRequired
name
stringRequired
postal-code
stringRequired
remit-to-code
stringRequired
return_object
state
stringRequired
street1
stringRequired
street2
street3
street4
supplier_id
integerRequired
tax-number

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Supplier Site

Description

Tool to create a supplier site for an existing supplier. Use when you need to establish a new location or site associated with a supplier in Coupa.

Action Parameters

account-types
active
Defaults to True
addresses
allow-change-requests
allow-order-confirmation-item-substitutions
buyer-hold
code
stringRequired
contacts
content-groups
cxml-domain
cxml-http-username
cxml-identity
cxml-protocol
cxml-secret
cxml-ssl-version
cxml-supplier-domain
cxml-supplier-identity
cxml-url
default-locale
disable-cert-verify
name
stringRequired
payment-method
payment-term
po-change-method
po-email
po-method
stringRequired
shipping-term
supplier_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Supplier with Contacts and Addresses

Description

Tool to create a new supplier with primary contact and address in one API call. Use when creating a supplier with contact and address information simultaneously.

Action Parameters

account-number
invoice-matching-level
name
stringRequired
number
po-change-method
po-email
po-method
primary-address
primary-contact
status
tax-id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create User Address

Description

Tool to create a personal address for a specified Coupa user. Use when you need to add a new address to a user's profile in Coupa.

Action Parameters

active
attention
business-group-name
city
stringRequired
country
objectRequired
external-src-name
external-src-ref
local-tax-number
location-code
name
stringRequired
postal-code
stringRequired
state
state-iso-code
street1
stringRequired
street2
street3
street4
user_id
integerRequired
vat-country
vat-number

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Currencies

Description

Tool to list currencies from Coupa. Use when you need to retrieve or filter configured currencies before processing.

Action Parameters

code
decimals
enabled_flag
fields
id
name
offset
return_object
symbol

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Currency by ID

Description

Tool to retrieve a specific currency by ID. Use when you need detailed information about a currency.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Data File Sources

Description

Tool to list data file sources from Coupa. Use when you need to retrieve file processing records that track data imports and exports, including upload status and error details.

Action Parameters

created_at[gt]
created_at[lt]
fields
file_file_name
id
offset
return_object
source_for
status
type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Default Receiving Locations

Description

Tool to list default receiving locations from Coupa. Use when you need to retrieve receiving location details linked to items and warehouses.

Action Parameters

fields
id
item-id
offset
return_object
warehouse-id
warehouse-location-id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Tax Registration

Description

Tool to delete a tax registration. Use when you need to permanently remove a supplier information tax registration by ID.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Requisition Line

Description

Tool to delete a requisition line. Use when you need to permanently remove a requisition line by ID.

Action Parameters

req_line_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Requisition Line Estimated Tax Line

Description

Tool to delete an estimated tax line from a requisition line. Use when you need to remove a specific estimated tax line by ID.

Action Parameters

est_tax_line_id
integerRequired
req_line_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Specific Contract Attachment

Description

Tool to delete a specific attachment from a contract. Use when you need to permanently remove an attachment by its ID from a contract.

Action Parameters

attachment_id
integerRequired
contract_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Purchase Order Attachment

Description

Tool to delete a specific attachment from a purchase order. Use when you need to remove an attachment by providing both the purchase order ID and attachment ID.

Action Parameters

attachment_id
integerRequired
purchase_order_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Requisition Attachment

Description

Tool to delete a specific attachment from a requisition. Use when removing an attachment from a requisition by attachment ID.

Action Parameters

attachment_id
integerRequired
requisition_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Department

Description

Tool to create a department in Coupa. Use when you need to provision a new department with a specified name and active status.

Action Parameters

active
booleanRequired
name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Department by ID

Description

Tool to retrieve a single department by ID. Use when you need detailed department information.

Action Parameters

fields
id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Department

Description

Tool to update an existing department in Coupa. Use when you need to modify department attributes such as name or active status after confirming the department ID.

Action Parameters

active
fields
id
integerRequired
name
payload
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Dispute Invoice

Description

Tool to dispute an invoice that is in pending approval or pending receipt status. Use when you need to notify the supplier that a problem exists with the invoice.

Action Parameters

comment
dispute_reason[code]
stringRequired
id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Easy Form Response

Description

Tool to delete an easy form response. Use when you need to permanently remove an easy form response by ID.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Exchange Rates

Description

Tool to retrieve exchange rates from Coupa for currencies used to pay for goods. Use when you need to query currency conversion rates with optional filters for date ranges, specific currencies, or rate values.

Action Parameters

created_at
fields
from-currency[code]
id
offset
rate
rate-date
return_object
to-currency[code]

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Expense Reports

Description

Tool to list expense reports. Use when you need a paginated list of reports with optional filters.

Action Parameters

exported
fields
offset
return_object
status

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Financial Counterparties

Description

Tool to list financial counterparties from Coupa. Use when you need to retrieve banks and financial institutions used for payment and treasury operations.

Action Parameters

abbreviation
active
bank_code
branch_code
created_at[gt]
created_at[lt]
external_identification_lei
fields
id
name
offset
payment-usage
return_object
swift-code
treasury-usage
updated_at[gt]
updated_at[lt]

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get All Active Pick Lists

Description

Tool to retrieve active pick lists (fulfillment reservations) from Coupa. Use when you need to query fulfillment reservation data with optional filters and pagination.

Action Parameters

exported
fields
id
limit
offset
return_object
status

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get All Attachments for a Contract

Description

Tool to retrieve all attachments for a specific contract. Use when you need to list attachments linked to a contract.

Action Parameters

contract_id
integerRequired
limit
offset

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get All Attachments for a Invoice

Description

Tool to retrieve all attachments for a specific invoice. Use when you need to list or access files, URLs, or text attachments associated with an invoice.

Action Parameters

fields
invoice_id
integerRequired
limit
offset
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get All Attachments for a Purchase Order

Description

Tool to retrieve all attachments for a specific purchase order. Use when you need to list attachments linked to a purchase order.

Action Parameters

limit
offset
purchase_order_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get All Attachments on a CoupaPay Charge

Description

Tool to retrieve all attachments for a CoupaPay charge. Use when you need to list or access files, URLs, or text attachments associated with a charge.

Action Parameters

charge_id
integerRequired
limit
offset

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get All Charges Linked to Statement

Description

Tool to retrieve charges from Coupa, with optional filtering by statement ID. Use when you need to get all charges linked to a specific statement or query charges with various filters.

Action Parameters

exported
fields
holding_account_id[blank]
limit
offset
return_object
statement-id
virtual_card[document_type]
virtual_card[document_type][blank]

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get All Funds Transfers by Batch ID

Description

Tool to retrieve all funds transfers (payments) in a specific payment batch by payment batch ID. Use when you need to fetch payment details for a specific batch from Coupa Pay.

Action Parameters

exported
fields
payment_batch_id
integerRequired
status
status[in]
updated-at[gt]

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get All SIM Sites Against a SIM Record

Description

Tool to retrieve all supplier information sites associated with a specific supplier information record. Use when you need to list all sites linked to a particular SIM record, including nested address and contact information.

Action Parameters

active
fields
limit
offset
order_by
supplier_information_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Statements by Payment Partner

Description

Tool to retrieve corporate card payment partner statements from Coupa Pay. Use when you need to get statements filtered by payment partner, export status, or approval status.

Action Parameters

exported
payment-partner[issuing-bank]
status

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get All Supplier Sites for Supplier

Description

Tool to retrieve all supplier sites associated with a specific supplier record. Use when you need to get site data including codes, names, PO methods, contact information, and addresses for a particular supplier.

Action Parameters

fields
limit
offset
supplier_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get All Tasks Linked to All Projects

Description

Tool to retrieve all tasks linked to all projects from Coupa. Use when you need to fetch task records with optional filtering and pagination.

Action Parameters

fields
limit
offset
owner-id
return_object
status

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get All Tasks Linked to a Specific Project

Description

Tool to retrieve all tasks linked to a specific project in Coupa. Use when you need to fetch task records for a particular project with optional filtering and pagination.

Action Parameters

fields
limit
offset
project_id
integerRequired
return_object
status

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get API Documentation Modules

Description

Tool to retrieve the list of API documentation modules available in Coupa. Use when you need to discover available API documentation categories including Core Platform, Purchasing, Expense Reporting, Sourcing, Inventory, and other Coupa services.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Approval by ID

Description

Tool to retrieve details for a specific approval record by ID. Use when you need complete approval information including status, approver details, and associated approvable object.

Action Parameters

fields
id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get ASN Headers

Description

Tool to retrieve ASN (Advanced Ship Notice) headers from Coupa. Use when you need to fetch shipment notification records with optional filters for status, dates, supplier, or ASN number.

Action Parameters

asn-number
created-at[gt]
created-at[gt_or_eq]
created-at[lt]
created-at[lt_or_eq]
exported
fields
limit
offset
return_object
status
supplier[name]
updated-at[gt]
updated-at[gt_or_eq]
updated-at[lt]
updated-at[lt_or_eq]

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Budget Line Adjustments

Description

Tool to retrieve budget line adjustments for a specific budget line. Use when you need to get all adjustments associated with a budget line ID.

Action Parameters

budget_line_id
integerRequired
fields
limit
offset
order_by
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Business Entities

Description

Tool to retrieve business entities from Coupa. Use when you need to query legal or organizational business entities with their addresses, contacts, relationships, and metadata.

Action Parameters

created_at[gt]
created_at[lt]
fields
id
limit
name
name[contains]
offset
order_by
status
type
updated_at[gt]
updated_at[lt]

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Business Entity by ID

Description

Tool to retrieve a specific business entity by ID. Use when you need detailed information about a legal or organizational business entity.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get COAs for Supplier Site

Description

Tool to retrieve Chart of Accounts (COAs) assigned to a specific supplier site. Use when you need to view which content groups (COAs) are associated with a supplier site for visibility and access control purposes.

Action Parameters

fields
id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Comments for Expense Report

Description

Tool to retrieve comments for a specific expense report. Use when you need to view all comments associated with an expense report.

Action Parameters

expense_report_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Comments for Invoice

Description

Tool to retrieve all comments for a specific invoice. Use when you need to view existing notes, feedback, or communication on an invoice.

Action Parameters

invoice-id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Comments for Purchase Order

Description

Tool to retrieve all comments for a specific purchase order. Use when you need to view comments, notes, or discussion history on a purchase order.

Action Parameters

fields
id
integerRequired
limit
offset
order-by
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Comments for Requisition

Description

Tool to retrieve all comments for a specific requisition. Use when you need to view comments, notes, or feedback on a requisition.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Content Groups of Supplier Site

Description

Tool to retrieve business groups (content groups) of a supplier site. Use when you need to check which content groups are assigned to a specific supplier site for visibility management.

Action Parameters

supplier_site_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Contract By ID

Description

Tool to retrieve a single contract by ID. Use when you need detailed contract information including supplier, terms, dates, and status.

Action Parameters

fields
id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get CoupaPay Payment by ID

Description

Tool to retrieve a specific CoupaPay payment record by ID. Use when you need detailed payment information including payment amounts, payee details, payment batch, and associated invoice information for integration and reconciliation purposes.

Action Parameters

fields
id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Custom Object Instances

Description

Tool to retrieve all data records for a specified Custom Object in Coupa. Use when you need to fetch custom object instance data with optional filtering and pagination.

Action Parameters

custom_object_id
integerRequired
fields
limit
offset
order_by
return_object
updated_at[gt_or_eq]
updated_at[lt_or_eq]

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Department by Name

Description

Tool to retrieve department records by filtering with name or other parameters. Use when you need to find departments by name, ID, or active status.

Action Parameters

active
fields
id
limit
name
offset
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Exchange Rate By ID

Description

Tool to retrieve a specific exchange rate record by ID. Use when you need detailed exchange rate information including currency conversion rates, effective dates, and audit metadata.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get External Payables by Source

Description

Tool to retrieve external payable records from Coupa by source system. Use when you need to query external payables that originate from source systems outside of Coupa (e.g., SAP, Oracle, NetSuite). Returns payable details including amounts, dates, status, and source system information.

Action Parameters

document-date[gt_or_eq]
document-date[lt_or_eq]
document-number
document-type
due-date[gt_or_eq]
due-date[lt_or_eq]
fields
offset
order-by
return_object
source-name
source-reference
status

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Favorite Accounts

Description

Tool to retrieve favorite accounts from Coupa. Use when you need to get the list of accounts marked as favorites by the user.

Action Parameters

code
fields
id
offset
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Integration Run

Description

Tool to retrieve a specific integration run by ID. Use when you need detailed information about an integration run including status, timestamps, record counts, and errors.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Inventory Adjustments

Description

Tool to retrieve inventory adjustments from Coupa. Use when you need to query inventory adjustment records with optional filtering, pagination, and field selection.

Action Parameters

account[code]
created-at
exported
fields
from-warehouse[id]
item[id]
limit
offset
return_object
status
to-warehouse[id]
transaction-date
type
updated-at

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Item Image

Description

Tool to download the image for a catalog item. Use when you need to retrieve the image associated with a specific item ID.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Lookup Value by ID

Description

Tool to retrieve a specific lookup value by ID. Use when you need detailed information about a lookup value used for categorization and standardization in Coupa.

Action Parameters

fields
id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Matching Allocation for Invoice Line

Description

Tool to retrieve matching allocation records that link invoice lines to purchase orders, ASNs, and inventory transactions. Use when you need to reconcile invoices with purchase orders or track allocation history for specific invoice lines.

Action Parameters

fields
invoice_line[invoice_header_id][in]
invoice_line_id
offset
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Payable Invoice By ID

Description

Tool to retrieve a single payable invoice by ID. Use when you need detailed payable invoice information including amounts, currency, status, dates, allocations, and reconciliation lines.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Payable Invoices

Description

Tool to retrieve payable invoices from Coupa. Use when you need to query invoice payables with optional filters for status, dates, document information, and pagination support.

Action Parameters

created-at[gt]
created-at[lt]
currency[id]
document-id
document-type
fields
id
id[gt]
id[lt]
limit
maturity-date[gt]
maturity-date[lt]
offset
return_object
status
status[in]
updated-at[gt]
updated-at[lt]

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Pay Invoices - Fields Query Param

Description

Tool to retrieve Coupa Pay invoices with optional field filtering. Use when you need to fetch invoice data from Coupa Pay with control over which fields are returned.

Action Parameters

fields
limit
offset

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Pay Orders Pending Document Approval

Description

Tool to get pay orders with status pending_document_approval. Use when you need to retrieve orders awaiting document approval in the payables system.

Action Parameters

exported
fields
offset
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get PO Confirmation by ID

Description

Tool to retrieve a specific order header confirmation by ID. Use when you need details about a purchase order confirmation record.

Action Parameters

fields
id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get PO Confirmations Cancelled and Not Exported

Description

Tool to retrieve PO confirmations with cancelled status that have not been exported. Use when you need to identify cancelled order confirmations requiring processing or export to external systems.

Action Parameters

created-at[gt]
created-at[lt]
fields
offset
return_object
updated-at[gt]
updated-at[lt]

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get PO Line by Order Header ID and Line Number

Description

Tool to retrieve purchase order line(s) by order header ID and line number. Use when you need to get specific PO line details using the order header ID and line number combination.

Action Parameters

line_num
stringRequired
order_header_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Project Memberships

Description

Tool to query project memberships from Coupa. Use when you need to get project membership information based on user and/or project filters. This allows you to find which users are members of specific projects and their roles (owner, participant).

Action Parameters

fields
id
limit
offset
owner
participant
project-id
return_object
user-id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Purchase Order

Description

Tool to retrieve a specific purchase order. Use when you need PO details by its ID.

Action Parameters

fields
id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get PO Changes Pending Certain Approver

Description

Tool to get purchase order changes pending approval by a certain approver. Use when you need to retrieve PO modifications awaiting approval from a specific user.

Action Parameters

created-at[gt]
created-at[lt]
current-approval[approver-id]
current-approval[approver][login]
fields
limit
offset
order-header-id
status
updated-at[gt]
updated-at[lt]

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Remit-To Addresses of Supplier

Description

Tool to retrieve remit-to addresses for a specific supplier. The remit-to address (RTA) specifies where payment should be delivered and is owned by the supplier.

Action Parameters

active
country[code]
created-at[gt]
created-at[gt_or_eq]
created-at[lt]
created-at[lt_or_eq]
fields
id
Required
limit
offset
order_by
return_object
updated-at[gt]
updated-at[lt]
updated_by[login]

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Requisition Assignment

Description

Tool to retrieve assignment information for a specific requisition. Use when you need to see who is assigned to a requisition and in what role.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Requisition Line Estimated Tax Lines

Description

Tool to retrieve estimated tax lines for a requisition line. Use when you need tax calculation details for a specific requisition line.

Action Parameters

fields
id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Return To Supplier Transactions

Description

Tool to retrieve return to supplier transactions for reverse logistics operations. Use when you need to query transactions related to inventory returns to vendors.

Action Parameters

exported
fields
filters
id
offset
return_object
status
type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Supplier Risk Aware Feed

Description

Tool to retrieve supplier governance, risk, and compliance (GRC) data from Risk Aware feed. Use when you need to query supplier risk data by supplier ID, name, or number. Each supplier can only have one Risk Aware feed.

Action Parameters

supplier[id]
supplier[name]
supplier[number]

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get SIM Easy Form Responses

Description

Tool to retrieve easy form responses for a specific supplier information record. Use when you need to query form responses associated with SIM records or custom objects.

Action Parameters

fields
limit
offset
status
supplier_information_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get SIM Site by ID

Description

Tool to retrieve a specific supplier information site by ID. Use when you need detailed information about a single supplier information site including code, name, PO methods, cXML configuration, addresses, and contacts.

Action Parameters

fields
id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Soft Applied PO Updates

Description

Tool to retrieve soft applied purchase order updates using a confirmation ID. Use when you need to review PO changes that have been soft-applied by a supplier.

Action Parameters

confirmation_id
stringRequired
id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Specific Attachment on Purchase Order Line

Description

Tool to retrieve a specific attachment file from a purchase order line. Use when you need to download an attachment associated with a specific purchase order line.

Action Parameters

attachment_id
integerRequired
po_line_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Specific Attachment on Requisition Line

Description

Tool to retrieve a specific attachment file from a requisition line. Use when you need to download an attachment associated with a specific requisition line.

Action Parameters

attachment_id
integerRequired
req_line_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Specific Attachment on Purchase Order

Description

Tool to retrieve a specific attachment from a purchase order. Use when you need to get details about a specific attachment including file URL, metadata, or text content.

Action Parameters

attachment_id
integerRequired
purchase_order_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Specific Attachment Using Attachment ID

Description

Tool to retrieve a specific attachment associated with a charge. Use when you need to get attachment details by charge ID and attachment ID.

Action Parameters

attachment_id
integerRequired
charge_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Contract Attachment

Description

Tool to retrieve metadata for a specific contract attachment. Use when you need attachment details like file-url, type, intent, or file size for a known contract and attachment ID.

Action Parameters

attachment_id
integerRequired
contract_id
integerRequired
style

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Custom Object Instance

Description

Tool to retrieve a specific custom object instance by ID. Use when you need detailed information about a particular custom object data record.

Action Parameters

custom_object_id
integerRequired
fields
instance_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get EasyFormResponse Attachment File

Description

Tool to retrieve a specific attachment file from an EasyFormResponse. Use when you need to download attachment files for a known easy form response and attachment ID.

Action Parameters

attachment_id
integerRequired
easy_form_response_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Specific Invoice Attachment File

Description

Tool to retrieve a specific attachment from an invoice. Use when you need to get attachment metadata and file information for a specific invoice attachment.

Action Parameters

attachment_id
integerRequired
invoice_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Specific Requisition Attachment

Description

Tool to retrieve detailed information about a specific attachment on a requisition. Use when you need attachment metadata, file URL, type, intent, or content details for a requisition attachment.

Action Parameters

attachment_id
integerRequired
fields
requisition_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Statement By ID

Description

Tool to retrieve a single Coupa Pay statement by its unique identifier. Use when you need detailed information about a specific corporate card payment partner statement.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Status of an Import File

Description

Tool to retrieve status and details of a specific data import file source. Use when you need to monitor the status of CSV import files uploaded to Coupa, tracking whether they have been processed successfully, are in progress, or have failed.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Supplier Item by ID

Description

Tool to retrieve a specific supplier item by ID. Use when you need detailed supplier item information including pricing, availability, and item specifications.

Action Parameters

direction
fields
id
integerRequired
limit
offset
order_by

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Supplier Items by Item Name

Description

Tool to retrieve supplier items filtered by item name. Use when you need to find supplier items for a specific item.

Action Parameters

item[name]
limit
offset

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Supplier Site by Code

Description

Tool to retrieve supplier sites with optional filters. Use when you need to query supplier sites by code, name, or other attributes.

Action Parameters

active
code
code[contains]
code[starts_with]
limit
name
name[contains]
offset
po-method
supplier-id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Tax Registration by ID

Description

Tool to retrieve a specific supplier information tax registration record by ID. Use when you need detailed tax registration information for supplier information management.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get User Address by ID

Description

Tool to retrieve a specific address by ID for a Coupa user. Use when you need detailed information about a particular user address.

Action Parameters

coupa_user_id
integerRequired
fields
id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get User Memberships

Description

Tool to list user group memberships. Use when you need to retrieve user memberships in groups or projects with optional filtering and pagination.

Action Parameters

fields
id
limit
offset
owner
participant
return_object
user-group-id
user-group-type
user-id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Ignore Window And Issue

Description

Ignore Window And Issue

Action Parameters

fields
id
integerRequired
return_object
x-coupa-api-user-login

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Import Budget Lines

Description

Tool to import budget lines via CSV file upload. Use when uploading batch budget line data to Coupa for processing.

Action Parameters

content_b64
file
filename
mimetype
source_for
stringDefaults to BudgetLine

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Inspection Codes

Description

Tool to list inspection codes. Use when you need to retrieve id and code of inspection codes for inventory transactions.

Action Parameters

active
fields
lookup[name]
offset
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Integration Errors

Description

Tool to list and query integration errors in Coupa. Use when you need to retrieve error IDs and details for troubleshooting or resolving failed transactions.

Action Parameters

fields
filters
limit
offset
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Integration Runs

Description

Tool to list integration runs. Use after identifying an integration to retrieve run IDs and statuses.

Action Parameters

fields
filters
offset
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Integration

Description

Tool to create a new integration in Coupa. Use when you need to define a connection between Coupa and an external system, specifying the business object, data flow direction, and integration method.

Action Parameters

business-object
stringRequired
code
stringRequired
direction
stringRequired
end-system
stringRequired
end-system-type
stringRequired
integration-type
stringRequired
name
stringRequired
standard
booleanRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Integrations

Description

Tool to list integrations from Coupa. Use when you need to retrieve integration definitions and IDs for filtering integration runs.

Action Parameters

business_object
code
created_at
direction
end_system
end_system_type
fields
id
integration_type
name
offset
return_object
standard
updated_at

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Integration

Description

Tool to retrieve a specific integration by ID. Use when you need detailed information about a single integration.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Inventory Consumption

Description

Tool to delete an inventory consumption record. Use when you need to permanently remove an inventory consumption by ID.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Inventory Transfer

Description

Tool to delete an inventory transfer. Use when you need to permanently remove an inventory transfer by ID.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Invoice Attachment

Description

Tool to create an attachment on an invoice. Use when attaching files, text, or URLs to invoices.

Action Parameters

attachment[file]
attachment[intent]
attachment[text]
attachment[type]
stringRequired
attachment[url]
invoice_id
integerRequired
x-coupa-api-user-login

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Invoice

Description

Tool to delete an invoice. Use when you need to permanently remove an invoice by ID. Note: Invoices with pending approvals or certain statuses cannot be deleted.

Action Parameters

id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Invoices

Description

Tool to list invoices with optional pagination and filters. Use when you need to obtain invoice IDs or details for testing void invoice extensively.

Action Parameters

fields
filters
offset
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Remove Approver From Invoice

Description

Tool to remove a manually added approver from an invoice. Use when you need to remove a manually added approver from an invoice's approval chain by providing the approval ID.

Action Parameters

approval_id
integerRequired
id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Revalidate Invoice Tolerances

Description

Tool to revalidate tolerances on an invoice. Use when tolerance checks need rerunning after invoice submission issues.

Action Parameters

id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Invoice

Description

Tool to retrieve a single invoice by ID. Use when you need detailed invoice information including line items, charges, attachments, and approval details.

Action Parameters

fields
id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Submit Invoice

Description

Tool to submit a draft invoice for approval. Use when you need to kick off the approval workflow on a draft invoice.

Action Parameters

id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Invoice

Description

Tool to update an invoice via PUT /api/invoices/:id.

Action Parameters

bill-to-address
business_role
comments
currency
fields
id
integerRequired
internal-note
invoice-date
invoice-lines
invoice-number
line-level-taxation
lock-version-key
on_behalf_of
payload
payment-term
remit-to-address
return_object
ship-to-address
status
supplier
taggings
tags
tax-lines

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Issue Purchase Order Without Send

Description

Tool to issue a purchase order without transmitting it to the supplier. Use when purchase orders are communicated through alternative means outside of Coupa's transmission channels.

Action Parameters

fields
id
integerRequired
return_object
x-coupa-api-user-login

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Item

Description

Tool to create a catalog item. Use when provisioning items with minimal details in Coupa.

Action Parameters

description
stringRequired
item-number
name
stringRequired
price
uom

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Items

Description

Tool to list catalog items. Use when you need item IDs and item numbers for inventory adjustment.

Action Parameters

offset

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Existing Item

Description

Tool to update an existing item in Coupa catalog. Use when modifying item details like name, description, commodity, UOM, or other attributes. Only specified fields are updated; omit fields to leave unchanged.

Action Parameters

active
allow-partial-quantity
commodity
consumption-quantity
description
external-image-url
id
integerRequired
image-url
inventory-lot-expiration-type
inventory-lot-tracking-enabled
item-number
item-type
manufacturer-name
manufacturer-part-number
name
net-weight
pack-qty
pack-weight
receive-catch-weight
reorder-point
require-asset-tag
require-inspection
return_object
storage-quantity
uom
use-pack-weight

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Suppliers

Description

Tool to list suppliers with filters. Use when you need suppliers matching certain criteria.

Action Parameters

allow-cxml-invoicing
created-at[gt]
cxml-domain[contains]
cxml-supplier-domain[contains]
id
name
name[contains]
name[ends_with]
name[starts_with]
offset
payment-term[code]
payment-term[days-for-discount-payment]
po-method
primary-address[city]
primary-contact[email][contains]
reviews-count[gt]
status

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Logout Iframe Session

Description

Tool to log out CSP (Coupa Supplier Portal) iframe session. Use when you need to terminate an active supplier portal iframe session.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Mark a Charge as Exported

Description

Tool to mark a charge as exported in the accounting system. Use when you need to flag a charge as having been exported to an external system (such as an ERP).

Action Parameters

exported
booleanDefaults to True
id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Mark Payable Invoice as Tracking Externally

Description

Tool to mark a payable invoice as tracking externally. Use when an invoice payment will be managed outside of Coupa and you need to stop Coupa from tracking it internally.

Action Parameters

id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Mark Statement as Exported

Description

Tool to mark a Coupa Pay statement as exported. Use when you need to flag that a statement has been exported to an external system.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Mark CoupaPay Payment as Exported

Description

Tool to mark a CoupaPay payment as exported. Use after successfully retrieving and processing a payment in an external system to prevent duplicate retrieval in subsequent queries.

Action Parameters

exported
booleanDefaults to True
fields
id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Mark Payable Invoice as Tracking in Coupa

Description

Tool to mark a payable invoice as tracking in Coupa. Use when you want to start tracking an invoice payment within Coupa's internal payment system.

Action Parameters

id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Mark Payable Invoice as Paid Externally

Description

Tool to mark a payable invoice as paid externally. Use when a payment has been made outside of Coupa and you need to stop tracking it in the system. The invoice status will change to 'externally_paid'.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Mark Pay Invoice as Exported

Description

Tool to mark a Coupa Pay invoice as exported. Use after successfully retrieving and processing an invoice in an external system to prevent duplicate retrieval in subsequent queries.

Action Parameters

exported
booleanDefaults to True
id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Mark PO Confirmation as Integration Complete

Description

Tool to mark an order header confirmation as integration_complete. Use when an integration process has completed successfully and you need to update the confirmation status to reflect completion.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Mark PO Confirmation as Integration Failed

Description

Tool to mark an order header confirmation as integration_failed. Use when an integration process has failed and you need to update the confirmation status to reflect the integration failure.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Matching Allocation

Description

Tool to retrieve a specific matching allocation record by ID. Use when you need details about allocations between inventory transactions, PO lines, invoice lines, and ASN lines.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Notify Contract Signature Created

Description

Tool to notify that a signature has been added in CCC (Coupa Contract Collaboration). Use when you need to notify the system about signature creation for a contract.

Action Parameters

api_user_email
api_user_id
api_user_login
business_role
fields
id
integerRequired
on_behalf_of
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Object Translation

Description

Tool to create a translation for a UOM object in Coupa. Use when you need to add locale-specific translations for unit of measure attributes in different languages.

Action Parameters

key
stringRequired
locale
stringRequired
uom-id
integerRequired
value
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Object Translation

Description

Tool to delete a UOM translation. Use when you need to permanently remove a specific translation for a Unit of Measure by ID.

Action Parameters

id
integerRequired
uom_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Object Translations

Description

Tool to list all translations for a specific Unit of Measure (UOM). Use when you need to retrieve multi-language translations for UOM objects in Coupa.

Action Parameters

fields
offset
return_object
uom_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get UOM Translation

Description

Tool to retrieve a specific translation record for a Unit of Measure (UOM). Use when you need details about a particular UOM translation by ID for multi-language support.

Action Parameters

id
integerRequired
uom_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Order Confirmation

Description

Tool to delete an order confirmation. Use when you need to permanently remove an order confirmation by ID.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Order List

Description

Tool to create an order pad (order list) in Coupa. Use when you need to create a list, set, or kit of frequently requested items from a supplier catalog for easy ordering.

Action Parameters

add-all-items
any-supplier
booleanRequired
base-value
numberRequired
base-value-currency
Required
business-groups
locked
name
stringRequired
order-pad-lines
order-pad-sections
suppliers
array
use-base-value
booleanRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Order List

Description

Tool to delete an order list (order pad). Use when you need to permanently remove an order list by ID.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Order List

Description

Tool to retrieve a specific order list (order pad) by ID. Use when you need detailed information about an order list including suppliers, items, and business groups.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Order List

Description

Tool to update an existing order list (order pad) in Coupa. Use when you need to modify order list attributes such as name, locked status, or supplier settings.

Action Parameters

any-supplier
base-value
id
integerRequired
locked
name
payload
use-base-value

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Order Pads

Description

Tool to list order pads (order lists) from Coupa. Order pads are lists, sets, or kits of frequently requested items within a supplier catalog for streamlined ordering. Use when you need to retrieve order pad IDs, names, and associated suppliers with optional pagination.

Action Parameters

fields
offset
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Business Entity

Description

Tool to update a business entity using PATCH method. Use when you need to modify specific fields of an existing business entity without sending all fields.

Action Parameters

addresses
business-entity-account-owners
business-entity-alternate-names
business-entity-external-references
business-entity-relationships
business_role
country-of-origin
display-name
fields
formation-type
id
integerRequired
name
on_behalf_of
payload
primary-address
primary-contact
return_object
status
type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Purchase Order

Description

Tool to update a purchase order. Use when you need to modify specific fields of an existing PO. Only fields provided will be updated. Note: exported field cannot be updated simultaneously with other fields by default.

Action Parameters

business_role
classification
confirm-by-hrs
currency
exported
fields
hide-price
id
integerRequired
on_behalf_of
order-lines
payload
payment-term
po-number
reason-insight-event-comment
reason-insight-id
return_object
ship-to-address
ship-to-attention
shipping-term
supplier
supplier-site
transmission-emails
transmission-method-override

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Payment Terms

Description

Tool to list payment terms with filters.

Action Parameters

active
code
code_contains
code_ends_with
code_starts_with
created_at_gt
created_at_lt
days_for_discount_payment
days_for_net_payment
discount_cutoff_day
discount_due_day
discount_due_month
discount_rate
fields
limit
net_cutoff_day
net_due_day
net_due_month
offset
return_object
type
updated_at_gt
updated_at_lt

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Payment Term

Description

Tool to retrieve a single payment term by ID. Use when you need detailed payment term information.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Post Comment on Invoice

Description

Tool to post a comment on an invoice. Use when you need to add notes, feedback, or mention users on an existing invoice.

Action Parameters

comments
stringRequired
inv_id
integerRequired
reason-code
to-supplier

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Project

Description

Tool to create a Coupa project. Use when you need to create a new project in Coupa with required details like name, dates, and description.

Action Parameters

active
booleanDefaults to True
category
commodity-id
content-groups
department
description
stringRequired
end-date
stringRequired
external-reference-number
mention-name
name
stringRequired
open
start-date
stringRequired
status
users

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Projects

Description

Tool to list/query all projects from Coupa. Use when you need to retrieve project information with optional filtering and pagination.

Action Parameters

active
fields
filters
id
limit
name
offset
return_object
status

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Project

Description

Tool to retrieve a single project by ID. Use when you need detailed project information after knowing the project ID.

Action Parameters

fields
id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Project

Description

Tool to update an existing Coupa project. Use when you need to modify project attributes after confirming project ID.

Action Parameters

active
additional-negotiated-savings
additional-planned-savings
additional-realized-savings
allow-users-to-view-member
business_role
category
category-plan
commodity
commodity-id
completion-percentage
content-groups
copy-project-id
department
description
display-date-range-warning
enabled-tabs
end-date
external-reference-number
fields
id
integerRequired
mention-name
name
on_behalf_of
open
payload
return_object
show-contracts-rollup-fields
show-sourcing-rollup-fields
show-suppliers-rollup-fields
start-date
status
taggings
template-group
users

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Purchase Order Attachment

Description

Tool to create an attachment on a purchase order. Use when attaching files, text, or URLs to purchase orders.

Action Parameters

api_user_login
file
intent
purchase_order_id
integerRequired
text
type
stringRequired
url

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Close Purchase Order

Description

Tool to close a purchase order. Use when you need to finalize a PO after confirming receipt.

Action Parameters

id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Purchase Orders

Description

Tool to list purchase order headers. Use when you need to fetch filtered and paginated purchase order records from Coupa.

Action Parameters

created-at[gt]
created-at[lt]
exported
fields
filter
id
offset
return_object
show_deleted_lines
status
status[in]
supplier[name]
updated-at[gt]
updated-at[lt]

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Issue Purchase Order

Description

Tool to issue and send a purchase order to the supplier. Use after preparing a PO to dispatch it.

Action Parameters

fields
id
integerRequired
return_object
x-coupa-api-user-login

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update User Account

Description

Tool to update a Coupa user account. Use when you need to modify user information such as name, email, permissions, licenses, or other attributes.

Action Parameters

account-groups
account-security-type
active
aic-user
allow-employee-payment-account-creation
allow-user-to-upload-invoice-from-mobile
analytics-user
api-user
approval-groups
authentication-method
business-function
business-group-security-type
can-expense-for
category-planner-user
ccw-user
content-groups
contract-approval-limit
contract-self-approval-limit
contracts-user
country-of-residence
default-account
default-account-type
default-address
default-currency
default-locale
department
email
employee-number
employee-payment-channel
escalation-threshold
expense-approval-limit
expense-self-approval-limit
expense-user
expenses-delegated-to
fields
firstname
generate-password-and-notify
id
integerRequired
inventory-organizations
inventory-user
invoice-approval-limit
invoice-self-approval-limit
invoicing-user
lastname
legal-entity
login
manager
mention-name
middlename
password
phone-mobile
phone-work
purchasing-user
requisition-approval-limit
requisition-self-approval-limit
return_object
risk-assess-user
roles
salesforce-enabled
salesforce-id
self-approval-limit
seniority-level
sourcing-user
spend-guard-user
sso-identifier
supply-chain-user
travel-user
treasury-user
user-groups
work-confirmation-approval-limit
working-warehouses

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Reason Insights

Description

Tool to list Reason Insights. Use when you need to retrieve reason insights with optional filters and pagination.

Action Parameters

active
code
fields
id
name
offset
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Receipt Request

Description

Tool to create a new receipt request. Use when you need to create a receipt request for purchase order lines.

Action Parameters

lines
arrayRequired
status
type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Receipt Requests

Description

Tool to list receipt requests from Coupa. Use when you need to retrieve receipt request records with optional filtering and pagination.

Action Parameters

direction
fields
filters
limit
offset
order_by
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Receipt Request

Description

Tool to update an existing receipt request via PUT /api/receipt_requests/:id. Use when you need to modify receipt request attributes after confirming the receipt request exists.

Action Parameters

business_role
id
integerRequired
lines
on_behalf_of
payload
return_object
status
type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Release Purchase Order from Buyer Hold

Description

Tool to release a purchase order from buyer hold status. Use when you need to transition a PO from buyer_hold to an active state, allowing further processing.

Action Parameters

fields
id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Remit-To Address

Description

Tool to delete a remit-to address from a supplier. Use when you need to permanently remove a remit-to address by supplier ID and address ID.

Action Parameters

id
integerRequired
supplier_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Remit-To Addresses

Description

Tool to list remit-to addresses from Coupa. Use when you need to retrieve supplier payment addresses with optional filtering and pagination.

Action Parameters

country[code]
created-at[gt]
fields
id
offset
return_object
supplier-id
updated-by[login]

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Remove Content Group from Contract

Description

Tool to remove a specific content group (business group) from a contract. Use when you need to revoke access control for a particular group from a contract.

Action Parameters

business_group_id
integerRequired
contract_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Remove All Content Groups from Contract

Description

Tool to remove all content groups (business groups) from a contract. Use when you need to clear all access control groups from a contract, making it inaccessible to users without unrestricted access.

Action Parameters

contract_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Remove All Content Groups from SIM Record

Description

Tool to remove all content groups (business groups) from a Supplier Information Management (SIM) record. Use when you need to clear all access control groups from a SIM record, making it inaccessible to users without unrestricted access.

Action Parameters

sim_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Remove All Content Groups from SIM Site

Description

Tool to remove all content groups (business groups) from a Supplier Information Management (SIM) site record. Use when you need to clear all access control groups from a SIM site, making it inaccessible to users without unrestricted access.

Action Parameters

sim_site_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Remove All Content Groups on Supplier

Description

Tool to remove all content groups (business groups) from a supplier. Use when you need to clear all content group associations from a supplier for access control or visibility management.

Action Parameters

supplier_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Remove Contract Approval

Description

Tool to remove a manually added approver from a contract. Use when you need to remove an approver or watcher that was manually added to a contract's approval chain.

Action Parameters

api_user_email
api_user_id
api_user_login
approval_id
approver_id
id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Remove Content Group from Supplier Site

Description

Tool to remove a content group (business group) from a supplier site. Use when you need to revoke a content group assignment from a supplier site for access control or visibility management.

Action Parameters

business_group_id
integerRequired
supplier_site_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Remove Content Group from SIM Record

Description

Tool to remove a content group (business group) from a Supplier Information Management (SIM) record. Use when you need to revoke a content group assignment from a SIM record for access control or visibility management.

Action Parameters

business_group_id
integerRequired
sim_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Remove Content Group from Supplier

Description

Tool to remove a content group (business group) from a supplier. Use when you need to revoke a content group assignment from a supplier for access control or visibility management.

Action Parameters

business_group_id
integerRequired
supplier_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Reopen PO Line for Receiving

Description

Tool to reopen a purchase order line for receiving. Use when a PO line needs to be reopened to allow additional receiving transactions.

Action Parameters

id
integerRequired
reason-insight-event-comment
stringRequired
reason-insight-id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Re-Open Soft-Closed PO

Description

Tool to reopen a soft-closed purchase order. Use when an invoice or credit memo submission is needed, or if a PO was closed prematurely or by mistake.

Action Parameters

id
integerRequired
reason-insight-code
reason-insight-event-comment
reason-insight-id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Requisition Lines

Description

Tool to retrieve requisition line items from Coupa procurement system. Use when you need to query requisition line data with filtering, pagination, and field selection capabilities.

Action Parameters

created-at[gt]
created-at[lt]
description
description[contains]
fields
id
limit
line-num
need-by-date[gt]
offset
status
status[in]
updated-at[gt]

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add To Cart

Description

Tool to add items from a requisition to the shopping cart. Use after constructing the add_to_cart payload.

Action Parameters

requisition-lines
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Requisition Attachment

Description

Tool to create an attachment on a requisition. Use when attaching files, text, or URLs to requisitions.

Action Parameters

attachment[file]
attachment[intent]
attachment[text]
attachment[type]
stringRequired
attachment[url]
requisition_id
integerRequired
x-coupa-api-user-login

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Requisition

Description

Tool to create a new requisition. Endpoint: POST /api/requisitions

Action Parameters

attachments
buyer-note
justification
requested-by
objectRequired
requisition-lines
arrayRequired
ship-to-address

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Current Cart

Description

Tool to get the current user's requisition cart. Use when you need to fetch or initialize the current cart for the authenticated user.

Action Parameters

fields
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Requisition

Description

Tool to delete a requisition. Use when you need to permanently remove a requisition by ID.

Action Parameters

id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Requisitions

Description

Tool to list requisitions with filters.

Action Parameters

fields
limit
offset
requested-by[login]
return_object
status

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List My Requisitions

Description

Tool to list the authenticated user's requisitions. Use when you need to retrieve paginated user requisitions with optional filters.

Action Parameters

created-at
fields
limit
offset
requested-by[login]
return_object
status

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Remove Approver from Requisition

Description

Tool to remove an approver from a requisition. Use when you need to remove a manually added approver from a requisition. Endpoint: PUT /api/requisitions/:id/remove_approval

Action Parameters

api_user_email
api_user_id
api_user_login
approval_id
approver_id
id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Save Requisition for Later

Description

Tool to save a requisition for later. Use when you need to stash a draft requisition without submitting it.

Action Parameters

fields
id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Requisition

Description

Tool to retrieve a single requisition by its ID. Use when you need detailed requisition data.

Action Parameters

fields
id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Submit Requisition for Approval

Description

Tool to submit a requisition for approval. Use when you need to create a requisition and immediately submit it for approval.

Action Parameters

attachments
buyer-note
justification
requested-by
objectRequired
requisition-lines
arrayRequired
ship-to-address

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update and Submit for Approval

Description

Tool to update a requisition and submit it for approval. Endpoint: PUT /api/requisitions/:id/update_and_submit_for_approval

Action Parameters

id
integerRequired
requisition-header
objectRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Restart Invoice Approval

Description

Tool to clear the current approval chain and regenerate a new approval chain for an invoice that has been modified. Use when an invoice has undergone changes requiring the approval workflow to be regenerated. All manually added approvers will be removed.

Action Parameters

id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve All SIM Records

Description

Tool to retrieve all Supplier Information Management (SIM) records from Coupa. Use when you need to list supplier information records with optional filters for date ranges, export status, supplier ID, name, or status. The SIM API is used to retrieve supplier information collected via Coupa's Supplier Information Management system. Supports pagination with limit and offset parameters.

Action Parameters

created-at[gt]
created-at[gt_or_eq]
created-at[lt]
created-at[lt_or_eq]
exported
fields
limit
name
name[contains]
name[ends_with]
name[starts_with]
offset
order-by
status
status[contains]
supplier-id
supplier-id[eq]
supplier-id[gt]
supplier-id[lt]
updated-at[gt]
updated-at[gt_or_eq]
updated-at[lt]
updated-at[lt_or_eq]

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve Invoice Clearance Document

Description

Tool to download the ZATCA compliance clearance document for an invoice. Use when you need the clearance document attached to a specific invoice.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve Invoice Image Scan

Description

Tool to download the invoice image scan attachment. Use when you need to retrieve the scanned PDF or image file of the original invoice document.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve SIM Record by ID

Description

Tool to retrieve a specific Supplier Information Management (SIM) record by ID. Use when you need detailed supplier information collected via SIM. Requires SIM API permissions.

Action Parameters

fields
id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Return to Supplier Transaction

Description

Tool to delete a return to supplier transaction. Use when you need to permanently remove a return to supplier transaction by ID.

Action Parameters

id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Coupa S3 File Upload or Get

Description

Coupa S3 File Upload or Get

Action Parameters

attachment_id
content_b64
file
filename
intent
mimetype
operation
stringRequired
resource_id
resource_type
text
type
url

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Schedule Requisition Issuance

Description

Tool to set scheduled issuance dates for requisition lines. Use when you need to schedule specific requisition lines for issuance on a particular date, optionally with automatic retry logic if the requisition is not yet approved.

Action Parameters

requisition_line_ids
arrayRequired
schedule_issuance_date
stringRequired
schedule_retry_interval

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Shipping Term

Description

Tool to create a new shipping term in Coupa. Use when you need to provision a new shipping term with a unique code and activation status.

Action Parameters

active
booleanRequired
code
stringRequired
content-groups
description

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Shipping Term

Description

Tool to retrieve a specific shipping term by ID. Use when you need detailed information about shipping terms and conditions.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Shipping Term

Description

Tool to update an existing shipping term. Use when you need to modify shipping term attributes after verifying it exists.

Action Parameters

active
code
content-groups
description
id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Soft Close PO Line for Invoicing

Description

Tool to soft close a purchase order line for invoicing. Use when a PO line should be marked as complete for invoicing purposes but may need to remain open for other operations.

Action Parameters

id
integerRequired
reason-insight-code
reason-insight-event-comment
reason-insight-id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Soft Close PO Line for Receiving

Description

Tool to soft close a purchase order line for receiving. Use when a PO line should be marked as complete for receiving purposes but may need to remain open for other operations.

Action Parameters

id
integerRequired
reason-insight-code
reason-insight-event-comment
reason-insight-id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Submit Contract for Approval

Description

Tool to submit a contract for approval. Use when you need to start the approval process for a contract.

Action Parameters

api_user_email
api_user_id
api_user_login
business_role
fields
id
integerRequired
on_behalf_of
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Supplier Information Site

Description

Tool to delete a supplier information site. Use when you need to permanently remove a supplier information site by ID. Requires SIM API permissions.

Action Parameters

id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Supplier Information Sites

Description

Tool to list supplier information sites from Coupa SIM (Supplier Information Management). Use when you need to retrieve supplier site data including codes, names, PO methods, contact information, addresses, and status for transmission to ERP or financial systems.

Action Parameters

active
code
exported
fields
id
limit
name
offset
order_by

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Supplier Item

Description

Tool to delete a supplier item. Use when you need to permanently remove a supplier item by its unique ID.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Supplier Risk Aware Feed

Description

Tool to delete a Supplier Risk Aware Feed. Use when you need to permanently remove a Supplier Risk Aware Feed record by ID.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Supplier Risk Aware Feed

Description

Tool to retrieve a specific Supplier Risk Feed record by ID. Use when you need to get governance, risk, and compliance (GRC) data for a supplier from Risk Aware.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Supplier Site

Description

Tool to create a new supplier site in Coupa. Use when you need to add a new site location for an existing supplier with specific PO transmission methods and contact details.

Action Parameters

active
booleanRequired
allow-change-requests
allow-order-confirmation-item-substitutions
buyer-hold
code
stringRequired
cxml-domain
cxml-http-username
cxml-identity
cxml-protocol
cxml-secret
cxml-ssl-version
cxml-supplier-domain
cxml-supplier-identity
cxml-url
default-locale
disable-cert-verify
name
stringRequired
payment-method
po-change-method
stringRequired
po-email
po-method
stringRequired
supplier-id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Supplier Site

Description

Tool to delete a supplier site. Use when you need to remove a supplier site by ID. Note: This performs a soft delete by setting the 'active' field to false rather than physically removing the record.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Supplier

Description

Tool to retrieve a single supplier. Use when you need detailed supplier information by ID.

Action Parameters

fields
id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Supplier

Description

Tool to update a supplier. Use when revising supplier details after verifying the supplier exists; only changed fields need to be included.

Action Parameters

account-number
allow-cxml-invoicing
allow-inv-from-connect
business_role
cxml-domain
cxml-identity
cxml-protocol
cxml-secret
cxml-supplier-domain
cxml-supplier-identity
cxml-url
duns
fields
id
integerRequired
invoice-matching-level
name
number
on-hold
on_behalf_of
payload
payment-term
po-email
po-method
primary-address
primary-contact
return_object
shipping-term
status

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Sync Supplier User Locale

Description

Tool to sync supplier user locale settings. Use when you need to synchronize locale preferences for a specific supplier user.

Action Parameters

email
stringRequired
supplier_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Task

Description

Tool to delete a task. Use when you need to permanently remove a task by ID.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Task by ID

Description

Tool to retrieve a single task by ID. Use when you need detailed task information after knowing the task ID.

Action Parameters

fields
id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Task

Description

Tool to update an existing Task in Coupa via PUT /api/tasks/:id. Use when you need to modify task attributes such as title, description, status, percentage, owner, or linked objects.

Action Parameters

business_role
description
due-date
duration
fields
id
integerRequired
linkable-id
linkable-type
on_behalf_of
owner-id
payload
percentage
return_object
start-date
status
title

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Query Tax Registrations

Description

Tool to query tax registrations from Coupa. Use when you need to retrieve tax identification numbers and fiscal representative details for entities.

Action Parameters

active
country[code]
fields
id
local
number
offset
owner-id
owner-type
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Tax Registration

Description

Tool to retrieve a single tax registration record by ID. Use when you need detailed tax registration information including country, registration number, and fiscal representative.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Unschedule Requisition Issuance

Description

Tool to remove scheduled issuance dates from requisition lines. Use when you need to unschedule requisition lines that were previously configured for automatic purchase order issuance.

Action Parameters

requisition_line_ids
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Units of Measure

Description

Tool to list units of measure. Use when retrieving or filtering UOM catalog for inventory or purchasing flows.

Action Parameters

active
allowable-precision
code
created-at[gt]
created-at[lt]
fields
id
name
offset
return_object
updated-at[gt]
updated-at[lt]

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Business Entity

Description

Tool to update a business entity in Coupa. Use when you need to modify business entity attributes after verifying the entity exists.

Action Parameters

addresses
business-entity-account-owners
business-entity-alternate-names
business-entity-external-references
business-entity-relationships
business_role
country-of-origin
display-name
formation-type
id
integerRequired
name
on_behalf_of
payload
primary-address
primary-contact
return_object
status
type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Exchange Rate

Description

Tool to update an exchange rate between two currencies in Coupa. Use when you need to modify exchange rate values or effective dates. Exchange rates are one-way only (e.g., USD→EUR and EUR→USD require separate records). The currencies must already exist in the system before updating the exchange rate.

Action Parameters

business_role
fields
from-currency
id
integerRequired
on_behalf_of
payload
rate
rate-date
return_object
to-currency

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Existing Address

Description

Tool to update an existing address in Coupa. Use when revising address details after verifying the address exists and is active.

Action Parameters

active
attention
business-group-name
business_role
city
country
fields
id
integerRequired
local-tax-number
location-code
name
on_behalf_of
payload
postal-code
return_object
state
state-iso-code
street1
street2
street3
street4
vat-country
vat-number

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Existing Department

Description

Tool to update an existing department in Coupa. Use when you need to modify department attributes such as name or active status.

Action Parameters

active
fields
id
integerRequired
name
payload
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Existing Lookup Value

Description

Tool to update an existing lookup value in Coupa. Use when you need to modify lookup value attributes like name, description, or active status.

Action Parameters

account-type
active
business_role
description
external-ref-code
external-ref-num
fields
id
integerRequired
is-default
lookup-id
name
on_behalf_of
parent
payload
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Existing Payment Term

Description

Tool to update an existing payment term in Coupa. Use when you need to modify payment term attributes after confirming the payment term ID.

Action Parameters

active
business_role
code
content-groups
days-for-discount-payment
days-for-net-payment
description
discount-cutoff-day
discount-due-day
discount-due-month
discount-rate
fields
id
integerRequired
net-cutoff-day
net-due-day
net-due-month
on_behalf_of
payload
return_object
type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Existing Supplier Item

Description

Tool to update an existing supplier item in Coupa. Use when modifying supplier item details such as price, availability, or other attributes after verifying the supplier item exists.

Action Parameters

availability
availability-date
business_role
catalog
contract
contract-term
currency
id
integerRequired
item
lead-time
manufacturer
minimum-order-quantity
on_behalf_of
order-increment
payload
preferred
price
price-tier-1
price-tier-10
price-tier-11
price-tier-12
price-tier-13
price-tier-14
price-tier-15
price-tier-16
price-tier-17
price-tier-18
price-tier-19
price-tier-2
price-tier-20
price-tier-3
price-tier-4
price-tier-5
price-tier-6
price-tier-7
price-tier-8
price-tier-9
purchasable
return_object
savings-pct
supplier
supplier-aux-part-num
supplier-part-num
unspsc-code

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Existing Task

Description

Tool to update an existing task within a specific project in Coupa via PUT /api/projects/:project_id/tasks/:task_id. Use when you need to modify task attributes for a project-linked task.

Action Parameters

business_role
description
due-date
duration
fields
on_behalf_of
owner-id
payload
percentage
project_id
integerRequired
return_object
start-date
status
task_id
integerRequired
title

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Image Scan on Invoice

Description

Tool to update image scan on an invoice via PUT /api/invoices/:id/image_scan. Use when updating an invoice's scanned document by providing either a file or URL reference.

Action Parameters

id
integerRequired
return_object
type
stringRequired
url

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Pay Order Status to Ready to Pay

Description

Tool to update a payable order status to ready to pay. Use when you need to transition a payable order to a 'ready to pay' status for payment processing.

Action Parameters

pay_order_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Project

Description

Tool to update an existing Coupa project. Use when modifying project attributes after confirming project ID exists.

Action Parameters

active
additional-negotiated-savings
additional-planned-savings
additional-realized-savings
allow-users-to-view-member
business_role
category
category-plan
commodity
commodity-id
completion-percentage
content-groups
copy-project-id
department
description
display-date-range-warning
enabled-tabs
end-date
external-reference-number
fields
id
integerRequired
mention-name
name
on_behalf_of
open
payload
return_object
show-contracts-rollup-fields
show-sourcing-rollup-fields
show-suppliers-rollup-fields
start-date
status
taggings
template-group
users

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Project Member as Owner

Description

Tool to update a project member as owner in Coupa. Use when you need to change owner/administrator or participant status for a project membership.

Action Parameters

fields
owner
booleanRequired
participant
booleanRequired
project_id
integerRequired
project_membership_id
integerRequired
return_object
user_id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update PO Change (Remote Approver)

Description

Tool to update a purchase order change with remote approver information. Use when you need to modify a pending PO change request by providing the current approver's login.

Action Parameters

approver_login
stringRequired
order-header-id
payload
po_change_id
integerRequired
reason-insight-code
reason-insight-event-comment
reason-insight-id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Status of a Project

Description

Tool to update the status of a project by transitioning it to a specific state. Use when you need to change a project's status to draft, planned, in_progress, complete, or canceled. Returns HTTP 204 for successful transitions and HTTP 304 for invalid transitions.

Action Parameters

id
integerRequired
status
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Supplier Remit-To Address

Description

Tool to update an existing remit-to address for a supplier. Use when you need to modify address details or deactivate a remit-to address for payment routing in Coupa.

Action Parameters

active
address_id
integerRequired
city
country
external-src-name
external-src-ref
local-tax-number
name
postal-code
remit-to-code
return_object
state
street1
street2
street3
street4
supplier_id
integerRequired
vat-country
vat-number

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List User Groups

Description

Tool to list user groups (user memberships). Use when you need to retrieve user group information including members, approval permissions, and group metadata.

Action Parameters

active
can-approve
fields
limit
name
name[contains]
offset
order-by
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create User

Description

Tool to create a Coupa user. Use when you need to programmatically add a new user to your Coupa instance.

Action Parameters

active
email
stringRequired
firstname
stringRequired
lastname
stringRequired
login
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Users

Description

Tool to list users. Use when you need to retrieve multiple user records with optional pagination and filtering.

Action Parameters

fields
limit
offset
return_object
status

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get User

Description

Tool to retrieve a single user by ID. Use when you need detailed user information after knowing the user ID.

Action Parameters

fields
id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update User

Description

Tool to update an existing Coupa user. Use when you need to modify user attributes via Coupa API after confirming user ID.

Action Parameters

account-groups
account-security-type
active
aic-user
allow-employee-payment-account-creation
allow-user-to-upload-invoice-from-mobile
analytics-user
api-user
approval-limit
authentication-method
business-group-security-type
business_role
category-planner-user
ccw-user
content-groups
contract-approval-limit
contract-self-approval-limit
contracts-user
country-of-residence
default-account
default-account-type
default-address
default-currency
default-locale
department
email
employee-number
employee-payment-channel
escalation-threshold
expense-approval-limit
expense-self-approval-limit
expense-user
fields
firstname
generate-password-and-notify
id
integerRequired
inventory-organizations
inventory-user
invoice-approval-limit
invoice-self-approval-limit
invoicing-user
lastname
legal-entity
login
manager
mention-name
on_behalf_of
password
payload
phone-mobile
phone-work
purchasing-user
requisition-approval-limit
requisition-self-approval-limit
return_object
risk-assess-user
roles
salesforce-enabled
salesforce-id
self-approval-limit
seniority-level
sourcing-user
spend-guard-user
sso-identifier
supply-chain-user
travel-user
treasury-user
user-groups
work-confirmation-approval-limit
working-warehouses

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Void Invoice

Description

Tool to void an invoice. Use when an approved or pending invoice needs to be voided. Example: Void invoice with ID 12345.

Action Parameters

fields
id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Withdraw Contract Signatures

Description

Tool to withdraw signatures from a contract in Coupa Contract Center (CCC). Use when you need to move a contract to the corresponding status after CCC signature withdrawal. The contract must be in 'pending_signatures' status for this operation to succeed.

Action Parameters

api_user_email
api_user_id
api_user_login
business_role
fields
id
integerRequired
on_behalf_of
return_object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Withdraw Invoice Dispute

Description

Tool to withdraw a dispute on an invoice. Use when a disputed invoice needs to be returned to the approval process due to supplier inaction or a mistake on the buyer side.

Action Parameters

id
integerRequired
return_object

Action Response

data
objectRequired
error
successful
booleanRequired