Coupa provides a comprehensive business spend management platform with procurement, invoicing, and expense capabilities.
Coupa provides a comprehensive business spend management platform with procurement, invoicing, and expense capabilities. On Nagent, Coupa is exposed as a fully-configurable accounting integration that any agent can call — 384 actions, and OAuth authentication. No code is required to wire Coupa into your workflow — connect it once via the External Integrations panel and reuse it across every agent you build.
Agent builders use Coupa to automate the kinds of tasks accounting teams previously handled manually. Concrete examples — each one is a single agent step in Nagent — include:
Every action and trigger is paired with a structured input/output schema (visible in the sections below), so when you wire Coupa into Helix — our agentic agent builder — the editor knows exactly what each step expects and produces. Configure once, deploy anywhere across your Nagent agents.
Every operation an agent can call against Coupa, with input parameters and output schema. Drop these into any step of an agent built in Helix.
COUPA_ABANDON_AN_INVOICETool to abandon an invoice. Use when an invoice is invalid and needs to be abandoned. Invoice once abandoned cannot be reversed.
Input parameters
Coupa unique identifier of the invoice to abandon.
Optional comment explaining why the invoice is being abandoned.
Whether to send notification to the supplier about the abandoned invoice.
The ID of the Reason Insight to use for abandoning the invoice. Either reason_insight_id or reason_insight_code must be provided.
The code of the Reason Insight to use for abandoning the invoice. Either reason_insight_id or reason_insight_code must be provided.
Comma-separated list of additional email recipients to notify.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ACCOUNTS_CREATETool 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.
Input parameters
Optional user-friendly account nickname.
Whether the account is active/available to users.
First code segment (≤100 characters)
Second code segment (≤100 characters)
Third code segment (≤100 characters)
Fourth code segment (≤100 characters)
Fifth code segment (≤100 characters)
Sixth code segment (≤100 characters)
Seventh code segment (≤100 characters)
Eighth code segment (≤100 characters)
Ninth code segment (≤100 characters)
Tenth code segment (≤100 characters)
Eleventh code segment (≤100 characters)
Twelfth code segment (≤100 characters)
Thirteenth code segment (≤100 characters)
Fourteenth code segment (≤100 characters)
Fifteenth code segment (≤100 characters)
Sixteenth code segment (≤100 characters)
Seventeenth code segment (≤100 characters)
Eighteenth code segment (≤100 characters)
Nineteenth code segment (≤100 characters)
Twentieth code segment (≤100 characters)
Reference to an existing Coupa Account Type. Provide `id` or `name`.
ID of the existing Account Type. Alternative to `account-type` object.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ACCOUNTS_INDEXTool to list accounts from Coupa. Use when you need to retrieve account IDs and codes with optional filters and pagination.
Input parameters
Exact-match filter by Coupa account ID
Exact-match filter by account code; supports Coupa query operators
Filter by active status: true for active accounts, false for inactive
JSON array of fields to return; e.g., \["id","code"\]
Pagination offset; results are returned in pages up to 50
Response verbosity: 'limited' returns only IDs; 'shallow' returns full object attributes with one-level association IDs
Filter by account type ID
Filter by account type name
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ACCOUNTS_RECENTTool to retrieve recently accessed accounts from Coupa. Use when you need to view accounts that the user has recently interacted with.
Input parameters
Maximum number of records to return (1-50)
JSON array of fields to return; e.g., \["id","code","name"\]
Pagination offset; results are returned in pages up to 50
Response verbosity: 'limited' returns only IDs; 'shallow' returns full object attributes with one-level association IDs
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ACCOUNTS_SHOWTool to retrieve a specific account by ID. Use when you need detailed account information including segments, type, and status.
Input parameters
ID of the account to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ACCOUNTS_UPDATETool to update an existing Coupa account. Use when you need to modify account information including account type, activation status, code segments, and display name.
Input parameters
Coupa unique identifier of the account to update.
All segments concatenated with a hyphen (-). Auto-generated from segments if not provided.
Display nickname searchable through the user interface.
Controls account availability; false deactivates, true activates.
First code segment (≤100 characters)
Second code segment (≤100 characters)
Third code segment (≤100 characters)
Fourth code segment (≤100 characters)
Fifth code segment (≤100 characters)
Sixth code segment (≤100 characters)
Seventh code segment (≤100 characters)
Eighth code segment (≤100 characters)
Ninth code segment (≤100 characters)
Tenth code segment (≤100 characters)
Eleventh code segment (≤100 characters)
Twelfth code segment (≤100 characters)
Thirteenth code segment (≤100 characters)
Fourteenth code segment (≤100 characters)
Fifteenth code segment (≤100 characters)
Sixteenth code segment (≤100 characters)
Seventeenth code segment (≤100 characters)
Eighteenth code segment (≤100 characters)
Nineteenth code segment (≤100 characters)
Twentieth code segment (≤100 characters)
Reference to an existing Coupa Account Type. Provide `id` or `name`.
ID of the existing Account Type. Alternative to `account-type` object.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ACCOUNT_TYPES_INDEXTool to list account types in Coupa. Use when you need account type IDs and names for account creation.
Input parameters
Exact-match filter by Coupa account type ID
Filter by active status (true or false)
JSON array of fields to return; e.g., \["id","name"\].
Pagination offset; results are returned in pages of up to 50
Filter by dynamic account type flag (true or false)
Filter account types whose name contains the given text
Response size control: 'limited' returns only IDs; 'shallow' returns top-level fields with one-level associations
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ACCOUNT_TYPES_SHOWTool to retrieve a specific account type by ID. Use when you need detailed information about a chart of accounts.
Input parameters
ID of the account type to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ACCOUNT_VALIDATION_RULES_CREATETool to create account validation rules in Coupa. Use when setting up rules to manage chart of accounts validation with segment conditions.
Input parameters
Name/identifier for the validation rule (max 100 characters).
Activation status for the rule (true/false).
Description of the validation rule (max 255 characters).
Reference to the Account Type (provide `id` or `name`).
Error message displayed when validation fails (max 255 characters).
Maximum value rule for segment 1 (max 255 characters).
Minimum value rule for segment 1 (max 255 characters).
Maximum value rule for segment 2 (max 255 characters).
Minimum value rule for segment 2 (max 255 characters).
Maximum value rule for segment 3 (max 255 characters).
Minimum value rule for segment 3 (max 255 characters).
Maximum value rule for segment 4 (max 255 characters).
Minimum value rule for segment 4 (max 255 characters).
Maximum value rule for segment 5 (max 255 characters).
Minimum value rule for segment 5 (max 255 characters).
Maximum value rule for segment 6 (max 255 characters).
Minimum value rule for segment 6 (max 255 characters).
Maximum value rule for segment 7 (max 255 characters).
Minimum value rule for segment 7 (max 255 characters).
Maximum value rule for segment 8 (max 255 characters).
Minimum value rule for segment 8 (max 255 characters).
Maximum value rule for segment 9 (max 255 characters).
Minimum value rule for segment 9 (max 255 characters).
Maximum value rule for segment 10 (max 255 characters).
Minimum value rule for segment 10 (max 255 characters).
Maximum value rule for segment 11 (max 255 characters).
Minimum value rule for segment 11 (max 255 characters).
Maximum value rule for segment 12 (max 255 characters).
Minimum value rule for segment 12 (max 255 characters).
Maximum value rule for segment 13 (max 255 characters).
Minimum value rule for segment 13 (max 255 characters).
Maximum value rule for segment 14 (max 255 characters).
Minimum value rule for segment 14 (max 255 characters).
Maximum value rule for segment 15 (max 255 characters).
Minimum value rule for segment 15 (max 255 characters).
Maximum value rule for segment 16 (max 255 characters).
Minimum value rule for segment 16 (max 255 characters).
Maximum value rule for segment 17 (max 255 characters).
Minimum value rule for segment 17 (max 255 characters).
Maximum value rule for segment 18 (max 255 characters).
Minimum value rule for segment 18 (max 255 characters).
Maximum value rule for segment 19 (max 255 characters).
Minimum value rule for segment 19 (max 255 characters).
Maximum value rule for segment 20 (max 255 characters).
Minimum value rule for segment 20 (max 255 characters).
Condition for segment 1 (e.g., 'blank_value' or custom condition).
Condition for segment 2 (e.g., 'blank_value' or custom condition).
Condition for segment 3 (e.g., 'blank_value' or custom condition).
Condition for segment 4 (e.g., 'blank_value' or custom condition).
Condition for segment 5 (e.g., 'blank_value' or custom condition).
Condition for segment 6 (e.g., 'blank_value' or custom condition).
Condition for segment 7 (e.g., 'blank_value' or custom condition).
Condition for segment 8 (e.g., 'blank_value' or custom condition).
Condition for segment 9 (e.g., 'blank_value' or custom condition).
Condition for segment 10 (e.g., 'blank_value' or custom condition).
Condition for segment 11 (e.g., 'blank_value' or custom condition).
Condition for segment 12 (e.g., 'blank_value' or custom condition).
Condition for segment 13 (e.g., 'blank_value' or custom condition).
Condition for segment 14 (e.g., 'blank_value' or custom condition).
Condition for segment 15 (e.g., 'blank_value' or custom condition).
Condition for segment 16 (e.g., 'blank_value' or custom condition).
Condition for segment 17 (e.g., 'blank_value' or custom condition).
Condition for segment 18 (e.g., 'blank_value' or custom condition).
Condition for segment 19 (e.g., 'blank_value' or custom condition).
Condition for segment 20 (e.g., 'blank_value' or custom condition).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ACCOUNT_VALIDATION_RULES_SHOWTool 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.
Input parameters
ID of the account validation rule to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ACCOUNT_VALIDATION_RULES_UPDATETool to update an existing account validation rule in Coupa. Use when you need to modify validation rule attributes after confirming the rule ID.
Input parameters
Coupa unique identifier of the account validation rule to update.
Item name (max 100 characters) - must be unique.
Status indicator - when NOT active, item is effectively deleted.
Additional account validation rule properties to update; use Coupa API hyphenated names as keys.
Item description (max 255 characters) - must be unique.
Reference to account type, e.g., {'id': 1}.
Error message to be displayed when validation fails (max 255 characters) - must be unique.
Controls response format: 'none' (nothing returned), 'limited' (only IDs), 'shallow' (attributes plus IDs of associations). Default returns full object.
Custom maximum rule for segment 1 (max 255 characters).
Custom minimum rule for segment 1 (max 255 characters).
Custom maximum rule for segment 2 (max 255 characters).
Custom minimum rule for segment 2 (max 255 characters).
Custom maximum rule for segment 3 (max 255 characters).
Custom minimum rule for segment 3 (max 255 characters).
Custom maximum rule for segment 4 (max 255 characters).
Custom minimum rule for segment 4 (max 255 characters).
Custom maximum rule for segment 5 (max 255 characters).
Custom minimum rule for segment 5 (max 255 characters).
Custom maximum rule for segment 6 (max 255 characters).
Custom minimum rule for segment 6 (max 255 characters).
Custom maximum rule for segment 7 (max 255 characters).
Custom minimum rule for segment 7 (max 255 characters).
Custom maximum rule for segment 8 (max 255 characters).
Custom minimum rule for segment 8 (max 255 characters).
Custom maximum rule for segment 9 (max 255 characters).
Custom minimum rule for segment 9 (max 255 characters).
Custom maximum rule for segment 10 (max 255 characters).
Custom minimum rule for segment 10 (max 255 characters).
Custom maximum rule for segment 11 (max 255 characters).
Custom minimum rule for segment 11 (max 255 characters).
Custom maximum rule for segment 12 (max 255 characters).
Custom minimum rule for segment 12 (max 255 characters).
Custom maximum rule for segment 13 (max 255 characters).
Custom minimum rule for segment 13 (max 255 characters).
Custom maximum rule for segment 14 (max 255 characters).
Custom minimum rule for segment 14 (max 255 characters).
Custom maximum rule for segment 15 (max 255 characters).
Custom minimum rule for segment 15 (max 255 characters).
Custom maximum rule for segment 16 (max 255 characters).
Custom minimum rule for segment 16 (max 255 characters).
Custom maximum rule for segment 17 (max 255 characters).
Custom minimum rule for segment 17 (max 255 characters).
Custom maximum rule for segment 18 (max 255 characters).
Custom minimum rule for segment 18 (max 255 characters).
Custom maximum rule for segment 19 (max 255 characters).
Custom minimum rule for segment 19 (max 255 characters).
Custom maximum rule for segment 20 (max 255 characters).
Custom minimum rule for segment 20 (max 255 characters).
Custom condition for segment 1.
Custom condition for segment 2.
Custom condition for segment 3.
Custom condition for segment 4.
Custom condition for segment 5.
Custom condition for segment 6.
Custom condition for segment 7.
Custom condition for segment 8.
Custom condition for segment 9.
Custom condition for segment 10.
Custom condition for segment 11.
Custom condition for segment 12.
Custom condition for segment 13.
Custom condition for segment 14.
Custom condition for segment 15.
Custom condition for segment 16.
Custom condition for segment 17.
Custom condition for segment 18.
Custom condition for segment 19.
Custom condition for segment 20.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ADD_A_COMMENT_TO_EXPENSE_REPORTTool to add a comment to an expense report. Use when you need to add notes or feedback to an existing expense report.
Input parameters
Coupa unique identifier of the expense report to add a comment to.
The comment text to add to the expense report.
Type of the commentable object. Use 'ExpenseReport' for standard expense reports or 'ExpenseReportHeader' for header-level comments.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ADD_APPROVAL_GROUP_TO_REQUISITION_APPROVAL_CHAINTool 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.
Input parameters
Coupa internal ID of the requisition.
Position to add the approver in the approval chain. Acceptable values: after_current_approver, before_current_approver, end_of_list, watcher.
Coupa internal ID of the User or UserGroup to add as approver.
User ID of the current approver in the approval chain. If the current approver is a UserGroup, this should be the User ID of one of the UserGroup members.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ADD_APPROVER_TO_AN_INVOICE_MANUALLYTool 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.
Input parameters
Coupa unique identifier of the invoice.
String representation of the approver position. Acceptable values: before_current_approver, after_current_approver, end_of_list, watcher.
User ID or UserGroup ID to add as approver.
Type of approver entity. Acceptable values: user, UserGroup.
Active approver ID. Required when position is 'before_current_approver' or 'after_current_approver' to specify which approver to add before/after.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ADD_APPROVER_TO_PO_CHANGE_AFTER_CURRENT_APPROVERTool 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.
Input parameters
Coupa internal ID of the purchase order change
Position to add the approver in the approval chain. Use 'after_current_approver' to add after current approver.
The ID of the user or user group to add as approver.
Type of approver entity. Use 'user' for a user or 'UserGroup' for a user group.
ID of the current active approver. Required when position is 'before_current_approver' or 'after_current_approver'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ADD_ATTACHMENT_FILE_TO_PROJECTTool 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.
Input parameters
File to upload to the project.
Designation indicating the intended audience (e.g., 'Supplier'). Maximum 40 characters
Filename when providing base64 content.
MIME type (e.g., 'text/plain', 'application/pdf') when using base64 content
Links attachment to specific features. Maximum 255 characters
ID of the project to attach the file to
Base64-encoded file content.
Login of the user to impersonate; sent as 'x-coupa-api-user-login' header
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ADD_ATTACHMENT_FILE_TO_PURCHASE_ORDERTool 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.
Input parameters
File to upload to the purchase order.
Designation indicating the intended audience (e.g., 'Supplier'). Maximum 40 characters
Links attachment to specific features. Maximum 255 characters
ID of the purchase order to attach the file to
Login of the user to impersonate; sent as 'x-coupa-api-user-login' header
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ADD_ATTACHMENT_FILE_TO_PURCHASE_ORDER_LINETool 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.
Input parameters
File to upload to the purchase order line.
Designation indicating the intended audience (e.g., 'Supplier'). Maximum 40 characters
Filename when providing base64 content (e.g., 'document.pdf')
MIME type when using base64 content (e.g., 'application/pdf', 'image/jpeg')
Base64-encoded file content.
ID of the purchase order line to attach the file to
Login of the user to impersonate; sent as 'x-coupa-api-user-login' header
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ADD_ATTACHMENT_FILE_TO_REQUISITION_LINETool 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.
Input parameters
File to upload to the requisition line.
Designation indicating the intended audience (e.g., 'Supplier'). Maximum 40 characters
Filename when providing base64 content.
MIME type (e.g., 'text/plain', 'application/pdf') when using base64 content
Links attachment to specific features. Maximum 255 characters
Base64-encoded file content.
ID of the requisition line to attach the file to
Login of the user to impersonate; sent as 'x-coupa-api-user-login' header
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ADD_ATTACHMENT_TO_COMMENTTool to add a file attachment to an existing comment. Use when you need to upload and attach files to comments in Coupa.
Input parameters
File to upload to the comment.
Purpose identifier for the attachment (e.g., 'Internal', 'Supplier'). Maximum 40 characters
Filename when providing base64 content.
MIME type (e.g., 'text/plain', 'application/pdf') when using base64 content
Links attachment to specific features. Maximum 255 characters
ID of the comment to attach the file to
Base64-encoded file content.
Login of the user to impersonate; sent as 'x-coupa-api-user-login' header
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ADD_COAS_ASSIGNED_TO_A_SPECIFIC_SUPPLIER_SITETool 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.
Input parameters
Coupa unique identifier of the supplier site to update.
JSON array of fields to return; e.g., \['id','name','account-types'\].
Additional supplier site attributes to update directly; keys should use Coupa API hyphenated names.
User email or login to perform the action on behalf of. Sent as 'X-COUPA-ON-BEHALF-OF' header.
List of account types (COAs) to assign to the supplier site. Each account type can be referenced by ID or name.
Coupa business role to use when acting on behalf of a user. Sent as 'X-COUPA-BUSINESS-ROLE'.
Controls response verbosity: 'none', 'limited', or 'shallow'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ADD_COMMENTS_TO_POTool to add a comment to a purchase order. Use when you need to add notes, feedback, or mention users on an existing purchase order.
Input parameters
Coupa unique identifier of the purchase order to add a comment to.
The comment text to add to the purchase order. You can include user mentions using @\[User:{user_id}\] format (e.g., '@\[User:2\] please review').
Optional comment reason code for categorization.
Optional flag indicating whether the comment should be visible to the supplier.
Type of the commentable object. Use 'OrderHeader' for purchase order header-level comments or 'PurchaseOrderHeader' for standard PO comments.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ADD_CONTENT_GROUP_TO_CONTRACTTool 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.
Input parameters
ID of the contract to which the content group will be added
ID of the business group/content group to add to the contract
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ADD_CONTENT_GROUP_TO_SUPPLIERTool 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.
Input parameters
ID of the supplier to which the content group will be added
ID of the business group/content group to add to the supplier
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ADD_CONTRACT_APPROVERTool 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.
Input parameters
Coupa unique identifier of the contract.
String representation of the approver position. Acceptable values: before_current_approver, after_current_approver, end_of_list, watcher.
User ID or UserGroup ID to add as approver.
Perform the action on behalf of this user (email or login); sent as X-COUPA-ON-BEHALF-OF header.
Type of approver entity. Acceptable values: user, UserGroup.
Impersonate as the given user email via X-COUPA-API-EMAIL header.
Active approver ID. Required when position is 'before_current_approver' or 'after_current_approver' to specify which approver to add before/after.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ADD_CONTRACT_TERMTool to add a contract term to an existing contract. Use when creating pricing tiers or discount structures for contracts.
Input parameters
Coupa unique identifier of the contract to add the term to.
Unique name/identifier for the contract term.
Discount percentage for tier 1 (decimal as string).
Discount percentage for tier 2 (decimal as string).
Discount percentage for tier 3 (decimal as string).
Discount percentage for tier 4 (decimal as string).
Discount percentage for tier 5 (decimal as string).
Discount percentage for tier 6 (decimal as string).
Discount percentage for tier 7 (decimal as string).
Discount percentage for tier 8 (decimal as string).
Discount percentage for tier 9 (decimal as string).
Discount percentage for tier 10 (decimal as string).
Discount percentage for tier 11 (decimal as string).
Discount percentage for tier 12 (decimal as string).
Discount percentage for tier 13 (decimal as string).
Discount percentage for tier 14 (decimal as string).
Discount percentage for tier 15 (decimal as string).
Discount percentage for tier 16 (decimal as string).
Discount percentage for tier 17 (decimal as string).
Discount percentage for tier 18 (decimal as string).
Discount percentage for tier 19 (decimal as string).
Discount percentage for tier 20 (decimal as string).
Boolean flag indicating whether percentage-based discounts apply.
Type classification for the contract term. Valid values: PerOrderContractTerm, TotalQtyContractTerm, TotalAmtContractTerm.
Upper boundary for tier 1 (decimal as string).
Upper boundary for tier 2 (decimal as string).
Upper boundary for tier 3 (decimal as string).
Upper boundary for tier 4 (decimal as string).
Upper boundary for tier 5 (decimal as string).
Upper boundary for tier 6 (decimal as string).
Upper boundary for tier 7 (decimal as string).
Upper boundary for tier 8 (decimal as string).
Upper boundary for tier 9 (decimal as string).
Upper boundary for tier 10 (decimal as string).
Upper boundary for tier 11 (decimal as string).
Upper boundary for tier 12 (decimal as string).
Upper boundary for tier 13 (decimal as string).
Upper boundary for tier 14 (decimal as string).
Upper boundary for tier 15 (decimal as string).
Upper boundary for tier 16 (decimal as string).
Upper boundary for tier 17 (decimal as string).
Upper boundary for tier 18 (decimal as string).
Upper boundary for tier 19 (decimal as string).
Upper boundary for tier 20 (decimal as string).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ADD_LINE_W_ALLOCATIONS_TO_EXTERNAL_POTool 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.
Input parameters
Coupa internal ID of the purchase order to update
List of order lines with allocations to add to the PO
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ADDRESSES_CREATETool to create a new address in Coupa. Use when you need to create personal or supplier remit-to addresses with location details.
Input parameters
City name (max 255 characters, required)
Address nickname/identifier (max 255 characters, required)
State abbreviation (max 255 characters, required)
Activation status; 'true' makes address available to users (optional, defaults to true)
Country reference containing code or name (required). Must already exist in the system.
Primary street address line (max 255 characters, required)
Secondary street address line (max 255 characters, optional)
Third street address line (max 255 characters, optional)
Fourth street address line (max 255 characters, optional)
Address default attention line (max 255 characters, optional)
VAT identifier (max 255 characters, optional)
Postal/ZIP code (max 255 characters, required)
Reference to a country object.
Location code identifier (max 255 characters, optional)
ISO state code format: CC-SSS (max 255 characters, optional)
External Source Reference (max 255 characters, optional)
Local tax identifier (max 255 characters, optional)
External Source Name (max 255 characters, optional)
Content Group Name for Address (max 255 characters, optional)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ADDRESSES_INDEXTool to list addresses from Coupa. Use when you need paginated address records for processing.
Input parameters
JSON array of fields to return; e.g., \["id","city","state"\].
Pagination offset; results are returned in batches of up to 50.
Response size control: 'limited' returns only IDs; 'shallow' returns full object attributes with one-level association IDs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ADD_SPECIFIC_CONTENT_GROUP_TO_SIM_RECORDTool 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.
Input parameters
ID of the supplier information record to which the content group will be added
ID of the business group/content group to add to the SIM record
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ADD_SPECIFIC_CONTENT_GROUP_TO_SIM_SITETool to add a content group (business group) to a Supplier Information Management (SIM) site. Use when you need to assign a content group to a SIM site for access control or visibility management.
Input parameters
ID of the supplier information site to which the content group will be added
ID of the business group/content group to add to the SIM site
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ADD_SPECIFIC_CONTENT_GROUP_TO_SUPPLIER_SITETool 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.
Input parameters
ID of the supplier site to which the content group will be added
ID of the business group/content group to add to the supplier site
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ADD_USER_TO_A_GROUPTool 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.
Input parameters
Indicates admin status for the membership.
JSON array of fields to return; e.g., \['id','user-id','user-group-id'\].
User identifier to add to the group.
Indicates participant status for the membership.
User email or login to perform the action on behalf of. Sent as 'X-COUPA-ON-BEHALF-OF' header.
Coupa business role when acting on behalf of a user. Sent as 'X-COUPA-BUSINESS-ROLE'.
Coupa unique identifier for the user group membership to update.
Controls response verbosity: 'none', 'limited', or 'shallow'.
User group ID or Project ID to add the user to.
Type of the group: 'UserGroup' or 'Project'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ANNOUNCEMENTS_INDEXTool to list all announcements from Coupa. Use when you need to retrieve multiple announcements with optional pagination and filters.
Input parameters
Maximum number of records to return (1-50, default 50)
JSON array of fields to return; e.g., \["id","subject","message"\]
Number of records to skip for pagination; results are returned in pages up to 50
Additional attribute filters using Coupa syntax. Example: {'created-at\[gt_or_eq\]':'2023-01-01T00:00:00Z','updated-at\[gt_or_eq\]':'2023-01-01T00:00:00Z'}
Field name to sort results by
Response verbosity: 'limited' returns only IDs; 'shallow' returns full object attributes with one-level association IDs
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ANNOUNCEMENTS_SHOWTool to retrieve a specific announcement by ID from Coupa Mobile. Use when you need detailed information about an announcement.
Input parameters
The Coupa unique identifier for the announcement
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_APPROVALS_APPROVETool to approve a pending approval record. Use when you need to programmatically approve a pending approval by ID.
Input parameters
ID of the approval to approve
Optional Coupa API user impersonation header value. If provided, sets X-COUPA-API-USER-ID to this user ID to act as that user (must be the approver).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_APPROVALS_HOLDTool to place an approval on hold. Use when you need to pause approval workflow temporarily.
Input parameters
ID of the approval to place on hold
Optional note/reason for placing on hold. Coupa does not require a body for hold, but this field is accepted for future compatibility and auditing.
Optional Coupa API user impersonation header value. If provided, sets X-COUPA-API-USER-ID to this user ID to act as that user (must be the approver).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_APPROVALS_INDEXTool to list approvals with optional pagination and filters. Use when you need to retrieve multiple approval records.
Input parameters
Maximum number of records to return (1-50).
JSON array of fields to return; e.g., \['id',{'approver':\['id','login'\]}\]
Number of records to skip for pagination (default 0).
Additional attribute filters using Coupa syntax. Example: {'status':'approved','created-at\[gt\]':'2023-01-01T00:00:00Z'}
Response verbosity: 'limited' or 'shallow'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_APPROVALS_REJECTTool to reject an approval. Use when you need to programmatically reject a pending approval by ID.
Input parameters
ID of the approval to reject
Additional note to include in the body of the rejection
Rejection reason as query parameter
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_BUDGET_LINES_INDEXTool to retrieve budget lines from Coupa. Use when you need to query budget line information associated with accounts and periods.
Input parameters
Filter by specific budget line ID
Limit number of results returned. Recommended for large data sets.
JSON array of fields to return; e.g., \["id","amount","description"\]
Pagination offset; results are returned in pages
Sort results by specified field
Filter by period name (e.g., Q3FY09)
Filter by budget owner's last name
Filter by period open status
Filter by owner approver status
Filter by account type name within period
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_BUSINESS_GROUPS_INDEXTool to list business groups (content groups) in Coupa. Use when you need IDs, names, and metadata of content groups for assignments.
Input parameters
Exact-match filter by Coupa ID
Pagination offset; results are returned in pages of up to 50
Return groups created after this ISO-8601 timestamp
Filter groups whose name contains the given text
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_BUSINESS_GROUPS_SHOWTool to retrieve a specific business group (content group) by ID. Use when you need detailed information about a content group.
Input parameters
ID of the business group to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_BUYER_ACCEPTING_HEADER_LEVEL_CONFIRMATIONTool 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.
Input parameters
Coupa's internal ID for the order header confirmation to accept
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_BUYER_REJECTING_HEADER_LEVEL_CONFIRMATIONTool 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.
Input parameters
Coupa's internal ID for the order header confirmation to reject
Simple rejection comment. If provided, will be used to create a reason insight event.
Reason insight events documenting the rejection. At least one event with a comment is recommended.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_BYPASS_ALL_APPROVALS_OF_AN_INVOICETool 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.
Input parameters
Coupa unique identifier of the invoice to bypass all approvals for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_BYPASS_CURRENT_APPROVALS_OF_AN_INVOICETool 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.
Input parameters
Coupa unique identifier of the invoice to bypass current approval for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CANCEL_EXTERNAL_POTool 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.
Input parameters
Coupa internal ID of the external purchase order to cancel
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CLOSE_SOFT_CLOSE_EXTERNAL_POTool to close or soft-close an external purchase order. Use when finalizing an external PO after confirming receipt or when business rules require closure.
Input parameters
Coupa internal ID of the purchase order to close
Reference to reason insight for the close action
Code identifying the reason for closing
Comment explaining why the PO is being closed
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_COMPLETE_CONTRACTTool to complete a contract and transition it to legally binding status. Use when you need to mark a contract as completed and executed.
Input parameters
Coupa internal ID of the contract to complete
JSON array of specific fields/associations to include in the response. Example: \['id','status'\]
Impersonate as the given user id via X-COUPA-API-USER-ID header.
Perform the action on behalf of this user (email or login); sent as X-COUPA-ON-BEHALF-OF header.
Coupa business role to use when acting on behalf of a user; sent as X-COUPA-BUSINESS-ROLE header.
Controls response verbosity: 'none', 'limited', or 'shallow'
Impersonate as the given user email via X-COUPA-API-EMAIL header.
Impersonate as the given user login via X-COUPA-API-USER-LOGIN header.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CONTENT_GROUPS_CREATETool 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.
Input parameters
The name of the content group (max 100 characters)
A text description of the content group's purpose (max 255 characters)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CONTENT_GROUPS_UPDATETool 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.
Input parameters
Coupa unique identifier of the business group to update
The name of the content group. Must be unique.
A text description of the content group's purpose. Must be unique.
Controls response format: 'none' (nothing returned), 'limited' (only IDs returned), 'shallow' (all attributes plus IDs of associations)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CONTRACTS_ATTACHMENTS_CREATETool to create an attachment on a contract. Use when attaching files, text, or URLs to contracts.
Input parameters
URL for URL attachments. Required when type='url'
File to upload. Required when type='file'
Text content for text attachments. Required when type='text'
Type of the attachment. 'file', 'text', or 'url'
Designation indicating the intended audience (e.g., 'Supplier')
Links attachment to specific features like 'quote_request_attachment' or 'event_terms'
ID of the contract to attach the file to
Login of the user to impersonate; sent as 'x-coupa-api-user-login' header
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CONTRACTS_INDEXTool to list contracts. Use when you need contract IDs and metadata for subsequent actions, e.g., adding an approver.
Input parameters
JSON array of fields to return; e.g., \['id','number',{'supplier':\['id','name'\]}\].
Pagination offset for contract list in multiples of 50 (default 0).
Attribute filters using Coupa syntax. Example: {'status':'active', 'supplier\[name\]':'SomeSupplier'}.
Response verbosity control: 'limited' returns only IDs; 'shallow' returns one-level associations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CONTRACTS_UPDATETool 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.
Input parameters
Coupa unique identifier of the contract to update.
Contract name.
JSON array of fields to return; e.g., \['id','name',{'supplier':\['id','name'\]}\].
Contract number.
Status of the contract.
Additional contract attributes to update directly; keys should use Coupa API hyphenated names.
Contract currency code reference, e.g., {'code': 'USD'}.
Expire date of the contract in ISO 8601 format (YYYY-MM-DD).
Supplier information reference, e.g., {'id': 2} or {'name': 'Amazon.com'}.
Department information reference, e.g., {'id': 4}.
Start date of the contract in ISO 8601 format (YYYY-MM-DD).
Descriptive notes about the contract.
Savings percentage (decimal).
User email or login to perform the action on behalf of. Sent as 'X-COUPA-ON-BEHALF-OF' header.
Payment term code on contract, e.g., {'code': 'Net 30'}.
Coupa business role when acting on behalf of a user. Sent as 'X-COUPA-BUSINESS-ROLE'.
Contract type reference, e.g., {'id': 1}.
Maximum commit amount (decimal 32,4).
Minimum commit amount (decimal 32,4).
Controls response verbosity: 'none', 'limited', or 'shallow'.
Business groups associated with the contract, e.g., \[{'id': 1}\].
Contract owner user reference, e.g., {'id': 5}.
Contract terms reference, e.g., {'id': 3}.
Contract execution date in ISO 8601 format.
Contract published date in ISO 8601 format.
Supplier account number.
Enable order windows.
URL to the legal agreement document.
Default contract on unbacked lines.
Allow supplier to invoice directly.
Stop spend when contract value is exceeded.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CONTRACT_TEMPLATE_DESTROYTool to delete a contract template. Use when you need to permanently remove a contract template by ID.
Input parameters
Contract template ID to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_COPY_ACCOUNT_TYPETool to copy/clone an existing chart of accounts (account type). Creates a duplicate of the specified account type with all its associated properties.
Input parameters
The ID of the account type to copy
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_A_TAX_REGISTRATIONTool 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.
Input parameters
Identifies if this is a local tax number designation
Indicates registration status (active/inactive)
Tax identification number - the primary tax ID for the registration
Country object with ID for tax jurisdiction
Links to parent supplier information record
Associates with primary address ID (address must exist with primary designation)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_BUDGET_LINETool to create a new budget line in Coupa. Use when you need to create a budget line with description, period, amount, owner, and optional account segment values.
Input parameters
Additional notes or comments for the budget line.
Owner reference with firstname, lastname, and login.
Budget amount for this line.
Budget period reference with name field.
First account segment value (e.g., location, department).
Second account segment value (e.g., cost center, category).
Third account segment value (e.g., expense type).
Description of the budget line explaining its purpose.
Whether the owner is an approver for this budget line.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_BUDGET_LINE_ADJUSTMENTTool 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.
Input parameters
Currency for the adjustment. Must have active status in Coupa.
Optional description text explaining the reason for the adjustment (max 255 characters).
Budget period reference for the adjustment.
Budget segment reference for the adjustment.
The ID of the budget line to adjust. Must be an existing budget line in Coupa.
The budget line adjustment amount to be applied. Can be positive (increase) or negative (decrease).
Chart of accounts reference for the adjustment.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_BUSINESS_ENTITIESTool to create a business entity in Coupa. Use when creating a legal or organizational business entity with name, type, formation type, and optional address and contact information.
Input parameters
Entity name (required, max 100 characters, must be unique)
Business entity type enumeration.
Current operational status of the entity
Human-readable display name (max 100 characters)
Formation type enumeration.
Model for primary address in request.
Model for primary contact in request.
Country code where the entity was established
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_COMMENT_ON_TRANSACTIONAL_OBJECTTool to create a comment on any transactional object. Use when you need to add notes, feedback, or mention users on an existing transactional object like requisitions, purchase orders, invoices, or expense reports.
Input parameters
The comment text to add to the object. You can include user mentions using @\[User:{user_id}\] format (e.g., '@\[User:2\] please review').
The ID of the object to comment on.
The type of object to comment on (e.g., requisitions, purchase_orders, invoices, invoice_headers, expense_reports, contracts, receipts).
Optional comment reason code for categorization.
Optional flag indicating whether the comment should be visible to the supplier.
The type of object being commented on (e.g., RequisitionHeader, OrderHeader, InvoiceHeader). This must match the object_type.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_COMMODITYTool to create a commodity in Coupa. Use when you need to provision a new commodity with a specified name, category, and deductibility level.
Input parameters
Commodity name (required, must be unique, max 255 characters)
Status flag - true makes it available to users, false inactivates it
Reference to a parent commodity.
Commodity category - must be one of: goods, services, monetary, or others
Preferred options for commodities.
Subcategory options for commodities.
Deductibility level - must be one of: fully_deductible, partially_deductible, or not_deductible
Localized name variant for the commodity
Indicates if sourced from Coupa's taxonomy
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_EXTERNAL_PURCHASE_ORDERTool to create an external purchase order. Use when integrating external POs via Coupa API.
Input parameters
Type of order; must be 'ExternalOrderHeader'
Currency reference - provide code.
Supplier reference for the PO
External PO number (max 20 characters)
List of order line items
Payment term reference - provide the Coupa internal payment term ID.
User reference - provide one of id, login, or email.
Shipping term reference - provide the Coupa internal shipping term ID.
Supplier site reference - provide the Coupa internal supplier site ID.
Classification of order: msp, supplier, or vms
Payment method
Address reference - provide id.
Ship-to attention text
Comma-separated transmission emails
Override transmission method: supplier_default, email, or do_not_transmit
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_FXRATESTool 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.
Input parameters
Exchange rate value for converting from source to target currency
Effective date for this exchange rate in format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS
Target currency reference with code
Source currency reference with code
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_INTEGRATION_ERRORS_AGAINST_AN_INTEGRATIONTool to create integration errors against an integration run in Coupa. Use when you need to log and track errors that occurred during integration processes or data imports.
Input parameters
Status of the integration error (e.g., error, warning)
List of IntegrationRecordResponse objects containing error codes and messages
ID of the document associated with the error
External identifier for the error record
Reference to the integration resource (requires integration id)
Type of document (e.g., User, OrderHeader, InvoiceHeader, RequisitionHeader)
Method used to create the error (e.g., api, ui)
Status of the document (e.g., failed, pending)
Revision number of the document
Type of contact alert (e.g., error, warning)
ID of the integration run that generated this error
Filename of the integration file
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_INTEGRATION_RUNTool to create an integration run. Use when you need to initialize a new run for an integration before processing records.
Input parameters
ISO 8601 timestamp when the run starts. Leave empty to default to current time.
Total number of records intended for this run.
Coupa internal ID of the integration. Provide either integration_id or integration_code.
Unique integration code. Provide either integration_code or integration_id.
Number of records processed so far in this run.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_INVOICE_AGAINST_APO_AMOUNT_BASEDTool 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.
Input parameters
Administrative notes (max 255 characters)
Currency of the invoice transaction
Supplier reference for the invoice
Header-level tax charge (decimal string)
Invoice date in YYYY-MM-DD format (DATE ONLY, without timestamp)
Payment term reference. Provide id or code.
Internal confidential notes
List of invoice line items linked to PO lines
Invoice identification code (max 40 characters)
Invoice discount reduction (decimal string)
Processing surcharge (decimal string)
Transportation surcharge (decimal string)
Whether tax is computed per line (true) or at header level (false)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_ITEMS_SUPPLIER_ITEMSTool to create a supplier item associated with an existing item in Coupa. Use when adding a new supplier source for an item with pricing and availability details.
Input parameters
The item ID to which the supplier item will be associated
Item reference object with 'id' or 'name', e.g., {'id': 21}
Price for the supplier item as a decimal string
Related contract reference, e.g., {'id': 10} or {'name': 'Contract Name'}
Currency object reference with 'code' or 'id', e.g., {'code': 'USD'} or {'id': 1}
Supplier reference object with 'id' or 'number', e.g., {'id': 13} or {'number': 'SUP-001'}
Lead time in days
Whether this is a preferred supplier for the item
Whether the item is purchasable
UNSPSC classification code
Stock status: in_stock, out_of_stock, or backordered
Manufacturer name
User email or login to perform the action on behalf of. Sent as 'X-COUPA-ON-BEHALF-OF' header.
Coupa business role to use when acting on behalf of a user. Sent as 'X-COUPA-BUSINESS-ROLE'.
Controls response verbosity: 'none' (nothing returned), 'limited' (only IDs returned), 'shallow' (returns all attributes/fields and IDs of one-deep associations). Default returns full object.
Order increment value as a decimal string
Date of availability change in ISO 8601 format (YYYY-MM-DDTHH:MM:SS+HH:MM)
Supplier's part number
Auxiliary part number for the supplier
Minimum order quantity as a decimal string
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_LOOKUP_VALUETool to create a new lookup value in Coupa. Use when you need to add a new value to an existing lookup for categorization and standardization purposes.
Input parameters
The lookup value identifier
Boolean status indicating if the lookup value is active
Parent lookup reference (provide id or name)
Detailed description of the lookup value
External reference number
External reference code
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_NEW_CUSTOM_OBJECT_INSTANCETool 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.
Input parameters
Custom fields for the object instance. Field names and types depend on your Custom Object definition. All custom fields must be nested within this object.
The identifier of the Custom Object for which to create an instance (path parameter)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_PAYMENT_RECONCILIATION_LINES_FOR_A_PAY_ORDERTool to create payment reconciliation lines for a pay order in Coupa. Use when you need to record payment transactions against payable orders or invoices.
Input parameters
Payment note (alternate field). Optional.
Payment notes or comments. Optional.
Amount value (decimal string). Optional.
Category classification for the reconciliation line. Required. Use 'payment' for standard payment reconciliation.
Unique identifier of the payable (e.g., order or invoice ID).
Amount paid for this reconciliation line (decimal string).
Type of payable (e.g., 'OrderHeader', 'InvoiceHeader').
Payment date in ISO 8601 format (YYYY-MM-DDTHH:MM:SS±HH:MM).
Adjustment date in ISO 8601 format (YYYY-MM-DDTHH:MM:SS±HH:MM). Optional.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_PAYMENT_TERMTool 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.
Input parameters
Unique identifier for the payment term
Payment term type. DaysAfterNetPaymentTerm for standard net days (e.g., Net 30), SpecificDayPaymentTerm for specific calendar dates, DaysToBaseEomPaymentTerm for days until end of month, BaseEomToDaysPaymentTerm for days from end of month.
Status flag; true activates the term making it available to users, false inactivates it
Description of the payment term
Determines the document's payment due date (1-31). Used with SpecificDayPaymentTerm type.
Discount rate percentage (as decimal, e.g., 0.02 for 2% discount)
Determines the document's payment due date along with net-due-day (0-6 months offset)
Documents before this day are eligible for net payment in current month, otherwise fall into next month (1-31)
Used to calculate the document's discount due date (1-31)
Used to calculate the document's discount due date along with discount-due-day (0-6 months offset)
Documents before this day are eligible for discount, otherwise fall into next month (1-31)
Number of days for net payment calculation. For DaysAfterNetPaymentTerm, this is the number of days until payment is due (e.g., 30 for Net 30).
Number of days for discount payment calculation. Set to 0 if no discount is offered.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_PROJECTTool to create a Coupa project. Use when you need to create a new project with specified name, start date, and end date.
Input parameters
Project name (required, max 255 characters)
Whether the project is open for everyone to join or owner must invite others
List of users associated with the project
Whether the project is active
Project status (e.g., draft, active, completed)
Project end date in ISO format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS+HH:MM)
Reference to a Coupa commodity.
Project start date in ISO format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS+HH:MM)
Project description
Mention name for the project
List of content groups for the project
Completion percentage (0-100)
External reference number to sync with 3rd party Project ID
Additional planned savings amount
Member visibility control (0 or 1)
Provide warning if task dates fall outside project dates
Additional realized savings amount
Show sourcing rollup fields if enabled
Show contracts rollup fields if enabled
Show suppliers rollup fields if enabled
Additional negotiated savings amount
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_PROJECT_MEMBERSHIPTool to create a project membership in Coupa. Use when you need to add a user to a project and define their role as owner or participant.
Input parameters
Whether the user should be a project owner/administrator. Owners have elevated privileges to manage the project
The ID of the user to add as a project member
The ID of the project to add the member to
Whether the user should be a participant in the project. Participants can collaborate on project activities
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_QUOTE_REQUESTS_TASKSTool to create a task for a quote request. Use when you need to add tasks to track work or milestones for a specific quote request.
Input parameters
The quote request ID to create a task for
The task title
Task status
Task due date in ISO format
Task duration in days
Task completion percentage (0-100)
Task start date in ISO format
Task description
Attributes specific to sourcing event tasks.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_REQ_ASSIGNMENT_TO_USERTool to create a requisition assignment to a user. Use when you need to assign a user to a requisition for approval or buyer role.
Input parameters
The ID of the user to assign to the requisition.
The type of assignee. Must be 'User'.
The ID of the requisition to assign the user to.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_REQUISITION_LINES_ESTIMATED_TAX_LINESTool 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.
Input parameters
Tax rate as a percentage (e.g., 8.5 for 8.5%)
Tax amount to be applied
Reference to a Chart of Accounts entry.
Reference to a tax code.
Description of the tax line
ID of the requisition line to add the estimated tax line to
Base amount on which tax is calculated
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_REQUISITION_LINES_MULTIPLE_ESTIMATED_TAX_LINESTool 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.
Input parameters
Total amount for the line item.
Additional requisition line attributes to update. Keys should use Coupa API hyphenated names.
Quantity for the line item.
Unit price for the line item.
Line item description.
The requisition line ID to update.
List of estimated tax lines to add to the requisition line.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_RISKAWAREFEED_FOR_A_SUPPLIERTool 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'.
Input parameters
Supplier reference. Provide exactly one of: id, name, or number to identify the supplier.
First custom numeric field for GRC data (decimal with up to 4 decimal places)
Second custom numeric field for GRC data (decimal with up to 4 decimal places)
Third custom numeric field for GRC data (decimal with up to 4 decimal places)
Fourth custom numeric field for GRC data (decimal with up to 4 decimal places)
Fifth custom numeric field for GRC data (decimal with up to 4 decimal places)
Sixth custom numeric field for GRC data (decimal with up to 4 decimal places)
Seventh custom numeric field for GRC data (decimal with up to 4 decimal places)
Eighth custom numeric field for GRC data (decimal with up to 4 decimal places)
Ninth custom numeric field for GRC data (decimal with up to 4 decimal places)
Tenth custom numeric field for GRC data (decimal with up to 4 decimal places)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_SIM_RECORD_AGAINST_EXISTING_SUPPLIERTool 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.
Input parameters
Status of the SIM record. For shell records, this should be 'approved'.
Exported flag. Set to true to mark the shell SIM record as exported.
Reference to the existing supplier by ID
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_SIM_SITE_USING_SIM_ID_IN_POST_URLTool 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.
Input parameters
Unique supplier site code identifier (max 20 characters)
Supplier information site name (max 255 characters)
Whether the site is active
Array of contact references for the site
PO destination URL for cXML transmission (max 255 characters)
Email destination for email-based POs (max 255 characters)
Array of address references for the site
Purchase order transmission method (max 255 characters)
Hold all POs for buyer review
From domain identifier for cXML (max 255 characters)
Shared authentication secret for cXML (max 255 characters)
From identity value for cXML (max 255 characters)
Transmission protocol specification for cXML (max 255 characters)
Array of content group references to assign to the site
Default locale for supplier communications (max 255 characters)
SSL version for cXML communication (max 255 characters)
PO change transmission method (max 255 characters)
Username for supplier's online store (max 255 characters)
Ignore SSL certificate mismatch errors
To supplier domain for cXML (max 255 characters)
Enable supplier change requests (integer value)
To supplier identity for cXML (max 255 characters)
ID of the supplier information record under which the site will be created
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_SIM_SITE_USING_SIMID_IN_THE_PAYLOADTool 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.
Input parameters
Unique supplier site code identifier (max 20 characters)
Supplier information site name/designation (max 255 characters)
Site operational status (true=active, false=inactive)
Supplier information site contacts collection
Destination for PO transmission via cXML
Email recipient when transmission method is 'email'
Supplier information site addresses collection
Purchase order transmission method (e.g., 'email', 'cxml')
When true, hold all POs for buyer review
cXML 'From' domain identifier
Shared authentication credential for cXML
Reference to a payment term.
cXML 'From' identity value
Transmission protocol specification
Reference to a shipping term.
Content grouping collection for visibility control
Default locale for sending emails to this supplier site
SSL version for cXML communication
PO change transmission method
Online store access credential
SSL certificate validation override setting
cXML 'To' supplier domain
Allows suppliers to create change requests from CSP
cXML 'To' supplier identity
ID of the parent supplier information record to link this site to
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_SUPPLIER_ITEMTool to create a new supplier item against an existing catalog item. Use when linking a supplier's part number to a catalog item with pricing and contract information.
Input parameters
Catalog item reference with id.
Price of the supplier item (decimal value).
Contract reference for the supplier item.
Currency information with either id or code.
Supplier reference with either id or number.
Lead time in days.
Flag to mark this supplier item as preferred.
UNSPSC classification code.
Manufacturer name.
Order increment value.
Supplier's part number for the item.
Auxiliary part number from the supplier.
Minimum order quantity.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_SUPPLIER_REMIT_TO_ADDRESSTool 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.
Input parameters
City name (max 255 characters).
Name/description of the remit address (max 255 characters).
State/province abbreviation (max 255 characters).
Status flag (true for active, false for inactive).
Country information containing country name.
Primary street address line (max 255 characters).
Secondary street address line (max 255 characters).
Third street address line (max 255 characters).
Fourth street address line (max 255 characters).
Tax identification number (max 255 characters).
Postal/zip code (max 255 characters).
Coupa unique identifier of the supplier.
Unique code identifying the remit address (max 255 characters).
Controls response format. Values: 'none' (no response body), 'limited' (only IDs), 'shallow' (full object with limited nested data).
Company registration number (max 255 characters).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_SUPPLIER_SITETool 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.
Input parameters
Supplier site code identifier; must be unique within the supplier context
Supplier site name
Activation status; defaults to true if not provided
Supplier site contact information
Required if po-method = cxml
Email address for purchase orders. Required if po-method is 'email'.
Supplier site addresses
Purchase order transmission method. Required field.
Holds all POs for buyer review
Required if po-method = cxml
Required if po-method = cxml
Coupa unique identifier of the supplier to add the site to
Reference to an existing Coupa Payment Term.
Associated account types
Required if po-method = cxml
Required if po-method = cxml
Reference to an existing Coupa Shipping Term.
Controls visibility; defaults to Everyone if omitted
Locale for supplier emails
Default payment method
SSL version: TLSv1_2, TLSv1_1, or TLSv1
Purchase order change transmission method
cXML HTTP username
Ignores SSL certificate mismatches
Required if po-method = cxml
Enables suppliers to create change requests via CSP
Required if po-method = cxml
Permits item substitutions on order confirmations
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_SUPPLIER_WITH_CONTACTS_ADDRESSESTool 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.
Input parameters
Supplier name (required, unique, max 100 characters).
Supplier identifier/code (optional, unique).
Supplier status. Defaults to 'draft' if not specified. Options: active, draft, etc.
Tax identification number.
PO email address (required if po-method=email).
Purchase order transmission method. Options: cxml, xml, email, prompt, mark_as_sent, buy_online.
Account number with this supplier.
Model for primary address details.
Model for primary contact details.
Purchase order change transmission method. Options: cxml, xml, email, prompt, mark_as_sent, buy_online.
Invoice matching level. Options: 2-way, 3-way, 3-way-direct, none.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_TASKTool to create a new task in Coupa. Use when you need to create a task with title and assignment. Note: Either owner-id OR (linkable-id + linkable-type) must be provided along with title.
Input parameters
Task name (required, max 255 characters)
Task status (e.g., 'open', 'in_progress', 'completed')
Due date in format YYYY-MM-DDTHH:MM:SS+HH:MMZ (e.g., 2024-12-31T23:59:59+00:00Z)
Task duration (non-negative float)
User ID assigned to task. Either owner-id OR (linkable-id + linkable-type) must be provided.
Completion percentage (0-100)
Start date in format YYYY-MM-DDTHH:MM:SS+HH:MMZ (e.g., 2024-01-01T00:00:00+00:00Z)
Detailed task description
ID of associated UserGroup or Project. Required with linkable-type if owner-id is not provided.
Link type: 'UserGroup' or 'Project'. Required with linkable-id if owner-id is not provided.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_TASK_AGAINST_PROJECTTool to create a task against an existing project in Coupa. Use when you need to add a new task to a specific project by project ID.
Input parameters
Task title (required, max 255 characters)
Task status (e.g., pending, in_progress, completed)
Task due date in ISO format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS+HH:MM)
Task duration in days
ID of the user who owns this task
Task completion percentage (0-100). Defaults to 0 if not specified.
ID of the project to create the task under
Task start date in ISO format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS+HH:MM)
Task description providing details about what needs to be done
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_USER_ADDRESSTool 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.
Input parameters
City name.
Address 'Nickname' or label to identify this address.
State abbreviation.
Set to true to activate address or false to deactivate. Inactive addresses are not available to users.
Country information. The country must already exist in the Coupa system.
Address Line 1 (primary street address).
Address Line 2 (apartment, suite, unit, etc.).
Address Line 3 (additional address information).
Address Line 4 (additional address information).
The ID of the user for whom the address is being created.
Address Default Attention Line / contact person name.
VAT number associated with this address.
Postal/ZIP code.
VAT country information for the address.
Location code for the address.
ISO Code for State in format CC-SSS (e.g., 'US-CA' for California).
External Source Reference identifier.
Local tax number for the address.
External Source Name.
Content Group Name for Address.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_USER_GROUPTool to create a new user group in Coupa. Use when you need to provision a new user group for organizing users and managing approvals.
Input parameters
The user group identifier (max 255 chars)
Controls if membership is self-service (true) or invitation-only (false)
Designates 'Project' or leave blank for standard groups
User reference for individual responsible for the group. Should contain user ID, e.g., {'id': 123}.
Initial member assignments - list of user references with IDs, e.g., \[{'id': 123}, {'id': 456}\].
Status indicator for the group - true for active, false for inactive
Whether the group functions as an approver entity
Details about the group's purpose
Handle for group mentions (max 255 chars)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_USER_GROUP_MEMBERSHIPSTool to create user group memberships in Coupa. Use when you need to add a user to a specific group or project with defined owner and participant permissions.
Input parameters
Indicates whether the user is admin or owner of the group
User ID to add to the group
Indicates whether the user is a participant in the group
User group ID or Project ID
Type of the group: 'User Group' or 'Project'
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CREATE_USER_GROUPS_TASKSTool to create a task within a user group. Use when you need to assign a new task to a specific user group with a title and optional details like due date, description, and owner.
Input parameters
User group ID to create the task for
Task title (required, max 255 characters)
Task status (e.g., pending, in-progress, completed)
Due date in ISO format (YYYY-MM-DDTHH:MM:SS+HH:MMZ)
Duration value in days
User ID for task assignment
Completion percentage (0 to 100)
Start date in ISO format (YYYY-MM-DDTHH:MM:SS+HH:MMZ)
Task description providing additional details
Extra attributes for sourcing event tasks
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CURRENCIES_INDEXTool to list currencies from Coupa. Use when you need to retrieve or filter configured currencies before processing.
Input parameters
Exact-match filter by Coupa currency ID
Filter by currency code; supports operators like contains, starts_with, ends_with.
Filter by currency name; supports standard operators.
JSON array of fields to return; e.g., \["id","code","name"\].
Pagination offset; results are returned in pages of up to 50.
Filter by currency symbol; supports standard operators.
Filter by number of decimal places; supports comparison operators (gt, lt, etc.).
Filter by enabled status (true or false).
Response size control: 'limited' returns only IDs; 'shallow' returns attributes with one-level associations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_CURRENCIES_SHOWTool to retrieve a specific currency by ID. Use when you need detailed information about a currency.
Input parameters
ID of the currency to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_DATA_FILE_SOURCES_INDEXTool 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.
Input parameters
Query specific DataFileSource by internal ID
Filter by file type (e.g., BackgroundCsvFileLoad, DataFileSource)
JSON array of fields to return; e.g., \["id","status","created_at"\]
Pagination offset; Coupa returns maximum 50 records per call
Filter by processing status (e.g., Done, Failed, Retrying, Loading, Pending)
Filter by object type (e.g., LookupValue, Supplier, Invoice, User)
Filter records created after specified timestamp (ISO 8601 format, e.g., '2024-01-01T00:00:00Z')
Filter records created before specified timestamp (ISO 8601 format, e.g., '2024-12-31T23:59:59Z')
Response verbosity: 'limited' returns only IDs; 'shallow' returns full object attributes with one-level associations
Search for data file sources for a specific file name
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_DEFAULT_RECEIVING_LOCATIONS_INDEXTool to list default receiving locations from Coupa. Use when you need to retrieve receiving location details linked to items and warehouses.
Input parameters
Exact-match filter by Coupa default receiving location ID
JSON array of fields to return; e.g., \["id","item-id","warehouse-id"\]
Pagination offset; results are returned in pages of up to 50
Filter by item ID associated with the receiving location
Filter by warehouse ID associated with the receiving location
Response verbosity: 'limited' returns only IDs; 'shallow' returns full object attributes with one-level association IDs
Filter by warehouse location ID
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_DELETE_A_TAX_REGISTRATIONTool to delete a tax registration. Use when you need to permanently remove a supplier information tax registration by ID.
Input parameters
Tax registration ID to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_DELETE_PROJECT_MEMBERSHIPSTool to delete a project membership. Use when you need to remove a user's membership from a project by the membership ID.
Input parameters
The ID of the project membership to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_DELETE_PROJECTS_TASKSTool to delete a task from a specific project. Use when you need to permanently remove a task by ID from a project.
Input parameters
The unique identifier of the task to be deleted
The unique identifier of the project containing the task
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_DELETE_QUOTE_REQUEST_TASKTool to delete a task from a quote request. Use when you need to permanently remove a task from a specific quote request by their IDs.
Input parameters
The ID of the task to delete from the quote request.
The ID of the quote request containing the task.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_DELETE_REQUISITION_LINETool to delete a requisition line. Use when you need to permanently remove a requisition line by ID.
Input parameters
Coupa requisition line ID to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_DELETE_REQUISITION_LINES_ESTIMATED_TAX_LINESTool to delete an estimated tax line from a requisition line. Use when you need to remove a specific estimated tax line by ID.
Input parameters
Coupa requisition line ID.
Coupa estimated tax line ID to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_DELETE_SPECIFIC_CONTRACT_ATTACHMENTTool to delete a specific attachment from a contract. Use when you need to permanently remove an attachment by its ID from a contract.
Input parameters
The unique identifier for the contract
The unique identifier for the attachment to be removed
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_DELETE_SPECIFIC_PO_ATTACHMENTTool 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.
Input parameters
The attachment ID to delete
The ID of the purchase order from which to delete the attachment
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_DELETE_SPECIFIC_REQUISITION_ATTACHMENTTool to delete a specific attachment from a requisition. Use when removing an attachment from a requisition by attachment ID.
Input parameters
ID of the attachment to delete
ID of the requisition containing the attachment
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_DELETE_SUPPLIER_INFORMATION_SUPPLIER_INFORMATION_SITETool to delete a supplier information site from a specific supplier information record. Use when you need to remove a supplier information site by its ID and parent supplier information ID. Requires SIM API permissions.
Input parameters
The ID of the supplier information site to delete
The ID of the parent supplier information record
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_DEPARTMENTS_CREATETool to create a department in Coupa. Use when you need to provision a new department with a specified name and active status.
Input parameters
Name of the department to create
Whether the department is active (true) or inactive (false)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_DEPARTMENTS_SHOWTool to retrieve a single department by ID. Use when you need detailed department information.
Input parameters
Coupa unique identifier for the department
JSON array specifying which fields to return in response; e.g., \['id','name','active'\].
Response verbosity: 'limited' (IDs only) or 'shallow' (all attributes plus IDs of associations).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_DEPARTMENTS_UPDATETool 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.
Input parameters
Coupa unique identifier of the department to update.
Department name.
Control whether the Department is Active or Inactive.
JSON array of fields to return; e.g., \['id','name','active'\].
Additional department properties to update; use Coupa API hyphenated names as keys.
Controls response verbosity: 'none', 'limited', or 'shallow'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_DISPUTE_AN_INVOICETool 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.
Input parameters
Coupa unique identifier of the invoice to dispute. The invoice must be in pending_approval or pending_receipt status.
Supplier-facing comment explaining the dispute reason.
Controls response format: 'none' for no response body, 'limited' for IDs only, 'shallow' for all attributes (default).
The dispute reason code. Must correspond to an active dispute reason code in your Coupa instance (e.g., INCORRECT-QUANTITY, PRICING-ERROR).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_EASY_FORM_RESPONSES_DESTROYTool to delete an easy form response. Use when you need to permanently remove an easy form response by ID.
Input parameters
Easy form response ID to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_EXCHANGE_RATES_INDEXTool 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.
Input parameters
Exact-match filter by Coupa exchange rate ID
Filter by exchange rate value. Supports operators like \[gt\], \[lt\], \[gte\], \[lte\], \[eq\] in the format: rate\[lt\]=1
JSON array of fields to return; e.g., \["id","rate","rate-date"\].
Pagination offset; results are returned in pages of up to 50.
Filter by effective rate date. Supports operators like \[gt\], \[lt\], \[gte\], \[lte\] in the format: rate-date\[gt\]=2010-11-11T00:00:00
Filter by creation date. Supports operators like \[gt\], \[lt\], \[gte\], \[lte\] in the format: created_at\[gt\]=2010-11-15T00:00:00
Response size control: 'limited' returns only IDs; 'shallow' returns attributes with one-level associations; 'none' for minimal response.
Filter by target currency code (e.g., EUR). Cannot be used simultaneously with from-currency\[code\].
Filter by source currency code (e.g., USD). Cannot be used simultaneously with to-currency\[code\].
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_EXPENSE_REPORTS_INDEXTool to list expense reports. Use when you need a paginated list of reports with optional filters.
Input parameters
JSON array of fields to return; e.g., \['id','title','status'\].
Pagination offset; Coupa returns up to 50 records per call; use in multiples of 50.
Filter by expense report status; operators supported, e.g., status\[not_eq\]=closed.
Filter by export status; true for exported reports, false for unexported.
Control response verbosity; set to false or true (server may ignore unexpected values).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_EXPORT_PAYABLES_INVOICETool to mark a payables invoice as exported. Use when you need to track that an invoice has been exported to an external system by updating its last-exported-at timestamp.
Input parameters
The ID of the payables invoice to mark as exported
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_EXPORT_PAYABLES_INVOICESTool to mark a payable invoice as exported. Use after successfully retrieving and processing an invoice in an external system to update the last-exported-at timestamp.
Input parameters
The unique identifier of the invoice payable to be marked as exported.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_FINANCIAL_COUNTERPARTIES_INDEXTool to list financial counterparties from Coupa. Use when you need to retrieve banks and financial institutions used for payment and treasury operations.
Input parameters
Exact-match filter by Coupa financial counterparty ID
Filter by counterparty name; supports standard operators.
Filter by active status: true for active counterparties, false for inactive
JSON array of fields to return; e.g., \["id","abbreviation","name"\]
Pagination offset; results are returned in pages of up to 50
Filter by bank code identifier
Filter by SWIFT/BIC code identifier
Filter by branch code identifier
Filter by counterparty abbreviation; supports Coupa query operators like contains, starts_with, ends_with.
Filter records created after this ISO timestamp (YYYY-MM-DDTHH:MM:SS+HH:MM)
Filter records created before this ISO timestamp (YYYY-MM-DDTHH:MM:SS+HH:MM)
Filter by payment operations usage designation
Response verbosity: 'limited' returns only IDs; 'shallow' returns full object attributes with one-level association IDs
Filter records updated after this ISO timestamp (YYYY-MM-DDTHH:MM:SS+HH:MM)
Filter records updated before this ISO timestamp (YYYY-MM-DDTHH:MM:SS+HH:MM)
Filter by treasury operations usage designation
Filter by Legal Entity Identifier (LEI)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_ACCOUNT_STATEMENTS_BY_CREATION_DATETool to retrieve Coupa Pay account statements filtered by creation date. Use when you need to get statements created within a specific date range for reconciliation or reporting purposes.
Input parameters
Maximum number of statement records to return.
JSON array of fields to return; e.g., \["id","name","statement-date"\].
Pagination offset for statement list.
Response verbosity control: 'limited' returns only IDs; 'shallow' returns one-level associations.
Filter by creation date greater than or equal to (ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ).
Filter by creation date less than or equal to (ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_ALL_ACTIVE_PICK_LISTSTool to retrieve active pick lists (fulfillment reservations) from Coupa. Use when you need to query fulfillment reservation data with optional filters and pagination.
Input parameters
Specific pick list ID to retrieve
Number of records per request (max 50, default 50)
JSON array of specific fields to return, e.g., \["id","status","qty-ordered"\]
Starting position for pagination
Filter by status: 'active' or 'closed'
Filter by export status
Controls response payload size: 'shallow' for IDs and natural keys only, 'limited' for IDs only, or omit for full response
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_ALL_ATTACHMENTS_FOR_A_CONTRACTTool to retrieve all attachments for a specific contract. Use when you need to list attachments linked to a contract.
Input parameters
Number of attachments to return (max 50, default 50)
Pagination offset for retrieving attachments (standard Coupa pagination)
The unique identifier of the contract
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_ALL_ATTACHMENTS_FOR_A_INVOICETool 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.
Input parameters
Controls the number of records returned per request (default is 50)
Selective field specification using JSON structure, e.g., '\["id","file-url","type"\]'
Specifies the starting position for results
The unique identifier of the invoice
Controls response format. 'limited' returns only IDs, 'shallow' returns all attributes and IDs of one-deep associations
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_ALL_ATTACHMENTS_FOR_A_PURCHASEORDERTool to retrieve all attachments for a specific purchase order. Use when you need to list attachments linked to a purchase order.
Input parameters
Number of attachments to return (max 50, default 50)
Pagination offset for retrieving attachments (standard Coupa pagination)
The unique identifier of the purchase order
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_ALL_ATTACHMENTS_FOR_A_REQUISITIONTool to retrieve all attachments for a specific requisition. Use when you need to list or access files, URLs, or text attachments associated with a requisition.
Input parameters
Controls the number of records returned per request (default is 50)
Selective field specification using JSON structure, e.g., '\["id","file-url","type"\]'
Specifies the starting position for results
The unique identifier of the requisition
Controls response format. 'limited' returns only IDs, 'shallow' returns all attributes and IDs of one-deep associations
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_ALL_ATTACHMENTS_ON_A_COUPAPAY_CHARGETool 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.
Input parameters
Controls the number of records returned per request (default is 50)
Specifies the starting position for results
The unique identifier of the CoupaPay charge
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_ALL_CHARGES_LINKED_TO_SPECIFIC_STATEMENTTool 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.
Input parameters
Maximum number of charge records to return.
JSON array of fields to return; e.g., \['id','total','charge-date'\].
Pagination offset for charge list.
Filter charges by export status. Set to false to get unexported charges.
Filter charges by specific statement ID. Returns all charges linked to this statement.
Response verbosity control: 'limited' returns only IDs; 'shallow' returns one-level associations.
Filter by holding account presence. Set to false to get charges with holding accounts.
Filter by document type. Valid values: OrderHeader, CoupaPay::Payment, CoupaPay::PaymentAccount, ExpensePreapproval, Travel::TripBooking.
Filter for unbacked charges (charges without associated documents). Set to true to get charges with no document type.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_ALL_FUNDS_TRANSFERS_SPECIFIC_PAYMENT_BATCHTool 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.
Input parameters
Maximum number of records to return per call (1-50). Default: 50 records.
JSON array of fields to return; e.g., \['id','payment-batch-id','status','exchange_rate'\].
Starting position for retrieving records in subsequent calls (default 0). Example: offset=50 retrieves records 51-100.
Filter by payment status. Valid values: draft, approved, payment_initiated, payment_in_progress, completed_successfully, completed_with_errors.
Filter by export status; e.g., exported=false for unexported payments.
Filter by multiple statuses; e.g., status\[in\]=completed_successfully,completed_with_errors.
Filter payments updated after this timestamp (ISO 8601 format: YYYY-MM-DDTHH:MM:SS+HH:MMZ).
Payment batch identifier to filter payments (required).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_ALL_SIM_SITES_AGAINST_A_SIM_RECORDTool 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.
Input parameters
Maximum number of records to return per request. Default is 50, maximum is 50.
Filter by activation status (true/false).
JSON array of specific fields to return in response (e.g., '\["id","code","name"\]').
Starting position for result set. Used for pagination (e.g., offset=50 retrieves records 51-100).
Field name to sort results by.
The ID of the supplier information record to retrieve sites for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_ALL_SUPPLIER_SITES_AGAINST_A_SUPPLIER_RECORDTool 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.
Input parameters
Limits the number of records returned (default is 50 if not specified)
JSON array of specific fields to return in response for performance optimization; e.g., \["id","name","code"\]
Skips a specified number of records for pagination (e.g., offset=50)
The unique identifier of the parent supplier whose sites are to be retrieved
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_ALL_TASKS_LINKED_TO_ALL_PROJECTSTool to retrieve all tasks linked to all projects from Coupa. Use when you need to fetch task records with optional filtering and pagination.
Input parameters
Maximum number of records to return (1-50).
JSON array of fields to return; e.g., \['id','title','status'\].
Pagination offset; results are returned in batches of up to 50.
Filter by task status; e.g., 'pending', 'completed'.
Filter tasks by owner user ID.
Response verbosity: 'limited' returns only IDs; 'shallow' returns full object attributes with one-level association IDs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_ALL_TASKS_LINKED_TO_A_SPECIFIC_PROJECTTool 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.
Input parameters
Maximum number of records to return (1-50).
JSON array of fields to return; e.g., \['id','title','status'\].
Pagination offset; results are returned in batches of up to 50.
Filter by task status; e.g., 'pending', 'completed'.
The unique identifier of the project whose tasks you want to retrieve
Response verbosity: 'limited' returns only IDs; 'shallow' returns full object attributes with one-level association IDs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_API_DOCSTool 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.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_APPROVAL_BY_IDTool 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.
Input parameters
The unique Coupa identifier for the approval record
Allows selective field inclusion in response using JSON format. Example: '\["id","status","approval-date",{"approver":\["id","email"\]}\]'. This is the recommended alternative to return_object for better performance.
Controls response payload size. 'limited' returns only IDs of objects, 'shallow' returns all attributes/fields of the object and only the IDs and natural keys of one-deep associations
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_AS_NSTool 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.
Input parameters
Maximum number of records to return per call. Default: 50 (API enforced maximum).
JSON array of fields to return in response; e.g., \["id","asn-number",{"supplier":\["id","name"\]}\].
Pagination offset to skip records and retrieve subsequent batches.
Filter by transaction status (e.g., draft, pending receipt, received, error, cancelled). Supports operators: \[in\], \[not_in\], \[contains\], \[starts_with\], \[ends_with\], \[blank\], \[not_eq\].
Filter results by export status.
Filter by ASN number. Supports text operators.
Filter ASNs created after this timestamp (ISO 8601 format).
Filter ASNs created before this timestamp (ISO 8601 format).
Response verbosity control: 'none' (nothing returned), 'limited' (IDs only), 'shallow' (all attributes + IDs of associations). Note: Being deprecated in favor of 'fields' parameter.
Filter by supplier name.
Filter ASNs updated after this timestamp (ISO 8601 format).
Filter ASNs updated before this timestamp (ISO 8601 format).
Filter ASNs created on or after this timestamp (ISO 8601 format).
Filter ASNs created on or before this timestamp (ISO 8601 format).
Filter ASNs updated on or after this timestamp (ISO 8601 format).
Filter ASNs updated on or before this timestamp (ISO 8601 format).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_BUDGET_LINETool to retrieve a specific budget line by ID. Use when you need detailed information about a budget line including amount, remaining budget, and account segments.
Input parameters
ID of the budget line to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_BUDGET_LINE_ADJUSTMENTS_FOR_BUDGET_LINETool to retrieve budget line adjustments for a specific budget line. Use when you need to get all adjustments associated with a budget line ID.
Input parameters
Number of records to return per page. Default is 50, maximum is 50 per call
JSON array specifying which fields to include in response (e.g., \["id","amount","description"\])
Number of records to skip for pagination (e.g., offset=50 for records 51-100)
Field name to sort results by
Level of detail in response. Values: 'shallow', 'limited', 'none'
The unique identifier of the budget line for which to retrieve adjustments
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_BUDGET_LINES_BUDGET_LINE_ADJUSTMENTSTool to retrieve a specific budget line adjustment by ID. Use when you need detailed information about a budget line adjustment including amount, currency, description, and related references.
Input parameters
ID of the budget line containing the adjustment
ID of the budget line adjustment to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_BUSINESS_ENTITIESTool to retrieve business entities from Coupa. Use when you need to query legal or organizational business entities with their addresses, contacts, relationships, and metadata.
Input parameters
Exact-match filter by business entity ID.
Exact-match filter by business entity name.
Filter by business entity type (LegalBusinessEntity or OrganizationalBusinessEntity).
Maximum number of records to return per API call. Default: 50.
JSON-formatted array of specific fields to return in response; e.g., \["id","name","type"\].
Number of records to skip for pagination.
Filter by business entity status.
Field name to sort results by.
Return business entities created after this ISO-8601 timestamp.
Return business entities created before this ISO-8601 timestamp.
Filter business entities whose name contains the given text.
Return business entities updated after this ISO-8601 timestamp.
Return business entities updated before this ISO-8601 timestamp.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_BUSINESS_ENTITIES_BY_IDTool to retrieve a specific business entity by ID. Use when you need detailed information about a legal or organizational business entity.
Input parameters
The Coupa internal ID of the business entity to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_COAS_ASSIGNED_TO_A_SPECIFIC_SUPPLIER_SITETool 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.
Input parameters
Coupa unique identifier of the supplier site to retrieve.
JSON array of fields to return; e.g., \['id','name','content-groups'\].
Response verbosity: 'limited' or 'shallow'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_COMMENTS_FOR_A_SPECIFIC_EXPENSEREPORTTool to retrieve comments for a specific expense report. Use when you need to view all comments associated with an expense report.
Input parameters
The unique identifier for the expense report whose comments you want to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_COMMODITYTool to retrieve a specific commodity by ID. Use when you need detailed commodity information.
Input parameters
The unique identifier of the commodity to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_CONTENT_GROUP_OF_A_SUPPLIER_SITETool 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.
Input parameters
ID of the supplier site whose business groups you want to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_CONTRACT_BY_IDTool to retrieve a single contract by ID. Use when you need detailed contract information including supplier, terms, dates, and status.
Input parameters
ID of the contract to retrieve
JSON array of fields to return; e.g., \['id','name','status',{'supplier':\['id','name'\]}\].
Response verbosity: 'limited' returns only IDs; 'shallow' returns one-level associations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_CONTRACTS_LEGAL_DOCUMENTSTool to retrieve all legal documents for a contract. Use when you need to list legal documents associated with a specific contract.
Input parameters
The contract ID to retrieve legal documents for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_COUPAPAY_EXPENSE_PAYMENT_BY_IDTool 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.
Input parameters
Coupa unique payment identifier
Specify specific fields to include in response body (JSON format array)
Response verbosity: 'shallow' returns limited JSON/XML response instead of entire schema
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_CUSTOM_OBJECT_INSTANCESTool 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.
Input parameters
Restricts the number of records returned per API call. Default is 50 records maximum.
JSON array specifying which fields to include in the response. Example: \["id","created-at","updated-at"\]. Supports nested objects like {"created_by":\["id"\]}.
Pagination parameter to retrieve subsequent record batches. Example: offset=50 retrieves records 51-100.
Specifies the field to sort results by.
Controls response structure. Values: 'limited' (only IDs) or 'shallow' (all attributes plus IDs of associations). Deprecated in favor of 'fields' parameter.
The unique identifier for the Custom Object definition (required path parameter).
Filter instances updated at or after this timestamp (ISO 8601 format).
Filter instances updated at or before this timestamp (ISO 8601 format).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_CUSTOM_OBJECT_RELATED_FORM_RESPONSESTool to retrieve easy form responses for custom objects and SIM (Supplier Information Management). Use when you need to get form responses with optional filtering and pagination.
Input parameters
Maximum number of records to return (default: 50).
JSON array of fields to return; e.g., \["id","name","status",{"subject":\["id","supplier_id"\]}\].
Number of records to skip for pagination (default: 0).
Filter by status (e.g., 'pending', 'submitted', 'approved').
Additional attribute filters using Coupa syntax. Supports operators: \[contains\], \[starts_with\], \[ends_with\], \[gt\], \[lt\], \[gt_or_eq\], \[lt_or_eq\], \[not_eq\], \[in\], \[not_in\], \[blank\]. Example: {'created_at\[gt_or_eq\]':'2024-01-01','status\[not_eq\]':'draft'}
Field name to sort results by (e.g., 'id', 'created_at').
Filter by easy form ID.
Response verbosity: 'shallow' (all attributes + IDs), 'limited' (only IDs), 'none' (no response body).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_CYCLE_COUNTSTool to retrieve cycle counts from Coupa. Use when you need to query cycle count records for inventory management.
Input parameters
Maximum number of records to return (default: 50, max: 50).
JSON array of specific fields to return; e.g., \["id","status","created-at"\]
Pagination offset; results are returned in batches of up to 50.
Controls response payload: 'limited' (IDs only), 'shallow' (all attributes + IDs of associations).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_DELEGATIONSTool to retrieve delegations from Coupa. Use when you need to view user delegation configurations including approval, receiving, and review delegations.
Input parameters
Maximum number of records to return (1-50)
Pagination offset; results are returned in pages up to 50
Filter delegations created at or after this timestamp (format: YYYY-MM-DDTHH:MM:SS+HH:MMZ)
Filter delegations updated at or after this timestamp (format: YYYY-MM-DDTHH:MM:SS+HH:MMZ)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_DEPARTMENT_BY_NAMETool to retrieve department records by filtering with name or other parameters. Use when you need to find departments by name, ID, or active status.
Input parameters
Filter by department ID
Filter departments by exact name match
Maximum number of records to return
Filter by active status: true for active departments, false for inactive
JSON array of fields to return; e.g., \["id","name","active"\]
Pagination offset; skip specified number of records
Response verbosity: 'limited' returns only IDs; 'shallow' returns all fields with IDs of associations
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_EXCHANGE_RATE_BY_IDTool 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.
Input parameters
Coupa's unique identifier for the exchange rate
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_EXTERNAL_PAYABLE_BY_SOURCETool 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.
Input parameters
JSON array of fields to return in response; e.g., \["id","source-name","source-reference","document-number"\].
Pagination offset for retrieving records beyond the first 50 (default: 0).
Filter by payable status. Values: 'active', 'voided'. Supports operators: \[not_eq\], \[in\], \[not_in\].
Sort results by specified field (e.g., 'document-date', 'due-date').
Filter payables by source system name (e.g., 'SAP', 'Oracle'). Supports operators: exact match, \[contains\], \[starts_with\], \[ends_with\].
Filter by document type (e.g., 'Invoice', 'CreditMemo', 'DebitMemo').
Response verbosity control: 'none', 'limited', or 'shallow'. Controls response depth.
Filter by document number from source system.
Filter by unique reference number from source system. Supports operators: exact match, \[contains\], \[starts_with\], \[ends_with\].
Filter payables with due date greater than or equal to this timestamp (ISO 8601 format).
Filter payables with due date less than or equal to this timestamp (ISO 8601 format).
Filter payables with document date greater than or equal to this timestamp (ISO 8601 format).
Filter payables with document date less than or equal to this timestamp (ISO 8601 format).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_FAVORITE_ACCOUNTSTool to retrieve favorite accounts from Coupa. Use when you need to get the list of accounts marked as favorites by the user.
Input parameters
Exact-match filter by Coupa account ID
Filter by account code; supports Coupa query operators
JSON array of fields to return; e.g., \["id","code","name"\]
Pagination offset; results are returned in pages up to 50
Response verbosity: 'limited' returns only IDs; 'shallow' returns full object attributes with one-level association IDs
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_INTEGRATION_HISTORY_RECORDSTool to retrieve integration history records from Coupa. Use when you need to monitor integration transactions, check status of API calls, or troubleshoot integration issues.
Input parameters
Maximum number of records to return (1-50).
JSON array of fields to return; e.g., \['id','document-id','status','created-at'\].
Number of records to skip for pagination.
Additional attribute filters using Coupa syntax. Example: {'status':'success','created-at\[gt\]':'2023-01-01T00:00:00Z','document-type':'OrderHeader'}
Response verbosity: 'limited' returns only IDs; 'shallow' returns full object attributes with one-level association IDs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_INTEGRATION_RUNTool 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.
Input parameters
Coupa's unique identifier for the integration run
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_INVENTORY_ADJUSTMENTSTool to retrieve inventory adjustments from Coupa. Use when you need to query inventory adjustment records with optional filtering, pagination, and field selection.
Input parameters
Filter by transaction type.
Maximum number of records to return (default: 50, max: 50).
JSON array of specific fields to return; e.g., \["id","quantity","price"\]
Pagination offset; results are returned in batches of up to 50 (offset multiples of 50).
Filter by transaction status.
Filter by item ID.
Filter by export status (true/false).
Filter by creation date (ISO 8601 format). Supports operators: \[gt\], \[lt\], \[gt_or_eq\], \[lt_or_eq\].
Filter by update date (ISO 8601 format). Supports operators: \[gt\], \[lt\], \[gt_or_eq\], \[lt_or_eq\].
Filter by account code.
Controls response payload: 'limited' (IDs only), 'shallow' (all attributes + IDs of associations), 'none' (nothing returned).
Filter by destination warehouse ID.
Filter by transaction date (ISO 8601 format). Supports operators: \[gt\], \[lt\], \[gt_or_eq\], \[lt_or_eq\].
Filter by source warehouse ID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_INVOICES_COMMENTSTool to retrieve a specific comment on an invoice by comment ID. Use when you need to get detailed information about a particular invoice comment.
Input parameters
The unique identifier for the specific comment to retrieve.
The unique identifier for the invoice.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_ITEMTool to retrieve a single catalog item by ID. Use when you need detailed item information after knowing the item ID.
Input parameters
Coupa unique identifier of the item to retrieve
Enum for return_object query parameter values.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_ITEM_IMAGETool to download the image for a catalog item. Use when you need to retrieve the image associated with a specific item ID.
Input parameters
Coupa unique identifier of the item to retrieve the image for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_ITEMS_SUPPLIER_ITEMSTool to retrieve supplier items for a specific catalog item. Use when you need supplier-specific pricing, contract details, and purchasing information for an item.
Input parameters
The ID of the item to retrieve supplier items for
Maximum number of records to return (default: 50, max: 50).
JSON array of fields to return; e.g., \['id','price',{'supplier':\['name'\]}\].
Skip specified number of records for pagination (default: 0).
Field name to sort results by.
Sort direction, 'asc' for ascending or 'desc' for descending.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_ITEMS_SUPPLIER_ITEMS2Tool to retrieve a specific supplier item associated with a catalog item. Use when you need detailed information about a particular supplier item for an item, including pricing, availability, and supplier details.
Input parameters
Maximum number of records to return (default: 50, max: 50).
JSON array of fields to return; e.g., \['id','price',{'supplier':\['name'\]}\].
Skip specified number of records for pagination (default: 0).
The ID of the item
Field name to sort results by.
Sort direction, 'asc' for ascending or 'desc' for descending.
The ID of the supplier item associated with the item
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_LOOKUP_VALUE_BY_IDTool 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.
Input parameters
Coupa unique identifier for the lookup value
JSON array of fields to return in response body; e.g., \["id","name","active"\]
Controls response payload size: 'limited' returns only IDs, 'shallow' returns all attributes and IDs of one-deep associations
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_MATCHING_ALLOCATION_FOR_AN_INVOICE_LINETool 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.
Input parameters
JSON array of desired response fields; e.g., \["id","amount","quantity","invoice_line_id"\].
Pagination offset for retrieving records beyond initial set (default 0, returns 50 records per call).
Controls response payload size: 'none' for minimal data, 'limited' returns IDs only, 'shallow' returns full attributes with association IDs.
Filter by specific invoice line ID to get matching allocations for that invoice line.
Filter by comma-separated list of invoice header IDs to get matching allocations for invoice lines belonging to those headers.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_ORDER_PADS_ORDER_PAD_LINESTool to retrieve order pad lines for a specific order pad. Use when you need to fetch the list of items (lines) associated with an order pad.
Input parameters
The ID of the order pad to retrieve lines for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_PAYABLE_INVOICE_BY_IDTool 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.
Input parameters
ID of the payable invoice to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_PAYABLE_INVOICESTool 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.
Input parameters
Filter by specific payable ID; supports operators \[gt\], \[lt\], \[gt_or_eq\], \[lt_or_eq\], \[in\].
Filter payables with ID greater than this value.
Filter payables with ID less than this value.
Maximum number of records to return per request (default: 50, max: 50).
JSON array of fields to return; e.g., \["id","status","payable-amount"\] or with nested: \["id","status",{"currency":\["id","code"\]}\].
Number of records to skip for pagination.
Filter by payable status; supports operators like \[in\], \[not_in\], \[eq\], \[not_eq\]. Example: 'pending' or use status_in for multiple values.
Filter by multiple statuses (comma-separated); e.g., 'pending,approved'.
Filter by currency ID.
Filter by associated document ID.
Filter payables created after this timestamp (ISO 8601 format).
Filter payables created before this timestamp (ISO 8601 format).
Filter by document type (e.g., 'invoice').
Response verbosity: 'limited' returns only IDs; 'shallow' returns attributes with first-level IDs.
Filter payables updated after this timestamp (ISO 8601 format).
Filter payables updated before this timestamp (ISO 8601 format).
Filter payables with maturity date (payment due date) after this timestamp (ISO 8601 format).
Filter payables with maturity date (payment due date) before this timestamp (ISO 8601 format).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_PAY_INVOICES_FIELDS_QUERY_PARAMTool 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.
Input parameters
Maximum number of invoices to return for pagination.
Comma-separated list of fields to return; e.g., "id,status" or "id,status,invoice_number".
Pagination offset for invoice list.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_PAY_ORDERS_IN_STATUS_PENDING_DOCUMENT_APPROVALTool to get pay orders with status pending_document_approval. Use when you need to retrieve orders awaiting document approval in the payables system.
Input parameters
JSON array of fields to return; e.g., \['id','status',{'reconciliation-lines':\['id'\]}\].
Pagination offset; results are returned in batches of up to 50 (offset multiples of 50).
Filter by export status; e.g., exported=false to fetch unexported orders.
Response verbosity control: 'limited' returns only IDs; 'shallow' returns one-level associations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_PO_CONFIRMATION_BY_IDTool to retrieve a specific order header confirmation by ID. Use when you need details about a purchase order confirmation record.
Input parameters
Coupa's internal ID for the order header confirmation
JSON array specifying which fields to include in response. Format: \['id', 'status', {'order-line-confirmations': \['id', 'line-num'\]}\]. Allows selective field inclusion to reduce payload size.
Controls response detail level. Values: 'limited' (returns only IDs), 'shallow' (returns all attributes of main object and only IDs/natural keys of one-deep associations). Default returns complete response.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_PO_CONFIRMATION_CANCELLED_STATUS_NOT_EXPORTEDTool 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.
Input parameters
JSON array of fields to return; e.g., \["id","status","exported"\].
Pagination offset; results are returned in batches of up to 50 (offset multiples of 50).
Filter confirmations created after this timestamp (ISO 8601 format).
Filter confirmations created before this timestamp (ISO 8601 format).
Response size control: 'limited' returns only IDs; 'shallow' returns all attributes with IDs of one-level associations.
Filter confirmations updated after this timestamp (ISO 8601 format).
Filter confirmations updated before this timestamp (ISO 8601 format).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_PO_LINE_USING_ORDER_HEADER_ID_AND_LINE_NUMBERTool 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.
Input parameters
The line number to filter by (e.g., '1', '2')
The purchase order header ID to filter by
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_PROJECT_MEMBERSHIPTool 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).
Input parameters
Filter by specific project membership ID
Maximum number of records to return (1-50). Default is 50
Filter by owner status (admin status). Set to true to get only owner memberships, false for non-owners
JSON array of specific fields to return; e.g., \["id","user-id","project-id","owner"\]
Number of records to skip for pagination (default 0)
Filter by specific user ID to get memberships for that user
Filter by specific project ID to get memberships for that project
Filter by participant status. Set to true to get only participant memberships, false for non-participants
Response verbosity: 'limited' returns only IDs; 'shallow' returns attributes with one-level associations; 'none' for minimal data
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_PROJECT_MEMBERSHIP_BY_IDTool to retrieve a single project membership by ID. Use when you need detailed information about a specific project membership after knowing its ID.
Input parameters
The unique identifier of the project membership to retrieve
JSON array of fields to return; e.g., \["id","project-id","user-id","owner","participant"\]
Response verbosity: 'limited' returns only IDs; 'shallow' returns full object attributes with one-level association IDs
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_PROJECT_TASKTool to retrieve a specific task from a specific project by their IDs. Use when you need detailed information about a particular task within a project.
Input parameters
The ID of the task within the project
The ID of the project
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_PURCHASE_ORDERTool to retrieve a specific purchase order. Use when you need PO details by its ID.
Input parameters
Coupa internal ID of the purchase order to retrieve
JSON array of specific fields/associations to return. Example: \['id', 'po-number', {'order-lines': \['id', 'line-num'\]}\]
Controls response verbosity for GET: 'limited' for IDs-only, 'shallow' for shallow associations
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_PURCHASE_ORDER_ATTACHMENT_FILETool to retrieve a specific attachment file from a purchase order. Use when you need to download the actual file content of an attachment associated with a specific purchase order.
Input parameters
Coupa unique identifier of the purchase order
Coupa unique identifier of the attachment to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_PURCHASE_ORDER_CHANGESTool to retrieve a specific purchase order change. Use when you need details about a PO modification request by its ID.
Input parameters
Coupa's unique identifier for the PO change request
JSON array of specific fields/associations to return. Example: \['id','status',{'current-approval':\['id','approver'\]}\]
Controls response verbosity for GET: 'limited' for IDs-only, 'shallow' for shallow associations
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_PURCHASE_ORDER_CHANGES_PENDING_CERTAIN_APPROVERTool 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.
Input parameters
Maximum number of records to return per API call (default: 50, max: 50).
JSON array of fields to return; e.g., \['id','status',{'current-approval':\['id','approver'\]}\].
Pagination offset to skip records and retrieve subsequent sets (default: 0).
Filter by PO change approval status; e.g., 'pending_approval' or 'approved'.
Filter PO changes created after this timestamp (ISO 8601).
Filter PO changes created before this timestamp (ISO 8601).
Filter PO changes updated after this timestamp (ISO 8601).
Filter PO changes updated before this timestamp (ISO 8601).
Filter by the original purchase order ID being changed.
Filter by the current approver's user ID to get PO changes pending this specific approver.
Filter by the current approver's login to get PO changes pending this specific approver.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_PURCHASE_ORDER_COMMENTTool to retrieve a specific comment on a purchase order by ID. Use when you need to view details of a particular comment on a purchase order.
Input parameters
JSON array string of specific fields to include in the response.
Coupa unique identifier of the specific comment to retrieve.
Level of detail in the response: 'shallow', 'limited', or 'none'.
Coupa unique identifier of the purchase order.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_PURCHASE_ORDER_LINESTool to retrieve a specific purchase order line by ID. Use when you need detailed information about a single purchase order line.
Input parameters
Coupa unique identifier of the purchase order line to retrieve
JSON array of fields to return; e.g., \['id','line-num','description',{'item':\['id','name'\]}\]
Response verbosity: 'limited' for IDs-only, 'shallow' for shallow associations
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_QUOTE_REQUESTS_TASKSTool to retrieve all tasks for a specific quote request in Coupa. Use when you need to fetch task records for a particular quote request with optional filtering and pagination.
Input parameters
The ID of the quote request to retrieve tasks for
Maximum number of records to return (1-50)
JSON array of fields to return; e.g., \['id','title','status'\]
Pagination offset; results are returned in batches
Filter by task status
Response verbosity: 'limited' returns only IDs; 'shallow' returns full object attributes with one-level association IDs
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_RECONCILIATION_LINES_FOR_PAYABLE_ORDERTool to retrieve reconciliation lines for payable orders. Use when you need to fetch payment reconciliation records linked to pay orders or invoices.
Input parameters
Coupa unique identifier for a specific reconciliation line. If provided, retrieves a single reconciliation line; otherwise, retrieves all reconciliation lines.
ID of the payable order to filter reconciliation lines by. Use this to retrieve only reconciliation lines associated with a specific payable order.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_REMIT_TO_ADDRESS_OF_A_SUPPLIERTool 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.
Input parameters
Supplier identifier (required path parameter)
Number of records to return per request. Default: 50, Maximum: 50.
Filter by active status (true/false).
JSON array specifying which fields to include in response. Example: \["id","name",{"country":\["code","name"\]}\]
Number of records to skip for pagination.
Field name to sort results by (alphabetical or numeric order).
Get specific address by ID.
Filter addresses by country code (e.g., 'US').
Filter addresses created after specified date (format: YYYY-MM-DDTHH:MM:SS).
Filter addresses created before specified date (format: YYYY-MM-DDTHH:MM:SS).
Response format control. Values: 'limited' (returns only IDs), 'shallow' (returns all attributes plus IDs of one-deep associations).
Filter addresses updated after specified date (format: YYYY-MM-DDTHH:MM:SS).
Filter addresses updated before specified date (format: YYYY-MM-DDTHH:MM:SS).
Filter addresses updated by specific user login.
Filter addresses created on or after specified date (format: YYYY-MM-DDTHH:MM:SS).
Filter addresses created on or before specified date (format: YYYY-MM-DDTHH:MM:SS).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_REQUISITION_ASSIGNMENTTool to retrieve assignment information for a specific requisition. Use when you need to see who is assigned to a requisition and in what role.
Input parameters
Coupa unique identifier of the requisition to retrieve assignments for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_REQUISITION_LINES_ESTIMATED_TAX_LINESTool to retrieve estimated tax lines for a requisition line. Use when you need tax calculation details for a specific requisition line.
Input parameters
Coupa unique identifier of the requisition line to retrieve estimated tax lines for.
JSON array of fields to return; e.g., \['id','tax_code',{'tax_rate':\['id','rate'\]}\].
Response verbosity: 'limited' or 'shallow'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_REQUISITIONS_COMMENTSTool to retrieve a specific comment on a requisition by comment ID. Use when you need to get detailed information about a particular requisition comment.
Input parameters
The unique identifier for the specific comment to retrieve.
The unique identifier for the requisition.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_RETURN_TO_SUPPLIER_TRANSACTIONSTool to retrieve return to supplier transactions for reverse logistics operations. Use when you need to query transactions related to inventory returns to vendors.
Input parameters
Exact-match filter by transaction ID
Filter by transaction type (ReturnToSupplierTransaction, InventoryReceiptReturnToSupplier, ReceivingQuantityConsumptionReturnToSupplier, ReceivingAmountConsumptionReturnToSupplier)
JSON array of fields to return; e.g., \["id","status","quantity"\]
Pagination offset; results are returned in pages up to 50
Filter by transaction status
Additional attribute filters using Coupa syntax. Example: {'created_at\[gt\]':'2024-01-01', 'item\[name\]':'Widget'}. Supports operators like \[contains\], \[starts_with\], \[gt\], \[lt\], \[in\], etc.
Filter by export status: true for exported transactions, false for not exported
Response verbosity: 'limited' returns only IDs; 'shallow' returns full object attributes with one-level association IDs
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_RISKAWAREFEEDTool 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.
Input parameters
Filter by Coupa supplier identifier to get Risk Aware feed for a specific supplier.
Filter by supplier name to get Risk Aware feed. Use when you don't know the supplier ID.
Filter by supplier number to get Risk Aware feed. Each supplier has only one Risk Aware feed.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_SHIPPING_TERMSTool to retrieve shipping terms from Coupa. Use when you need to query shipping term records with optional filtering by ID, active status, code, or content groups.
Input parameters
Coupa unique identifier for specific shipping term
Filter by shipping term code
Filter by active status
Filter by BusinessGroup
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_SIM_EASY_FORM_RESPONSESTool 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.
Input parameters
Limit the number of results returned
JSON array of fields to return in the response. Example: \["id","created_at","updated_at","easy_form_id","name","status","submitted_at"\]
Pagination parameter to skip a number of records
Filter by status value (e.g., pending, approved, submitted)
The unique identifier of the supplier information record
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_SIM_SITE_BY_IDTool 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.
Input parameters
The Coupa Internal ID of the supplier information site to retrieve
Comma-separated list of fields to return in the response for response filtering; e.g., "id,code,name" or JSON array format \["id","code","name"\]
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_SOFT_APPLIED_PO_UPDATES_USING_CONFIRMATION_IDTool 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.
Input parameters
Coupa internal ID of the purchase order to review confirmation for
The confirmation ID used to retrieve soft applied PO updates
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_SPECIFIC_ATTACHMENT_ON_PURCHASE_ORDER_LINETool 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.
Input parameters
Coupa unique identifier of the purchase order line.
Coupa unique identifier of the attachment to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_SPECIFIC_ATTACHMENT_ON_REQUISITION_LINETool to retrieve a specific attachment file from a requisition line. Use when you need to download an attachment associated with a specific requisition line.
Input parameters
The unique identifier of the requisition line
The unique identifier of the specific attachment to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_SPECIFIC_ATTACHMENT_USING_ATTACHMENT_IDTool to retrieve a specific attachment associated with a charge. Use when you need to get attachment details by charge ID and attachment ID.
Input parameters
The unique identifier of the charge
The unique identifier of the attachment
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_SPECIFIC_CONTRACT_ATTACHMENT_FILETool 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.
Input parameters
For image attachments: 'preview' (640x640) or 'thumb' (128x128). For non-image files: downloads the original file
The unique identifier for the contract in Coupa's system
The specific attachment ID to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_SPECIFIC_CUSTOM_OBJECT_INSTANCE_BY_IDTool to retrieve a specific custom object instance by ID. Use when you need detailed information about a particular custom object data record.
Input parameters
JSON array specifying which fields to include in the response. Format: \["id","created_at","updated_at","custom_object_name","custom_object_code","form_response_id","owner_id","due_date","start_date","duration","percentage","linkable_type","linkable_id",{"created_by":\["id"\]},{"updated_by":\["id"\]},{"custom_fields":{}}\]. Supports nested object structures.
The unique identifier for the specific data record to retrieve
The unique identifier for the custom object being queried
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_SPECIFIC_EASYFORMRESPONSE_ATTACHMENT_FILETool 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.
Input parameters
Coupa unique identifier of the attachment to retrieve.
Coupa unique identifier of the EasyFormResponse object.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_SPECIFIC_INVOICE_ATTACHMENT_FILETool to retrieve a specific attachment from an invoice. Use when you need to get attachment metadata and file information for a specific invoice attachment.
Input parameters
The unique identifier of the invoice.
The unique identifier of the attachment to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_SPECIFIC_REQUSITION_ATTACHMENT_FILETool 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.
Input parameters
JSON array of fields to return in the response using the format \["field1","field2",{"nested_object":\["field1","field2"\]}\]
The unique identifier for the attachment.
The unique identifier for the requisition.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_SPECIFIC_SCHEMATool to retrieve the Swagger 2.0 API schema documentation for a specific Coupa resource. Use when you need to understand the API structure, available endpoints, parameters, and response schemas for resources like users, invoices, purchase orders, or suppliers.
Input parameters
The resource name or identifier for which to retrieve the API schema. Common values include resource names like 'users', 'invoices', 'purchase_orders', 'suppliers', 'requisitions', etc.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_STATEMENTS_BY_IDTool 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.
Input parameters
Unique identifier of the statement to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_STATUS_OF_AN_IMPORT_FILETool 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.
Input parameters
Coupa's unique identifier for the data file source
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_SUPPLIER_INFORMATION_SUPPLIER_INFORMATION_SITETool to retrieve a specific supplier information site by supplier information ID and site ID. Use when you need detailed information about a single supplier information site including code, name, PO methods, addresses, and contacts.
Input parameters
The ID of the supplier information site to retrieve
Comma-separated list of fields to return in the response for response filtering; e.g., "id,code,name" or JSON array format \["id","code","name"\]
The ID of the supplier information record
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_SUPPLIER_ITEM_BY_IDTool to retrieve a specific supplier item by ID. Use when you need detailed supplier item information including pricing, availability, and item specifications.
Input parameters
Coupa's unique identifier for the supplier item
Maximum number of records to return (default: 50, max: 50).
JSON array of fields to return; e.g., \['id','price',{'item':\['name'\]}\].
Skip specified number of records for pagination (default: 0).
Field name to sort results by.
Sort direction, 'asc' for ascending or 'desc' for descending.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_SUPPLIER_ITEMS_BY_ITEM_NAMETool to retrieve supplier items filtered by item name. Use when you need to find supplier items for a specific item.
Input parameters
Limit the number of supplier items returned.
Pagination offset for results.
Filter supplier items by item name (exact match).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_SUPPLIER_SITE_BY_CODETool to retrieve supplier sites with optional filters. Use when you need to query supplier sites by code, name, or other attributes.
Input parameters
Exact-match filter by supplier site code (e.g., 'Standard', 'TSS001')
Exact-match filter by supplier site name
Number of records to return (max 50)
Filter by activation status: true for active sites, false for inactive
Pagination offset; results returned in pages of up to 50
Filter by PO transmission method
Filter by the ID of the parent supplier
Filter by supplier site code containing this substring
Filter by supplier site name containing this substring
Filter by supplier site code starting with this substring
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_TAX_REGISTRATIONS_USING_IDTool to retrieve a specific supplier information tax registration record by ID. Use when you need detailed tax registration information for supplier information management.
Input parameters
The unique identifier for the tax registration record
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_USER_ADDRESS_BY_IDTool to retrieve a specific address by ID for a Coupa user. Use when you need detailed information about a particular user address.
Input parameters
ID of the address to retrieve.
JSON array of fields to return; e.g., \["id","name","city","state","country"\].
ID of the user whose address to retrieve.
Response verbosity: 'limited' returns minimal fields, 'shallow' returns full attributes with one-level associations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_USER_ADDRESS_BY_ID2Tool to retrieve a specific address by ID for a Coupa user using the nested user endpoint. Use when you need detailed information about a particular user address.
Input parameters
ID of the address to retrieve.
JSON array of fields to return; e.g., \["id","name","city","state","country"\].
ID of the user whose address to retrieve.
Response verbosity: 'limited' returns minimal fields, 'shallow' returns full attributes with one-level associations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_USER_GROUPTool to retrieve a specific user group by ID. Use when you need detailed information about a user group including its members, approval permissions, and metadata.
Input parameters
The unique identifier of the user group to retrieve
JSON array of fields to return; e.g., \["id","name","active"\].
Response verbosity: 'limited' returns only IDs; 'shallow' returns full object attributes with one-level association IDs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_USER_GROUP_MEMBERSHIPTool to retrieve a single user group membership by ID. Use when you need detailed information about a specific user's membership in a group or project.
Input parameters
The unique identifier for the user group membership record
JSON array of fields to return; e.g., \["id","user-id","user-group-id"\].
Response verbosity: 'limited' or 'shallow'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_USER_GROUPS_TASKSTool to retrieve tasks associated with a specific user group. Use when you need to query tasks assigned to or managed by a user group.
Input parameters
Maximum number of records to return (1-50). Default is 50 records.
JSON array of fields to return; e.g., \["id","title","status"\].
Number of records to skip for pagination (default 0).
Field(s) to order results by (alphabetical/numeric order). E.g., 'title', 'due-date'.
Response verbosity: 'limited' returns only IDs; 'shallow' returns all attributes and IDs of one-deep associations.
ID of the user group to retrieve tasks for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_GET_USER_MEMBERSHIPSTool to list user group memberships. Use when you need to retrieve user memberships in groups or projects with optional filtering and pagination.
Input parameters
Exact-match filter by membership ID
Maximum number of records to return (1-50). Default is 50.
Filter by owner status: true for admin users, false for non-admin
JSON array of fields to return; e.g., \["id","user-id","user-group-id"\]
Number of records to skip for pagination (default 0).
Filter by user ID to get memberships for a specific user
Filter by participant status
Response verbosity: 'limited', 'shallow', or 'none'
Filter by user group ID or project ID
Filter by group type: 'User group' or 'Project'
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_IGNORE_WINDOW_AND_ISSUEIgnore Window And Issue
Input parameters
Coupa internal Purchase Order ID to issue
Optional fields selector per Coupa API as a JSON string. Example: \['id', {'order_lines':\['id','line_num'\]}\]
Optional return object size: none \\ | limited \\ | shallow
Optional Coupa user login to impersonate; sent as x-coupa-api-user-login header
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_IMPORT_BUDGET_LINESTool to import budget lines via CSV file upload. Use when uploading batch budget line data to Coupa for processing.
Input parameters
CSV file containing budget lines to import.
Filename when providing base64 content.
MIME type (e.g., 'text/csv') when using base64 content
The object type being imported. Should be 'BudgetLine' for budget line imports.
Base64-encoded file content.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_INSPECTION_CODES_INDEXTool to list inspection codes. Use when you need to retrieve id and code of inspection codes for inventory transactions.
Input parameters
Filter by active status (true or false).
JSON array of fields to return; e.g., \["id","code"\]. If not provided, Coupa returns the default shallow representation.
Pagination offset; results are returned in batches of up to 50 (offset multiples of 50).
Filter by parent lookup name (e.g., 'Inspection Code').
Response size control: 'limited' returns only IDs; 'shallow' returns attributes with one-level associations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_INTEGRATION_ERRORS_INDEXTool to list and query integration errors in Coupa. Use when you need to retrieve error IDs and details for troubleshooting or resolving failed transactions.
Input parameters
Maximum number of records to return (1-50).
JSON array of fields to return; e.g., \['id','document-id','integration-filename'\].
Number of records to skip for pagination.
Additional attribute filters using Coupa syntax. Example: {'status':'error','created-at\[gt\]':'2023-01-01T00:00:00Z'}
Response verbosity: 'limited' returns only IDs; 'shallow' returns full object attributes with one-level association IDs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_INTEGRATION_RUNS_INDEXTool to list integration runs. Use after identifying an integration to retrieve run IDs and statuses.
Input parameters
JSON array of fields to return; e.g., \["id","status","start_time"\]
Pagination offset; Coupa returns up to 50 runs per request, use offset to page.
Attribute filters using Coupa query syntax. Example: {'status\[in\]':'running,paused', 'created-at\[gt_or_eq\]':'2023-01-01T00:00:00Z'}
Response verbosity: 'limited' returns only IDs; 'shallow' returns full object attributes with one-level associations
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_INTEGRATIONS_CREATETool 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.
Input parameters
Unique Integration Code - must be unique across all integrations.
Integration Name - human-readable name for the integration.
Standard indicator flag. Set to true for standard integrations, false for custom integrations.
Direction of data flow. Use 'to_coupa' for importing data into Coupa, 'from_coupa' for exporting data from Coupa.
End System name - the external system being integrated.
Business Object identifier for the integration (e.g., User, Supplier, Invoice).
Classification of the end system type.
Method type for the integration.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_INTEGRATIONS_INDEXTool to list integrations from Coupa. Use when you need to retrieve integration definitions and IDs for filtering integration runs.
Input parameters
Exact-match filter by Coupa integration ID
Exact-match filter by integration code; supports Coupa query operators
Exact-match filter by integration name; supports Coupa query operators
JSON array of fields to return; e.g., \["id","code","name"\]
Pagination offset; results are returned in pages up to 50 records
Filter by standard flag: true for standard integrations, false otherwise
Filter by direction: to_coupa or from_coupa
Filter by creation timestamp; supports Coupa query operators
Filter by end system
Filter by update timestamp; supports Coupa query operators
Response verbosity: 'limited' returns only IDs; 'shallow' returns top-level attributes and one-level association IDs
Filter by business object
Filter by end system type: internal, payroll, erp, hr, third_party_partner, third_party_vendor, other
Filter by integration type: flat_file, api, corporate_credit_card_file, json, xml
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_INTEGRATIONS_SHOWTool to retrieve a specific integration by ID. Use when you need detailed information about a single integration.
Input parameters
Coupa's unique identifier for the integration
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_INVENTORY_CONSUMPTIONS_DESTROYTool to delete an inventory consumption record. Use when you need to permanently remove an inventory consumption by ID.
Input parameters
Inventory consumption ID to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_INVENTORY_TRANSFERS_DESTROYTool to delete an inventory transfer. Use when you need to permanently remove an inventory transfer by ID.
Input parameters
Inventory transfer ID to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_INVITE_SUPPLIERS_TO_THE_CSP_PORTALTool to invite suppliers to the Coupa Supplier Portal (CSP). Use when you need to send portal invitation emails to one or more suppliers. The invitation is processed asynchronously as a background job.
Input parameters
Array of supplier objects to invite. Each supplier object must contain an 'id' field with the supplier ID.
Custom message text to include in the invitation email sent to suppliers. If not provided, a default invitation message will be used.
Specifies whether the invited supplier can manage their contact information in the portal. Defaults to false if not provided.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_INVOICES_ATTACHMENTS_CREATETool to create an attachment on an invoice. Use when attaching files, text, or URLs to invoices.
Input parameters
URL for URL attachments. Required when type='url'
File to upload. Required when type='file'
Text content for text attachments. Required when type='text'
Type of the attachment. 'file', 'text', or 'url'
Intent of the attachment (max 40 characters)
ID of the invoice to attach the resource
Login of the user to impersonate; sent as 'x-coupa-api-user-login' header
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_INVOICES_DESTROYTool 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.
Input parameters
Coupa invoice ID to delete
Optional response control; e.g., 'limited' to return only IDs
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_INVOICES_LISTTool to list invoices with optional pagination and filters. Use when you need to obtain invoice IDs or details for testing void invoice extensively.
Input parameters
JSON array of fields to return; e.g., \['id','invoice-number',{'invoice-lines':\['id','line-num'\]}\].
Pagination offset for invoice list in multiples of 50 (default 0).
Attribute filters using Coupa syntax. Example: {'status\[in\]':'approved,voided', 'supplier\[name\]':'CDW'}.
Response verbosity control: 'limited' returns only IDs; 'shallow' returns one-level associations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_INVOICES_REMOVE_APPROVALTool 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.
Input parameters
Coupa unique identifier of the invoice.
Approval record ID to remove. This is the ID of the manually added approval to be removed.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_INVOICES_RETRIEVE_LEGAL_INVOICE_PDFTool to download the legal invoice PDF. Use when you need the official Coupa legal invoice document after invoice approval.
Input parameters
Coupa unique identifier of the invoice to retrieve the legal PDF for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_INVOICES_REVALIDATE_TOLERANCESTool to revalidate tolerances on an invoice. Use when tolerance checks need rerunning after invoice submission issues.
Input parameters
ID of the invoice to revalidate tolerances for
Optional response size control: none \\ | limited \\ | shallow
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_INVOICES_SHOWTool to retrieve a single invoice by ID. Use when you need detailed invoice information including line items, charges, attachments, and approval details.
Input parameters
ID of the invoice to retrieve
JSON array of fields to return; e.g., \['id','invoice-number',{'currency':\['code'\]}\].
Response verbosity: 'limited' or 'shallow'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_INVOICES_SUBMITTool to submit a draft invoice for approval. Use when you need to kick off the approval workflow on a draft invoice.
Input parameters
Coupa unique identifier of the invoice to submit.
Optional response size control: none \\ | limited \\ | shallow.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_INVOICES_UPDATETool to update an invoice via PUT /api/invoices/:id.
Input parameters
Coupa unique identifier of the invoice to update.
Tags applied to invoice
JSON array of fields to return; e.g., \['id','invoice-number',{'invoice-lines':\['id','line-num'\]}\]
Invoice status (updates may be restricted depending on workflow/state).
Additional invoice attributes to update directly; keys should use Coupa API hyphenated names. Example: {'comments': null, 'invoice-number': 'INV-1002'}
Freeform comments
Currency object, e.g., {'code': 'USD'}
Supplier reference, e.g., {'id': 2} or {'name': 'Super Printers'}
Taggings metadata
Tax line items for the invoice.
Invoice date (YYYY-MM-DD)
User email or login to perform the action on behalf of. Sent as 'X-COUPA-ON-BEHALF-OF' header.
The payment term for the invoice.
Coupa business role to use when acting on behalf of a user. Sent as 'X-COUPA-BUSINESS-ROLE'.
An internal note for the invoice.
Array of invoice line objects to update/add. For updates, include line 'id'. Example: \[{'id': 123, 'description': 'New desc', 'price': '15.00'}\]
Controls response verbosity: 'full', 'limited', 'shallow', or 'none'.
The invoice number.
The bill-to address for the invoice.
The ship-to address for delivery.
The lock version key for optimistic concurrency control.
The remit-to address for payment.
Whether taxation is applied at the line level.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ISSUE_PURCHASE_ORDER_WITHOUT_SENDTool 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.
Input parameters
Coupa internal ID of the purchase order to issue without sending
JSON array of specific fields/associations to include in the response. Example: \['id', 'status', 'po-number'\]
Controls response verbosity: 'none' returns no body; 'limited' returns only IDs; 'shallow' returns object attributes with one-level associations
Optional Coupa user login to impersonate; sent as x-coupa-api-user-login header
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ITEMS_CREATETool to create a catalog item. Use when provisioning items with minimal details in Coupa.
Input parameters
Unit of measure reference - provide code.
Item name
Price of the item (optional)
Item description
Unique item number (unique if provided)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ITEMS_INDEXTool to list catalog items. Use when you need item IDs and item numbers for inventory adjustment.
Input parameters
Pagination offset; results are returned in batches of up to 50 (offset multiples of 50).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ITEMS_UPDATETool 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.
Input parameters
Coupa unique identifier of the item to update
Unit of measure reference - provide code.
Item designation/name
Status indicator; deletion occurs if set to inactive
Pack quantity
Reference to a Commodity resource. Provide id, name, or both.
Item image URL
Item classification type
Net weight value
Item description
Unique item identifier/number
Pack weight value
Reorder point value
Controls response format: 'none' (no response), 'limited' (IDs only), 'shallow' (attributes + one-level IDs)
Whether to use pack weight
Storage quantity
Manufacturer name (max 255 characters)
Require asset tag flag
External item image URL
Require inspection flag
Consumption quantity
Receive catch weight flag
Allow partial quantities flag
Manufacturer part number (max 255 characters)
Lot expiration type
Enable inventory lot tracking
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_LEGAL_DOCUMENTS_SHOWTool to retrieve a specific legal document by ID. Use when you need detailed information about a legal document associated with a contract.
Input parameters
ID of the legal document to retrieve
ID of the contract that the legal document is associated with
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_LEGAL_ENTITIES_SHOWTool to retrieve a single legal entity by ID. Use when you need detailed information about a specific legal entity.
Input parameters
ID of the legal entity to retrieve
JSON-formatted array specifying fields to return; e.g., '\["id","name","active",{"currency":\["id","code"\]}\]'.
Response verbosity: 'limited' (returns only object IDs) or 'shallow' (returns all attributes and IDs of one-deep associations).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_LIST_ACCOUNT_VALIDATION_RULESTool to retrieve account validation rules from Coupa. Use when you need to list validation rules with optional filters like active status or creator.
Input parameters
Filter by exact account validation rule ID
Maximum number of records to return (1-50)
Filter by active status to retrieve only active or inactive validation rules
JSON array of fields to return; e.g., \["id","name","active"\]
Number of records to skip for pagination
Filter by ID of the user who created the validation rule
Response verbosity: 'limited' returns only IDs; 'shallow' returns top-level fields with one-level associations
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_LIST_COMMENTSTool to query and list comments in Coupa. Use when you need to retrieve comments across the system or apply filters to find specific comments.
Input parameters
Maximum number of records to return. Default is 50.
JSON array string of specific fields to include in the response.
Number of records to skip for pagination. Default is 0.
Field name to sort results by (alphabetical/numeric order).
Level of detail in the response: 'shallow', 'limited', or 'none'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_LIST_COMMODITIESTool to list commodities from Coupa. Use when you need to query or retrieve multiple commodities.
Input parameters
Maximum number of records to return (1-50).
Pagination offset; results are returned in batches of up to 50.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_LIST_CONTRACT_TERMSTool to query contract terms for a specific contract. Use when you need to retrieve pricing tiers or discount structures for a contract.
Input parameters
The ID of the contract to retrieve terms for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_LIST_OBJ_COMMENTSTool to query comments for a specific transactional object. Use when you need to retrieve comments, notes, or discussion history on requisitions, invoices, purchase orders, expense reports, or users.
Input parameters
The unique identifier of the specific object to retrieve comments for.
The type of transactional object to query comments for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_LIST_QUERY_SUPPLIERSTool to list suppliers with filters. Use when you need suppliers matching certain criteria.
Input parameters
Exact Coupa internal supplier ID; exact match (e.g., id=6).
Filter by supplier name (exact). For other operators, use name_contains, name_starts_with, or name_ends_with.
Pagination offset; results returned in pages of 50 by default.
Filter by supplier status (e.g., active).
Filter by PO transmission method; one of cxml, xml, email, prompt, mark_as_sent, buy_online.
Return suppliers created after this timestamp (YYYY-MM-DDTHH:MM:SS).
Filter by supplier name containing this substring.
Filter by supplier name ending with this substring.
Filter by supplier name starting with this substring.
Filter suppliers with more than this number of reviews.
Filter by Payment Term code (e.g., Net+30).
Filter suppliers allowed for cXML invoicing (true/false).
Filter by cXML buyer domain containing this value.
Filter by city of the supplier’s primary address.
Filter by cXML supplier domain containing this value.
Filter by primary contact email containing this value.
Filter by discount payment days (integer).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_LIST_RECEIVING_TRANSACTIONSTool to query receiving transactions in Coupa. Use when you need to fetch receipt records with optional filters for status, dates, type, or export status.
Input parameters
Exact-match filter by transaction ID.
Filter by transaction type (e.g., ReceivingTransaction, InventoryReceiptReceiving). Supports operators: \[contains\], \[starts_with\], \[in\], \[not_in\].
Maximum number of records to return per call. Default: 50 (API enforced maximum).
JSON array of fields to return in response; e.g., \["id","type","status",{"item":\["id","name"\]}\].
Pagination offset; results are returned in pages of up to 50 records.
Filter by transaction status. Supports operators: \[in\], \[not_in\], \[contains\], \[not_eq\].
Additional attribute filters using Coupa syntax. Example: {'quantity\[gt\]':'10', 'item\[name\]\[contains\]':'Widget'}. Supports operators like \[contains\], \[starts_with\], \[gt\], \[lt\], \[in\], \[blank\], etc.
Filter by export status: true for exported transactions, false for not exported.
Filter transactions created after this timestamp (ISO 8601 format).
Filter transactions created before this timestamp (ISO 8601 format).
Response verbosity control: 'limited' returns only IDs; 'shallow' returns full object attributes with one-level association IDs.
Filter transactions updated after this timestamp (ISO 8601 format).
Filter transactions updated before this timestamp (ISO 8601 format).
Filter transactions created on or after this timestamp (ISO 8601 format).
Filter transactions created on or before this timestamp (ISO 8601 format).
Filter transactions with transaction date after this timestamp (ISO 8601 format).
Filter transactions with transaction date before this timestamp (ISO 8601 format).
Filter transactions updated on or after this timestamp (ISO 8601 format).
Filter transactions updated on or before this timestamp (ISO 8601 format).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_LIST_WORK_CONFIRMATION_HEADERSTool to retrieve work confirmation headers from Coupa. Use when you need to query work confirmation header records.
Input parameters
Maximum number of records to return (1-50)
JSON array of fields to return; e.g., \["id","status","created-at"\]
Pagination offset; results are returned in pages up to 50
Response verbosity: 'limited' returns only IDs; 'shallow' returns full object attributes with one-level association IDs
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_LOGOUT_IFRAME_SESSIONTool to log out CSP (Coupa Supplier Portal) iframe session. Use when you need to terminate an active supplier portal iframe session.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_MARK_A_CHARGE_AS_EXPORTEDTool 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).
Input parameters
The unique Coupa ID of the charge to mark as exported.
Set to true to mark the charge as exported. Defaults to true.
Controls response format. Options: 'none' (no response body), 'limited' (only IDs returned), 'shallow' (all attributes with IDs of associations).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_MARK_A_PAYABLEINVOICE_AS_TRACKING_EXTERNALLYTool 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.
Input parameters
Coupa unique identifier of the payable invoice to mark as tracking externally.
Optional response size control: 'none' (no data returned), 'limited' (only IDs returned), 'shallow' (all attributes plus IDs of one-deep associations).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_MARK_A_STATEMENT_AS_EXPORTEDTool to mark a Coupa Pay statement as exported. Use when you need to flag that a statement has been exported to an external system.
Input parameters
Coupa internal ID of the statement to mark as exported
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_MARK_COUPA_PAY_PAYMENT_AS_EXPORTEDTool 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.
Input parameters
Unique Coupa payment identifier to mark as exported.
JSON array of specific fields to return in response. Example: \["id","status","exported","last-exported-at"\]
Set to true to mark the payment as exported. This prevents duplicate retrieval in subsequent queries.
Controls response verbosity: 'none' (empty response), 'limited' (only IDs), or 'shallow' (complete payment object with associations).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_MARK_PAYABLE_INVOICE_AS_TRACKING_IN_COUPATool 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.
Input parameters
Coupa unique identifier of the payable invoice to mark as tracking in Coupa.
Optional response size control: 'none' (no data returned), 'limited' (only IDs returned), 'shallow' (all attributes plus IDs of one-deep associations).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_MARK_PAYABLEINVOICE_PAID_EXTERNALLYTool 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'.
Input parameters
Coupa unique identifier of the payable invoice to mark as paid externally
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_MARK_PAY_INVOICE_AS_EXPORTEDTool 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.
Input parameters
Unique Coupa Pay invoice identifier to mark as exported.
Set to true to mark the invoice as exported. This prevents duplicate retrieval in subsequent queries.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_MARK_PO_CONFIRMATION_AS_INTEGRATION_COMPLETETool 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.
Input parameters
Coupa's internal ID for the order header confirmation to mark as integration_complete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_MARK_PO_CONFIRMATION_AS_INTEGRATION_FAILEDTool 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.
Input parameters
Coupa's internal ID for the order header confirmation to mark as integration_failed
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_MATCHING_ALLOCATIONS_SHOWTool 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.
Input parameters
Coupa unique identifier for the matching allocation to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_NOTIFY_CONTRACT_SIGNATURE_CREATEDTool 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.
Input parameters
Coupa internal ID of the contract to notify signature creation
JSON array of specific fields/associations to include in the response. Example: \['id','status'\]
Impersonate as the given user id via X-COUPA-API-USER-ID header.
Perform the action on behalf of this user (email or login); sent as X-COUPA-ON-BEHALF-OF header.
Coupa business role to use when acting on behalf of a user; sent as X-COUPA-BUSINESS-ROLE header.
Controls response verbosity: 'none', 'limited', or 'shallow'
Impersonate as the given user email via X-COUPA-API-EMAIL header.
Impersonate as the given user login via X-COUPA-API-USER-LOGIN header.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_OBJECT_TRANSLATION_CREATETool 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.
Input parameters
Model attribute to be translated (typically 'name' for UOM translations). Specifies which attribute of the object should be translated.
Translated text value for the specified attribute in the specified locale.
Locale code for the translation (e.g., 'en', 'de', 'ja', 'fr', 'es', 'pt-BR', 'zh-CN'). Supported locale codes include over 70 standard language codes.
Coupa unique identifier of the UOM object to add a translation for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_OBJECT_TRANSLATION_DESTROYTool to delete a UOM translation. Use when you need to permanently remove a specific translation for a Unit of Measure by ID.
Input parameters
Translation record identifier to be deleted.
Unit of Measure identifier for which the translation belongs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_OBJECT_TRANSLATION_INDEXTool 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.
Input parameters
JSON array of fields to return; e.g., \["id","locale","key","value"\].
Pagination offset; results are returned in pages of up to 50.
Unique identifier for the Unit of Measure whose translations you want to retrieve.
Response size control: 'limited' returns only IDs; 'shallow' returns attributes with one-level associations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_OBJECT_TRANSLATION_SHOWTool 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.
Input parameters
The unique identifier of the translation record
The unique identifier of the parent UOM (Unit of Measure)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ORDER_CONFIRMATIONS_DESTROYTool to delete an order confirmation. Use when you need to permanently remove an order confirmation by ID.
Input parameters
Order confirmation ID to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ORDER_LIST_CREATETool 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.
Input parameters
Order pad identifier/name
Lock status indicator - when true, the order pad cannot be modified
List of associated supplier references (provide supplier ID or SupplierReference objects)
Base monetary value for the order pad
Flag for supplier selection - set to false to restrict to specific suppliers
Indicator for adding all items from supplier catalogs (optional)
Whether base value applies
List of associated business groups (optional)
Line item collection for the order pad (optional)
Section groupings for organizing order pad lines (optional)
Currency reference for base value (provide currency code as string or CurrencyReference object)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ORDER_LIST_DESTROYTool to delete an order list (order pad). Use when you need to permanently remove an order list by ID.
Input parameters
Order list ID to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ORDER_LIST_SHOWTool 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.
Input parameters
ID of the order list to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ORDER_LIST_UPDATETool 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.
Input parameters
Coupa unique identifier of the order list (order pad) to update.
Name of the order list.
Whether the order list is locked.
Additional order list attributes to update directly; keys should use Coupa API hyphenated names.
Base value for the order list.
Whether the order list can be used with any supplier.
Whether to use base value for the order list.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_ORDER_PADS_INDEXTool 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.
Input parameters
JSON array of fields to return; e.g., \["id","name"\]
Pagination offset; results are returned in batches of up to 50 (offset multiples of 50).
Response verbosity: 'limited' returns only IDs; 'shallow' returns full object attributes with one-level association IDs
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_PATCH_BUSINESS_ENTITYTool 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.
Input parameters
Coupa unique identifier of the business entity to update.
Business entity name.
Entity type: 'LegalBusinessEntity' or 'OrganizationalBusinessEntity'.
JSON array of fields to return; e.g., \['id','name','display-name'\].
Entity status (e.g., 'active', 'inactive').
Additional business entity attributes to update directly; keys should use Coupa API hyphenated names.
Array of address objects associated with the business entity.
Display name for the entity.
User email or login to perform the action on behalf of. Sent as 'X-COUPA-ON-BEHALF-OF' header.
Coupa business role to use when acting on behalf of a user. Sent as 'X-COUPA-BUSINESS-ROLE'.
Controls response verbosity: 'none', 'limited', 'shallow', or 'full'.
Formation type: 'Organization' or 'Person'.
Primary address information. Reference by ID: {'id': 123}.
Primary contact details. Reference by ID: {'id': 456}.
Country of origin. Reference by code: {'code': 'US'}.
Array of relationship objects linking this entity to others.
Array of account owner objects for the business entity.
Array of alternate names for the business entity.
Array of external reference objects for the business entity.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_PATCH_PURCHASE_ORDERTool 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.
Input parameters
Coupa internal identifier of the purchase order to update.
JSON array of fields to return; e.g., \['id','po-number','status'\].
Additional purchase order attributes to update directly; keys should use Coupa API hyphenated names.
Transaction currency reference.
Export flag. Note: cannot update other fields simultaneously by default.
Supplier reference by Coupa internal ID.
Purchase order number (max 20 characters).
Price visibility control.
Array of order line objects to update/add.
User email or login to perform the action on behalf of. Sent as 'X-COUPA-ON-BEHALF-OF' header.
Payment terms reference.
Coupa business role to use when acting on behalf of a user. Sent as 'X-COUPA-BUSINESS-ROLE'.
Controls response verbosity: 'none', 'limited', or 'shallow'.
Shipping terms reference.
Supplier site reference.
Order classification (max 255 characters).
Confirmation deadline in hours.
Delivery address details.
Reason code for changes or reopening.
Recipient name for shipment (max 255 characters).
Comma-separated recipient emails for transmission.
Comment for reason insight.
Transmission method override (max 30 characters).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_PAYMENT_TERMS_INDEXTool to list payment terms with filters.
Input parameters
Filter by payment term code
Filter by payment term type
Maximum number of records to return (1-50).
Filter by active (true/false)
JSON array of fields to return; e.g., \['id','code','active'\] or nested associations.
Number of records to skip for pagination.
Filter by net due day (1-31)
Filter where code contains the provided value
Filter records created after this ISO timestamp
Filter records created before this ISO timestamp
Filter by discount rate (as decimal)
Filter by net due month (0-6)
Response verbosity: 'limited' or 'shallow'.
Filter records updated after this ISO timestamp
Filter records updated before this ISO timestamp
Filter where code ends with the provided value
Filter by net cutoff day (1-31)
Filter where code starts with the provided value
Filter by discount due day (1-31)
Filter by discount due month (0-6)
Filter by discount cutoff day (1-31)
Filter by days for net payment
Filter by days for discount payment
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_PAYMENT_TERMS_SHOWTool to retrieve a single payment term by ID. Use when you need detailed payment term information.
Input parameters
ID of the payment term to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_PROJECTS_INDEXTool to list/query all projects from Coupa. Use when you need to retrieve project information with optional filtering and pagination.
Input parameters
Exact-match filter by project ID
Filter by project name; supports Coupa query operators like \[contains\], \[starts_with\], \[ends_with\]
Maximum number of records to return per request (1-50, default 50)
Filter by active status: true for active projects, false for inactive
JSON array of fields to return; e.g., \["id","name","status",{"commodity":\["id","name"\]}\]
Pagination offset; results are returned in pages up to 50
Filter by project status; e.g., 'in_progress', 'completed', 'active', 'pending'. Supports operators like \[in\], \[not_in\], \[not_eq\]
Additional attribute filters using Coupa syntax. Example: {'completion-percentage\[gt\]':'50', 'start-date\[gt_or_eq\]':'2024-01-01'}. Supports operators: \[contains\], \[starts_with\], \[ends_with\], \[gt\], \[lt\], \[gt_or_eq\], \[lt_or_eq\], \[not_eq\], \[in\], \[not_in\], \[blank\]
Response verbosity: 'limited' returns only IDs; 'shallow' returns full object attributes with one-level association IDs
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_PROJECTS_SHOWTool to retrieve a single project by ID. Use when you need detailed project information after knowing the project ID.
Input parameters
ID of the project to retrieve
JSON array of fields to return; e.g., \["id","name","status",{"commodity":\["id","name"\]}\]
Response verbosity: 'limited' returns only IDs; 'shallow' returns full object attributes with one-level association IDs
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_PROJECTS_UPDATETool to update an existing Coupa project. Use when you need to modify project attributes after confirming project ID.
Input parameters
Coupa unique identifier of the project to update.
Project identifier; must be unique.
Project is open for everyone to join or owner must invite others.
Team member assignments.
Active status of the project.
JSON array of fields to return; e.g., \['id','name',{'users':\['id','login'\]}\].
Project status indicator.
Additional project properties to update; use Coupa API hyphenated names as keys.
The category associated with the project.
Project completion date (format: YYYY-MM-DDTHH:MM:SS+HH:MMZ).
Tags associated with the project.
Associated commodity reference, e.g., {'id': 1}.
The department associated with the project.
Project commencement date (format: YYYY-MM-DDTHH:MM:SS+HH:MMZ).
Project details and description.
Unique identifier for a commodity (non-editable).
List of tabs enabled for linked objects.
Mention name for the project.
User email or login to perform the action on behalf of. Sent as 'X-COUPA-ON-BEHALF-OF' header.
Coupa business role when acting on behalf of a user. Sent as 'X-COUPA-BUSINESS-ROLE'.
Budgeting framework/category plan.
Controls response verbosity: 'none', 'limited', or 'shallow'.
Linked organizational units/content groups.
Project template reference.
Copy project identifier.
Progress indicator (0-100).
Third-party system identifier for syncing external project IDs.
Additional planned savings amount.
Controls member tab visibility.
Provide warning if task dates fall outside project dates.
Additional realized savings amount.
Show sourcing rollup field if flag enabled.
Show contracts rollup field if flag enabled.
Show suppliers rollup field if flag enabled.
Additional negotiated savings amount.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_PURCHASE_ORDERS_INDEXTool to list purchase order headers. Use when you need to fetch filtered and paginated purchase order records from Coupa.
Input parameters
Exact match for PO ID.
JSON array of fields to return; e.g., \['id','po-number',{ 'order-lines': \['id','line-num'\] }\].
Name of an API Response Filter to control returned fields.
Pagination offset; results are returned in batches of up to 50 (offset multiples of 50).
Filter by PO status; operators supported, e.g., status\[not_eq\]=closed.
Filter by export status; e.g., exported=false to fetch unexported POs.
Multi-status filter; e.g., status\[in\]=issued,canceled,closed.
Filter POs created after this timestamp (ISO 8601).
Filter POs created before this timestamp (ISO 8601).
Response size control: 'limited' returns only IDs; 'shallow' returns full object attributes with one-level association IDs.
Filter POs by associated supplier name.
Filter POs updated after this timestamp (ISO 8601).
Filter POs updated before this timestamp (ISO 8601).
Include deleted PO lines when querying (useful for ERP syncs).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_PURCHASE_ORDERS_ISSUETool to issue and send a purchase order to the supplier. Use after preparing a PO to dispatch it.
Input parameters
Coupa internal ID of the purchase order to issue
JSON array of specific fields/associations to include in the response. Example: \['id', 'status', 'po-number'\]
Controls response verbosity: 'none' returns no body; 'limited' returns only IDs; 'shallow' returns object attributes with one-level associations
Optional Coupa user login to impersonate; sent as x-coupa-api-user-login header
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_PUT_USERSTool to update a Coupa user account. Use when you need to modify user information such as name, email, permissions, licenses, or other attributes.
Input parameters
Coupa unique identifier of the user to update.
User email address; must be unique across the instance.
User login; must be unique across the instance.
Roles to assign to the user (e.g., \[{'id': 1}\]).
User active status; true means the user is active.
JSON array of fields to return (e.g., "\['id','login',{'roles':\['id','name'\]}\]").
Manager user reference object (e.g., {'id': 5}).
Enable AI CoPilot license for this user.
Enable API access for this user.
Enable CCW license for this user.
User's last name.
Password for changing user password; case-sensitive.
User's first name.
Department reference object (e.g., {'id': 3}).
User's middle name.
Work phone number object.
Enable travel management license for this user.
User groups to assign to the user.
Enable expense management license for this user.
Legal entity assignment reference object.
Display name for user mentions.
Mobile phone number object.
Response verbosity control: 'none', 'limited', or 'shallow'.
Salesforce record identifier for integration.
Enable sourcing license for this user.
Enable treasury license for this user.
Account groups for document security.
Enable analytics license for this user.
Content (business) groups for access control.
Enable contracts management license for this user.
User's default locale code (e.g., 'en', 'fr', 'de').
Enable inventory management license for this user.
Enable invoicing license for this user.
Single Sign-on identifier for the user.
Approval groups for routing assignments.
User reference object for expense delegation recipient.
Default GL account reference object.
Default address reference object (e.g., {'id': 2}).
Unique employee identifier.
Enable purchasing license for this user.
Job grade or seniority band designation.
Default currency reference object (e.g., {'code': 'USD'}).
Enable risk assessment license for this user.
Enable spend guard license for this user.
Role classification or business function.
Enable supply chain license for this user.
Enable Salesforce integration for this user.
Warehouse access assignments.
General self-approval maximum reference object.
Country of residence reference object.
Default account type reference object.
Override triggering amount reference object.
Account security type setting.
Authentication method: 'coupa_credentials', 'ldap', or 'saml' (case-sensitive).
Enable category planner license for this user.
User reference object for delegate assignment.
Maximum expense approval amount reference object.
Invoice authorization limit reference object.
Contract authorization limit reference object.
Inventory organization assignments.
Payment channel. Default: 'ERP'; alternative: 'CoupaPay'.
Purchase requisition authority limit reference object.
Expense self-approval threshold reference object.
Invoice self-approval cap reference object.
Business group security type. Values: 0 or 1.
Contract self-approval threshold reference object.
Trigger user invitation with generated password. Values: 'Yes' or 'No'.
Requisition self-approval cap reference object.
Service confirmation authority limit reference object.
Allow user to create employee payment accounts.
Allow invoice upload via mobile device.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_QUERY_LOOKUPSTool to query and list lookups with filters. Use when you need to fetch lookup objects that define categories, hierarchies, and standardization lists in Coupa.
Input parameters
Sort direction options for lookups query.
Filter by lookup name; exact match on the lookup name.
Maximum number of records to return for pagination.
Advanced filter expression for complex query conditions.
Number of records to skip for pagination (offset).
Field name to sort results by (e.g., 'name', 'id').
Return object type options for controlling response payload size.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_REASON_INSIGHTS_INDEXTool to list Reason Insights. Use when you need to retrieve reason insights with optional filters and pagination.
Input parameters
Exact-match filter by Reason Insight ID
Exact-match filter by Reason Insight code; supports Coupa query operators
Filter by Reason Insight name; supports Coupa query operators
Filter by active status: true for active reason insights, false for inactive
List of fields to return; e.g., \['id','code'\]. Provide as a list, will be JSON-encoded in the query.
Pagination offset; results are returned in pages up to 50
Response verbosity: 'limited' returns only IDs; 'shallow' returns full object attributes with one-level associations
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_RECEIPT_REQUESTS_CREATETool to create a new receipt request. Use when you need to create a receipt request for purchase order lines.
Input parameters
Receipt request type classification.
List of receipt request line items. At least one line is required.
Initial status of the receipt request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_RECEIPT_REQUESTS_INDEXTool to list receipt requests from Coupa. Use when you need to retrieve receipt request records with optional filtering and pagination.
Input parameters
Maximum number of records to return per request (1-50).
JSON array of fields to return; e.g., \["id","status","type"\].
Number of records to skip for pagination.
Attribute filters using Coupa query operators. Examples: {'status':'pending'}, {'created_at\[gt\]':'2024-01-01T00:00:00Z'}, {'id\[in\]':'1,2,3'}, {'type\[contains\]':'standard'}.
Field(s) to order results by.
Sort direction for order_by field: 'asc' for ascending, 'desc' for descending.
Response verbosity: 'limited' returns only IDs; 'shallow' returns full attributes with one-level association IDs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_RECEIPT_REQUESTS_UPDATETool 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.
Input parameters
Coupa unique identifier of the receipt request to update.
Receipt request classification type.
Array of receipt request line items to update/add. For updates, include line 'id'. Example: \[{'id': 123, 'quantity': '10.0', 'description': 'Updated description'}\]
Current state of the receipt request (updates may be restricted depending on workflow/state).
Additional receipt request attributes to update directly; keys should use Coupa API hyphenated names. Example: {'status': 'approved', 'type': 'standard'}
User email or login to perform the action on behalf of. Sent as 'X-COUPA-ON-BEHALF-OF' header.
Coupa business role to use when acting on behalf of a user. Sent as 'X-COUPA-BUSINESS-ROLE'.
Controls response verbosity: 'none', 'limited', or 'shallow'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_RELEASE_PURCHASE_ORDER_FROM_BUYER_HOLDTool 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.
Input parameters
Coupa internal ID of the purchase order to release from buyer hold
JSON array of specific fields/associations to include in the response. Example: \['id', 'status', 'po-number'\]
Controls response verbosity: 'none' returns no body; 'limited' returns only IDs; 'shallow' returns object attributes with one-level associations
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_REMIT_TO_ADDRESSES_DESTROYTool 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.
Input parameters
ID of the remit-to address to delete.
ID of the supplier who owns the remit-to address.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_REMOVE_A_CONTENT_GROUP_ON_CONTRACTTool 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.
Input parameters
ID of the contract from which the content group will be removed
ID of the business group/content group to remove from the contract
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_REMOVE_ALL_CONTENT_GROUP_ON_CONTRACTTool 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.
Input parameters
ID of the contract from which all content groups will be removed
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_REMOVE_ALL_CONTENT_GROUP_ON_SIM_RECORDTool 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.
Input parameters
ID of the supplier information record from which all content groups will be removed
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_REMOVE_ALL_CONTENT_GROUP_ON_SIM_SITE_RECORDTool 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.
Input parameters
ID of the supplier information site record from which all content groups will be removed
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_REMOVE_ALL_CONTENT_GROUPS_ON_SUPPLIERTool 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.
Input parameters
ID of the supplier from which all content groups will be removed
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_REMOVE_CONTRACT_APPROVALTool 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.
Input parameters
Coupa unique identifier of the contract.
Impersonate as the given user id via X-COUPA-API-USER-ID header.
Approval record ID to remove. One of approver_id or approval_id may be required.
Coupa internal user ID of the approver to remove. One of approver_id or approval_id may be required.
Impersonate as the given user email via X-COUPA-API-USER-EMAIL header.
Impersonate as the given user login via X-COUPA-API-USER-LOGIN header.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_REMOVE_SPECIFIC_CONTENT_GROUP_FROM_SIM_SITETool to remove a content group (business group) from a Supplier Information Management (SIM) site. Use when you need to revoke a content group assignment from a SIM site for access control or visibility management.
Input parameters
ID of the supplier information site from which the content group will be removed
ID of the business group/content group to remove from the SIM site
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_REMOVE_SPECIFIC_CONTENT_GROUP_FROM_SUPPLIER_SITETool 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.
Input parameters
ID of the supplier site from which the content group will be removed
ID of the business group/content group to remove from the supplier site
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_REMOVE_SPECIFIC_CONTENT_GROUP_ON_SIM_RECORDTool 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.
Input parameters
ID of the supplier information record from which the content group will be removed
ID of the business group/content group to remove from the SIM record
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_REMOVE_SPECIFIC_CONTENT_GROUP_ON_SUPPLIERTool 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.
Input parameters
ID of the supplier from which the content group will be removed
ID of the business group/content group to remove from the supplier
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_REOPEN_FOR_RECEIVING_LINE_FROM_EXTERNAL_POTool to reopen a purchase order line for receiving. Use when a PO line needs to be reopened to allow additional receiving transactions.
Input parameters
Coupa internal ID of the purchase order line to reopen for receiving
ID of the reason insight explaining why the line is being reopened
Comment explaining the reason for reopening the line for receiving
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_RE_OPEN_SOFTCLOSED_POTool 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.
Input parameters
Coupa internal ID of the purchase order to reopen
The ID of the reason insight for reopening the PO. Use either this or reason-insight-code.
The code of the reason insight for reopening the PO. Use either this or reason-insight-id.
Comment describing the reason for reopening the PO
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_REQUISITION_LINES_INDEXTool 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.
Input parameters
Exact-match filter by requisition line ID
Maximum number of records to return per request (1-50, default: 50)
JSON array specifying which fields to return, e.g., \["id","description","total"\]
Number of records to skip for pagination (default: 0)
Filter by line status (e.g., approved, pending)
Filter by line number
Filter by multiple statuses (comma-separated list, e.g., approved,pending)
Exact-match filter by line description
Filter lines created after this date (ISO 8601 format with timezone, e.g., 2025-01-01T00:00:00-07:00)
Filter lines created before this date (ISO 8601 format with timezone)
Filter lines updated after this date (ISO 8601 format with timezone)
Filter lines with need-by date after this date (ISO 8601 format with timezone)
Substring filter for line description
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_REQUISITIONS_ADD_TO_CARTTool to add items from a requisition to the shopping cart. Use after constructing the add_to_cart payload.
Input parameters
List of requisition line items to add to cart. At least one line is required.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_REQUISITIONS_ATTACHMENTS_CREATETool to create an attachment on a requisition. Use when attaching files, text, or URLs to requisitions.
Input parameters
URL for URL attachments. Required when type='url'
File to upload. Required when type='file'
Text content for text attachments. Required when type='text'
Type of the attachment. 'file', 'text', or 'url'
Intent of the attachment (max 40 characters). For example, 'Supplier'
ID of the requisition to attach the resource
Login of the user to impersonate; sent as 'x-coupa-api-user-login' header
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_REQUISITIONS_CREATETool to create a new requisition. Endpoint: POST /api/requisitions
Input parameters
Buyer note/comment
List of attachments (text or URL)
User who requested the requisition. Provide id, login, or email.
Justification for the requisition
Address reference - provide id.
List of requisition line items. At least one line is required.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_REQUISITIONS_CURRENT_CARTTool to get the current user's requisition cart. Use when you need to fetch or initialize the current cart for the authenticated user.
Input parameters
JSON array of fields to return; e.g., \['id',{'requisition-lines':\['id','line-num'\]}\].
Controls response verbosity: 'limited' returns IDs only, 'shallow' includes one-deep associations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_REQUISITIONS_DESTROYTool to delete a requisition. Use when you need to permanently remove a requisition by ID.
Input parameters
Coupa requisition ID to delete.
Optional response control; e.g., 'limited' to return only IDs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_REQUISITIONS_INDEXTool to list requisitions with filters.
Input parameters
Maximum number of records to return (1-50).
JSON array of fields to return; e.g., \['id',{"requisition-lines":\["id","line-num"\]}\]
Number of records to skip for pagination.
Filter by requisition status (draft, cart, pending_buyer_action, pending_approval, approved, ordered, partially_received, received, abandoned, backgrounded, withdrawn).
Response verbosity: 'limited' or 'shallow'.
Filter by requester login
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_REQUISITIONS_MINETool to list the authenticated user's requisitions. Use when you need to retrieve paginated user requisitions with optional filters.
Input parameters
Maximum number of records to return (1-50). Coupa enforces a maximum of 50.
JSON array of fields to return; e.g., \['id',{'requisition-lines':\['id','line-num'\]}\].
Number of records to skip for pagination. Must be non-negative.
Filter by requisition status.
Filter requisitions by creation timestamp (ISO 8601).
Controls response verbosity: 'limited' returns IDs only, 'shallow' includes one-deep associations.
Filter requisitions by requester login name.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_REQUISITIONS_REMOVE_APPROVALTool 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
Input parameters
Coupa internal ID of the requisition.
Impersonate as the given user id via X-COUPA-API-USER-ID header.
Approval record ID to remove. This is the recommended parameter for removing an approver.
Coupa internal user ID of the approver to remove. May be used in combination with approval_id.
Impersonate as the given user email via X-COUPA-API-USER-EMAIL header.
Impersonate as the given user login via X-COUPA-API-USER-LOGIN header.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_REQUISITIONS_SAVE_FOR_LATERTool to save a requisition for later. Use when you need to stash a draft requisition without submitting it.
Input parameters
ID of the requisition to save for later
JSON array of fields to return, e.g. \["id","status"\]. Supports nested selection.
Controls response body. none returns no content, limited returns only IDs, shallow returns top-level attributes plus IDs of one-deep associations. If omitted, full object is returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_REQUISITIONS_SHOWTool to retrieve a single requisition by its ID. Use when you need detailed requisition data.
Input parameters
Coupa unique identifier of the requisition to retrieve.
JSON array of fields to return; e.g., \['id','status',{'requisition_lines':\['id','line_num'\]}\]
Response verbosity: 'limited' or 'shallow'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_REQUISITIONS_SUBMIT_FOR_APPROVALTool to submit a requisition for approval. Use when you need to create a requisition and immediately submit it for approval.
Input parameters
Buyer note/comment
List of attachments (text or URL)
User who requested the requisition. Provide id, login, or email.
Justification for the requisition
Address reference - provide id.
List of requisition line items. At least one line is required.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_REQUISITIONS_UPDATE_AND_SUBMIT_FOR_APPROVALTool to update a requisition and submit it for approval. Endpoint: PUT /api/requisitions/:id/update_and_submit_for_approval
Input parameters
Coupa requisition ID to update and submit.
Writable requisition header fields per Coupa API.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_RESTART_INVOICE_APPROVALTool 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.
Input parameters
Coupa unique identifier of the invoice to restart approvals for.
Optional response size control: 'none' (no response body), 'limited' (only IDs), 'shallow' (all attributes with one-deep association IDs).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_RETRIEVE_ALL_SIM_RECORDSTool 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.
Input parameters
Filter by supplier name (exact match).
Maximum number of records to return per call (1-50). Default: 50 records.
JSON array of specific fields to return in response. Example: \["id","name","status"\]
Starting position for retrieving records in subsequent calls (default 0). Example: offset=50 retrieves records 51-100.
Filter by supplier status (e.g., 'active'). Supports operators: \[eq\], \[contains\], \[starts_with\], \[ends_with\], \[not_eq\], \[in\], \[not_in\].
Filter by export status. Set to false to retrieve only records that have not been exported before.
Specifies the field to order results by (e.g., 'id', 'name', 'created-at').
Filter by associated supplier ID (exact match).
Filter by creation date greater than this timestamp. ISO 8601 format (YYYY-MM-DDTHH:MM:SS).
Filter by creation date less than this timestamp. ISO 8601 format (YYYY-MM-DDTHH:MM:SS).
Filter by supplier name containing this substring.
Filter by update date greater than this timestamp. ISO 8601 format (YYYY-MM-DDTHH:MM:SS).
Filter by update date less than this timestamp. ISO 8601 format (YYYY-MM-DDTHH:MM:SS).
Filter by supplier name ending with this substring.
Filter by supplier ID equal to this value.
Filter by supplier ID greater than this value.
Filter by supplier ID less than this value.
Filter by supplier status containing this substring.
Filter by supplier name starting with this substring.
Filter by creation date greater than or equal to this timestamp. ISO 8601 format.
Filter by creation date less than or equal to this timestamp. ISO 8601 format.
Filter by update date greater than or equal to this timestamp. ISO 8601 format.
Filter by update date less than or equal to this timestamp. ISO 8601 format.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_RETRIEVE_CONTRACT_LEGAL_AGREEMENTTool to download the legal agreement file for a contract. Use after confirming the contract ID.
Input parameters
ID of the contract to retrieve the legal agreement
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_RETRIEVE_INVOICE_CLEARANCE_DOCUMENTTool to download the ZATCA compliance clearance document for an invoice. Use when you need the clearance document attached to a specific invoice.
Input parameters
Coupa unique identifier of the invoice to retrieve the clearance document for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_RETRIEVE_INVOICES_IMAGE_SCANTool to download the invoice image scan attachment. Use when you need to retrieve the scanned PDF or image file of the original invoice document.
Input parameters
Coupa unique identifier of the invoice to retrieve the image scan for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_RETRIEVE_SIM_RECORD_BY_IDTool 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.
Input parameters
The SIM record identifier - unique identifier for the supplier information record to retrieve
JSON array of specific fields to return; e.g., \['id','name','status'\].
Response verbosity: 'limited' for IDs-only or 'shallow' for shallow associations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_RETURN_TO_SUPPLIER_TRANSACTIONS_DESTROYTool to delete a return to supplier transaction. Use when you need to permanently remove a return to supplier transaction by ID.
Input parameters
Coupa return to supplier transaction ID to delete.
Optional response control; e.g., 'limited' to return only IDs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_S3_FILE_UPLOAD_OR_GETCoupa S3 File Upload or Get
Input parameters
URL when type='url'
File to upload (type='file').
Text content when type='text'
Attachment type for upload: 'file', 'text', or 'url'
Attachment intent/category (optional, max ~40 chars)
Filename when providing base64 content.
MIME type (e.g., 'text/plain', 'application/pdf') when using base64 content
'upload' to create attachment; 'get' to verify attachment exists
Base64-encoded file content.
Coupa resource id for attachment operations
Attachment id to verify (returned as a file reference key if found)
Coupa resource type (e.g., 'invoices', 'purchase_orders', 'expense_reports')
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_SCHEDULE_REQUISITION_ISSUANCETool 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.
Input parameters
List of requisition line IDs to schedule for issuance. Example: \[54214, 54220, 54224\]
Target issuance date in MM/DD/YYYY format. This is the date when the requisition lines should be issued.
Number of days before retrying issuance if requisition remains unapproved. This allows automatic retry logic for unapproved requisitions.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_SHIPPING_TERMS_CREATETool 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.
Input parameters
Unique shipping term code identifier (max 255 characters)
Whether the shipping term is active and available to users
Description of the shipping term
List of content groups (business groups) to associate with this shipping term
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_SHIPPING_TERMS_SHOWTool to retrieve a specific shipping term by ID. Use when you need detailed information about shipping terms and conditions.
Input parameters
ID of the shipping term to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_SHIPPING_TERMS_UPDATETool to update an existing shipping term. Use when you need to modify shipping term attributes after verifying it exists.
Input parameters
Coupa unique identifier of the shipping term to update
Unique shipping term code identifier (max 255 characters)
Whether the shipping term is active and available to users
Description of the shipping term
List of content groups (business groups) to associate with this shipping term
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_SOFT_CLOSE_FOR_INVOICING_LINE_FROM_EXTERNAL_POTool 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.
Input parameters
Coupa internal ID of the purchase order line to soft close for invoicing
ID of the reason insight explaining why the line is being soft closed
Code identifying the reason for soft closing
Comment explaining the reason for soft closing the line for invoicing
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_SOFT_CLOSE_FOR_RECEIVING_LINE_FROM_EXTERNAL_POTool 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.
Input parameters
Coupa internal ID of the purchase order line to soft close for receiving
ID of the reason insight explaining why the line is being soft closed
Code identifying the reason for soft closing
Comment explaining the reason for soft closing the line for receiving
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_SUBMIT_CONTRACT_FOR_APPROVALTool to submit a contract for approval. Use when you need to start the approval process for a contract.
Input parameters
Coupa internal ID of the contract to submit for approval
JSON array of specific fields/associations to include in the response. Example: \['id','status'\]
Impersonate as the given user id via X-COUPA-API-USER-ID header.
Perform the action on behalf of this user (email or login); sent as X-COUPA-ON-BEHALF-OF header.
Coupa business role to use when acting on behalf of a user; sent as X-COUPA-BUSINESS-ROLE header.
Controls response verbosity: 'none', 'limited', or 'shallow'
Impersonate as the given user email via X-COUPA-API-USER-EMAIL header.
Impersonate as the given user login via X-COUPA-API-USER-LOGIN header.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_SUPPLIER_INFORMATION_SITES_DESTROYTool to delete a supplier information site. Use when you need to permanently remove a supplier information site by ID. Requires SIM API permissions.
Input parameters
The Coupa internal identifier for the supplier information site to be deleted.
Optional response control; supports 'none' (empty response), 'limited' (IDs only), or 'shallow' (object with attributes).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_SUPPLIER_INFORMATION_SITES_INDEXTool 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.
Input parameters
Exact-match filter by Coupa internal unique identifier for the supplier information site
Filter by supplier code (unique identifier, max 20 chars); supports Coupa query operators like contains, starts_with, ends_with.
Filter by supplier information name (max 255 chars); supports Coupa query operators.
Number of records to return per request. Default: 50, Maximum: 50
Filter by site active status: true for active sites, false for inactive
JSON array of specific fields to return in response; e.g., \["id","name","code",{"addresses":\["id","street1"\]}\]
Starting position for pagination. Increment by 50 for successive batches.
Filter by export status: true for exported records, false for not exported
Field name to sort results by (e.g., created_at, updated_at, id, name)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_SUPPLIER_ITEMS_DESTROYTool to delete a supplier item. Use when you need to permanently remove a supplier item by its unique ID.
Input parameters
The Coupa unique identifier for the supplier item to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_SUPPLIER_RISK_AWARE_FEED_DESTROYTool to delete a Supplier Risk Aware Feed. Use when you need to permanently remove a Supplier Risk Aware Feed record by ID.
Input parameters
Supplier Risk Aware Feed ID to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_SUPPLIER_RISK_AWARE_FEED_SHOWTool 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.
Input parameters
ID of the supplier risk aware feed to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_SUPPLIER_SITES_CREATETool 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.
Input parameters
Unique supplier site code identifier (max 20 characters)
Name of the supplier site
Whether the supplier site is active and available for use
URL for cXML transmission (required if po-method is 'cxml')
Email address for PO delivery (required if po-method is 'email')
Purchase order transmission method. Valid values: cxml, xml, email, prompt, mark_as_sent, buy_online
Whether to hold POs for buyer review before transmission
cXML 'From' domain for authentication
Shared secret for cXML authentication
ID of the parent supplier to which this site belongs
cXML 'From' identity for authentication
Transmission protocol for cXML
Default locale setting for the supplier site
Default payment method for this supplier site
SSL version for cXML transmission. Valid values: TLSv1_2, TLSv1_1, TLSv1
Method for transmitting purchase order changes. Valid values: cxml, xml, email, prompt, mark_as_sent, buy_online
HTTP username for cXML access credentials
Whether to disable certificate verification
cXML 'To' supplier domain
Setting for allowing CSP change requests
cXML 'To' supplier identity
Settings for item substitutions in order confirmations
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_SUPPLIER_SITES_DESTROYTool 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.
Input parameters
Supplier site ID to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_SUPPLIERS_SHOWTool to retrieve a single supplier. Use when you need detailed supplier information by ID.
Input parameters
ID of the supplier to retrieve
JSON array of fields to return; e.g., \['id','name','status'\].
Response verbosity: 'limited' or 'shallow'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_SUPPLIERS_UPDATETool to update a supplier. Use when revising supplier details after verifying the supplier exists; only changed fields need to be included.
Input parameters
Coupa unique identifier of the supplier to update.
DUNS number.
Supplier name.
JSON array of fields to return; e.g., \['id','name'\].
Supplier number.
Supplier status; defaults to 'draft' on create if unset.
Put supplier on hold.
Additional supplier attributes to update directly; keys should use Coupa API hyphenated names.
cXML endpoint URL.
Email used when po-method=email.
Purchase order transmission method.
cXML domain.
cXML secret.
User email or login to perform the action on behalf of. Sent as 'X-COUPA-ON-BEHALF-OF' header.
Payment term by ID or code.
Coupa business role to use when acting on behalf of a user. Sent as 'X-COUPA-BUSINESS-ROLE'.
cXML identity.
cXML protocol.
Controls response verbosity: 'none', 'limited', or 'shallow'.
Shipping term by ID.
Account number.
Primary address details.
Primary contact details.
Enable cXML invoicing.
cXML supplier domain.
Enable invoicing from Coupa Connect.
cXML supplier identity.
Invoice matching level.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_SYNC_SUPPLIER_USER_LOCALETool to sync supplier user locale settings. Use when you need to synchronize locale preferences for a specific supplier user.
Input parameters
Email address of the supplier user whose locale needs to be synced.
Coupa internal ID of the supplier to which the user belongs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_TASKS_DESTROYTool to delete a task. Use when you need to permanently remove a task by ID.
Input parameters
Coupa task ID to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_TASKS_SHOWTool to retrieve a single task by ID. Use when you need detailed task information after knowing the task ID.
Input parameters
ID of the task to retrieve
JSON array of fields to return; e.g., \['id','title','status'\].
Response verbosity: 'shallow' returns all attributes and IDs of one-deep associations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_TASKS_UPDATETool 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.
Input parameters
Coupa unique identifier of the task to update.
Task title.
JSON array of fields to return; e.g., \['id','title','status'\].
Task status (e.g., 'pending', 'in_progress', 'completed').
Additional task attributes to update directly; keys should use Coupa API hyphenated names.
Task due date in ISO format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS).
Task duration in days.
User ID to whom the task is assigned.
Task completion percentage (0-100).
Task start date in ISO format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS).
Task description or details.
ID of the linked object (e.g., requisition, purchase order). Required if linkable-type is provided.
User email or login to perform the action on behalf of. Sent as 'X-COUPA-ON-BEHALF-OF' header.
Coupa business role to use when acting on behalf of a user. Sent as 'X-COUPA-BUSINESS-ROLE'.
Type of the linked object (e.g., 'Requisition', 'PurchaseOrder'). Required if linkable-id is provided.
Controls response verbosity: 'none', 'limited', or 'shallow'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_TAX_REGISTRATIONS_INDEXTool to query tax registrations from Coupa. Use when you need to retrieve tax identification numbers and fiscal representative details for entities.
Input parameters
Exact-match filter by Coupa unique identifier
Filter by local status: true for non-cross-border registrations, false otherwise
Filter by active status: true for enabled tax codes, false for disabled
JSON array of fields to return; e.g., \["id","number","active"\].
Filter by tax registration number; supports operators like contains, starts_with, ends_with.
Pagination offset; results are returned in pages of up to 50
Filter by Coupa unique identifier of the associated object
Filter by type of the owning object
Filter by country code where the tax code is applied
Response size control: 'limited' returns only IDs; 'shallow' returns attributes with one-level associations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_TAX_REGISTRATIONS_SHOWTool to retrieve a single tax registration record by ID. Use when you need detailed tax registration information including country, registration number, and fiscal representative.
Input parameters
ID of the tax registration to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UNSCHEDULE_REQUISITION_ISSUANCETool 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.
Input parameters
Array of requisition line IDs to unschedule from automatic PO issuance
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UO_MS_INDEXTool to list units of measure. Use when retrieving or filtering UOM catalog for inventory or purchasing flows.
Input parameters
Exact-match filter by Coupa UOM ID
Filter by UOM code; supports operators like contains, starts_with, ends_with.
Filter by UOM name; supports standard operators.
Filter by active status (true or false).
JSON array of fields to return; e.g., \["id","code","name"\].
Pagination offset; results are returned in pages of up to 50.
Filter UOMs created after this timestamp (ISO 8601).
Filter UOMs created before this timestamp (ISO 8601).
Response size control: 'limited' returns only IDs; 'shallow' returns attributes with one-level associations.
Filter UOMs updated after this timestamp (ISO 8601).
Filter UOMs updated before this timestamp (ISO 8601).
Filter by allowable precision; supports comparison operators (gt, lt, etc.).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_BUDGET_LINETool to update an existing budget line in Coupa. Use when modifying budget line attributes such as amount, description, remaining balance, or account segments after confirming the budget line ID exists.
Input parameters
Coupa unique identifier of the budget line to update.
Additional notes or comments for the budget line.
Budget line amount (decimal). The total budgeted amount for this line.
Remaining budget amount (decimal). The amount left available to spend from this budget line.
Account segment 1 value for chart of accounts categorization.
Account segment 2 value for chart of accounts categorization.
Budget line description explaining the purpose or details of this budget line.
Whether the budget line owner is also an approver for transactions against this budget line.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_BUDGET_LINES_ADJUSTTool to adjust a budget line in Coupa. Use when you need to perform an adjustment operation on an existing budget line. This endpoint does not require a request body and returns an empty response on success.
Input parameters
The ID of the budget line to adjust
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_BUSINESS_ENTITYTool to update a business entity in Coupa. Use when you need to modify business entity attributes after verifying the entity exists.
Input parameters
Coupa unique identifier of the business entity to update.
Unique name of the business entity.
Type of business entity.
Status of the business entity.
Additional business entity attributes to update; use Coupa API hyphenated names as keys.
Collection of addresses associated with the business entity.
Display name for the business entity.
User email or login to perform the action on behalf of. Sent as 'X-COUPA-ON-BEHALF-OF' header.
Coupa business role to use when acting on behalf of a user. Sent as 'X-COUPA-BUSINESS-ROLE'.
Controls response verbosity: 'none', 'limited', or 'shallow'.
Formation type of the business entity.
Primary address reference for the business entity.
Primary contact details for the business entity.
Country where the business entity originates.
Relationships with other business entities.
Account owners for the business entity.
Alternate names for the business entity.
External system references for the business entity.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_COMMODITIESTool to update an existing Coupa commodity. Use when modifying commodity attributes after confirming the commodity ID exists.
Input parameters
The Coupa unique identifier of the commodity to update
Unique commodity identifier (max 255 chars)
Controls availability to users - true makes it available, false inactivates it
JSON array of fields to return; e.g., \['id','name','active'\].
Additional commodity properties to update; use Coupa API hyphenated names as keys.
Category options for commodities.
Preferred options for commodities.
Subcategory options for commodities.
User email or login to perform the action on behalf of. Sent as 'X-COUPA-ON-BEHALF-OF' header.
Coupa business role to use when acting on behalf of a user. Sent as 'X-COUPA-BUSINESS-ROLE'.
Deductibility options for commodities.
Controls response verbosity: 'none', 'limited', or 'shallow'.
Localized name variant for the commodity
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_CONTRACT_LEGAL_AGREEMENTTool to update a contract's legal agreement file. Use when adding or replacing the legal agreement PDF on a contract.
Input parameters
ID of the contract to add or update the legal agreement file
Use with a binary (e.g., PDF) file.
Optional fields selector per Coupa API as a JSON string. Example: \['id', {'legal_agreement':\['id','file-url'\]}\]
Filename to use when uploading raw content (e.g., 'agreement.pdf')
Optional return object size: none \\ | limited \\ | shallow
MIME type for raw content (e.g., 'application/pdf')
Optional Coupa user login to impersonate; sent as 'x-coupa-api-user-login' header
Base64-encoded file content used when a file reference is not available
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_EXCHANGE_RATETool 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.
Input parameters
Coupa unique identifier of the exchange rate to update.
The exchange rate value between the source and target currencies. For example, if 1 USD = 0.85 EUR, the rate is 0.85.
JSON array of fields to return; e.g., \['id','rate','rate-date'\].
Additional exchange rate attributes to update directly; keys should use Coupa API hyphenated names.
The effective date when this exchange rate applies. Format: YYYY-MM-DD.
Currency reference object.
User email or login to perform the action on behalf of. Sent as 'X-COUPA-ON-BEHALF-OF' header.
Coupa business role to use when acting on behalf of a user. Sent as 'X-COUPA-BUSINESS-ROLE'.
Currency reference object.
Controls response verbosity: 'none', 'limited', or 'shallow'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_EXISTING_ADDRESSTool to update an existing address in Coupa. Use when revising address details after verifying the address exists and is active.
Input parameters
Coupa unique identifier of the address to update.
City name.
Address nickname for identification.
State or province abbreviation.
Controls whether address is available to users. Cannot update if address is already inactive.
JSON array of fields to return; e.g., \['id','name','city'\].
Country object reference. Must exist in system. Can specify by id, code, or name.
Additional address attributes to update directly; keys should use Coupa API hyphenated names.
Address line 1 (primary street address).
Address line 2 (suite, building, etc.).
Address line 3 (additional address information).
Address line 4 (additional address information).
Attention line for the address (recipient name or department).
VAT identifier for the address.
Postal or ZIP code.
VAT country reference. Must exist in system.
User email or login to perform the action on behalf of. Sent as 'X-COUPA-ON-BEHALF-OF' header.
Coupa business role to use when acting on behalf of a user. Sent as 'X-COUPA-BUSINESS-ROLE'.
Location code for the address.
Controls response verbosity: 'none' (no response), 'limited' (IDs only), or 'shallow' (all attributes + IDs of associations).
ISO format state code (CC-SSS format, e.g., US-CA for California).
Local tax identifier for the address.
Content group name for access control.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_EXISTING_COMMODITYTool to update an existing commodity in Coupa. Use when you need to modify commodity attributes like name, category, or active status.
Input parameters
Coupa unique identifier for the commodity to update
Commodity name (max 255 characters)
A false value will inactivate the commodity making it no longer available to users
Category options for commodities.
Preferred options for commodities.
Subcategory options for commodities.
Deductibility options for commodities.
Translated name of the commodity
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_EXISTING_LOOKUP_VALUETool to update an existing lookup value in Coupa. Use when you need to modify lookup value attributes like name, description, or active status.
Input parameters
Coupa unique identifier of the lookup value to update.
The lookup value's display name.
Controls visibility; setting to false inactivates the lookup value.
JSON array of fields to return; e.g., \['id','name','active'\].
External Ref Code of the parent element in hierarchy, e.g., {'external-ref-code': '123'}.
Additional lookup value properties to update; use Coupa API hyphenated names as keys.
Associated lookup identifier to update the lookup for a lookup value.
Designates this as the default option.
Text describing the lookup value.
Reference to the associated account type, e.g., {'id': 1}.
User email or login to perform the action on behalf of. Sent as 'X-COUPA-ON-BEHALF-OF' header.
Coupa business role to use when acting on behalf of a user. Sent as 'X-COUPA-BUSINESS-ROLE'.
Controls response verbosity: 'none', 'limited', or 'shallow'.
The actual account value used in accounting systems.
Hierarchical identifier for lookups; concatenates External Ref Num fields.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_EXISTING_PAYMENT_TERMTool to update an existing payment term in Coupa. Use when you need to modify payment term attributes after confirming the payment term ID.
Input parameters
Coupa unique identifier of the payment term to update.
Payment term code identifier.
Payment term type: DaysAfterNetPaymentTerm or SpecificDayPaymentTerm.
Activation status; false inactivates, true activates the payment term.
JSON array of fields to return; e.g., \['id','code','description'\].
Additional payment term attributes to update directly; keys should use Coupa API hyphenated names.
Descriptive text for the payment term.
Determines payment due date (1-31).
User email or login to perform the action on behalf of. Sent as 'X-COUPA-ON-BEHALF-OF' header.
Coupa business role to use when acting on behalf of a user. Sent as 'X-COUPA-BUSINESS-ROLE'.
Discount percentage rate (as decimal).
Determines payment due date (0-6).
Controls response verbosity: 'none', 'limited', or 'shallow'.
Associated content groups (business groups).
Helps to determine payment due date if document (1-31).
Used to calculate discount due date (1-31).
Calculates discount due date with day (0-6).
Documents before this day are eligible for discount (1-31).
Days allowed for net payment.
Days allowed for discount payment.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_EXISTING_SUPPLIER_ITEMTool 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.
Input parameters
Coupa unique identifier of the supplier item to update.
Item reference, e.g., {'id': 202}.
Item price as a decimal string.
Associated catalog reference, e.g., {'id': 5}.
Additional supplier item attributes to update directly; keys should use Coupa API hyphenated names.
Related contract reference, e.g., {'id': 10}.
Currency object reference, e.g., {'code': 'USD'} or {'id': 1}.
Supplier reference, e.g., {'id': 3} or {'name': 'Office Depot (USA)'}.
Lead time value in days.
Preferred supplier indicator.
Whether the item is purchasable.
Savings percentage as a decimal string.
UNSPSC classification code.
Stock status: in_stock, out_of_stock, or backordered.
Manufacturer name.
User email or login to perform the action on behalf of. Sent as 'X-COUPA-ON-BEHALF-OF' header.
Price tier 1 as a decimal string.
Price tier 2 as a decimal string.
Price tier 3 as a decimal string.
Price tier 4 as a decimal string.
Price tier 5 as a decimal string.
Price tier 6 as a decimal string.
Price tier 7 as a decimal string.
Price tier 8 as a decimal string.
Price tier 9 as a decimal string.
Coupa business role to use when acting on behalf of a user. Sent as 'X-COUPA-BUSINESS-ROLE'.
Contract term details reference.
Price tier 10 as a decimal string.
Price tier 11 as a decimal string.
Price tier 12 as a decimal string.
Price tier 13 as a decimal string.
Price tier 14 as a decimal string.
Price tier 15 as a decimal string.
Price tier 16 as a decimal string.
Price tier 17 as a decimal string.
Price tier 18 as a decimal string.
Price tier 19 as a decimal string.
Price tier 20 as a decimal string.
Controls response verbosity: 'none' (nothing returned), 'limited' (only IDs returned), 'shallow' (returns all attributes/fields and IDs of one-deep associations). Default returns full object.
Order increment value as a decimal string.
Date of availability change in ISO 8601 format (YYYY-MM-DDTHH:MM:SS+HH:MM).
Supplier's part number.
Auxiliary part number.
Minimum order amount as a decimal string.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_EXISTING_TASKTool 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.
Input parameters
Task title.
JSON array of fields to return; e.g., \['id','title','status'\].
Current task state (e.g., 'pending', 'in_progress', 'completed').
Additional task attributes to update directly; keys should use Coupa API hyphenated names.
The unique identifier of the task to update.
Task due date in ISO format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS).
Task duration in days.
User ID to whom the task is assigned.
Task completion percentage (0-100).
The unique identifier of the project containing the task.
Task start date in ISO format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS).
Task description providing additional details.
User email or login to perform the action on behalf of. Sent as 'X-COUPA-ON-BEHALF-OF' header.
Coupa business role to use when acting on behalf of a user. Sent as 'X-COUPA-BUSINESS-ROLE'.
Controls response verbosity: 'none', 'limited', or 'shallow'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_EXISTING_USER_ADDRESSTool to update an existing user address in Coupa. Use when you need to modify address details for a specific user's address.
Input parameters
ID of the address to update.
City name.
Address 'Nickname' or label to identify this address.
State abbreviation.
Set to true to activate address or false to deactivate. Inactive addresses are not available to users.
JSON array of fields to return; e.g., \["id","name","city","state","country"\].
Country information for the address.
Address Line 1 (primary street address).
Address Line 2 (apartment, suite, unit, etc.).
Address Line 3 (additional address information).
Address Line 4 (additional address information).
Address Default Attention Line / contact person name.
VAT number associated with this address.
Postal/ZIP code.
Country information for the address.
ID of the user whose address to update.
Location code for the address.
Response verbosity: 'none' (no response), 'limited' (minimal fields), or 'shallow' (full attributes with one-level associations).
ISO Code for State in format CC-SSS (e.g., 'US-CA' for California).
External Source Reference identifier.
Local tax number for the address.
External Source Name.
Content Group Name for Address.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_EXTERNAL_PO_WITH_LINE_LEVELTool to update an external purchase order with line level confirmation and tax lines. Use when updating PO line details, adding tax information, or associating order confirmation IDs.
Input parameters
Coupa internal ID of the purchase order to update
List of order lines to update with their IDs and new values
Order confirmation ID to associate with the purchase order
External reference number for the purchase order
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_IMAGE_SCAN_ON_AN_INVOICETool 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.
Input parameters
Coupa unique identifier of the invoice to update image scan for
URL of the image scan document. Must begin with 'http://' or 'https://'
Type of image scan update: 'url' for providing a URL reference to the image scan document
Controls response verbosity: 'none', 'limited', or 'shallow'. Default varies by operation
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_INVOICESTool to update an existing invoice in Coupa. Use when you need to modify invoice fields such as notes, payment information, or status.
Input parameters
Coupa unique identifier of the invoice to update.
JSON array of fields to return in response; e.g., \['id','invoice-number',{'currency':\['code'\]}\].
Invoice status (e.g., 'pending_approval', 'approved', 'disputed').
Additional invoice fields to update using Coupa API hyphenated field names as keys (e.g., 'is-credit-note', 'original-invoice-date', 'account-allocations', 'custom-fields').
Currency reference object, e.g., {'code': 'USD'}.
Invoice date (format: YYYY-MM-DD). IMPORTANT: Provide only the date, do not include timestamp to avoid credit note linking issues.
Date when payment was made (format: YYYY-MM-DD).
Payment term reference object, e.g., {'id': 1} or {'code': 'NET30'}.
Exchange rate for currency conversion.
Internal notes for the invoice (visible to internal users only).
Notes related to payment processing.
Optional response verbosity control: 'none' (no response body), 'limited' (only IDs), 'shallow' (all attributes with one-deep association IDs).
Notes visible to the supplier.
Invoice number from the supplier.
Payment method reference object, e.g., {'id': 1}.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_ITEMS_SUPPLIER_ITEMSTool to update a supplier item for a specific item in Coupa. Use when you need to modify supplier item details like price, lead time, or preferred status.
Input parameters
Price as decimal string
The ID of the item
Reference to a contract.
Reference to a currency.
Lead time in days
Whether this supplier item is preferred
Savings percentage as decimal string
UNSPSC code
Availability status: in_stock, out_of_stock, or backordered
Manufacturer name
Price tier 1 as decimal string
Price tier 2 as decimal string
Price tier 3 as decimal string
Price tier 4 as decimal string
Price tier 5 as decimal string
Reference to a contract term.
Order increment as decimal string
The ID of the supplier item to update
Availability date in ISO format
Supplier part number
Supplier auxiliary part number
Minimum order quantity as decimal string
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_PAYABLES_INVOICES_TRACK_IN_COUPATool to start tracking an invoice payable in Coupa. Use when you need to change an externally tracked invoice to be tracked within Coupa's payment system. The invoice status will typically change to 'ready_to_pay'.
Input parameters
The unique identifier of the invoice payable to start tracking in Coupa
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_PAY_ORDER_STATUS_TO_READY_TO_PAYTool 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.
Input parameters
The unique Coupa identifier of the payable order to mark as ready to pay
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_PROJECT_MEMBER_AS_OWNERTool to update a project member as owner in Coupa. Use when you need to change owner/administrator or participant status for a project membership.
Input parameters
Whether the user is a project owner/administrator. Set to true to designate as owner.
JSON array of fields to return; e.g., \["id","owner","participant"\]
The ID of the user being updated. Can be null for certain membership types.
The ID of the project.
Whether the user is a participant in the project.
Controls response verbosity: 'none', 'limited', or 'shallow'.
Coupa unique identifier of the project membership to update.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_PROJECTS_TASKSTool to update an existing task within a specific project in Coupa via PATCH /api/projects/:project_id/tasks/:id. Use when you need to partially modify task attributes for a project-linked task.
Input parameters
The unique identifier of the task to update.
Task title.
JSON array of fields to return; e.g., \['id','title','status'\].
Current task state (e.g., 'pending', 'in_progress', 'completed').
Additional task attributes to update directly; keys should use Coupa API hyphenated names.
Task due date in ISO format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS).
Task duration in days.
User ID to whom the task is assigned.
Task completion percentage (0-100).
The unique identifier of the project containing the task.
Task start date in ISO format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS).
Task description providing additional details.
User email or login to perform the action on behalf of. Sent as 'X-COUPA-ON-BEHALF-OF' header.
Coupa business role to use when acting on behalf of a user. Sent as 'X-COUPA-BUSINESS-ROLE'.
Controls response verbosity: 'none', 'limited', or 'shallow'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_PURCHASE_ORDER_CHANGE_REMOTE_APPROVERTool 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.
Input parameters
Additional order header properties to update using Coupa API hyphenated names as keys
Coupa internal ID of the purchase order change to update
The current approver's login/username. Must exist in Coupa system.
Purchase order header identifier
Reason insight identifier
Reason insight code for the purchase order change
Comment body explaining the reason for the change
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_QUOTE_REQUESTS_TASKSTool to update a task on a quote request. Use when you need to modify task attributes like title, status, percentage, or due dates for a specific quote request task.
Input parameters
Updated task title
Updated task status
The ID of the task to update
Updated task due date in ISO format (YYYY-MM-DD)
Updated task duration in days
Updated owner user ID for the task
Updated task completion percentage (0-100)
Updated task start date in ISO format (YYYY-MM-DD)
Updated task description
The ID of the quote request containing the task
Attributes specific to sourcing event tasks.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_REQUISITIONTool to update an existing requisition in Coupa. Use when you need to modify requisition attributes such as justification, title, need-by date, or status.
Input parameters
Coupa unique identifier of the requisition to update.
Transaction status of the requisition.
Additional requisition attributes to update; keys should use Coupa API hyphenated names.
Indicates if transaction has been exported.
Optional title of the requisition.
Requester user reference. Provide id, login, or email. Example: {'id': 5}
User who created the requisition. Provide id, login, or email. Example: {'id': 3}
List of attachments. Each attachment can have id, intent, type, and url.
Item need by date in ISO 8601 format (YYYY-MM-DDTHH:MM:SS+HH:MMZ).
Requisition justification comments.
Ship-to address reference. Provide id or full address details.
List of requisition line items. Each line should include description, item, and other required fields.
Ship to address attention field.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_STATUS_OF_A_PROJECTTool 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.
Input parameters
ID of the project to update status
Target status to transition the project to. Valid values: 'draft', 'planned', 'in_progress', 'complete', 'canceled'
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_SUPPLIER_INFORMATION_SITETool to update an existing supplier information site in Coupa. Use when modifying site attributes such as name, PO methods, cXML configuration, or associated addresses and contacts.
Input parameters
The Coupa Internal ID of the supplier information site to update
Supplier code identifier (unique, max 20 chars)
Supplier Information name (max 255 chars)
True if the site is active
Comma-separated list of fields to return in the response; e.g., "id,code,name" or JSON array format \["id","code","name"\]
Additional supplier information site attributes to update; keys should use Coupa API hyphenated names.
Supplier Information Site contacts
URL for PO transmission via cXML
Email destination for PO transmission
Supplier Information Site addresses
Purchase order transmission method
Hold all POs for buyer review
From domain identifier
Shared secret credentials
User email or login to perform the action on behalf of. Sent as 'X-COUPA-ON-BEHALF-OF' header.
Payment term reference, e.g., {'id': 1} or {'code': 'Net 30'}
Coupa business role when acting on behalf of a user. Sent as 'X-COUPA-BUSINESS-ROLE'.
From identity identifier
Transmission protocol
Controls response verbosity: 'none', 'limited', or 'shallow'.
Shipping term reference, e.g., {'id': 2} or {'code': 'FOB'}
Content groups associated with the site, e.g., \[{'id': 1}\]
Default locale for emails
SSL version for cXML
Purchase order change transmission method
Supplier online store access credentials
Ignore SSL certificate mismatch errors
To supplier domain
Allows suppliers to create change requests from CSP
To supplier identity
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_SUPPLIER_INFORMATION_SUPPLIER_INFORMATION_SITETool to update supplier information sites within a supplier information record in Coupa. Use when you need to modify details of a specific supplier site such as name, code, contact info, or operational status.
Input parameters
ID of the supplier information site to update
Supplier site code identifier (max 20 characters)
Supplier information site name (max 255 characters)
Site operational status (true=active, false=inactive)
Email recipient for purchase order transmission when method is 'email'
Purchase order transmission method (e.g., 'email', 'cxml')
Reference to a payment term.
Purchase order change transmission method
ID of the supplier information record
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_SUPPLIER_REMIT_TO_ADDRESSTool 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.
Input parameters
City name (max 255 characters).
Name/description of the remit address (max 255 characters).
State/province abbreviation (max 255 characters).
Status flag (true for active, false for inactive). Setting to false deactivates the address.
Model for country details.
Primary street address line (max 255 characters).
Secondary street address line (max 255 characters).
Third street address line (max 255 characters).
Fourth street address line (max 255 characters).
Coupa unique identifier of the remit-to address to update.
VAT registration identifier (max 255 characters).
Postal/zip code (max 255 characters).
Coupa unique identifier of the supplier.
Model for country details.
Unique code identifying the remit address (max 255 characters).
Controls response format. Values: 'none' (no response body), 'limited' (only IDs), 'shallow' (full object with limited nested data).
Reference from originating system (max 255 characters).
Local tax identifier.
Source system identifier (max 255 characters).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_SUPPLIERS_SUPPLIER_SITESTool to update a supplier site's details such as name, active status, PO methods, and contact information. Use when you need to modify an existing supplier site's configuration.
Input parameters
The supplier site's unique identifier
The supplier's unique identifier
Supplier site update payload containing the fields to be updated
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_USER_GROUPTool to update a Coupa user group. Use when you need to modify group attributes like name, description, approval permissions, or membership settings.
Input parameters
The unique identifier of the user group to update
Group name (max 255 chars)
Open membership status - whether the group is open for anyone to join
Type designation for the group (max 255 chars)
Active status of the user group
Approver capability - whether members of this group can approve requests
Group description
Mention name for the user group (max 255 chars)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_USER_GROUP_MEMBERSHIPSTool to update user group memberships in Coupa. Use when modifying membership attributes like owner or participant status after confirming the membership ID exists.
Input parameters
Coupa unique identifier of the user group membership to update.
Indicates whether the user is admin or not.
JSON array of fields to return; e.g., \['id','owner','participant'\].
User identifier.
Indicates whether the user is participant or not.
User email or login to perform the action on behalf of. Sent as 'X-COUPA-ON-BEHALF-OF' header.
Coupa business role when acting on behalf of a user. Sent as 'X-COUPA-BUSINESS-ROLE'.
Controls response verbosity: 'none', 'limited', or 'shallow'.
User group ID or Project ID.
Type of the group: 'UserGroup' or 'Project'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_USER_GROUPS2Tool to update an existing user group in Coupa using PUT method. Use when you need to fully update a user group's attributes including name, description, owner, members, and approval permissions.
Input parameters
Coupa unique identifier for the user group
User group name
User group is open for everyone to join or owner must invite
Blank for Groups, Project for Projects
Reference to a user group owner.
Collection of users in the group
Active status indicator
User group has the ability to be an approver
User group description
Mention name for the group
URL for avatar thumbnail
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPDATE_USER_GROUPS_TASKSTool to update an existing task within a user group. Use when you need to modify task attributes like title, status, percentage, or due date for a task assigned to a specific user group.
Input parameters
ID of the task to update
Task title (max 255 characters)
Task status (max 255 characters)
Deadline in format YYYY-MM-DDTHH:MM:SS+HH:MMZ
Task duration in days
Assigned user ID
Completion percentage (0-100)
Start date in datetime format (YYYY-MM-DDTHH:MM:SS+HH:MMZ)
Task description providing additional details
ID of the user group containing the task
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_UPLOAD_CONTRACT_LEGAL_AGREEMENTTool to upload a legal agreement file for a contract. Use when adding or updating the contract's legal agreement document.
Input parameters
ID of the contract to upload the legal agreement for
Legal agreement file to upload.
Optional fields selector per Coupa API as a JSON string. Example: \['id', {'legal_agreement':\['id','file-url'\]}\]
Filename to use when uploading raw content (e.g., 'agreement.pdf')
Optional return object size: none \\ | limited \\ | shallow
Raw file content as a UTF-8 string for direct upload in environments where staging (s3key) is unavailable.
MIME type for raw content (e.g., 'application/pdf')
Optional Coupa user login to impersonate; sent as 'x-coupa-api-user-login' header
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_USER_GROUPS_INDEXTool to list user groups (user memberships). Use when you need to retrieve user group information including members, approval permissions, and group metadata.
Input parameters
Exact-match filter by user group name.
Maximum number of records to return (1-50). Default is 50 records.
Filter by active status: true for active groups, false for inactive.
JSON array of fields to return; e.g., \["id","name","active"\].
Number of records to skip for pagination (default 0).
Field(s) to order results by (alphabetical/numeric order). E.g., 'name'.
Filter by approval permission: true for groups that can approve.
Filter groups whose name contains the given text.
Response verbosity: 'limited' returns only IDs; 'shallow' returns full object attributes with one-level association IDs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_USERS_CREATETool to create a Coupa user. Use when you need to programmatically add a new user to your Coupa instance.
Input parameters
User email address
User login/username
When true the user account is active
User last name
User first name
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_USERS_INDEXTool to list users. Use when you need to retrieve multiple user records with optional pagination and filtering.
Input parameters
Maximum number of records to return (1-50). Coupa Core API returns up to 50 records per call.
JSON array of fields to return; e.g., \['id','login',{'roles':\['id','name'\]}\].
Number of records to skip for pagination (default 0).
Filter by user status; e.g., 'active'.
Response verbosity: 'limited' or 'shallow'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_USERS_SHOWTool to retrieve a single user by ID. Use when you need detailed user information after knowing the user ID.
Input parameters
ID of the user to retrieve
JSON array of fields to return; e.g., \['id','login',{'roles':\['id','name'\]}\].
Response verbosity: 'limited' or 'shallow'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_VOID_INVOICETool to void an invoice. Use when an approved or pending invoice needs to be voided. Example: Void invoice with ID 12345.
Input parameters
Coupa unique identifier of the invoice to void
JSON array of specific fields or associations to include in the response. Example: \['id', 'invoice-number'\]
Controls the shape of the response: 'none' for no object, 'limited' for minimal fields, 'shallow' for shallow associations
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_WITHDRAW_CONTRACT_SIGNATURESTool 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.
Input parameters
Coupa internal ID of the contract to withdraw signatures from. The contract must be in 'pending_signatures' status.
JSON array of specific fields/associations to include in the response. Example: \['id','status'\]
Impersonate as the given user id via X-COUPA-API-USER-ID header.
Perform the action on behalf of this user (email or login); sent as X-COUPA-ON-BEHALF-OF header.
Coupa business role to use when acting on behalf of a user; sent as X-COUPA-BUSINESS-ROLE header.
Controls response verbosity: 'none', 'limited', or 'shallow'
Impersonate as the given user email via X-COUPA-API-EMAIL header.
Impersonate as the given user login via X-COUPA-API-USER-LOGIN header.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
COUPA_WITHDRAW_INVOICE_DISPUTETool 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.
Input parameters
Coupa unique identifier of the invoice to withdraw dispute from.
Optional response size control: none \\ | limited \\ | shallow.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
No publicly available marketplace agent is found using this tool yet. There are 86 agents privately built on Nagent that already use Coupa.
Build on Nagent
Connect Coupa to any Nagent agent in minutes — no API key management, no boilerplate. Just configure and deploy.
The five questions agent builders ask before adopting a new integration.
Open the External Integrations panel inside Nagent (app.nagent.ai/externalIntegration), find Coupa, and click "Connect Now." You'll authenticate with OAuth — Nagent handles credential storage and refresh automatically. Once connected, Coupa is available to any agent in your workspace.
No. Nagent provides no-code integration for every tool. Once Coupa is connected, you configure its 384 actions directly in the agent builder UI — no API calls, no boilerplate, no schema management.
Helix — Nagent's agentic agent builder — lets you drop Coupa steps into any workflow visually. Pick an action (e.g., one of those listed above), fill in the inputs (Helix knows the required vs. optional schema for each parameter), and connect it to upstream/downstream steps. Triggers run as the entry point of an agent, so when a Coupa event fires, the agent kicks off automatically.
Every Coupa action and trigger ships with a fully-typed schema — input parameters with name, type, required flag, and description, plus the output payload shape. The schemas are documented in the sections above. Helix uses these schemas to validate your configuration at build time and to type-check the data flowing between steps.
Yes. While Coupa ships with 384 pre-built accounting actions, you can layer custom logic around them inside Helix — pre/post-processing steps, conditional branches, retries, or stitching Coupa together with other connected tools. For deeper customization, talk to our team about Nagent's Agentic AI Lab — forward-deployed engineers who build Coupa-based workflows tailored to your business.