Skip to main content
Coupa logo
  • Category: accounting
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 384
  • Triggers: 0
  • Slug: COUPA
  • Version: 20261101_00

Tools

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

integer
required
Coupa unique identifier of the invoice to abandon.
string
Optional comment explaining why the invoice is being abandoned.
boolean
Whether to send notification to the supplier about the abandoned invoice.
integer
The ID of the Reason Insight to use for abandoning the invoice. Either reason_insight_id or reason_insight_code must be provided.
string
The code of the Reason Insight to use for abandoning the invoice. Either reason_insight_id or reason_insight_code must be provided.
string
Comma-separated list of additional email recipients to notify.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional user-friendly account nickname.
boolean
Whether the account is active/available to users.
string
First code segment (≤100 characters)
string
Second code segment (≤100 characters)
string
Third code segment (≤100 characters)
string
Fourth code segment (≤100 characters)
string
Fifth code segment (≤100 characters)
string
Sixth code segment (≤100 characters)
string
Seventh code segment (≤100 characters)
string
Eighth code segment (≤100 characters)
string
Ninth code segment (≤100 characters)
string
Tenth code segment (≤100 characters)
string
Eleventh code segment (≤100 characters)
string
Twelfth code segment (≤100 characters)
string
Thirteenth code segment (≤100 characters)
string
Fourteenth code segment (≤100 characters)
string
Fifteenth code segment (≤100 characters)
string
Sixteenth code segment (≤100 characters)
string
Seventeenth code segment (≤100 characters)
string
Eighteenth code segment (≤100 characters)
string
Nineteenth code segment (≤100 characters)
string
Twentieth code segment (≤100 characters)
object
Reference to an existing Coupa Account Type. Provide id or name.
integer
ID of the existing Account Type. Alternative to account-type object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Exact-match filter by Coupa account ID
string
Exact-match filter by account code; supports Coupa query operators
boolean
Filter by active status: true for active accounts, false for inactive
string
JSON array of fields to return; e.g., [“id”,“code”]
integer
Pagination offset; results are returned in pages up to 50
string
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns full object attributes with one-level association IDs
integer
Filter by account type ID
string
Filter by account type name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_ACCOUNTS_RECENTRetrieve recently accessed Coupa accounts with optional pagination. An empty-body HTTP 400 is returned as an empty account list.

Input Parameters

integer
Maximum number of records to return (1-50)
string
JSON array of fields to return; e.g., [“id”,“code”,“name”]
integer
Pagination offset; results are returned in pages up to 50
string
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns full object attributes with one-level association IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_ACCOUNTS_SHOWTool to retrieve a specific account by ID. Use when you need detailed account information including segments, type, and status.

Input Parameters

integer
required
ID of the account to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the account to update.
string
All segments concatenated with a hyphen (-). Auto-generated from segments if not provided.
string
Display nickname searchable through the user interface.
boolean
Controls account availability; false deactivates, true activates.
string
First code segment (≤100 characters)
string
Second code segment (≤100 characters)
string
Third code segment (≤100 characters)
string
Fourth code segment (≤100 characters)
string
Fifth code segment (≤100 characters)
string
Sixth code segment (≤100 characters)
string
Seventh code segment (≤100 characters)
string
Eighth code segment (≤100 characters)
string
Ninth code segment (≤100 characters)
string
Tenth code segment (≤100 characters)
string
Eleventh code segment (≤100 characters)
string
Twelfth code segment (≤100 characters)
string
Thirteenth code segment (≤100 characters)
string
Fourteenth code segment (≤100 characters)
string
Fifteenth code segment (≤100 characters)
string
Sixteenth code segment (≤100 characters)
string
Seventeenth code segment (≤100 characters)
string
Eighteenth code segment (≤100 characters)
string
Nineteenth code segment (≤100 characters)
string
Twentieth code segment (≤100 characters)
object
Reference to an existing Coupa Account Type. Provide id or name.
integer
ID of the existing Account Type. Alternative to account-type object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_ACCOUNT_TYPES_INDEXTool to list account types in Coupa. Use when you need account type IDs and names for account creation.

Input Parameters

integer
Exact-match filter by Coupa account type ID
boolean
Filter by active status (true or false)
string
JSON array of fields to return; e.g., [“id”,“name”].
integer
Pagination offset; results are returned in pages of up to 50
boolean
Filter by dynamic account type flag (true or false)
string
Filter account types whose name contains the given text
string ("limited" | "shallow")
Response size control: ‘limited’ returns only IDs; ‘shallow’ returns top-level fields with one-level associations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the account type to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name/identifier for the validation rule (max 100 characters).
boolean
required
Activation status for the rule (true/false).
string
required
Description of the validation rule (max 255 characters).
object
required
Reference to the Account Type (provide id or name).
string
required
Error message displayed when validation fails (max 255 characters).
string
Maximum value rule for segment 1 (max 255 characters).
string
Minimum value rule for segment 1 (max 255 characters).
string
Maximum value rule for segment 2 (max 255 characters).
string
Minimum value rule for segment 2 (max 255 characters).
string
Maximum value rule for segment 3 (max 255 characters).
string
Minimum value rule for segment 3 (max 255 characters).
string
Maximum value rule for segment 4 (max 255 characters).
string
Minimum value rule for segment 4 (max 255 characters).
string
Maximum value rule for segment 5 (max 255 characters).
string
Minimum value rule for segment 5 (max 255 characters).
string
Maximum value rule for segment 6 (max 255 characters).
string
Minimum value rule for segment 6 (max 255 characters).
string
Maximum value rule for segment 7 (max 255 characters).
string
Minimum value rule for segment 7 (max 255 characters).
string
Maximum value rule for segment 8 (max 255 characters).
string
Minimum value rule for segment 8 (max 255 characters).
string
Maximum value rule for segment 9 (max 255 characters).
string
Minimum value rule for segment 9 (max 255 characters).
string
Maximum value rule for segment 10 (max 255 characters).
string
Minimum value rule for segment 10 (max 255 characters).
string
Maximum value rule for segment 11 (max 255 characters).
string
Minimum value rule for segment 11 (max 255 characters).
string
Maximum value rule for segment 12 (max 255 characters).
string
Minimum value rule for segment 12 (max 255 characters).
string
Maximum value rule for segment 13 (max 255 characters).
string
Minimum value rule for segment 13 (max 255 characters).
string
Maximum value rule for segment 14 (max 255 characters).
string
Minimum value rule for segment 14 (max 255 characters).
string
Maximum value rule for segment 15 (max 255 characters).
string
Minimum value rule for segment 15 (max 255 characters).
string
Maximum value rule for segment 16 (max 255 characters).
string
Minimum value rule for segment 16 (max 255 characters).
string
Maximum value rule for segment 17 (max 255 characters).
string
Minimum value rule for segment 17 (max 255 characters).
string
Maximum value rule for segment 18 (max 255 characters).
string
Minimum value rule for segment 18 (max 255 characters).
string
Maximum value rule for segment 19 (max 255 characters).
string
Minimum value rule for segment 19 (max 255 characters).
string
Maximum value rule for segment 20 (max 255 characters).
string
Minimum value rule for segment 20 (max 255 characters).
string
Condition for segment 1 (e.g., ‘blank_value’ or custom condition).
string
Condition for segment 2 (e.g., ‘blank_value’ or custom condition).
string
Condition for segment 3 (e.g., ‘blank_value’ or custom condition).
string
Condition for segment 4 (e.g., ‘blank_value’ or custom condition).
string
Condition for segment 5 (e.g., ‘blank_value’ or custom condition).
string
Condition for segment 6 (e.g., ‘blank_value’ or custom condition).
string
Condition for segment 7 (e.g., ‘blank_value’ or custom condition).
string
Condition for segment 8 (e.g., ‘blank_value’ or custom condition).
string
Condition for segment 9 (e.g., ‘blank_value’ or custom condition).
string
Condition for segment 10 (e.g., ‘blank_value’ or custom condition).
string
Condition for segment 11 (e.g., ‘blank_value’ or custom condition).
string
Condition for segment 12 (e.g., ‘blank_value’ or custom condition).
string
Condition for segment 13 (e.g., ‘blank_value’ or custom condition).
string
Condition for segment 14 (e.g., ‘blank_value’ or custom condition).
string
Condition for segment 15 (e.g., ‘blank_value’ or custom condition).
string
Condition for segment 16 (e.g., ‘blank_value’ or custom condition).
string
Condition for segment 17 (e.g., ‘blank_value’ or custom condition).
string
Condition for segment 18 (e.g., ‘blank_value’ or custom condition).
string
Condition for segment 19 (e.g., ‘blank_value’ or custom condition).
string
Condition for segment 20 (e.g., ‘blank_value’ or custom condition).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the account validation rule to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the account validation rule to update.
string
Item name (max 100 characters) - must be unique.
boolean
Status indicator - when NOT active, item is effectively deleted.
object
Additional account validation rule properties to update; use Coupa API hyphenated names as keys.
string
Item description (max 255 characters) - must be unique.
object
Reference to account type, e.g., {‘id’: 1}.
string
Error message to be displayed when validation fails (max 255 characters) - must be unique.
string ("none" | "limited" | "shallow")
Controls response format: ‘none’ (nothing returned), ‘limited’ (only IDs), ‘shallow’ (attributes plus IDs of associations). Default returns full object.
string
Custom maximum rule for segment 1 (max 255 characters).
string
Custom minimum rule for segment 1 (max 255 characters).
string
Custom maximum rule for segment 2 (max 255 characters).
string
Custom minimum rule for segment 2 (max 255 characters).
string
Custom maximum rule for segment 3 (max 255 characters).
string
Custom minimum rule for segment 3 (max 255 characters).
string
Custom maximum rule for segment 4 (max 255 characters).
string
Custom minimum rule for segment 4 (max 255 characters).
string
Custom maximum rule for segment 5 (max 255 characters).
string
Custom minimum rule for segment 5 (max 255 characters).
string
Custom maximum rule for segment 6 (max 255 characters).
string
Custom minimum rule for segment 6 (max 255 characters).
string
Custom maximum rule for segment 7 (max 255 characters).
string
Custom minimum rule for segment 7 (max 255 characters).
string
Custom maximum rule for segment 8 (max 255 characters).
string
Custom minimum rule for segment 8 (max 255 characters).
string
Custom maximum rule for segment 9 (max 255 characters).
string
Custom minimum rule for segment 9 (max 255 characters).
string
Custom maximum rule for segment 10 (max 255 characters).
string
Custom minimum rule for segment 10 (max 255 characters).
string
Custom maximum rule for segment 11 (max 255 characters).
string
Custom minimum rule for segment 11 (max 255 characters).
string
Custom maximum rule for segment 12 (max 255 characters).
string
Custom minimum rule for segment 12 (max 255 characters).
string
Custom maximum rule for segment 13 (max 255 characters).
string
Custom minimum rule for segment 13 (max 255 characters).
string
Custom maximum rule for segment 14 (max 255 characters).
string
Custom minimum rule for segment 14 (max 255 characters).
string
Custom maximum rule for segment 15 (max 255 characters).
string
Custom minimum rule for segment 15 (max 255 characters).
string
Custom maximum rule for segment 16 (max 255 characters).
string
Custom minimum rule for segment 16 (max 255 characters).
string
Custom maximum rule for segment 17 (max 255 characters).
string
Custom minimum rule for segment 17 (max 255 characters).
string
Custom maximum rule for segment 18 (max 255 characters).
string
Custom minimum rule for segment 18 (max 255 characters).
string
Custom maximum rule for segment 19 (max 255 characters).
string
Custom minimum rule for segment 19 (max 255 characters).
string
Custom maximum rule for segment 20 (max 255 characters).
string
Custom minimum rule for segment 20 (max 255 characters).
string
Custom condition for segment 1.
string
Custom condition for segment 2.
string
Custom condition for segment 3.
string
Custom condition for segment 4.
string
Custom condition for segment 5.
string
Custom condition for segment 6.
string
Custom condition for segment 7.
string
Custom condition for segment 8.
string
Custom condition for segment 9.
string
Custom condition for segment 10.
string
Custom condition for segment 11.
string
Custom condition for segment 12.
string
Custom condition for segment 13.
string
Custom condition for segment 14.
string
Custom condition for segment 15.
string
Custom condition for segment 16.
string
Custom condition for segment 17.
string
Custom condition for segment 18.
string
Custom condition for segment 19.
string
Custom condition for segment 20.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the expense report to add a comment to.
string
required
The comment text to add to the expense report.
string ("ExpenseReport" | "ExpenseReportHeader")
Type of the commentable object. Use ‘ExpenseReport’ for standard expense reports or ‘ExpenseReportHeader’ for header-level comments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa internal ID of the requisition.
string ("after_current_approver" | "before_current_approver" | "end_of_list" | "watcher")
required
Position to add the approver in the approval chain. Acceptable values: after_current_approver, before_current_approver, end_of_list, watcher.
integer
required
Coupa internal ID of the User or UserGroup to add as approver.
integer
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the invoice.
string ("before_current_approver" | "after_current_approver" | "end_of_list" | "watcher")
required
String representation of the approver position. Acceptable values: before_current_approver, after_current_approver, end_of_list, watcher.
integer
required
User ID or UserGroup ID to add as approver.
string ("user" | "UserGroup")
required
Type of approver entity. Acceptable values: user, UserGroup.
integer
Active approver ID. Required when position is ‘before_current_approver’ or ‘after_current_approver’ to specify which approver to add before/after.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_ADD_APPROVER_TO_PO_CHANGE_AFTER_CURRENT_APPROVERManually add a user or user group to a purchase order change approval chain at a selected position, including after the current approver.

Input Parameters

integer
required
Coupa internal ID of the purchase order change
string ("before_current_approver" | "after_current_approver" | "end_of_list" | "watcher")
required
Position to add the approver in the approval chain. Use ‘after_current_approver’ to add after current approver.
integer
required
The ID of the user or user group to add as approver.
string ("user" | "UserGroup")
required
Type of approver entity. Use ‘user’ for a user or ‘UserGroup’ for a user group.
integer
ID of the current active approver. Required when position is ‘before_current_approver’ or ‘after_current_approver’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
File to upload to the project.
string
Designation indicating the intended audience (e.g., ‘Supplier’). Maximum 40 characters
string
Filename when providing base64 content.
string
MIME type (e.g., ‘text/plain’, ‘application/pdf’) when using base64 content
string
Links attachment to specific features. Maximum 255 characters
integer
required
ID of the project to attach the file to
string
Base64-encoded file content.
string
Login of the user to impersonate; sent as ‘x-coupa-api-user-login’ header

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
File to upload to the purchase order.
string
Designation indicating the intended audience (e.g., ‘Supplier’). Maximum 40 characters
string
Links attachment to specific features. Maximum 255 characters
integer
required
ID of the purchase order to attach the file to
string
Login of the user to impersonate; sent as ‘x-coupa-api-user-login’ header

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
File to upload to the purchase order line.
string
Designation indicating the intended audience (e.g., ‘Supplier’). Maximum 40 characters
string
Filename when providing base64 content (e.g., ‘document.pdf’)
string
MIME type when using base64 content (e.g., ‘application/pdf’, ‘image/jpeg’)
string
Base64-encoded file content.
integer
required
ID of the purchase order line to attach the file to
string
Login of the user to impersonate; sent as ‘x-coupa-api-user-login’ header

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
File to upload to the requisition line.
string
Designation indicating the intended audience (e.g., ‘Supplier’). Maximum 40 characters
string
Filename when providing base64 content.
string
MIME type (e.g., ‘text/plain’, ‘application/pdf’) when using base64 content
string
Links attachment to specific features. Maximum 255 characters
string
Base64-encoded file content.
integer
required
ID of the requisition line to attach the file to
string
Login of the user to impersonate; sent as ‘x-coupa-api-user-login’ header

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
File to upload to the comment.
string
Purpose identifier for the attachment (e.g., ‘Internal’, ‘Supplier’). Maximum 40 characters
string
Filename when providing base64 content.
string
MIME type (e.g., ‘text/plain’, ‘application/pdf’) when using base64 content
string
Links attachment to specific features. Maximum 255 characters
integer
required
ID of the comment to attach the file to
string
Base64-encoded file content.
string
Login of the user to impersonate; sent as ‘x-coupa-api-user-login’ header

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_ADD_COAS_ASSIGNED_TO_A_SPECIFIC_SUPPLIER_SITEUpdate a supplier site with assigned Chart of Accounts (account types). Additional supplier site attributes can also be included in the update.

Input Parameters

integer
required
Coupa unique identifier of the supplier site to update.
string
JSON array of fields to return; e.g., [‘id’,‘name’,‘account-types’].
object
Additional supplier site attributes to update directly; keys should use Coupa API hyphenated names.
string
User email or login to perform the action on behalf of. Sent as ‘X-COUPA-ON-BEHALF-OF’ header.
array
required
List of account types (COAs) to assign to the supplier site. Each account type can be referenced by ID or name.
string
Coupa business role to use when acting on behalf of a user. Sent as ‘X-COUPA-BUSINESS-ROLE’.
string
Controls response verbosity: ‘none’, ‘limited’, or ‘shallow’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the purchase order to add a comment to.
string
required
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’).
string
Optional comment reason code for categorization.
boolean
Optional flag indicating whether the comment should be visible to the supplier.
string ("OrderHeader" | "PurchaseOrderHeader")
Type of the commentable object. Use ‘OrderHeader’ for purchase order header-level comments or ‘PurchaseOrderHeader’ for standard PO comments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the contract to which the content group will be added
integer
required
ID of the business group/content group to add to the contract

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the supplier to which the content group will be added
integer
required
ID of the business group/content group to add to the supplier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the contract.
string ("before_current_approver" | "after_current_approver" | "end_of_list" | "watcher")
required
String representation of the approver position. Acceptable values: before_current_approver, after_current_approver, end_of_list, watcher.
integer
required
User ID or UserGroup ID to add as approver.
string
Perform the action on behalf of this user (email or login); sent as X-COUPA-ON-BEHALF-OF header.
string ("user" | "UserGroup")
required
Type of approver entity. Acceptable values: user, UserGroup.
string
Impersonate as the given user email via X-COUPA-API-EMAIL header.
integer
Active approver ID. Required when position is ‘before_current_approver’ or ‘after_current_approver’ to specify which approver to add before/after.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the contract to add the term to.
string
required
Unique name/identifier for the contract term.
string
Discount percentage for tier 1 (decimal as string).
string
Discount percentage for tier 2 (decimal as string).
string
Discount percentage for tier 3 (decimal as string).
string
Discount percentage for tier 4 (decimal as string).
string
Discount percentage for tier 5 (decimal as string).
string
Discount percentage for tier 6 (decimal as string).
string
Discount percentage for tier 7 (decimal as string).
string
Discount percentage for tier 8 (decimal as string).
string
Discount percentage for tier 9 (decimal as string).
string
Discount percentage for tier 10 (decimal as string).
string
Discount percentage for tier 11 (decimal as string).
string
Discount percentage for tier 12 (decimal as string).
string
Discount percentage for tier 13 (decimal as string).
string
Discount percentage for tier 14 (decimal as string).
string
Discount percentage for tier 15 (decimal as string).
string
Discount percentage for tier 16 (decimal as string).
string
Discount percentage for tier 17 (decimal as string).
string
Discount percentage for tier 18 (decimal as string).
string
Discount percentage for tier 19 (decimal as string).
string
Discount percentage for tier 20 (decimal as string).
boolean
Boolean flag indicating whether percentage-based discounts apply.
string
required
Type classification for the contract term. Valid values: PerOrderContractTerm, TotalQtyContractTerm, TotalAmtContractTerm.
string
Upper boundary for tier 1 (decimal as string).
string
Upper boundary for tier 2 (decimal as string).
string
Upper boundary for tier 3 (decimal as string).
string
Upper boundary for tier 4 (decimal as string).
string
Upper boundary for tier 5 (decimal as string).
string
Upper boundary for tier 6 (decimal as string).
string
Upper boundary for tier 7 (decimal as string).
string
Upper boundary for tier 8 (decimal as string).
string
Upper boundary for tier 9 (decimal as string).
string
Upper boundary for tier 10 (decimal as string).
string
Upper boundary for tier 11 (decimal as string).
string
Upper boundary for tier 12 (decimal as string).
string
Upper boundary for tier 13 (decimal as string).
string
Upper boundary for tier 14 (decimal as string).
string
Upper boundary for tier 15 (decimal as string).
string
Upper boundary for tier 16 (decimal as string).
string
Upper boundary for tier 17 (decimal as string).
string
Upper boundary for tier 18 (decimal as string).
string
Upper boundary for tier 19 (decimal as string).
string
Upper boundary for tier 20 (decimal as string).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa internal ID of the purchase order to update
array
required
List of order lines with allocations to add to the PO

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
City name (max 255 characters, required)
string
required
Address nickname/identifier (max 255 characters, required)
string
required
State abbreviation (max 255 characters, required)
boolean
Activation status; ‘true’ makes address available to users (optional, defaults to true)
object
required
Country reference containing code or name (required). Must already exist in the system.
string
required
Primary street address line (max 255 characters, required)
string
Secondary street address line (max 255 characters, optional)
string
Third street address line (max 255 characters, optional)
string
Fourth street address line (max 255 characters, optional)
string
Address default attention line (max 255 characters, optional)
string
VAT identifier (max 255 characters, optional)
string
required
Postal/ZIP code (max 255 characters, required)
object
Reference to a country object.
string
Location code identifier (max 255 characters, optional)
string
ISO state code format: CC-SSS (max 255 characters, optional)
string
External Source Reference (max 255 characters, optional)
string
Local tax identifier (max 255 characters, optional)
string
External Source Name (max 255 characters, optional)
string
Content Group Name for Address (max 255 characters, optional)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_ADDRESSES_INDEXTool to list addresses from Coupa. Use when you need paginated address records for processing.

Input Parameters

string
JSON array of fields to return; e.g., [“id”,“city”,“state”].
integer
Pagination offset; results are returned in batches of up to 50.
string
Response size control: ‘limited’ returns only IDs; ‘shallow’ returns full object attributes with one-level association IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the supplier information record to which the content group will be added
integer
required
ID of the business group/content group to add to the SIM record

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the supplier information site to which the content group will be added
integer
required
ID of the business group/content group to add to the SIM site

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the supplier site to which the content group will be added
integer
required
ID of the business group/content group to add to the supplier site

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_ADD_USER_TO_A_GROUPUpdate an existing user group or project membership by membership ID, specifying the user, group, and owner and participant statuses.

Input Parameters

boolean
required
Indicates admin status for the membership.
string
JSON array of fields to return; e.g., [‘id’,‘user-id’,‘user-group-id’].
integer
required
User identifier to add to the group.
boolean
required
Indicates participant status for the membership.
string
User email or login to perform the action on behalf of. Sent as ‘X-COUPA-ON-BEHALF-OF’ header.
string
Coupa business role when acting on behalf of a user. Sent as ‘X-COUPA-BUSINESS-ROLE’.
integer
required
Coupa unique identifier for the user group membership to update.
string ("none" | "limited" | "shallow")
Controls response verbosity: ‘none’, ‘limited’, or ‘shallow’.
integer
required
User group ID or Project ID to add the user to.
string ("UserGroup" | "Project")
required
Type of the group: ‘UserGroup’ or ‘Project’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_ANNOUNCEMENTS_INDEXTool to list all announcements from Coupa. Use when you need to retrieve multiple announcements with optional pagination and filters.

Input Parameters

integer
Maximum number of records to return (1-50, default 50)
string
JSON array of fields to return; e.g., [“id”,“subject”,“message”]
integer
Number of records to skip for pagination; results are returned in pages up to 50
object
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’}
string
Field name to sort results by
string
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns full object attributes with one-level association IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_ANNOUNCEMENTS_SHOWTool to retrieve a specific announcement by ID from Coupa Mobile. Use when you need detailed information about an announcement.

Input Parameters

integer
required
The Coupa unique identifier for the announcement

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_APPROVALS_APPROVETool to approve a pending approval record. Use when you need to programmatically approve a pending approval by ID.

Input Parameters

integer
required
ID of the approval to approve
integer
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_APPROVALS_HOLDTool to place an approval on hold. Use when you need to pause approval workflow temporarily.

Input Parameters

integer
required
ID of the approval to place on hold
string
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.
integer
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_APPROVALS_INDEXTool to list approvals with optional pagination and filters. Use when you need to retrieve multiple approval records.

Input Parameters

integer
Maximum number of records to return (1-50).
string
JSON array of fields to return; e.g., [‘id’,{‘approver’:[‘id’,‘login’]}]
integer
Number of records to skip for pagination (default 0).
object
Additional attribute filters using Coupa syntax. Example: {‘status’:‘approved’,‘created-at[gt]’:‘2023-01-01T00:00:00Z’}
string
Response verbosity: ‘limited’ or ‘shallow’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_APPROVALS_REJECTTool to reject an approval. Use when you need to programmatically reject a pending approval by ID.

Input Parameters

integer
required
ID of the approval to reject
string
Additional note to include in the body of the rejection
string
Rejection reason as query parameter

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Filter by specific budget line ID
integer
Limit number of results returned. Recommended for large data sets.
string
JSON array of fields to return; e.g., [“id”,“amount”,“description”]
integer
Pagination offset; results are returned in pages
string
Sort results by specified field
string
Filter by period name (e.g., Q3FY09)
string
Filter by budget owner’s last name
boolean
Filter by period open status
boolean
Filter by owner approver status
string
Filter by account type name within period

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Exact-match filter by Coupa ID
integer
Pagination offset; results are returned in pages of up to 50
string
Return groups created after this ISO-8601 timestamp
string
Filter groups whose name contains the given text

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the business group to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa’s internal ID for the order header confirmation to accept

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa’s internal ID for the order header confirmation to reject
string
Simple rejection comment. If provided, will be used to create a reason insight event.
array
Reason insight events documenting the rejection. At least one event with a comment is recommended.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the invoice to bypass all approvals for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the invoice to bypass current approval for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa internal ID of the external purchase order to cancel

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa internal ID of the purchase order to close
integer
Reference to reason insight for the close action
string
Code identifying the reason for closing
string
Comment explaining why the PO is being closed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa internal ID of the contract to complete
array
JSON array of specific fields/associations to include in the response. Example: [‘id’,‘status’]
integer
Impersonate as the given user id via X-COUPA-API-USER-ID header.
string
Perform the action on behalf of this user (email or login); sent as X-COUPA-ON-BEHALF-OF header.
string
Coupa business role to use when acting on behalf of a user; sent as X-COUPA-BUSINESS-ROLE header.
string ("none" | "limited" | "shallow")
Controls response verbosity: ‘none’, ‘limited’, or ‘shallow’
string
Impersonate as the given user email via X-COUPA-API-EMAIL header.
string
Impersonate as the given user login via X-COUPA-API-USER-LOGIN header.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The name of the content group (max 100 characters)
string
A text description of the content group’s purpose (max 255 characters)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_CONTENT_GROUPS_UPDATEUpdate the name or description of an existing Coupa content group (business group) by ID. You can choose the level of detail returned.

Input Parameters

integer
required
Coupa unique identifier of the business group to update
string
The name of the content group. Must be unique.
string
A text description of the content group’s purpose. Must be unique.
string ("none" | "limited" | "shallow")
Controls response format: ‘none’ (nothing returned), ‘limited’ (only IDs returned), ‘shallow’ (all attributes plus IDs of associations)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_CONTRACTS_ATTACHMENTS_CREATETool to create an attachment on a contract. Use when attaching files, text, or URLs to contracts.

Input Parameters

string
URL for URL attachments. Required when type=‘url’
object
File to upload. Required when type=‘file’
string
Text content for text attachments. Required when type=‘text’
string ("file" | "text" | "url")
required
Type of the attachment. ‘file’, ‘text’, or ‘url’
string
Designation indicating the intended audience (e.g., ‘Supplier’)
string
Links attachment to specific features like ‘quote_request_attachment’ or ‘event_terms’
integer
required
ID of the contract to attach the file to
string
Login of the user to impersonate; sent as ‘x-coupa-api-user-login’ header

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_CONTRACTS_INDEXTool to list contracts. Use when you need contract IDs and metadata for subsequent actions, e.g., adding an approver.

Input Parameters

string
JSON array of fields to return; e.g., [‘id’,‘number’,{‘supplier’:[‘id’,‘name’]}].
integer
Pagination offset for contract list in multiples of 50 (default 0).
object
Attribute filters using Coupa syntax. Example: {‘status’:‘active’, ‘supplier[name]’:‘SomeSupplier’}.
string ("limited" | "shallow")
Response verbosity control: ‘limited’ returns only IDs; ‘shallow’ returns one-level associations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the contract to update.
string
Contract name.
string
JSON array of fields to return; e.g., [‘id’,‘name’,{‘supplier’:[‘id’,‘name’]}].
string
Contract number.
string ("published" | "inactive" | "draft")
Status of the contract.
object
Additional contract attributes to update directly; keys should use Coupa API hyphenated names.
object
Contract currency code reference, e.g., {‘code’: ‘USD’}.
string
Expire date of the contract in ISO 8601 format (YYYY-MM-DD).
object
Supplier information reference, e.g., {‘id’: 2} or {‘name’: ‘Amazon.com’}.
object
Department information reference, e.g., {‘id’: 4}.
string
Start date of the contract in ISO 8601 format (YYYY-MM-DD).
string
Descriptive notes about the contract.
string
Savings percentage (decimal).
string
User email or login to perform the action on behalf of. Sent as ‘X-COUPA-ON-BEHALF-OF’ header.
object
Payment term code on contract, e.g., {‘code’: ‘Net 30’}.
string
Coupa business role when acting on behalf of a user. Sent as ‘X-COUPA-BUSINESS-ROLE’.
object
Contract type reference, e.g., {‘id’: 1}.
string
Maximum commit amount (decimal 32,4).
string
Minimum commit amount (decimal 32,4).
string ("none" | "limited" | "shallow")
Controls response verbosity: ‘none’, ‘limited’, or ‘shallow’.
array
Business groups associated with the contract, e.g., [{‘id’: 1}].
object
Contract owner user reference, e.g., {‘id’: 5}.
object
Contract terms reference, e.g., {‘id’: 3}.
string
Contract execution date in ISO 8601 format.
string
Contract published date in ISO 8601 format.
string
Supplier account number.
boolean
Enable order windows.
URL to the legal agreement document.
boolean
Default contract on unbacked lines.
boolean
Allow supplier to invoice directly.
boolean
Stop spend when contract value is exceeded.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_CONTRACT_TEMPLATE_DESTROYTool to delete a contract template. Use when you need to permanently remove a contract template by ID.

Input Parameters

integer
required
Contract template ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the account type to copy

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Identifies if this is a local tax number designation
boolean
Indicates registration status (active/inactive)
string
required
Tax identification number - the primary tax ID for the registration
object
required
Country object with ID for tax jurisdiction
integer
Links to parent supplier information record
integer
Associates with primary address ID (address must exist with primary designation)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Additional notes or comments for the budget line.
object
required
Owner reference with firstname, lastname, and login.
number
required
Budget amount for this line.
object
required
Budget period reference with name field.
string
First account segment value (e.g., location, department).
string
Second account segment value (e.g., cost center, category).
string
Third account segment value (e.g., expense type).
string
required
Description of the budget line explaining its purpose.
boolean
Whether the owner is an approver for this budget line.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Currency for the adjustment. Must have active status in Coupa.
string
Optional description text explaining the reason for the adjustment (max 255 characters).
object
Budget period reference for the adjustment.
object
Budget segment reference for the adjustment.
integer
required
The ID of the budget line to adjust. Must be an existing budget line in Coupa.
number
required
The budget line adjustment amount to be applied. Can be positive (increase) or negative (decrease).
object
Chart of accounts reference for the adjustment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Entity name (required, max 100 characters, must be unique)
string ("LegalBusinessEntity" | "OrganizationalBusinessEntity")
Business entity type enumeration.
string
Current operational status of the entity
string
Human-readable display name (max 100 characters)
string ("Organization" | "Person")
Formation type enumeration.
object
Model for primary address in request.
object
Model for primary contact in request.
string
Country code where the entity was established

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_CREATE_COMMENT_ON_TRANSACTIONAL_OBJECTCreate a comment on a supported transactional object, such as a requisition, purchase order, invoice, expense report, contract, or receipt. Comments can include notes, feedback, or user mentions.

Input Parameters

string
required
The comment text to add to the object. You can include user mentions using @[User:{user_id}] format (e.g., ’@[User:2] please review’).
integer
required
The ID of the object to comment on.
string ("requisitions" | "purchase_orders" | "invoices" | "invoice_headers" | "expense_reports" | "contracts" | "receipts" | "requisition_headers" | "order_headers")
required
The type of object to comment on (e.g., requisitions, purchase_orders, invoices, invoice_headers, expense_reports, contracts, receipts).
string
Optional comment reason code for categorization.
boolean
Optional flag indicating whether the comment should be visible to the supplier.
string ("RequisitionHeader" | "Requisition" | "OrderHeader" | "InvoiceHeader" | "ExpenseReport" | "ExpenseReportHeader" | "Contract" | "Receipt")
required
The type of object being commented on (e.g., RequisitionHeader, OrderHeader, InvoiceHeader). This must match the object_type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Commodity name (required, must be unique, max 255 characters)
boolean
Status flag - true makes it available to users, false inactivates it
object
Reference to a parent commodity.
string ("goods" | "services" | "monetary" | "others")
required
Commodity category - must be one of: goods, services, monetary, or others
string ("Yes" | "No" | "Automatic" | "Always" | "Never")
Preferred options for commodities.
string ("raw_materials" | "investment_goods" | "services_exceptions")
Subcategory options for commodities.
string ("fully_deductible" | "partially_deductible" | "not_deductible")
required
Deductibility level - must be one of: fully_deductible, partially_deductible, or not_deductible
string
Localized name variant for the commodity
boolean
Indicates if sourced from Coupa’s taxonomy

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_CREATE_EXTERNAL_PURCHASE_ORDERTool to create an external purchase order. Use when integrating external POs via Coupa API.

Input Parameters

string
Type of order; must be ‘ExternalOrderHeader’
object
Currency reference - provide code.
object
required
Supplier reference for the PO
string
required
External PO number (max 20 characters)
array
required
List of order line items
object
Payment term reference - provide the Coupa internal payment term ID.
object
User reference - provide one of id, login, or email.
object
Shipping term reference - provide the Coupa internal shipping term ID.
object
Supplier site reference - provide the Coupa internal supplier site ID.
string ("msp" | "supplier" | "vms")
Classification of order: msp, supplier, or vms
string
Payment method
object
Address reference - provide id.
string
Ship-to attention text
string
Comma-separated transmission emails
string ("supplier_default" | "email" | "do_not_transmit")
Override transmission method: supplier_default, email, or do_not_transmit

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

number
required
Exchange rate value for converting from source to target currency
string
required
Effective date for this exchange rate in format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS
object
required
Target currency reference with code
object
required
Source currency reference with code

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Status of the integration error (e.g., error, warning)
array
required
List of IntegrationRecordResponse objects containing error codes and messages
integer
required
ID of the document associated with the error
string
required
External identifier for the error record
object
required
Reference to the integration resource (requires integration id)
string
required
Type of document (e.g., User, OrderHeader, InvoiceHeader, RequisitionHeader)
string
required
Method used to create the error (e.g., api, ui)
string
required
Status of the document (e.g., failed, pending)
integer
required
Revision number of the document
string
required
Type of contact alert (e.g., error, warning)
integer
required
ID of the integration run that generated this error
string
required
Filename of the integration file

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
ISO 8601 timestamp when the run starts. Leave empty to default to current time.
integer
Total number of records intended for this run.
integer
Coupa internal ID of the integration. Provide either integration_id or integration_code.
string
Unique integration code. Provide either integration_code or integration_id.
integer
Number of records processed so far in this run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Administrative notes (max 255 characters)
object
required
Currency of the invoice transaction
object
required
Supplier reference for the invoice
string
Header-level tax charge (decimal string)
string
required
Invoice date in YYYY-MM-DD format (DATE ONLY, without timestamp)
object
Payment term reference. Provide id or code.
string
Internal confidential notes
array
required
List of invoice line items linked to PO lines
string
required
Invoice identification code (max 40 characters)
string
Invoice discount reduction (decimal string)
string
Processing surcharge (decimal string)
string
Transportation surcharge (decimal string)
boolean
Whether tax is computed per line (true) or at header level (false)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_CREATE_ITEMS_SUPPLIER_ITEMSCreate a supplier item associated with a catalog item, with pricing and optional availability details. If the response body is empty, the returned ID is the parent item ID, not a confirmed supplier-item ID.

Input Parameters

integer
required
The item ID to which the supplier item will be associated
object
required
Item reference object with ‘id’ or ‘name’, e.g., {‘id’: 21}
string
required
Price for the supplier item as a decimal string
object
Related contract reference, e.g., {‘id’: 10} or {‘name’: ‘Contract Name’}
object
required
Currency object reference with ‘code’ or ‘id’, e.g., {‘code’: ‘USD’} or {‘id’: 1}
object
required
Supplier reference object with ‘id’ or ‘number’, e.g., {‘id’: 13} or {‘number’: ‘SUP-001’}
integer
Lead time in days
boolean
required
Whether this is a preferred supplier for the item
boolean
Whether the item is purchasable
string
UNSPSC classification code
string ("in_stock" | "out_of_stock" | "backordered")
Stock status: in_stock, out_of_stock, or backordered
string
Manufacturer name
string
User email or login to perform the action on behalf of. Sent as ‘X-COUPA-ON-BEHALF-OF’ header.
string
Coupa business role to use when acting on behalf of a user. Sent as ‘X-COUPA-BUSINESS-ROLE’.
string ("none" | "limited" | "shallow")
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.
string
Order increment value as a decimal string
string
Date of availability change in ISO 8601 format (YYYY-MM-DDTHH:MM:SS+HH:MM)
string
required
Supplier’s part number
string
Auxiliary part number for the supplier
string
Minimum order quantity as a decimal string

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The lookup value identifier
boolean
Boolean status indicating if the lookup value is active
object
required
Parent lookup reference (provide id or name)
string
Detailed description of the lookup value
string
External reference number
string
External reference code

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
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.
integer
required
The identifier of the Custom Object for which to create an instance (path parameter)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Payment note (alternate field). Optional.
string
Payment notes or comments. Optional.
string
Amount value (decimal string). Optional.
string
required
Category classification for the reconciliation line. Required. Use ‘payment’ for standard payment reconciliation.
integer
required
Unique identifier of the payable (e.g., order or invoice ID).
string
required
Amount paid for this reconciliation line (decimal string).
string
required
Type of payable (e.g., ‘OrderHeader’, ‘InvoiceHeader’).
string
required
Payment date in ISO 8601 format (YYYY-MM-DDTHH:MM:SS±HH:MM).
string
Adjustment date in ISO 8601 format (YYYY-MM-DDTHH:MM:SS±HH:MM). Optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique identifier for the payment term
string ("DaysAfterNetPaymentTerm" | "SpecificDayPaymentTerm" | "DaysToBaseEomPaymentTerm" | "BaseEomToDaysPaymentTerm")
required
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.
boolean
Status flag; true activates the term making it available to users, false inactivates it
string
Description of the payment term
integer
Determines the document’s payment due date (1-31). Used with SpecificDayPaymentTerm type.
number
Discount rate percentage (as decimal, e.g., 0.02 for 2% discount)
integer
Determines the document’s payment due date along with net-due-day (0-6 months offset)
integer
Documents before this day are eligible for net payment in current month, otherwise fall into next month (1-31)
integer
Used to calculate the document’s discount due date (1-31)
integer
Used to calculate the document’s discount due date along with discount-due-day (0-6 months offset)
integer
Documents before this day are eligible for discount, otherwise fall into next month (1-31)
integer
required
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).
integer
required
Number of days for discount payment calculation. Set to 0 if no discount is offered.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project name (required, max 255 characters)
boolean
Whether the project is open for everyone to join or owner must invite others
array
List of users associated with the project
boolean
Whether the project is active
string
Project status (e.g., draft, active, completed)
string
required
Project end date in ISO format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS+HH:MM)
object
Reference to a Coupa commodity.
string
required
Project start date in ISO format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS+HH:MM)
string
Project description
string
Mention name for the project
array
List of content groups for the project
integer
Completion percentage (0-100)
string
External reference number to sync with 3rd party Project ID
string
Additional planned savings amount
integer
Member visibility control (0 or 1)
boolean
Provide warning if task dates fall outside project dates
string
Additional realized savings amount
boolean
Show sourcing rollup fields if enabled
boolean
Show contracts rollup fields if enabled
boolean
Show suppliers rollup fields if enabled
string
Additional negotiated savings amount

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
required
Whether the user should be a project owner/administrator. Owners have elevated privileges to manage the project
integer
required
The ID of the user to add as a project member
integer
required
The ID of the project to add the member to
boolean
required
Whether the user should be a participant in the project. Participants can collaborate on project activities

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The quote request ID to create a task for
string
required
The task title
string
Task status
string
Task due date in ISO format
integer
Task duration in days
integer
required
Task completion percentage (0-100)
string
Task start date in ISO format
string
Task description
object
Attributes specific to sourcing event tasks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_CREATE_REQ_ASSIGNMENT_TO_USERCreate a requisition assignment to a user. The assignment request does not specify a role.

Input Parameters

integer
required
The ID of the user to assign to the requisition.
string
The type of assignee. Must be ‘User’.
integer
required
The ID of the requisition to assign the user to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

number
Tax rate as a percentage (e.g., 8.5 for 8.5%)
number
Tax amount to be applied
object
Reference to a Chart of Accounts entry.
object
Reference to a tax code.
string
Description of the tax line
integer
required
ID of the requisition line to add the estimated tax line to
number
Base amount on which tax is calculated

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_CREATE_REQUISITION_LINES_MULTIPLE_ESTIMATED_TAX_LINESUpdate a requisition line, including multiple estimated tax lines and other line attributes; the Chart of Account must have estimated taxes enabled. Coupa error details may be returned in the response.

Input Parameters

number
Total amount for the line item.
object
Additional requisition line attributes to update. Keys should use Coupa API hyphenated names.
number
Quantity for the line item.
number
Unit price for the line item.
string
Line item description.
integer
required
The requisition line ID to update.
array
List of estimated tax lines to add to the requisition line.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Supplier reference. Provide exactly one of: id, name, or number to identify the supplier.
number
First custom numeric field for GRC data (decimal with up to 4 decimal places)
number
Second custom numeric field for GRC data (decimal with up to 4 decimal places)
number
Third custom numeric field for GRC data (decimal with up to 4 decimal places)
number
Fourth custom numeric field for GRC data (decimal with up to 4 decimal places)
number
Fifth custom numeric field for GRC data (decimal with up to 4 decimal places)
number
Sixth custom numeric field for GRC data (decimal with up to 4 decimal places)
number
Seventh custom numeric field for GRC data (decimal with up to 4 decimal places)
number
Eighth custom numeric field for GRC data (decimal with up to 4 decimal places)
number
Ninth custom numeric field for GRC data (decimal with up to 4 decimal places)
number
Tenth custom numeric field for GRC data (decimal with up to 4 decimal places)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Status of the SIM record. For shell records, this should be ‘approved’.
boolean
Exported flag. Set to true to mark the shell SIM record as exported.
object
required
Reference to the existing supplier by ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique supplier site code identifier (max 20 characters)
string
required
Supplier information site name (max 255 characters)
boolean
Whether the site is active
array
Array of contact references for the site
string
PO destination URL for cXML transmission (max 255 characters)
string
Email destination for email-based POs (max 255 characters)
array
Array of address references for the site
string
Purchase order transmission method (max 255 characters)
boolean
Hold all POs for buyer review
string
From domain identifier for cXML (max 255 characters)
string
Shared authentication secret for cXML (max 255 characters)
string
From identity value for cXML (max 255 characters)
string
Transmission protocol specification for cXML (max 255 characters)
array
Array of content group references to assign to the site
string
Default locale for supplier communications (max 255 characters)
string
SSL version for cXML communication (max 255 characters)
string
PO change transmission method (max 255 characters)
string
Username for supplier’s online store (max 255 characters)
boolean
Ignore SSL certificate mismatch errors
string
To supplier domain for cXML (max 255 characters)
integer
Enable supplier change requests (integer value)
string
To supplier identity for cXML (max 255 characters)
integer
required
ID of the supplier information record under which the site will be created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique supplier site code identifier (max 20 characters)
string
required
Supplier information site name/designation (max 255 characters)
boolean
Site operational status (true=active, false=inactive)
array
Supplier information site contacts collection
string
Destination for PO transmission via cXML
string
Email recipient when transmission method is ‘email’
array
Supplier information site addresses collection
string
Purchase order transmission method (e.g., ‘email’, ‘cxml’)
boolean
When true, hold all POs for buyer review
string
cXML ‘From’ domain identifier
string
Shared authentication credential for cXML
object
Reference to a payment term.
string
cXML ‘From’ identity value
string
Transmission protocol specification
object
Reference to a shipping term.
array
Content grouping collection for visibility control
string
Default locale for sending emails to this supplier site
string
SSL version for cXML communication
string
PO change transmission method
string
Online store access credential
boolean
SSL certificate validation override setting
string
cXML ‘To’ supplier domain
integer
Allows suppliers to create change requests from CSP
string
cXML ‘To’ supplier identity
integer
ID of the parent supplier information record to link this site to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Catalog item reference with id.
number
required
Price of the supplier item (decimal value).
object
Contract reference for the supplier item.
object
required
Currency information with either id or code.
object
required
Supplier reference with either id or number.
integer
Lead time in days.
boolean
required
Flag to mark this supplier item as preferred.
string
UNSPSC classification code.
string
Manufacturer name.
number
Order increment value.
string
required
Supplier’s part number for the item.
string
Auxiliary part number from the supplier.
number
Minimum order quantity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_CREATE_SUPPLIER_REMIT_TO_ADDRESSCreate a remit-to address for an existing supplier in Coupa. When the response body is empty, the returned ID is the placeholder -1, not the address ID.

Input Parameters

string
required
City name (max 255 characters).
string
required
Name/description of the remit address (max 255 characters).
string
required
State/province abbreviation (max 255 characters).
boolean
required
Status flag (true for active, false for inactive).
object
required
Country information containing country name.
string
required
Primary street address line (max 255 characters).
string
Secondary street address line (max 255 characters).
string
Third street address line (max 255 characters).
string
Fourth street address line (max 255 characters).
string
Tax identification number (max 255 characters).
string
required
Postal/zip code (max 255 characters).
integer
required
Coupa unique identifier of the supplier.
string
required
Unique code identifying the remit address (max 255 characters).
string
Controls response format. Values: ‘none’ (no response body), ‘limited’ (only IDs), ‘shallow’ (full object with limited nested data).
string
Company registration number (max 255 characters).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Supplier site code identifier; must be unique within the supplier context
string
required
Supplier site name
boolean
Activation status; defaults to true if not provided
array
Supplier site contact information
string
Required if po-method = cxml
string
Email address for purchase orders. Required if po-method is ‘email’.
array
Supplier site addresses
string ("cxml" | "xml" | "email" | "prompt" | "mark_as_sent" | "buy_online")
required
Purchase order transmission method. Required field.
boolean
Holds all POs for buyer review
string
Required if po-method = cxml
string
Required if po-method = cxml
integer
required
Coupa unique identifier of the supplier to add the site to
object
Reference to an existing Coupa Payment Term.
array
Associated account types
string
Required if po-method = cxml
string
Required if po-method = cxml
object
Reference to an existing Coupa Shipping Term.
array
Controls visibility; defaults to Everyone if omitted
string
Locale for supplier emails
string
Default payment method
string
SSL version: TLSv1_2, TLSv1_1, or TLSv1
string ("cxml" | "xml" | "email" | "prompt" | "mark_as_sent" | "buy_online")
Purchase order change transmission method
string
cXML HTTP username
boolean
Ignores SSL certificate mismatches
string
Required if po-method = cxml
boolean
Enables suppliers to create change requests via CSP
string
Required if po-method = cxml
integer
Permits item substitutions on order confirmations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Supplier name (required, unique, max 100 characters).
string
Supplier identifier/code (optional, unique).
string
Supplier status. Defaults to ‘draft’ if not specified. Options: active, draft, etc.
string
Tax identification number.
string
PO email address (required if po-method=email).
string
Purchase order transmission method. Options: cxml, xml, email, prompt, mark_as_sent, buy_online.
string
Account number with this supplier.
object
Model for primary address details.
object
Model for primary contact details.
string
Purchase order change transmission method. Options: cxml, xml, email, prompt, mark_as_sent, buy_online.
string
Invoice matching level. Options: 2-way, 3-way, 3-way-direct, none.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Task name (required, max 255 characters)
string
Task status (e.g., ‘open’, ‘in_progress’, ‘completed’)
string
Due date in format YYYY-MM-DDTHH:MM:SS+HH:MMZ (e.g., 2024-12-31T23:59:59+00:00Z)
number
Task duration (non-negative float)
integer
User ID assigned to task. Either owner-id OR (linkable-id + linkable-type) must be provided.
integer
Completion percentage (0-100)
string
Start date in format YYYY-MM-DDTHH:MM:SS+HH:MMZ (e.g., 2024-01-01T00:00:00+00:00Z)
string
Detailed task description
integer
ID of associated UserGroup or Project. Required with linkable-type if owner-id is not provided.
string
Link type: ‘UserGroup’ or ‘Project’. Required with linkable-id if owner-id is not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Task title (required, max 255 characters)
string
Task status (e.g., pending, in_progress, completed)
string
Task due date in ISO format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS+HH:MM)
number
Task duration in days
integer
ID of the user who owns this task
integer
Task completion percentage (0-100). Defaults to 0 if not specified.
integer
required
ID of the project to create the task under
string
Task start date in ISO format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS+HH:MM)
string
Task description providing details about what needs to be done

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
City name.
string
required
Address ‘Nickname’ or label to identify this address.
string
State abbreviation.
boolean
Set to true to activate address or false to deactivate. Inactive addresses are not available to users.
object
required
Country information. The country must already exist in the Coupa system.
string
required
Address Line 1 (primary street address).
string
Address Line 2 (apartment, suite, unit, etc.).
string
Address Line 3 (additional address information).
string
Address Line 4 (additional address information).
integer
required
The ID of the user for whom the address is being created.
string
Address Default Attention Line / contact person name.
string
VAT number associated with this address.
string
required
Postal/ZIP code.
object
VAT country information for the address.
string
Location code for the address.
string
ISO Code for State in format CC-SSS (e.g., ‘US-CA’ for California).
string
External Source Reference identifier.
string
Local tax number for the address.
string
External Source Name.
string
Content Group Name for Address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The user group identifier (max 255 chars)
boolean
Controls if membership is self-service (true) or invitation-only (false)
string
Designates ‘Project’ or leave blank for standard groups
object
User reference for individual responsible for the group. Should contain user ID, e.g., {‘id’: 123}.
array
Initial member assignments - list of user references with IDs, e.g., [{‘id’: 123}, {‘id’: 456}].
boolean
required
Status indicator for the group - true for active, false for inactive
boolean
Whether the group functions as an approver entity
string
Details about the group’s purpose
string
Handle for group mentions (max 255 chars)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
required
Indicates whether the user is admin or owner of the group
integer
required
User ID to add to the group
boolean
required
Indicates whether the user is a participant in the group
integer
required
User group ID or Project ID
string
required
Type of the group: ‘User Group’ or ‘Project’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
User group ID to create the task for
string
required
Task title (required, max 255 characters)
string
Task status (e.g., pending, in-progress, completed)
string
Due date in ISO format (YYYY-MM-DDTHH:MM:SS+HH:MMZ)
number
Duration value in days
integer
User ID for task assignment
integer
Completion percentage (0 to 100)
string
Start date in ISO format (YYYY-MM-DDTHH:MM:SS+HH:MMZ)
string
Task description providing additional details
object
Extra attributes for sourcing event tasks

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_CURRENCIES_INDEXTool to list currencies from Coupa. Use when you need to retrieve or filter configured currencies before processing.

Input Parameters

integer
Exact-match filter by Coupa currency ID
string
Filter by currency code; supports operators like contains, starts_with, ends_with.
string
Filter by currency name; supports standard operators.
string
JSON array of fields to return; e.g., [“id”,“code”,“name”].
integer
Pagination offset; results are returned in pages of up to 50.
string
Filter by currency symbol; supports standard operators.
integer
Filter by number of decimal places; supports comparison operators (gt, lt, etc.).
boolean
Filter by enabled status (true or false).
string
Response size control: ‘limited’ returns only IDs; ‘shallow’ returns attributes with one-level associations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_CURRENCIES_SHOWTool to retrieve a specific currency by ID. Use when you need detailed information about a currency.

Input Parameters

integer
required
ID of the currency to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Query specific DataFileSource by internal ID
string
Filter by file type (e.g., BackgroundCsvFileLoad, DataFileSource)
string
JSON array of fields to return; e.g., [“id”,“status”,“created_at”]
integer
Pagination offset; Coupa returns maximum 50 records per call
string
Filter by processing status (e.g., Done, Failed, Retrying, Loading, Pending)
string
Filter by object type (e.g., LookupValue, Supplier, Invoice, User)
string
Filter records created after specified timestamp (ISO 8601 format, e.g., ‘2024-01-01T00:00:00Z’)
string
Filter records created before specified timestamp (ISO 8601 format, e.g., ‘2024-12-31T23:59:59Z’)
string
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns full object attributes with one-level associations
string
Search for data file sources for a specific file name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_DEFAULT_RECEIVING_LOCATIONS_INDEXList Coupa default receiving locations associated with items and warehouses. Filter by location, item, warehouse or warehouse location ID, and use an offset to retrieve pages of up to 50 records.

Input Parameters

integer
Exact-match filter by Coupa default receiving location ID
string
JSON array of fields to return; e.g., [“id”,“item-id”,“warehouse-id”]
integer
Pagination offset; results are returned in pages of up to 50
integer
Filter by item ID associated with the receiving location
integer
Filter by warehouse ID associated with the receiving location
string
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns full object attributes with one-level association IDs
integer
Filter by warehouse location ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Tax registration ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the project membership to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the task to be deleted
integer
required
The unique identifier of the project containing the task

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the task to delete from the quote request.
integer
required
The ID of the quote request containing the task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_DELETE_REQUISITION_LINETool to delete a requisition line. Use when you need to permanently remove a requisition line by ID.

Input Parameters

integer
required
Coupa requisition line ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa requisition line ID.
integer
required
Coupa estimated tax line ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier for the contract
integer
required
The unique identifier for the attachment to be removed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The attachment ID to delete
integer
required
The ID of the purchase order from which to delete the attachment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_DELETE_SPECIFIC_REQUISITION_ATTACHMENTDelete a specific requisition attachment using the requisition ID and attachment ID.

Input Parameters

integer
required
ID of the attachment to delete
integer
required
ID of the requisition containing the attachment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the supplier information site to delete
integer
required
The ID of the parent supplier information record

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the department to create
boolean
required
Whether the department is active (true) or inactive (false)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_DEPARTMENTS_SHOWTool to retrieve a single department by ID. Use when you need detailed department information.

Input Parameters

integer
required
Coupa unique identifier for the department
string
JSON array specifying which fields to return in response; e.g., [‘id’,‘name’,‘active’].
string
Response verbosity: ‘limited’ (IDs only) or ‘shallow’ (all attributes plus IDs of associations).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_DEPARTMENTS_UPDATEUpdate an existing Coupa department by ID, including its name, active status or other department properties. Send the attributes to change and optionally control the response detail.

Input Parameters

integer
required
Coupa unique identifier of the department to update.
string
Department name.
boolean
Control whether the Department is Active or Inactive.
string
JSON array of fields to return; e.g., [‘id’,‘name’,‘active’].
object
Additional department properties to update; use Coupa API hyphenated names as keys.
string ("none" | "limited" | "shallow")
Controls response verbosity: ‘none’, ‘limited’, or ‘shallow’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the invoice to dispute. The invoice must be in pending_approval or pending_receipt status.
string
Supplier-facing comment explaining the dispute reason.
string
Controls response format: ‘none’ for no response body, ‘limited’ for IDs only, ‘shallow’ for all attributes (default).
string
required
The dispute reason code. Must correspond to an active dispute reason code in your Coupa instance (e.g., INCORRECT-QUANTITY, PRICING-ERROR).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Easy form response ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_EXCHANGE_RATES_INDEXRetrieve Coupa exchange rates with optional filters for dates, currency codes, or rate values.

Input Parameters

integer
Exact-match filter by Coupa exchange rate ID
string
Filter by exchange rate value. Supports operators like [gt], [lt], [gte], [lte], [eq] in the format: rate[lt]=1
string
JSON array of fields to return; e.g., [“id”,“rate”,“rate-date”].
integer
Pagination offset; results are returned in pages of up to 50.
string
Filter by effective rate date. Supports operators like [gt], [lt], [gte], [lte] in the format: rate-date[gt]=2010-11-11T00:00:00
string
Filter by creation date. Supports operators like [gt], [lt], [gte], [lte] in the format: created_at[gt]=2010-11-15T00:00:00
string
Response size control: ‘limited’ returns only IDs; ‘shallow’ returns attributes with one-level associations; ‘none’ for minimal response.
string
Filter by target currency code (e.g., EUR). Cannot be used simultaneously with from-currency[code].
string
Filter by source currency code (e.g., USD). Cannot be used simultaneously with to-currency[code].

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_EXPENSE_REPORTS_INDEXTool to list expense reports. Use when you need a paginated list of reports with optional filters.

Input Parameters

array
JSON array of fields to return; e.g., [‘id’,‘title’,‘status’].
integer
Pagination offset; Coupa returns up to 50 records per call; use in multiples of 50.
string
Filter by expense report status; operators supported, e.g., status[not_eq]=closed.
boolean
Filter by export status; true for exported reports, false for unexported.
boolean
Control response verbosity; set to false or true (server may ignore unexpected values).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the payables invoice to mark as exported

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the invoice payable to be marked as exported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Exact-match filter by Coupa financial counterparty ID
string
Filter by counterparty name; supports standard operators.
boolean
Filter by active status: true for active counterparties, false for inactive
string
JSON array of fields to return; e.g., [“id”,“abbreviation”,“name”]
integer
Pagination offset; results are returned in pages of up to 50
string
Filter by bank code identifier
string
Filter by SWIFT/BIC code identifier
string
Filter by branch code identifier
string
Filter by counterparty abbreviation; supports Coupa query operators like contains, starts_with, ends_with.
string
Filter records created after this ISO timestamp (YYYY-MM-DDTHH:MM:SS+HH:MM)
string
Filter records created before this ISO timestamp (YYYY-MM-DDTHH:MM:SS+HH:MM)
string
Filter by payment operations usage designation
string
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns full object attributes with one-level association IDs
string
Filter records updated after this ISO timestamp (YYYY-MM-DDTHH:MM:SS+HH:MM)
string
Filter records updated before this ISO timestamp (YYYY-MM-DDTHH:MM:SS+HH:MM)
string
Filter by treasury operations usage designation
string
Filter by Legal Entity Identifier (LEI)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum number of statement records to return.
string
JSON array of fields to return; e.g., [“id”,“name”,“statement-date”].
integer
Pagination offset for statement list.
string
Response verbosity control: ‘limited’ returns only IDs; ‘shallow’ returns one-level associations.
string
Filter by creation date greater than or equal to (ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ).
string
Filter by creation date less than or equal to (ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_GET_ALL_ACTIVE_PICK_LISTSRetrieve Coupa pick lists (fulfillment reservations), optionally filtering by ID, status or export status. Use limit and offset to paginate, with up to 50 records per request.

Input Parameters

integer
Specific pick list ID to retrieve
integer
Number of records per request (max 50, default 50)
string
JSON array of specific fields to return, e.g., [“id”,“status”,“qty-ordered”]
integer
Starting position for pagination
string
Filter by status: ‘active’ or ‘closed’
boolean
Filter by export status
string
Controls response payload size: ‘shallow’ for IDs and natural keys only, ‘limited’ for IDs only, or omit for full response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_GET_ALL_ATTACHMENTS_FOR_A_CONTRACTList attachments linked to a specific contract, with optional pagination.

Input Parameters

integer
Number of attachments to return (max 50, default 50)
integer
Pagination offset for retrieving attachments (standard Coupa pagination)
integer
required
The unique identifier of the contract

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_GET_ALL_ATTACHMENTS_FOR_A_INVOICEList attachments associated with a specific invoice, including file URLs, URLs, or text where returned. Supports pagination.

Input Parameters

integer
Controls the number of records returned per request (default is 50)
string
Selective field specification using JSON structure, e.g., ’[“id”,“file-url”,“type”]’
integer
Specifies the starting position for results
integer
required
The unique identifier of the invoice
string ("limited" | "shallow")
Controls response format. ‘limited’ returns only IDs, ‘shallow’ returns all attributes and IDs of one-deep associations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_GET_ALL_ATTACHMENTS_FOR_A_PURCHASEORDERList attachments linked to a specific purchase order, with optional pagination.

Input Parameters

integer
Number of attachments to return (max 50, default 50)
integer
Pagination offset for retrieving attachments (standard Coupa pagination)
integer
required
The unique identifier of the purchase order

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_GET_ALL_ATTACHMENTS_FOR_A_REQUISITIONList attachments associated with a specific requisition, including file URLs, URLs, or text where returned. Supports pagination.

Input Parameters

integer
Controls the number of records returned per request (default is 50)
string
Selective field specification using JSON structure, e.g., ’[“id”,“file-url”,“type”]’
integer
Specifies the starting position for results
integer
required
The unique identifier of the requisition
string ("limited" | "shallow")
Controls response format. ‘limited’ returns only IDs, ‘shallow’ returns all attributes and IDs of one-deep associations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_GET_ALL_ATTACHMENTS_ON_A_COUPAPAY_CHARGEList attachments associated with a CoupaPay charge, including file URLs, URLs, or text where returned. Supports pagination.

Input Parameters

integer
Controls the number of records returned per request (default is 50)
integer
Specifies the starting position for results
integer
required
The unique identifier of the CoupaPay charge

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_GET_ALL_CHARGES_LINKED_TO_SPECIFIC_STATEMENTRetrieve Coupa charges with optional filtering by statement ID and other criteria. Supports pagination.

Input Parameters

integer
Maximum number of charge records to return.
string
JSON array of fields to return; e.g., [‘id’,‘total’,‘charge-date’].
integer
Pagination offset for charge list.
boolean
Filter charges by export status. Set to false to get unexported charges.
integer
Filter charges by specific statement ID. Returns all charges linked to this statement.
string
Response verbosity control: ‘limited’ returns only IDs; ‘shallow’ returns one-level associations.
boolean
Filter by holding account presence. Set to false to get charges with holding accounts.
string
Filter by document type. Valid values: OrderHeader, CoupaPay::Payment, CoupaPay::PaymentAccount, ExpensePreapproval, Travel::TripBooking.
boolean
Filter for unbacked charges (charges without associated documents). Set to true to get charges with no document type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum number of records to return per call (1-50). Default: 50 records.
string
JSON array of fields to return; e.g., [‘id’,‘payment-batch-id’,‘status’,‘exchange_rate’].
integer
Starting position for retrieving records in subsequent calls (default 0). Example: offset=50 retrieves records 51-100.
string
Filter by payment status. Valid values: draft, approved, payment_initiated, payment_in_progress, completed_successfully, completed_with_errors.
boolean
Filter by export status; e.g., exported=false for unexported payments.
string
Filter by multiple statuses; e.g., status[in]=completed_successfully,completed_with_errors.
string
Filter payments updated after this timestamp (ISO 8601 format: YYYY-MM-DDTHH:MM:SS+HH:MMZ).
integer
required
Payment batch identifier to filter payments (required).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum number of records to return per request. Default is 50, maximum is 50.
boolean
Filter by activation status (true/false).
string
JSON array of specific fields to return in response (e.g., ’[“id”,“code”,“name”]’).
integer
Starting position for result set. Used for pagination (e.g., offset=50 retrieves records 51-100).
string
Field name to sort results by.
integer
required
The ID of the supplier information record to retrieve sites for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Limits the number of records returned (default is 50 if not specified)
string
JSON array of specific fields to return in response for performance optimization; e.g., [“id”,“name”,“code”]
integer
Skips a specified number of records for pagination (e.g., offset=50)
integer
required
The unique identifier of the parent supplier whose sites are to be retrieved

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum number of records to return (1-50).
string
JSON array of fields to return; e.g., [‘id’,‘title’,‘status’].
integer
Pagination offset; results are returned in batches of up to 50.
string
Filter by task status; e.g., ‘pending’, ‘completed’.
integer
Filter tasks by owner user ID.
string
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns full object attributes with one-level association IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum number of records to return (1-50).
string
JSON array of fields to return; e.g., [‘id’,‘title’,‘status’].
integer
Pagination offset; results are returned in batches of up to 50.
string
Filter by task status; e.g., ‘pending’, ‘completed’.
integer
required
The unique identifier of the project whose tasks you want to retrieve
string
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns full object attributes with one-level association IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_GET_APPROVAL_BY_IDRetrieve a specific approval record by ID, including its status, approver details, and the ID and type of the associated approvable. Optional parameters control the fields returned.

Input Parameters

integer
required
The unique Coupa identifier for the approval record
string
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.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_GET_AS_NSRetrieve Coupa advance ship notice (ASN) headers for shipment tracking. Filter by status, dates, supplier, ASN number or export status, and paginate with an offset and a limit of up to 50 records.

Input Parameters

integer
Maximum number of records to return per call. Default: 50 (API enforced maximum).
string
JSON array of fields to return in response; e.g., [“id”,“asn-number”,{“supplier”:[“id”,“name”]}].
integer
Pagination offset to skip records and retrieve subsequent batches.
string
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].
boolean
Filter results by export status.
string
Filter by ASN number. Supports text operators.
string
Filter ASNs created after this timestamp (ISO 8601 format).
string
Filter ASNs created before this timestamp (ISO 8601 format).
string
Response verbosity control: ‘none’ (nothing returned), ‘limited’ (IDs only), ‘shallow’ (all attributes + IDs of associations). Note: Being deprecated in favor of ‘fields’ parameter.
string
Filter by supplier name.
string
Filter ASNs updated after this timestamp (ISO 8601 format).
string
Filter ASNs updated before this timestamp (ISO 8601 format).
string
Filter ASNs created on or after this timestamp (ISO 8601 format).
string
Filter ASNs created on or before this timestamp (ISO 8601 format).
string
Filter ASNs updated on or after this timestamp (ISO 8601 format).
string
Filter ASNs updated on or before this timestamp (ISO 8601 format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the budget line to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_GET_BUDGET_LINE_ADJUSTMENTS_FOR_BUDGET_LINERetrieve a page of budget line adjustments for a specific budget line ID, with optional pagination and response controls.

Input Parameters

integer
Number of records to return per page. Default is 50, maximum is 50 per call
string
JSON array specifying which fields to include in response (e.g., [“id”,“amount”,“description”])
integer
Number of records to skip for pagination (e.g., offset=50 for records 51-100)
string
Field name to sort results by
string
Level of detail in response. Values: ‘shallow’, ‘limited’, ‘none’
integer
required
The unique identifier of the budget line for which to retrieve adjustments

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the budget line containing the adjustment
integer
required
ID of the budget line adjustment to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Exact-match filter by business entity ID.
string
Exact-match filter by business entity name.
string
Filter by business entity type (LegalBusinessEntity or OrganizationalBusinessEntity).
integer
Maximum number of records to return per API call. Default: 50.
string
JSON-formatted array of specific fields to return in response; e.g., [“id”,“name”,“type”].
integer
Number of records to skip for pagination.
string
Filter by business entity status.
string
Field name to sort results by.
string
Return business entities created after this ISO-8601 timestamp.
string
Return business entities created before this ISO-8601 timestamp.
string
Filter business entities whose name contains the given text.
string
Return business entities updated after this ISO-8601 timestamp.
string
Return business entities updated before this ISO-8601 timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Coupa internal ID of the business entity to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_GET_COAS_ASSIGNED_TO_A_SPECIFIC_SUPPLIER_SITERetrieve a supplier site by ID, including its content groups when returned. Use it to view site information and visibility-related content groups.

Input Parameters

integer
required
Coupa unique identifier of the supplier site to retrieve.
string
JSON array of fields to return; e.g., [‘id’,‘name’,‘content-groups’].
string
Response verbosity: ‘limited’ or ‘shallow’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier for the expense report whose comments you want to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_GET_COMMODITYTool to retrieve a specific commodity by ID. Use when you need detailed commodity information.

Input Parameters

integer
required
The unique identifier of the commodity to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the supplier site whose business groups you want to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the contract to retrieve
string
JSON array of fields to return; e.g., [‘id’,‘name’,‘status’,{‘supplier’:[‘id’,‘name’]}].
string
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns one-level associations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique payment identifier
string
Specify specific fields to include in response body (JSON format array)
string
Response verbosity: ‘shallow’ returns limited JSON/XML response instead of entire schema

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_GET_CUSTOM_OBJECT_INSTANCESRetrieve a page of data records for a specified Custom Object in Coupa, with optional filtering and pagination.

Input Parameters

integer
Restricts the number of records returned per API call. Default is 50 records maximum.
string
JSON array specifying which fields to include in the response. Example: [“id”,“created-at”,“updated-at”]. Supports nested objects like {“created_by”:[“id”]}.
integer
Pagination parameter to retrieve subsequent record batches. Example: offset=50 retrieves records 51-100.
string
Specifies the field to sort results by.
string
Controls response structure. Values: ‘limited’ (only IDs) or ‘shallow’ (all attributes plus IDs of associations). Deprecated in favor of ‘fields’ parameter.
integer
required
The unique identifier for the Custom Object definition (required path parameter).
string
Filter instances updated at or after this timestamp (ISO 8601 format).
string
Filter instances updated at or before this timestamp (ISO 8601 format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_GET_CYCLE_COUNTSRetrieve Coupa cycle count records for inventory management. Use offset and limit to paginate, with up to 50 records per page, and optionally select fields or response detail. An empty-body HTTP 403 is returned as an empty list, so an empty result can also indicate an access or feature issue.

Input Parameters

integer
Maximum number of records to return (default: 50, max: 50).
string
JSON array of specific fields to return; e.g., [“id”,“status”,“created-at”]
integer
Pagination offset; results are returned in batches of up to 50.
string
Controls response payload: ‘limited’ (IDs only), ‘shallow’ (all attributes + IDs of associations).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum number of records to return (1-50)
integer
Pagination offset; results are returned in pages up to 50
string
Filter delegations created at or after this timestamp (format: YYYY-MM-DDTHH:MM:SS+HH:MMZ)
string
Filter delegations updated at or after this timestamp (format: YYYY-MM-DDTHH:MM:SS+HH:MMZ)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Filter by department ID
string
Filter departments by exact name match
integer
Maximum number of records to return
boolean
Filter by active status: true for active departments, false for inactive
string
JSON array of fields to return; e.g., [“id”,“name”,“active”]
integer
Pagination offset; skip specified number of records
string
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns all fields with IDs of associations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa’s unique identifier for the exchange rate

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
JSON array of fields to return in response; e.g., [“id”,“source-name”,“source-reference”,“document-number”].
integer
Pagination offset for retrieving records beyond the first 50 (default: 0).
string
Filter by payable status. Values: ‘active’, ‘voided’. Supports operators: [not_eq], [in], [not_in].
string
Sort results by specified field (e.g., ‘document-date’, ‘due-date’).
string
Filter payables by source system name (e.g., ‘SAP’, ‘Oracle’). Supports operators: exact match, [contains], [starts_with], [ends_with].
string
Filter by document type (e.g., ‘Invoice’, ‘CreditMemo’, ‘DebitMemo’).
string
Response verbosity control: ‘none’, ‘limited’, or ‘shallow’. Controls response depth.
string
Filter by document number from source system.
string
Filter by unique reference number from source system. Supports operators: exact match, [contains], [starts_with], [ends_with].
string
Filter payables with due date greater than or equal to this timestamp (ISO 8601 format).
string
Filter payables with due date less than or equal to this timestamp (ISO 8601 format).
string
Filter payables with document date greater than or equal to this timestamp (ISO 8601 format).
string
Filter payables with document date less than or equal to this timestamp (ISO 8601 format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_GET_FAVORITE_ACCOUNTSRetrieve the user’s favorite Coupa accounts, optionally filtering by account ID or code. Use an offset to paginate through pages of up to 50 records, and optionally select fields or response detail. An empty-body HTTP 400 is returned as an empty account list.

Input Parameters

integer
Exact-match filter by Coupa account ID
string
Filter by account code; supports Coupa query operators
string
JSON array of fields to return; e.g., [“id”,“code”,“name”]
integer
Pagination offset; results are returned in pages up to 50
string
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns full object attributes with one-level association IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum number of records to return (1-50).
string
JSON array of fields to return; e.g., [‘id’,‘document-id’,‘status’,‘created-at’].
integer
Number of records to skip for pagination.
object
Additional attribute filters using Coupa syntax. Example: {‘status’:‘success’,‘created-at[gt]’:‘2023-01-01T00:00:00Z’,‘document-type’:‘OrderHeader’}
string
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns full object attributes with one-level association IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa’s unique identifier for the integration run

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_GET_INVENTORY_ADJUSTMENTSRetrieve inventory adjustments from Coupa with optional filtering, pagination, and field selection. An empty response can also mean Coupa returned a 403 with an empty body.

Input Parameters

string
Filter by transaction type.
integer
Maximum number of records to return (default: 50, max: 50).
string
JSON array of specific fields to return; e.g., [“id”,“quantity”,“price”]
integer
Pagination offset; results are returned in batches of up to 50 (offset multiples of 50).
string
Filter by transaction status.
integer
Filter by item ID.
boolean
Filter by export status (true/false).
string
Filter by creation date (ISO 8601 format). Supports operators: [gt], [lt], [gt_or_eq], [lt_or_eq].
string
Filter by update date (ISO 8601 format). Supports operators: [gt], [lt], [gt_or_eq], [lt_or_eq].
string
Filter by account code.
string
Controls response payload: ‘limited’ (IDs only), ‘shallow’ (all attributes + IDs of associations), ‘none’ (nothing returned).
integer
Filter by destination warehouse ID.
string
Filter by transaction date (ISO 8601 format). Supports operators: [gt], [lt], [gt_or_eq], [lt_or_eq].
integer
Filter by source warehouse ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier for the specific comment to retrieve.
integer
required
The unique identifier for the invoice.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the item to retrieve
string ("shallow" | "limited" | "none")
Enum for return_object query parameter values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the item to retrieve the image for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the item to retrieve supplier items for
integer
Maximum number of records to return (default: 50, max: 50).
string
JSON array of fields to return; e.g., [‘id’,‘price’,{‘supplier’:[‘name’]}].
integer
Skip specified number of records for pagination (default: 0).
string
Field name to sort results by.
string ("asc" | "desc")
Sort direction, ‘asc’ for ascending or ‘desc’ for descending.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum number of records to return (default: 50, max: 50).
string
JSON array of fields to return; e.g., [‘id’,‘price’,{‘supplier’:[‘name’]}].
integer
Skip specified number of records for pagination (default: 0).
integer
required
The ID of the item
string
Field name to sort results by.
string ("asc" | "desc")
Sort direction, ‘asc’ for ascending or ‘desc’ for descending.
integer
required
The ID of the supplier item associated with the item

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier for the lookup value
string
JSON array of fields to return in response body; e.g., [“id”,“name”,“active”]
string
Controls response payload size: ‘limited’ returns only IDs, ‘shallow’ returns all attributes and IDs of one-deep associations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
JSON array of desired response fields; e.g., [“id”,“amount”,“quantity”,“invoice_line_id”].
integer
Pagination offset for retrieving records beyond initial set (default 0, returns 50 records per call).
string ("none" | "limited" | "shallow")
Controls response payload size: ‘none’ for minimal data, ‘limited’ returns IDs only, ‘shallow’ returns full attributes with association IDs.
integer
Filter by specific invoice line ID to get matching allocations for that invoice line.
string
Filter by comma-separated list of invoice header IDs to get matching allocations for invoice lines belonging to those headers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the order pad to retrieve lines for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the payable invoice to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Filter by specific payable ID; supports operators [gt], [lt], [gt_or_eq], [lt_or_eq], [in].
integer
Filter payables with ID greater than this value.
integer
Filter payables with ID less than this value.
integer
Maximum number of records to return per request (default: 50, max: 50).
string
JSON array of fields to return; e.g., [“id”,“status”,“payable-amount”] or with nested: [“id”,“status”,{“currency”:[“id”,“code”]}].
integer
Number of records to skip for pagination.
string
Filter by payable status; supports operators like [in], [not_in], [eq], [not_eq]. Example: ‘pending’ or use status_in for multiple values.
string
Filter by multiple statuses (comma-separated); e.g., ‘pending,approved’.
integer
Filter by currency ID.
string
Filter by associated document ID.
string
Filter payables created after this timestamp (ISO 8601 format).
string
Filter payables created before this timestamp (ISO 8601 format).
string
Filter by document type (e.g., ‘invoice’).
string
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns attributes with first-level IDs.
string
Filter payables updated after this timestamp (ISO 8601 format).
string
Filter payables updated before this timestamp (ISO 8601 format).
string
Filter payables with maturity date (payment due date) after this timestamp (ISO 8601 format).
string
Filter payables with maturity date (payment due date) before this timestamp (ISO 8601 format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum number of invoices to return for pagination.
string
Comma-separated list of fields to return; e.g., “id,status” or “id,status,invoice_number”.
integer
Pagination offset for invoice list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
JSON array of fields to return; e.g., [‘id’,‘status’,{‘reconciliation-lines’:[‘id’]}].
integer
Pagination offset; results are returned in batches of up to 50 (offset multiples of 50).
boolean
Filter by export status; e.g., exported=false to fetch unexported orders.
string ("limited" | "shallow")
Response verbosity control: ‘limited’ returns only IDs; ‘shallow’ returns one-level associations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa’s internal ID for the order header confirmation
array
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.
string ("limited" | "shallow")
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
JSON array of fields to return; e.g., [“id”,“status”,“exported”].
integer
Pagination offset; results are returned in batches of up to 50 (offset multiples of 50).
string
Filter confirmations created after this timestamp (ISO 8601 format).
string
Filter confirmations created before this timestamp (ISO 8601 format).
string
Response size control: ‘limited’ returns only IDs; ‘shallow’ returns all attributes with IDs of one-level associations.
string
Filter confirmations updated after this timestamp (ISO 8601 format).
string
Filter confirmations updated before this timestamp (ISO 8601 format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The line number to filter by (e.g., ‘1’, ‘2’)
integer
required
The purchase order header ID to filter by

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Filter by specific project membership ID
integer
Maximum number of records to return (1-50). Default is 50
boolean
Filter by owner status (admin status). Set to true to get only owner memberships, false for non-owners
string
JSON array of specific fields to return; e.g., [“id”,“user-id”,“project-id”,“owner”]
integer
Number of records to skip for pagination (default 0)
integer
Filter by specific user ID to get memberships for that user
integer
Filter by specific project ID to get memberships for that project
boolean
Filter by participant status. Set to true to get only participant memberships, false for non-participants
string
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns attributes with one-level associations; ‘none’ for minimal data

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the project membership to retrieve
string
JSON array of fields to return; e.g., [“id”,“project-id”,“user-id”,“owner”,“participant”]
string
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns full object attributes with one-level association IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the task within the project
integer
required
The ID of the project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_GET_PURCHASE_ORDERTool to retrieve a specific purchase order. Use when you need PO details by its ID.

Input Parameters

integer
required
Coupa internal ID of the purchase order to retrieve
array
Fields and nested associations to return. Prefer an array; a legacy JSON-array string is also accepted. Example: [“id”, “po-number”, {“order-lines”: [“id”, “line-num”]}].
string ("limited" | "shallow")
Controls response verbosity for GET: ‘limited’ for IDs-only, ‘shallow’ for shallow associations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the purchase order
integer
required
Coupa unique identifier of the attachment to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa’s unique identifier for the PO change request
string
JSON array of specific fields/associations to return. Example: [‘id’,‘status’,{‘current-approval’:[‘id’,‘approver’]}]
string ("limited" | "shallow")
Controls response verbosity for GET: ‘limited’ for IDs-only, ‘shallow’ for shallow associations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_GET_PURCHASE_ORDER_CHANGES_PENDING_CERTAIN_APPROVERList purchase order changes with optional status, current approver, purchase order, and date filters and pagination. Use the approver and status filters to query changes pending a particular user’s approval.

Input Parameters

integer
Maximum number of records to return per API call (default: 50, max: 50).
string
JSON array of fields to return; e.g., [‘id’,‘status’,{‘current-approval’:[‘id’,‘approver’]}].
integer
Pagination offset to skip records and retrieve subsequent sets (default: 0).
string
Filter by PO change approval status; e.g., ‘pending_approval’ or ‘approved’.
string
Filter PO changes created after this timestamp (ISO 8601).
string
Filter PO changes created before this timestamp (ISO 8601).
string
Filter PO changes updated after this timestamp (ISO 8601).
string
Filter PO changes updated before this timestamp (ISO 8601).
integer
Filter by the original purchase order ID being changed.
integer
Filter by the current approver’s user ID to get PO changes pending this specific approver.
string
Filter by the current approver’s login to get PO changes pending this specific approver.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
JSON array string of specific fields to include in the response.
integer
required
Coupa unique identifier of the specific comment to retrieve.
string ("none" | "limited" | "shallow")
Level of detail in the response: ‘shallow’, ‘limited’, or ‘none’.
integer
required
Coupa unique identifier of the purchase order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the purchase order line to retrieve
string
JSON array of fields to return; e.g., [‘id’,‘line-num’,‘description’,{‘item’:[‘id’,‘name’]}]
string
Response verbosity: ‘limited’ for IDs-only, ‘shallow’ for shallow associations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_GET_QUOTE_REQUESTS_TASKSRetrieve tasks for a specific quote request in Coupa, with optional status filtering and pagination.

Input Parameters

integer
required
The ID of the quote request to retrieve tasks for
integer
Maximum number of records to return (1-50)
string
JSON array of fields to return; e.g., [‘id’,‘title’,‘status’]
integer
Pagination offset; results are returned in batches
string
Filter by task status
string
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns full object attributes with one-level association IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Coupa unique identifier for a specific reconciliation line. If provided, retrieves a single reconciliation line; otherwise, retrieves all reconciliation lines.
integer
ID of the payable order to filter reconciliation lines by. Use this to retrieve only reconciliation lines associated with a specific payable order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Supplier identifier (required path parameter)
integer
Number of records to return per request. Default: 50, Maximum: 50.
boolean
Filter by active status (true/false).
string
JSON array specifying which fields to include in response. Example: [“id”,“name”,{“country”:[“code”,“name”]}]
integer
Number of records to skip for pagination.
string
Field name to sort results by (alphabetical or numeric order).
integer
Get specific address by ID.
string
Filter addresses by country code (e.g., ‘US’).
string
Filter addresses created after specified date (format: YYYY-MM-DDTHH:MM:SS).
string
Filter addresses created before specified date (format: YYYY-MM-DDTHH:MM:SS).
string
Response format control. Values: ‘limited’ (returns only IDs), ‘shallow’ (returns all attributes plus IDs of one-deep associations).
string
Filter addresses updated after specified date (format: YYYY-MM-DDTHH:MM:SS).
string
Filter addresses updated before specified date (format: YYYY-MM-DDTHH:MM:SS).
string
Filter addresses updated by specific user login.
string
Filter addresses created on or after specified date (format: YYYY-MM-DDTHH:MM:SS).
string
Filter addresses created on or before specified date (format: YYYY-MM-DDTHH:MM:SS).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the requisition to retrieve assignments for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the requisition line to retrieve estimated tax lines for.
string
JSON array of fields to return; e.g., [‘id’,‘tax_code’,{‘tax_rate’:[‘id’,‘rate’]}].
string
Response verbosity: ‘limited’ or ‘shallow’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier for the specific comment to retrieve.
integer
required
The unique identifier for the requisition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_GET_RETURN_TO_SUPPLIER_TRANSACTIONSRetrieve Coupa return-to-supplier transactions for inventory returns to vendors. Filter by ID, type, status, export status or additional attributes, and paginate using an offset; pages contain up to 50 records.

Input Parameters

integer
Exact-match filter by transaction ID
string
Filter by transaction type (ReturnToSupplierTransaction, InventoryReceiptReturnToSupplier, ReceivingQuantityConsumptionReturnToSupplier, ReceivingAmountConsumptionReturnToSupplier)
string
JSON array of fields to return; e.g., [“id”,“status”,“quantity”]
integer
Pagination offset; results are returned in pages up to 50
string
Filter by transaction status
object
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.
boolean
Filter by export status: true for exported transactions, false for not exported
string
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns full object attributes with one-level association IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Filter by Coupa supplier identifier to get Risk Aware feed for a specific supplier.
string
Filter by supplier name to get Risk Aware feed. Use when you don’t know the supplier ID.
string
Filter by supplier number to get Risk Aware feed. Each supplier has only one Risk Aware feed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Coupa unique identifier for specific shipping term
string
Filter by shipping term code
boolean
Filter by active status
string
Filter by BusinessGroup

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_GET_SIM_EASY_FORM_RESPONSESRetrieve easy form responses for a specific supplier information (SIM) record, with optional status filtering and pagination.

Input Parameters

integer
Limit the number of results returned
string
JSON array of fields to return in the response. Example: [“id”,“created_at”,“updated_at”,“easy_form_id”,“name”,“status”,“submitted_at”]
integer
Pagination parameter to skip a number of records
string
Filter by status value (e.g., pending, approved, submitted)
integer
required
The unique identifier of the supplier information record

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Coupa Internal ID of the supplier information site to retrieve
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_GET_SOFT_APPLIED_PO_UPDATES_USING_CONFIRMATION_IDRetrieve soft-applied purchase order updates using a purchase order ID and confirmation ID. A JSON 404 response is returned as result data and may contain errors.

Input Parameters

integer
required
Coupa internal ID of the purchase order to review confirmation for
string
required
The confirmation ID used to retrieve soft applied PO updates

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the purchase order line.
integer
required
Coupa unique identifier of the attachment to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the requisition line
integer
required
The unique identifier of the specific attachment to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the charge
integer
required
The unique identifier of the attachment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_GET_SPECIFIC_CONTRACT_ATTACHMENT_FILEDownload a specific contract attachment file by contract ID and attachment ID, optionally specifying an image style.

Input Parameters

string
For image attachments: ‘preview’ (640x640) or ‘thumb’ (128x128). For non-image files: downloads the original file
integer
required
The unique identifier for the contract in Coupa’s system
integer
required
The specific attachment ID to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
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.
integer
required
The unique identifier for the specific data record to retrieve
integer
required
The unique identifier for the custom object being queried

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the attachment to retrieve.
integer
required
Coupa unique identifier of the EasyFormResponse object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_GET_SPECIFIC_INVOICE_ATTACHMENT_FILEDownload a specific invoice attachment file by invoice ID and attachment ID.

Input Parameters

integer
required
The unique identifier of the invoice.
integer
required
The unique identifier of the attachment to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_GET_SPECIFIC_REQUSITION_ATTACHMENT_FILERetrieve a specific requisition attachment by requisition ID and attachment ID as a downloadable response file. An optional field selection can be sent with the request.

Input Parameters

string
JSON array of fields to return in the response using the format [“field1”,“field2”,{“nested_object”:[“field1”,“field2”]}]
integer
required
The unique identifier for the attachment.
integer
required
The unique identifier for the requisition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Unique identifier of the statement to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa’s unique identifier for the data file source

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the supplier information site to retrieve
string
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”]
integer
required
The ID of the supplier information record

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa’s unique identifier for the supplier item
integer
Maximum number of records to return (default: 50, max: 50).
string
JSON array of fields to return; e.g., [‘id’,‘price’,{‘item’:[‘name’]}].
integer
Skip specified number of records for pagination (default: 0).
string
Field name to sort results by.
string ("asc" | "desc")
Sort direction, ‘asc’ for ascending or ‘desc’ for descending.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Limit the number of supplier items returned.
integer
Pagination offset for results.
string
Filter supplier items by item name (exact match).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Exact-match filter by supplier site code (e.g., ‘Standard’, ‘TSS001’)
string
Exact-match filter by supplier site name
integer
Number of records to return (max 50)
boolean
Filter by activation status: true for active sites, false for inactive
integer
Pagination offset; results returned in pages of up to 50
string ("cxml" | "xml" | "email" | "prompt" | "mark_as_sent" | "buy_online")
Filter by PO transmission method
integer
Filter by the ID of the parent supplier
string
Filter by supplier site code containing this substring
string
Filter by supplier site name containing this substring
string
Filter by supplier site code starting with this substring

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier for the tax registration record

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_GET_USER_ADDRESS_BY_IDRetrieve a Coupa address by address ID, with optional field selection and response detail. A user ID is required, but the lookup does not verify that the address belongs to that user.

Input Parameters

integer
required
ID of the address to retrieve.
string
JSON array of fields to return; e.g., [“id”,“name”,“city”,“state”,“country”].
integer
required
ID of the user whose address to retrieve.
string
Response verbosity: ‘limited’ returns minimal fields, ‘shallow’ returns full attributes with one-level associations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the address to retrieve.
string
JSON array of fields to return; e.g., [“id”,“name”,“city”,“state”,“country”].
integer
required
ID of the user whose address to retrieve.
string
Response verbosity: ‘limited’ returns minimal fields, ‘shallow’ returns full attributes with one-level associations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the user group to retrieve
string
JSON array of fields to return; e.g., [“id”,“name”,“active”].
string
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns full object attributes with one-level association IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier for the user group membership record
string
JSON array of fields to return; e.g., [“id”,“user-id”,“user-group-id”].
string
Response verbosity: ‘limited’ or ‘shallow’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum number of records to return (1-50). Default is 50 records.
string
JSON array of fields to return; e.g., [“id”,“title”,“status”].
integer
Number of records to skip for pagination (default 0).
string
Field(s) to order results by (alphabetical/numeric order). E.g., ‘title’, ‘due-date’.
string
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns all attributes and IDs of one-deep associations.
integer
required
ID of the user group to retrieve tasks for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Exact-match filter by membership ID
integer
Maximum number of records to return (1-50). Default is 50.
boolean
Filter by owner status: true for admin users, false for non-admin
string
JSON array of fields to return; e.g., [“id”,“user-id”,“user-group-id”]
integer
Number of records to skip for pagination (default 0).
integer
Filter by user ID to get memberships for a specific user
boolean
Filter by participant status
string
Response verbosity: ‘limited’, ‘shallow’, or ‘none’
integer
Filter by user group ID or project ID
string
Filter by group type: ‘User group’ or ‘Project’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_IGNORE_WINDOW_AND_ISSUEIssue a purchase order while ignoring its supplier’s preferred sending window.

Input Parameters

integer
required
Coupa internal Purchase Order ID to issue
string
Optional fields selector per Coupa API as a JSON string. Example: [‘id’, {‘order_lines’:[‘id’,‘line_num’]}]
string
Optional return object size: none | limited | shallow
string
Optional Coupa user login to impersonate; sent as x-coupa-api-user-login header

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_IMPORT_BUDGET_LINESUpload a CSV file to Coupa for batch processing, targeting budget lines by default. The import target can be specified.

Input Parameters

object
CSV file containing budget lines to import.
string
Filename when providing base64 content.
string
MIME type (e.g., ‘text/csv’) when using base64 content
string
The object type being imported. Should be ‘BudgetLine’ for budget line imports.
string
Base64-encoded file content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_INSPECTION_CODES_INDEXList Coupa lookup values, optionally filtering by parent lookup name to retrieve inspection codes. Without that filter, results are not restricted to inspection codes.

Input Parameters

boolean
Filter by active status (true or false).
string
JSON array of fields to return; e.g., [“id”,“code”]. If not provided, Coupa returns the default shallow representation.
integer
Pagination offset; results are returned in batches of up to 50 (offset multiples of 50).
string
Filter by parent lookup name (e.g., ‘Inspection Code’).
string
Response size control: ‘limited’ returns only IDs; ‘shallow’ returns attributes with one-level associations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum number of records to return (1-50).
string
JSON array of fields to return; e.g., [‘id’,‘document-id’,‘integration-filename’].
integer
Number of records to skip for pagination.
object
Additional attribute filters using Coupa syntax. Example: {‘status’:‘error’,‘created-at[gt]’:‘2023-01-01T00:00:00Z’}
string
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns full object attributes with one-level association IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_INTEGRATION_RUNS_INDEXTool to list integration runs. Use after identifying an integration to retrieve run IDs and statuses.

Input Parameters

string
JSON array of fields to return; e.g., [“id”,“status”,“start_time”]
integer
Pagination offset; Coupa returns up to 50 runs per request, use offset to page.
object
Attribute filters using Coupa query syntax. Example: {‘status[in]’:‘running,paused’, ‘created-at[gt_or_eq]’:‘2023-01-01T00:00:00Z’}
string ("limited" | "shallow")
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns full object attributes with one-level associations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique Integration Code - must be unique across all integrations.
string
required
Integration Name - human-readable name for the integration.
boolean
required
Standard indicator flag. Set to true for standard integrations, false for custom integrations.
string ("to_coupa" | "from_coupa")
required
Direction of data flow. Use ‘to_coupa’ for importing data into Coupa, ‘from_coupa’ for exporting data from Coupa.
string
required
End System name - the external system being integrated.
string
required
Business Object identifier for the integration (e.g., User, Supplier, Invoice).
string ("internal" | "payroll" | "erp" | "hr" | "third_party_partner" | "third_party_vendor" | "other")
required
Classification of the end system type.
string ("flat_file" | "api" | "corporate_credit_card_file" | "json" | "xml")
required
Method type for the integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_INTEGRATIONS_INDEXTool to list integrations from Coupa. Use when you need to retrieve integration definitions and IDs for filtering integration runs.

Input Parameters

integer
Exact-match filter by Coupa integration ID
string
Exact-match filter by integration code; supports Coupa query operators
string
Exact-match filter by integration name; supports Coupa query operators
string
JSON array of fields to return; e.g., [“id”,“code”,“name”]
integer
Pagination offset; results are returned in pages up to 50 records
boolean
Filter by standard flag: true for standard integrations, false otherwise
string
Filter by direction: to_coupa or from_coupa
string
Filter by creation timestamp; supports Coupa query operators
string
Filter by end system
string
Filter by update timestamp; supports Coupa query operators
string
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns top-level attributes and one-level association IDs
string
Filter by business object
string
Filter by end system type: internal, payroll, erp, hr, third_party_partner, third_party_vendor, other
string
Filter by integration type: flat_file, api, corporate_credit_card_file, json, xml

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_INTEGRATIONS_SHOWTool to retrieve a specific integration by ID. Use when you need detailed information about a single integration.

Input Parameters

integer
required
Coupa’s unique identifier for the integration

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_INVENTORY_CONSUMPTIONS_DESTROYDelete an inventory consumption record by ID. The response includes the HTTP status and accepts a 404 as well as a successful deletion response.

Input Parameters

integer
required
Inventory consumption ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_INVENTORY_TRANSFERS_DESTROYDelete an inventory transfer by ID. The response includes the HTTP status and accepts a 404 as well as a successful deletion response.

Input Parameters

integer
required
Inventory transfer ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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
required
Array of supplier objects to invite. Each supplier object must contain an ‘id’ field with the supplier ID.
string
Custom message text to include in the invitation email sent to suppliers. If not provided, a default invitation message will be used.
boolean
Specifies whether the invited supplier can manage their contact information in the portal. Defaults to false if not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_INVOICES_ATTACHMENTS_CREATETool to create an attachment on an invoice. Use when attaching files, text, or URLs to invoices.

Input Parameters

string
URL for URL attachments. Required when type=‘url’
object
File to upload. Required when type=‘file’
string
Text content for text attachments. Required when type=‘text’
string ("file" | "text" | "url")
required
Type of the attachment. ‘file’, ‘text’, or ‘url’
string
Intent of the attachment (max 40 characters)
integer
required
ID of the invoice to attach the resource
string
Login of the user to impersonate; sent as ‘x-coupa-api-user-login’ header

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa invoice ID to delete
string
Optional response control; e.g., ‘limited’ to return only IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_INVOICES_LISTList and filter Coupa invoices. To match an invoice to a purchase order, request invoice-lines with po-number, order-header-num, or order-line-id in fields, or filter on invoice-lines[po-number]; PO linkage is line-level and is not an invoice-header field.

Input Parameters

array
Fields and nested associations to return. Prefer an array; a legacy JSON-array string is also accepted. To match invoices to purchase orders, include the invoice-lines association and its po-number, order-header-num, or order-line-id fields; for example: [“id”, “invoice-number”, {“invoice-lines”: [“id”, “line-num”, “po-number”, “order-header-num”, “order-line-id”, “order-line-num”]}]. Coupa omits associations not selected by fields.
integer
Pagination offset for invoice list in multiples of 50 (default 0).
object
Invoice query parameters as key-value pairs. Keys use Coupa’s attribute[operator] syntax and may traverse associations, such as supplier[name] or account-type[name][in]; use plural names for collections, e.g. invoice-lines[po-number] to find invoices for a PO number. Multiple filters are combined with AND. Supported operators are contains, starts_with, ends_with, gt, lt, gt_or_eq, lt_or_eq, not_eq, in, not_in, and blank; omit the operator for exact matches. For in/not_in, pass a comma-separated value. The not_blank operator does not exist; express ‘has a value’ as attribute[blank]=false. Do not use SQL, OData, or guessed aliases such as gte/lte/eq. Examples: {“status[in]”: “approved,voided”, “supplier[name]”: “CDW”} or {“invoice-date[gt]”: “2024-01-01T00:00:00”}.
string ("limited" | "shallow")
Response verbosity control: ‘limited’ returns only IDs; ‘shallow’ returns one-level associations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the invoice.
integer
required
Approval record ID to remove. This is the ID of the manually added approval to be removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_INVOICES_REVALIDATE_TOLERANCESRevalidate tolerances on an invoice. A 409 conflict is returned as a structured invoice result indicating that revalidation was ineligible or conflicted with the current state.

Input Parameters

integer
required
ID of the invoice to revalidate tolerances for
string
Optional response size control: none | limited | shallow

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_INVOICES_SHOWRetrieve one invoice by its Coupa ID. Purchase-order linkage is line-level; use fields to request invoice-lines with po-number, order-header-num, or order-line-id.

Input Parameters

integer
required
ID of the invoice to retrieve
array
Fields and nested associations to return. Prefer an array; a legacy JSON-array string is also accepted. To match this invoice to purchase orders, include the invoice-lines association and its po-number, order-header-num, or order-line-id fields; for example: [“id”, “invoice-number”, {“invoice-lines”: [“id”, “line-num”, “po-number”, “order-header-num”, “order-line-id”, “order-line-num”]}]. Coupa omits associations not selected by fields.
string
Response verbosity: ‘limited’ or ‘shallow’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the invoice to submit.
string
Optional response size control: none | limited | shallow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_INVOICES_UPDATETool to update an invoice via PUT /api/invoices/:id.

Input Parameters

integer
required
Coupa unique identifier of the invoice to update.
array
Tags applied to invoice
string
JSON array of fields to return; e.g., [‘id’,‘invoice-number’,{‘invoice-lines’:[‘id’,‘line-num’]}]
string
Invoice status (updates may be restricted depending on workflow/state).
object
Additional invoice attributes to update directly; keys should use Coupa API hyphenated names. Example: {‘comments’: null, ‘invoice-number’: ‘INV-1002’}
string
Freeform comments
object
Currency object, e.g., {‘code’: ‘USD’}
object
Supplier reference, e.g., {‘id’: 2} or {‘name’: ‘Super Printers’}
array
Taggings metadata
array
Tax line items for the invoice.
string
Invoice date (YYYY-MM-DD)
string
User email or login to perform the action on behalf of. Sent as ‘X-COUPA-ON-BEHALF-OF’ header.
object
The payment term for the invoice.
string
Coupa business role to use when acting on behalf of a user. Sent as ‘X-COUPA-BUSINESS-ROLE’.
string
An internal note for the invoice.
array
Array of invoice line objects to update/add. For updates, include line ‘id’. Example: [{‘id’: 123, ‘description’: ‘New desc’, ‘price’: ‘15.00’}]
string ("full" | "limited" | "shallow" | "none")
Controls response verbosity: ‘full’, ‘limited’, ‘shallow’, or ‘none’.
string
The invoice number.
object
The bill-to address for the invoice.
object
The ship-to address for delivery.
integer
The lock version key for optimistic concurrency control.
object
The remit-to address for payment.
boolean
Whether taxation is applied at the line level.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa internal ID of the purchase order to issue without sending
array
JSON array of specific fields/associations to include in the response. Example: [‘id’, ‘status’, ‘po-number’]
string ("none" | "limited" | "shallow")
Controls response verbosity: ‘none’ returns no body; ‘limited’ returns only IDs; ‘shallow’ returns object attributes with one-level associations
string
Optional Coupa user login to impersonate; sent as x-coupa-api-user-login header

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_ITEMS_CREATETool to create a catalog item. Use when provisioning items with minimal details in Coupa.

Input Parameters

object
Unit of measure reference - provide code.
string
required
Item name
number
Price of the item (optional)
string
required
Item description
string
Unique item number (unique if provided)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_ITEMS_INDEXTool to list catalog items. Use when you need item IDs and item numbers for inventory adjustment.

Input Parameters

integer
Pagination offset; results are returned in batches of up to 50 (offset multiples of 50).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the item to update
object
Unit of measure reference - provide code.
string
Item designation/name
boolean
Status indicator; deletion occurs if set to inactive
number
Pack quantity
object
Reference to a Commodity resource. Provide id, name, or both.
string
Item image URL
string
Item classification type
number
Net weight value
string
Item description
string
Unique item identifier/number
number
Pack weight value
number
Reorder point value
string ("none" | "limited" | "shallow")
Controls response format: ‘none’ (no response), ‘limited’ (IDs only), ‘shallow’ (attributes + one-level IDs)
boolean
Whether to use pack weight
integer
Storage quantity
string
Manufacturer name (max 255 characters)
boolean
Require asset tag flag
string
External item image URL
boolean
Require inspection flag
integer
Consumption quantity
boolean
Receive catch weight flag
boolean
Allow partial quantities flag
string
Manufacturer part number (max 255 characters)
string
Lot expiration type
boolean
Enable inventory lot tracking

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Filter by exact account validation rule ID
integer
Maximum number of records to return (1-50)
boolean
Filter by active status to retrieve only active or inactive validation rules
string
JSON array of fields to return; e.g., [“id”,“name”,“active”]
integer
Number of records to skip for pagination
integer
Filter by ID of the user who created the validation rule
string
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns top-level fields with one-level associations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_LIST_COMMENTSList comments in Coupa with pagination, ordering, and response field selection.

Input Parameters

integer
Maximum number of records to return. Default is 50.
string
JSON array string of specific fields to include in the response.
integer
Number of records to skip for pagination. Default is 0.
string
Field name to sort results by (alphabetical/numeric order).
string ("none" | "limited" | "shallow")
Level of detail in the response: ‘shallow’, ‘limited’, or ‘none’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_LIST_COMMODITIESTool to list commodities from Coupa. Use when you need to query or retrieve multiple commodities.

Input Parameters

integer
Maximum number of records to return (1-50).
integer
Pagination offset; results are returned in batches of up to 50.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the contract to retrieve terms for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the specific object to retrieve comments for.
string ("requisitions" | "invoices" | "purchase_orders" | "expense_reports" | "users")
required
The type of transactional object to query comments for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_LIST_QUERY_SUPPLIERSTool to list suppliers with filters. Use when you need suppliers matching certain criteria.

Input Parameters

integer
Exact Coupa internal supplier ID; exact match (e.g., id=6).
string
Filter by supplier name (exact). For other operators, use name_contains, name_starts_with, or name_ends_with.
integer
Pagination offset; results returned in pages of 50 by default.
string
Filter by supplier status (e.g., active).
string ("cxml" | "xml" | "email" | "prompt" | "mark_as_sent" | "buy_online")
Filter by PO transmission method; one of cxml, xml, email, prompt, mark_as_sent, buy_online.
string
Return suppliers created after this timestamp (YYYY-MM-DDTHH:MM:SS).
string
Filter by supplier name containing this substring.
string
Filter by supplier name ending with this substring.
string
Filter by supplier name starting with this substring.
integer
Filter suppliers with more than this number of reviews.
string
Filter by Payment Term code (e.g., Net+30).
boolean
Filter suppliers allowed for cXML invoicing (true/false).
string
Filter by cXML buyer domain containing this value.
string
Filter by city of the supplier’s primary address.
string
Filter by cXML supplier domain containing this value.
string
Filter by primary contact email containing this value.
integer
Filter by discount payment days (integer).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_LIST_RECEIVING_TRANSACTIONSQuery Coupa receiving transactions with optional filters for status, dates, type, export status and other attributes. Paginate using offset and limit, with up to 50 records per page. An empty result may also indicate an empty-body HTTP 403 response.

Input Parameters

integer
Exact-match filter by transaction ID.
string
Filter by transaction type (e.g., ReceivingTransaction, InventoryReceiptReceiving). Supports operators: [contains], [starts_with], [in], [not_in].
integer
Maximum number of records to return per call. Default: 50 (API enforced maximum).
string
JSON array of fields to return in response; e.g., [“id”,“type”,“status”,{“item”:[“id”,“name”]}].
integer
Pagination offset; results are returned in pages of up to 50 records.
string
Filter by transaction status. Supports operators: [in], [not_in], [contains], [not_eq].
object
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.
boolean
Filter by export status: true for exported transactions, false for not exported.
string
Filter transactions created after this timestamp (ISO 8601 format).
string
Filter transactions created before this timestamp (ISO 8601 format).
string
Response verbosity control: ‘limited’ returns only IDs; ‘shallow’ returns full object attributes with one-level association IDs.
string
Filter transactions updated after this timestamp (ISO 8601 format).
string
Filter transactions updated before this timestamp (ISO 8601 format).
string
Filter transactions created on or after this timestamp (ISO 8601 format).
string
Filter transactions created on or before this timestamp (ISO 8601 format).
string
Filter transactions with transaction date after this timestamp (ISO 8601 format).
string
Filter transactions with transaction date before this timestamp (ISO 8601 format).
string
Filter transactions updated on or after this timestamp (ISO 8601 format).
string
Filter transactions updated on or before this timestamp (ISO 8601 format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_LIST_WORK_CONFIRMATION_HEADERSTool to retrieve work confirmation headers from Coupa. Use when you need to query work confirmation header records.

Input Parameters

integer
Maximum number of records to return (1-50)
string
JSON array of fields to return; e.g., [“id”,“status”,“created-at”]
integer
Pagination offset; results are returned in pages up to 50
string
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns full object attributes with one-level association IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_LOGOUT_IFRAME_SESSIONRequest logout of a Coupa Supplier Portal iframe session. A 403 is returned as a normal result with a message suggesting there may be no active session; it does not confirm logout.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_MARK_A_CHARGE_AS_EXPORTEDSet a Coupa charge’s exported flag, defaulting to exported. Use it to flag a charge as exported to an external accounting system or clear the flag.

Input Parameters

integer
required
The unique Coupa ID of the charge to mark as exported.
boolean
Set to true to mark the charge as exported. Defaults to true.
string ("none" | "limited" | "shallow")
Controls response format. Options: ‘none’ (no response body), ‘limited’ (only IDs returned), ‘shallow’ (all attributes with IDs of associations).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the payable invoice to mark as tracking externally.
string
Optional response size control: ‘none’ (no data returned), ‘limited’ (only IDs returned), ‘shallow’ (all attributes plus IDs of one-deep associations).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa internal ID of the statement to mark as exported

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_MARK_COUPA_PAY_PAYMENT_AS_EXPORTEDSet the exported flag on a Coupa Pay payment by ID, defaulting to true. When an empty response is requested and returned, the result contains the supplied payment ID and exported flag.

Input Parameters

integer
required
Unique Coupa payment identifier to mark as exported.
string
JSON array of specific fields to return in response. Example: [“id”,“status”,“exported”,“last-exported-at”]
boolean
Set to true to mark the payment as exported. This prevents duplicate retrieval in subsequent queries.
string ("none" | "limited" | "shallow")
Controls response verbosity: ‘none’ (empty response), ‘limited’ (only IDs), or ‘shallow’ (complete payment object with associations).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the payable invoice to mark as tracking in Coupa.
string
Optional response size control: ‘none’ (no data returned), ‘limited’ (only IDs returned), ‘shallow’ (all attributes plus IDs of one-deep associations).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the payable invoice to mark as paid externally

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_MARK_PAY_INVOICE_AS_EXPORTEDSet the exported flag on a Coupa Pay invoice by ID, defaulting to true. Use after processing an invoice in an external system.

Input Parameters

integer
required
Unique Coupa Pay invoice identifier to mark as exported.
boolean
Set to true to mark the invoice as exported. This prevents duplicate retrieval in subsequent queries.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa’s internal ID for the order header confirmation to mark as integration_complete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa’s internal ID for the order header confirmation to mark as integration_failed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier for the matching allocation to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa internal ID of the contract to notify signature creation
array
JSON array of specific fields/associations to include in the response. Example: [‘id’,‘status’]
integer
Impersonate as the given user id via X-COUPA-API-USER-ID header.
string
Perform the action on behalf of this user (email or login); sent as X-COUPA-ON-BEHALF-OF header.
string
Coupa business role to use when acting on behalf of a user; sent as X-COUPA-BUSINESS-ROLE header.
string ("none" | "limited" | "shallow")
Controls response verbosity: ‘none’, ‘limited’, or ‘shallow’
string
Impersonate as the given user email via X-COUPA-API-EMAIL header.
string
Impersonate as the given user login via X-COUPA-API-USER-LOGIN header.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Model attribute to be translated (typically ‘name’ for UOM translations). Specifies which attribute of the object should be translated.
string
required
Translated text value for the specified attribute in the specified locale.
string
required
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.
integer
required
Coupa unique identifier of the UOM object to add a translation for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Translation record identifier to be deleted.
integer
required
Unit of Measure identifier for which the translation belongs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_OBJECT_TRANSLATION_INDEXList translations for a specific Unit of Measure (UOM) in Coupa. Results are retrieved one page at a time using an optional offset.

Input Parameters

string
JSON array of fields to return; e.g., [“id”,“locale”,“key”,“value”].
integer
Pagination offset; results are returned in pages of up to 50.
integer
required
Unique identifier for the Unit of Measure whose translations you want to retrieve.
string
Response size control: ‘limited’ returns only IDs; ‘shallow’ returns attributes with one-level associations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the translation record
integer
required
The unique identifier of the parent UOM (Unit of Measure)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_ORDER_CONFIRMATIONS_DESTROYTool to delete an order confirmation. Use when you need to permanently remove an order confirmation by ID.

Input Parameters

integer
required
Order confirmation ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Order pad identifier/name
boolean
Lock status indicator - when true, the order pad cannot be modified
array
List of associated supplier references (provide supplier ID or SupplierReference objects)
number
required
Base monetary value for the order pad
boolean
required
Flag for supplier selection - set to false to restrict to specific suppliers
boolean
Indicator for adding all items from supplier catalogs (optional)
boolean
required
Whether base value applies
array
List of associated business groups (optional)
array
Line item collection for the order pad (optional)
array
Section groupings for organizing order pad lines (optional)
string
required
Currency reference for base value (provide currency code as string or CurrencyReference object)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Order list ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the order list to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the order list (order pad) to update.
string
Name of the order list.
boolean
Whether the order list is locked.
object
Additional order list attributes to update directly; keys should use Coupa API hyphenated names.
number
Base value for the order list.
boolean
Whether the order list can be used with any supplier.
boolean
Whether to use base value for the order list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
JSON array of fields to return; e.g., [“id”,“name”]
integer
Pagination offset; results are returned in batches of up to 50 (offset multiples of 50).
string
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns full object attributes with one-level association IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the business entity to update.
string
Business entity name.
string ("LegalBusinessEntity" | "OrganizationalBusinessEntity")
Entity type: ‘LegalBusinessEntity’ or ‘OrganizationalBusinessEntity’.
string
JSON array of fields to return; e.g., [‘id’,‘name’,‘display-name’].
string
Entity status (e.g., ‘active’, ‘inactive’).
object
Additional business entity attributes to update directly; keys should use Coupa API hyphenated names.
array
Array of address objects associated with the business entity.
string
Display name for the entity.
string
User email or login to perform the action on behalf of. Sent as ‘X-COUPA-ON-BEHALF-OF’ header.
string
Coupa business role to use when acting on behalf of a user. Sent as ‘X-COUPA-BUSINESS-ROLE’.
string ("full" | "limited" | "shallow" | "none")
Controls response verbosity: ‘none’, ‘limited’, ‘shallow’, or ‘full’.
string ("Organization" | "Person")
Formation type: ‘Organization’ or ‘Person’.
object
Primary address information. Reference by ID: {‘id’: 123}.
object
Primary contact details. Reference by ID: {‘id’: 456}.
object
Country of origin. Reference by code: {‘code’: ‘US’}.
array
Array of relationship objects linking this entity to others.
array
Array of account owner objects for the business entity.
array
Array of alternate names for the business entity.
array
Array of external reference objects for the business entity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa internal identifier of the purchase order to update.
string
JSON array of fields to return; e.g., [‘id’,‘po-number’,‘status’].
object
Additional purchase order attributes to update directly; keys should use Coupa API hyphenated names.
object
Transaction currency reference.
boolean
Export flag. Note: cannot update other fields simultaneously by default.
object
Supplier reference by Coupa internal ID.
string
Purchase order number (max 20 characters).
boolean
Price visibility control.
array
Array of order line objects to update/add.
string
User email or login to perform the action on behalf of. Sent as ‘X-COUPA-ON-BEHALF-OF’ header.
object
Payment terms reference.
string
Coupa business role to use when acting on behalf of a user. Sent as ‘X-COUPA-BUSINESS-ROLE’.
string ("none" | "limited" | "shallow")
Controls response verbosity: ‘none’, ‘limited’, or ‘shallow’.
object
Shipping terms reference.
object
Supplier site reference.
string ("msp" | "supplier" | "vms")
Order classification (max 255 characters).
integer
Confirmation deadline in hours.
object
Delivery address details.
integer
Reason code for changes or reopening.
string
Recipient name for shipment (max 255 characters).
string
Comma-separated recipient emails for transmission.
string
Comment for reason insight.
string ("email" | "cxml" | "xml" | "do_not_transmit")
Transmission method override (max 30 characters).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_PAYMENT_TERMS_INDEXTool to list payment terms with filters.

Input Parameters

string
Filter by payment term code
string
Filter by payment term type
integer
Maximum number of records to return (1-50).
boolean
Filter by active (true/false)
string
JSON array of fields to return; e.g., [‘id’,‘code’,‘active’] or nested associations.
integer
Number of records to skip for pagination.
integer
Filter by net due day (1-31)
string
Filter where code contains the provided value
string
Filter records created after this ISO timestamp
string
Filter records created before this ISO timestamp
number
Filter by discount rate (as decimal)
integer
Filter by net due month (0-6)
string
Response verbosity: ‘limited’ or ‘shallow’.
string
Filter records updated after this ISO timestamp
string
Filter records updated before this ISO timestamp
string
Filter where code ends with the provided value
integer
Filter by net cutoff day (1-31)
string
Filter where code starts with the provided value
integer
Filter by discount due day (1-31)
integer
Filter by discount due month (0-6)
integer
Filter by discount cutoff day (1-31)
integer
Filter by days for net payment
integer
Filter by days for discount payment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_PAYMENT_TERMS_SHOWTool to retrieve a single payment term by ID. Use when you need detailed payment term information.

Input Parameters

integer
required
ID of the payment term to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_PROJECTS_INDEXList or query Coupa projects with optional filtering and pagination. Each call retrieves one page of results.

Input Parameters

integer
Exact-match filter by project ID
string
Filter by project name; supports Coupa query operators like [contains], [starts_with], [ends_with]
integer
Maximum number of records to return per request (1-50, default 50)
boolean
Filter by active status: true for active projects, false for inactive
string
JSON array of fields to return; e.g., [“id”,“name”,“status”,{“commodity”:[“id”,“name”]}]
integer
Pagination offset; results are returned in pages up to 50
string
Filter by project status; e.g., ‘in_progress’, ‘completed’, ‘active’, ‘pending’. Supports operators like [in], [not_in], [not_eq]
object
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]
string ("limited" | "shallow")
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns full object attributes with one-level association IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_PROJECTS_SHOWTool to retrieve a single project by ID. Use when you need detailed project information after knowing the project ID.

Input Parameters

integer
required
ID of the project to retrieve
string
JSON array of fields to return; e.g., [“id”,“name”,“status”,{“commodity”:[“id”,“name”]}]
string ("limited" | "shallow")
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns full object attributes with one-level association IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_PROJECTS_UPDATETool to update an existing Coupa project. Use when you need to modify project attributes after confirming project ID.

Input Parameters

integer
required
Coupa unique identifier of the project to update.
string
Project identifier; must be unique.
boolean
Project is open for everyone to join or owner must invite others.
array
Team member assignments.
boolean
Active status of the project.
string
JSON array of fields to return; e.g., [‘id’,‘name’,{‘users’:[‘id’,‘login’]}].
string
Project status indicator.
object
Additional project properties to update; use Coupa API hyphenated names as keys.
object
The category associated with the project.
string
Project completion date (format: YYYY-MM-DDTHH:MM:SS+HH:MMZ).
array
Tags associated with the project.
object
Associated commodity reference, e.g., {‘id’: 1}.
object
The department associated with the project.
string
Project commencement date (format: YYYY-MM-DDTHH:MM:SS+HH:MMZ).
string
Project details and description.
integer
Unique identifier for a commodity (non-editable).
array
List of tabs enabled for linked objects.
string
Mention name for the project.
string
User email or login to perform the action on behalf of. Sent as ‘X-COUPA-ON-BEHALF-OF’ header.
string
Coupa business role when acting on behalf of a user. Sent as ‘X-COUPA-BUSINESS-ROLE’.
object
Budgeting framework/category plan.
string ("none" | "limited" | "shallow")
Controls response verbosity: ‘none’, ‘limited’, or ‘shallow’.
array
Linked organizational units/content groups.
object
Project template reference.
integer
Copy project identifier.
integer
Progress indicator (0-100).
string
Third-party system identifier for syncing external project IDs.
string
Additional planned savings amount.
string
Controls member tab visibility.
boolean
Provide warning if task dates fall outside project dates.
string
Additional realized savings amount.
boolean
Show sourcing rollup field if flag enabled.
boolean
Show contracts rollup field if flag enabled.
boolean
Show suppliers rollup field if flag enabled.
string
Additional negotiated savings amount.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_PURCHASE_ORDERS_INDEXList purchase order headers with fixed filters and pagination, including status, dates, ID, and supplier name. Request PO numbers or order-line IDs to help correlate purchase orders with invoices.

Input Parameters

integer
Exact match for PO ID.
array
Fields and nested associations to return. Prefer an array; a legacy JSON-array string is also accepted. Example: [“id”, “po-number”, {“order-lines”: [“id”, “line-num”]}].
string
Name of an API Response Filter to control returned fields.
integer
Pagination offset; results are returned in batches of up to 50 (offset multiples of 50).
string
Filter by exact PO status. Coupa uses no operator for an exact match; the status[in] input supports multiple statuses.
boolean
Filter by export status; e.g., exported=false to fetch unexported POs.
string
Multi-status filter; e.g., status[in]=issued,canceled,closed.
string
Filter POs created after this timestamp (ISO 8601).
string
Filter POs created before this timestamp (ISO 8601).
string
Response size control: ‘limited’ returns only IDs; ‘shallow’ returns full object attributes with one-level association IDs.
string
Filter POs by an exact associated supplier name. Coupa’s documented operator vocabulary is contains, starts_with, ends_with, gt, lt, gt_or_eq, lt_or_eq, not_eq, in, not_in, and blank; no operator means exact match. This action exposes the fixed filters described here.
string
Filter POs updated after this timestamp (ISO 8601).
string
Filter POs updated before this timestamp (ISO 8601).
boolean
Include deleted PO lines when querying (useful for ERP syncs).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_PURCHASE_ORDERS_ISSUETool to issue and send a purchase order to the supplier. Use after preparing a PO to dispatch it.

Input Parameters

integer
required
Coupa internal ID of the purchase order to issue
array
JSON array of specific fields/associations to include in the response. Example: [‘id’, ‘status’, ‘po-number’]
string ("none" | "limited" | "shallow")
Controls response verbosity: ‘none’ returns no body; ‘limited’ returns only IDs; ‘shallow’ returns object attributes with one-level associations
string
Optional Coupa user login to impersonate; sent as x-coupa-api-user-login header

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the user to update.
string
User email address; must be unique across the instance.
string
User login; must be unique across the instance.
array
Roles to assign to the user (e.g., [{‘id’: 1}]).
boolean
User active status; true means the user is active.
string
JSON array of fields to return (e.g., ”[‘id’,‘login’,{‘roles’:[‘id’,‘name’]}]”).
object
Manager user reference object (e.g., {‘id’: 5}).
boolean
Enable AI CoPilot license for this user.
boolean
Enable API access for this user.
boolean
Enable CCW license for this user.
string
User’s last name.
string
Password for changing user password; case-sensitive.
string
User’s first name.
object
Department reference object (e.g., {‘id’: 3}).
string
User’s middle name.
object
Work phone number object.
boolean
Enable travel management license for this user.
array
User groups to assign to the user.
boolean
Enable expense management license for this user.
Legal entity assignment reference object.
string
Display name for user mentions.
object
Mobile phone number object.
string
Response verbosity control: ‘none’, ‘limited’, or ‘shallow’.
string
Salesforce record identifier for integration.
boolean
Enable sourcing license for this user.
boolean
Enable treasury license for this user.
array
Account groups for document security.
boolean
Enable analytics license for this user.
array
Content (business) groups for access control.
boolean
Enable contracts management license for this user.
string
User’s default locale code (e.g., ‘en’, ‘fr’, ‘de’).
boolean
Enable inventory management license for this user.
boolean
Enable invoicing license for this user.
string
Single Sign-on identifier for the user.
array
Approval groups for routing assignments.
object
User reference object for expense delegation recipient.
object
Default GL account reference object.
object
Default address reference object (e.g., {‘id’: 2}).
string
Unique employee identifier.
boolean
Enable purchasing license for this user.
string
Job grade or seniority band designation.
object
Default currency reference object (e.g., {‘code’: ‘USD’}).
boolean
Enable risk assessment license for this user.
boolean
Enable spend guard license for this user.
string
Role classification or business function.
boolean
Enable supply chain license for this user.
boolean
Enable Salesforce integration for this user.
array
Warehouse access assignments.
object
General self-approval maximum reference object.
object
Country of residence reference object.
object
Default account type reference object.
object
Override triggering amount reference object.
integer
Account security type setting.
string
Authentication method: ‘coupa_credentials’, ‘ldap’, or ‘saml’ (case-sensitive).
boolean
Enable category planner license for this user.
object
User reference object for delegate assignment.
object
Maximum expense approval amount reference object.
object
Invoice authorization limit reference object.
object
Contract authorization limit reference object.
array
Inventory organization assignments.
string
Payment channel. Default: ‘ERP’; alternative: ‘CoupaPay’.
object
Purchase requisition authority limit reference object.
object
Expense self-approval threshold reference object.
object
Invoice self-approval cap reference object.
integer
Business group security type. Values: 0 or 1.
object
Contract self-approval threshold reference object.
string
Trigger user invitation with generated password. Values: ‘Yes’ or ‘No’.
object
Requisition self-approval cap reference object.
object
Service confirmation authority limit reference object.
boolean
Allow user to create employee payment accounts.
boolean
Allow invoice upload via mobile device.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("asc" | "desc")
Sort direction options for lookups query.
string
Filter by lookup name; exact match on the lookup name.
integer
Maximum number of records to return for pagination.
string
Advanced filter expression for complex query conditions.
integer
Number of records to skip for pagination (offset).
string
Field name to sort results by (e.g., ‘name’, ‘id’).
string ("limited" | "shallow" | "none")
Return object type options for controlling response payload size.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_REASON_INSIGHTS_INDEXTool to list Reason Insights. Use when you need to retrieve reason insights with optional filters and pagination.

Input Parameters

integer
Exact-match filter by Reason Insight ID
string
Exact-match filter by Reason Insight code; supports Coupa query operators
string
Filter by Reason Insight name; supports Coupa query operators
boolean
Filter by active status: true for active reason insights, false for inactive
array
List of fields to return; e.g., [‘id’,‘code’]. Provide as a list, will be JSON-encoded in the query.
integer
Pagination offset; results are returned in pages up to 50
string
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns full object attributes with one-level associations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Receipt request type classification.
array
required
List of receipt request line items. At least one line is required.
string
Initial status of the receipt request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_RECEIPT_REQUESTS_INDEXList receipt requests from Coupa with optional filtering and pagination. An empty result may also indicate an empty-body 403 response.

Input Parameters

integer
Maximum number of records to return per request (1-50).
string
JSON array of fields to return; e.g., [“id”,“status”,“type”].
integer
Number of records to skip for pagination.
object
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’}.
string
Field(s) to order results by.
string ("asc" | "desc")
Sort direction for order_by field: ‘asc’ for ascending, ‘desc’ for descending.
string ("limited" | "shallow")
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns full attributes with one-level association IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the receipt request to update.
string
Receipt request classification type.
array
Array of receipt request line items to update/add. For updates, include line ‘id’. Example: [{‘id’: 123, ‘quantity’: ‘10.0’, ‘description’: ‘Updated description’}]
string
Current state of the receipt request (updates may be restricted depending on workflow/state).
object
Additional receipt request attributes to update directly; keys should use Coupa API hyphenated names. Example: {‘status’: ‘approved’, ‘type’: ‘standard’}
string
User email or login to perform the action on behalf of. Sent as ‘X-COUPA-ON-BEHALF-OF’ header.
string
Coupa business role to use when acting on behalf of a user. Sent as ‘X-COUPA-BUSINESS-ROLE’.
string ("none" | "limited" | "shallow")
Controls response verbosity: ‘none’, ‘limited’, or ‘shallow’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa internal ID of the purchase order to release from buyer hold
array
JSON array of specific fields/associations to include in the response. Example: [‘id’, ‘status’, ‘po-number’]
string ("none" | "limited" | "shallow")
Controls response verbosity: ‘none’ returns no body; ‘limited’ returns only IDs; ‘shallow’ returns object attributes with one-level associations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the remit-to address to delete.
integer
required
ID of the supplier who owns the remit-to address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the contract from which the content group will be removed
integer
required
ID of the business group/content group to remove from the contract

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the contract from which all content groups will be removed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the supplier information record from which all content groups will be removed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the supplier information site record from which all content groups will be removed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the supplier from which all content groups will be removed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the contract.
integer
Impersonate as the given user id via X-COUPA-API-USER-ID header.
integer
Approval record ID to remove. One of approver_id or approval_id may be required.
integer
Coupa internal user ID of the approver to remove. One of approver_id or approval_id may be required.
string
Impersonate as the given user email via X-COUPA-API-USER-EMAIL header.
string
Impersonate as the given user login via X-COUPA-API-USER-LOGIN header.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the supplier information site from which the content group will be removed
integer
required
ID of the business group/content group to remove from the SIM site

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the supplier site from which the content group will be removed
integer
required
ID of the business group/content group to remove from the supplier site

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the supplier information record from which the content group will be removed
integer
required
ID of the business group/content group to remove from the SIM record

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the supplier from which the content group will be removed
integer
required
ID of the business group/content group to remove from the supplier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa internal ID of the purchase order line to reopen for receiving
integer
required
ID of the reason insight explaining why the line is being reopened
string
required
Comment explaining the reason for reopening the line for receiving

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa internal ID of the purchase order to reopen
integer
The ID of the reason insight for reopening the PO. Use either this or reason-insight-code.
string
The code of the reason insight for reopening the PO. Use either this or reason-insight-id.
string
Comment describing the reason for reopening the PO

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Exact-match filter by requisition line ID
integer
Maximum number of records to return per request (1-50, default: 50)
string
JSON array specifying which fields to return, e.g., [“id”,“description”,“total”]
integer
Number of records to skip for pagination (default: 0)
string
Filter by line status (e.g., approved, pending)
integer
Filter by line number
string
Filter by multiple statuses (comma-separated list, e.g., approved,pending)
string
Exact-match filter by line description
string
Filter lines created after this date (ISO 8601 format with timezone, e.g., 2025-01-01T00:00:00-07:00)
string
Filter lines created before this date (ISO 8601 format with timezone)
string
Filter lines updated after this date (ISO 8601 format with timezone)
string
Filter lines with need-by date after this date (ISO 8601 format with timezone)
string
Substring filter for line description

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
List of requisition line items to add to cart. At least one line is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_REQUISITIONS_ATTACHMENTS_CREATETool to create an attachment on a requisition. Use when attaching files, text, or URLs to requisitions.

Input Parameters

string
URL for URL attachments. Required when type=‘url’
object
File to upload. Required when type=‘file’
string
Text content for text attachments. Required when type=‘text’
string ("file" | "text" | "url")
required
Type of the attachment. ‘file’, ‘text’, or ‘url’
string
Intent of the attachment (max 40 characters). For example, ‘Supplier’
integer
required
ID of the requisition to attach the resource
string
Login of the user to impersonate; sent as ‘x-coupa-api-user-login’ header

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_REQUISITIONS_CREATETool to create a new requisition. Endpoint: POST /api/requisitions

Input Parameters

string
Buyer note/comment
array
List of attachments (text or URL)
object
required
User who requested the requisition. Provide id, login, or email.
string
Justification for the requisition
object
Address reference - provide id.
array
required
List of requisition line items. At least one line is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
JSON array of fields to return; e.g., [‘id’,{‘requisition-lines’:[‘id’,‘line-num’]}].
string ("limited" | "shallow")
Controls response verbosity: ‘limited’ returns IDs only, ‘shallow’ includes one-deep associations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_REQUISITIONS_DESTROYTool to delete a requisition. Use when you need to permanently remove a requisition by ID.

Input Parameters

integer
required
Coupa requisition ID to delete.
string
Optional response control; e.g., ‘limited’ to return only IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_REQUISITIONS_INDEXTool to list requisitions with filters.

Input Parameters

integer
Maximum number of records to return (1-50).
string
JSON array of fields to return; e.g., [‘id’,{“requisition-lines”:[“id”,“line-num”]}]
integer
Number of records to skip for pagination.
string
Filter by requisition status (draft, cart, pending_buyer_action, pending_approval, approved, ordered, partially_received, received, abandoned, backgrounded, withdrawn).
string
Response verbosity: ‘limited’ or ‘shallow’.
string
Filter by requester login

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_REQUISITIONS_MINETool to list the authenticated user’s requisitions. Use when you need to retrieve paginated user requisitions with optional filters.

Input Parameters

integer
Maximum number of records to return (1-50). Coupa enforces a maximum of 50.
string
JSON array of fields to return; e.g., [‘id’,{‘requisition-lines’:[‘id’,‘line-num’]}].
integer
Number of records to skip for pagination. Must be non-negative.
string ("draft" | "cart" | "pending_buyer_action" | "pending_approval" | "approved" | "ordered" | "partially_received" | "received" | "abandoned" | "backgrounded" | "withdrawn")
Filter by requisition status.
string
Filter requisitions by creation timestamp (ISO 8601).
string ("limited" | "shallow")
Controls response verbosity: ‘limited’ returns IDs only, ‘shallow’ includes one-deep associations.
string
Filter requisitions by requester login name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa internal ID of the requisition.
integer
Impersonate as the given user id via X-COUPA-API-USER-ID header.
integer
Approval record ID to remove. This is the recommended parameter for removing an approver.
integer
Coupa internal user ID of the approver to remove. May be used in combination with approval_id.
string
Impersonate as the given user email via X-COUPA-API-USER-EMAIL header.
string
Impersonate as the given user login via X-COUPA-API-USER-LOGIN header.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the requisition to save for later
string
JSON array of fields to return, e.g. [“id”,“status”]. Supports nested selection.
string ("none" | "limited" | "shallow")
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_REQUISITIONS_SHOWRetrieve a single Coupa requisition by ID to view its details. Optionally select returned fields or control response verbosity.

Input Parameters

integer
required
Coupa unique identifier of the requisition to retrieve.
string
JSON array of fields to return; e.g., [‘id’,‘status’,{‘requisition_lines’:[‘id’,‘line_num’]}]
string
Response verbosity: ‘limited’ or ‘shallow’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Buyer note/comment
array
List of attachments (text or URL)
object
required
User who requested the requisition. Provide id, login, or email.
string
Justification for the requisition
object
Address reference - provide id.
array
required
List of requisition line items. At least one line is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa requisition ID to update and submit.
object
required
Writable requisition header fields per Coupa API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the invoice to restart approvals for.
string
Optional response size control: ‘none’ (no response body), ‘limited’ (only IDs), ‘shallow’ (all attributes with one-deep association IDs).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_RETRIEVE_ALL_SIM_RECORDSList Supplier Information Management (SIM) records from Coupa with optional date, export status, supplier ID, name, and status filters. Supports pagination using limit and offset; each call retrieves one page.

Input Parameters

string
Filter by supplier name (exact match).
integer
Maximum number of records to return per call (1-50). Default: 50 records.
string
JSON array of specific fields to return in response. Example: [“id”,“name”,“status”]
integer
Starting position for retrieving records in subsequent calls (default 0). Example: offset=50 retrieves records 51-100.
string
Filter by supplier status (e.g., ‘active’). Supports operators: [eq], [contains], [starts_with], [ends_with], [not_eq], [in], [not_in].
boolean
Filter by export status. Set to false to retrieve only records that have not been exported before.
string
Specifies the field to order results by (e.g., ‘id’, ‘name’, ‘created-at’).
integer
Filter by associated supplier ID (exact match).
string
Filter by creation date greater than this timestamp. ISO 8601 format (YYYY-MM-DDTHH:MM:SS).
string
Filter by creation date less than this timestamp. ISO 8601 format (YYYY-MM-DDTHH:MM:SS).
string
Filter by supplier name containing this substring.
string
Filter by update date greater than this timestamp. ISO 8601 format (YYYY-MM-DDTHH:MM:SS).
string
Filter by update date less than this timestamp. ISO 8601 format (YYYY-MM-DDTHH:MM:SS).
string
Filter by supplier name ending with this substring.
integer
Filter by supplier ID equal to this value.
integer
Filter by supplier ID greater than this value.
integer
Filter by supplier ID less than this value.
string
Filter by supplier status containing this substring.
string
Filter by supplier name starting with this substring.
string
Filter by creation date greater than or equal to this timestamp. ISO 8601 format.
string
Filter by creation date less than or equal to this timestamp. ISO 8601 format.
string
Filter by update date greater than or equal to this timestamp. ISO 8601 format.
string
Filter by update date less than or equal to this timestamp. ISO 8601 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the invoice to retrieve the clearance document for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the invoice to retrieve the image scan for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The SIM record identifier - unique identifier for the supplier information record to retrieve
string
JSON array of specific fields to return; e.g., [‘id’,‘name’,‘status’].
string
Response verbosity: ‘limited’ for IDs-only or ‘shallow’ for shallow associations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_RETURN_TO_SUPPLIER_TRANSACTIONS_DESTROYDelete a return to supplier transaction by ID. A 404 response is returned without an error and may mean the transaction was already deleted or never existed.

Input Parameters

integer
required
Coupa return to supplier transaction ID to delete.
string
Optional response control; e.g., ‘limited’ to return only IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_S3_FILE_UPLOAD_OR_GETCreate a file, text, or URL attachment on a Coupa resource, or check an attachment by ID. Returns the Coupa attachment ID as a string in the s3key field.

Input Parameters

string
URL when type=‘url’
object
File to upload (type=‘file’).
string
Text content when type=‘text’
string ("file" | "text" | "url")
Attachment type for upload: ‘file’, ‘text’, or ‘url’
string
Attachment intent/category (optional, max ~40 chars)
string
Filename when providing base64 content.
string
MIME type (e.g., ‘text/plain’, ‘application/pdf’) when using base64 content
string ("upload" | "get")
required
‘upload’ to create attachment; ‘get’ to verify attachment exists
string
Base64-encoded file content.
integer
Coupa resource id for attachment operations
integer
Attachment id to verify (returned as a file reference key if found)
string
Coupa resource type (e.g., ‘invoices’, ‘purchase_orders’, ‘expense_reports’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
List of requisition line IDs to schedule for issuance. Example: [54214, 54220, 54224]
string
required
Target issuance date in MM/DD/YYYY format. This is the date when the requisition lines should be issued.
integer
Number of days before retrying issuance if requisition remains unapproved. This allows automatic retry logic for unapproved requisitions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique shipping term code identifier (max 255 characters)
boolean
required
Whether the shipping term is active and available to users
string
Description of the shipping term
array
List of content groups (business groups) to associate with this shipping term

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the shipping term to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the shipping term to update
string
Unique shipping term code identifier (max 255 characters)
boolean
Whether the shipping term is active and available to users
string
Description of the shipping term
array
List of content groups (business groups) to associate with this shipping term

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa internal ID of the purchase order line to soft close for invoicing
integer
ID of the reason insight explaining why the line is being soft closed
string
Code identifying the reason for soft closing
string
Comment explaining the reason for soft closing the line for invoicing

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa internal ID of the purchase order line to soft close for receiving
integer
ID of the reason insight explaining why the line is being soft closed
string
Code identifying the reason for soft closing
string
Comment explaining the reason for soft closing the line for receiving

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_SUBMIT_CONTRACT_FOR_APPROVALSubmit a Coupa contract by ID to start its approval process. You can control response detail and specify a user or business role for the action.

Input Parameters

integer
required
Coupa internal ID of the contract to submit for approval
array
JSON array of specific fields/associations to include in the response. Example: [‘id’,‘status’]
integer
Impersonate as the given user id via X-COUPA-API-USER-ID header.
string
Perform the action on behalf of this user (email or login); sent as X-COUPA-ON-BEHALF-OF header.
string
Coupa business role to use when acting on behalf of a user; sent as X-COUPA-BUSINESS-ROLE header.
string ("none" | "limited" | "shallow")
Controls response verbosity: ‘none’, ‘limited’, or ‘shallow’
string
Impersonate as the given user email via X-COUPA-API-USER-EMAIL header.
string
Impersonate as the given user login via X-COUPA-API-USER-LOGIN header.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Coupa internal identifier for the supplier information site to be deleted.
string
Optional response control; supports ‘none’ (empty response), ‘limited’ (IDs only), or ‘shallow’ (object with attributes).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Exact-match filter by Coupa internal unique identifier for the supplier information site
string
Filter by supplier code (unique identifier, max 20 chars); supports Coupa query operators like contains, starts_with, ends_with.
string
Filter by supplier information name (max 255 chars); supports Coupa query operators.
integer
Number of records to return per request. Default: 50, Maximum: 50
boolean
Filter by site active status: true for active sites, false for inactive
string
JSON array of specific fields to return in response; e.g., [“id”,“name”,“code”,{“addresses”:[“id”,“street1”]}]
integer
Starting position for pagination. Increment by 50 for successive batches.
boolean
Filter by export status: true for exported records, false for not exported
string
Field name to sort results by (e.g., created_at, updated_at, id, name)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Coupa unique identifier for the supplier item to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_SUPPLIER_RISK_AWARE_FEED_DESTROYDelete a Supplier Risk Aware Feed record by ID. A 404 is returned as a non-error result with status 404, so it does not confirm that a record was deleted.

Input Parameters

integer
required
Supplier Risk Aware Feed ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the supplier risk aware feed to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_SUPPLIER_SITES_CREATECreate a supplier site in Coupa for an existing supplier with specified PO transmission methods.

Input Parameters

string
required
Unique supplier site code identifier (max 20 characters)
string
required
Name of the supplier site
boolean
required
Whether the supplier site is active and available for use
string
URL for cXML transmission (required if po-method is ‘cxml’)
string
Email address for PO delivery (required if po-method is ‘email’)
string
required
Purchase order transmission method. Valid values: cxml, xml, email, prompt, mark_as_sent, buy_online
boolean
Whether to hold POs for buyer review before transmission
string
cXML ‘From’ domain for authentication
string
Shared secret for cXML authentication
integer
required
ID of the parent supplier to which this site belongs
string
cXML ‘From’ identity for authentication
string
Transmission protocol for cXML
string
Default locale setting for the supplier site
string
Default payment method for this supplier site
string
SSL version for cXML transmission. Valid values: TLSv1_2, TLSv1_1, TLSv1
string
required
Method for transmitting purchase order changes. Valid values: cxml, xml, email, prompt, mark_as_sent, buy_online
string
HTTP username for cXML access credentials
boolean
Whether to disable certificate verification
string
cXML ‘To’ supplier domain
string
Setting for allowing CSP change requests
string
cXML ‘To’ supplier identity
integer
Settings for item substitutions in order confirmations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Supplier site ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_SUPPLIERS_SHOWTool to retrieve a single supplier. Use when you need detailed supplier information by ID.

Input Parameters

integer
required
ID of the supplier to retrieve
string
JSON array of fields to return; e.g., [‘id’,‘name’,‘status’].
string
Response verbosity: ‘limited’ or ‘shallow’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the supplier to update.
string
DUNS number.
string
Supplier name.
string
JSON array of fields to return; e.g., [‘id’,‘name’].
string
Supplier number.
string
Supplier status; defaults to ‘draft’ on create if unset.
boolean
Put supplier on hold.
object
Additional supplier attributes to update directly; keys should use Coupa API hyphenated names.
string
cXML endpoint URL.
string
Email used when po-method=email.
string ("cxml" | "xml" | "email" | "prompt" | "mark_as_sent" | "buy_online")
Purchase order transmission method.
string
cXML domain.
string
cXML secret.
string
User email or login to perform the action on behalf of. Sent as ‘X-COUPA-ON-BEHALF-OF’ header.
object
Payment term by ID or code.
string
Coupa business role to use when acting on behalf of a user. Sent as ‘X-COUPA-BUSINESS-ROLE’.
string
cXML identity.
string
cXML protocol.
string ("none" | "limited" | "shallow")
Controls response verbosity: ‘none’, ‘limited’, or ‘shallow’.
object
Shipping term by ID.
string
Account number.
object
Primary address details.
object
Primary contact details.
boolean
Enable cXML invoicing.
string
cXML supplier domain.
boolean
Enable invoicing from Coupa Connect.
string
cXML supplier identity.
string ("2-way" | "3-way" | "3-way-direct" | "none")
Invoice matching level.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Email address of the supplier user whose locale needs to be synced.
integer
required
Coupa internal ID of the supplier to which the user belongs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_TASKS_DESTROYTool to delete a task. Use when you need to permanently remove a task by ID.

Input Parameters

integer
required
Coupa task ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_TASKS_SHOWTool to retrieve a single task by ID. Use when you need detailed task information after knowing the task ID.

Input Parameters

integer
required
ID of the task to retrieve
string
JSON array of fields to return; e.g., [‘id’,‘title’,‘status’].
string
Response verbosity: ‘shallow’ returns all attributes and IDs of one-deep associations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the task to update.
string
Task title.
string
JSON array of fields to return; e.g., [‘id’,‘title’,‘status’].
string
Task status (e.g., ‘pending’, ‘in_progress’, ‘completed’).
object
Additional task attributes to update directly; keys should use Coupa API hyphenated names.
string
Task due date in ISO format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS).
number
Task duration in days.
integer
User ID to whom the task is assigned.
integer
Task completion percentage (0-100).
string
Task start date in ISO format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS).
string
Task description or details.
integer
ID of the linked object (e.g., requisition, purchase order). Required if linkable-type is provided.
string
User email or login to perform the action on behalf of. Sent as ‘X-COUPA-ON-BEHALF-OF’ header.
string
Coupa business role to use when acting on behalf of a user. Sent as ‘X-COUPA-BUSINESS-ROLE’.
string
Type of the linked object (e.g., ‘Requisition’, ‘PurchaseOrder’). Required if linkable-id is provided.
string ("none" | "limited" | "shallow")
Controls response verbosity: ‘none’, ‘limited’, or ‘shallow’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Exact-match filter by Coupa unique identifier
boolean
Filter by local status: true for non-cross-border registrations, false otherwise
boolean
Filter by active status: true for enabled tax codes, false for disabled
string
JSON array of fields to return; e.g., [“id”,“number”,“active”].
string
Filter by tax registration number; supports operators like contains, starts_with, ends_with.
integer
Pagination offset; results are returned in pages of up to 50
integer
Filter by Coupa unique identifier of the associated object
string
Filter by type of the owning object
string
Filter by country code where the tax code is applied
string
Response size control: ‘limited’ returns only IDs; ‘shallow’ returns attributes with one-level associations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the tax registration to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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
required
Array of requisition line IDs to unschedule from automatic PO issuance

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_UO_MS_INDEXTool to list units of measure. Use when retrieving or filtering UOM catalog for inventory or purchasing flows.

Input Parameters

integer
Exact-match filter by Coupa UOM ID
string
Filter by UOM code; supports operators like contains, starts_with, ends_with.
string
Filter by UOM name; supports standard operators.
boolean
Filter by active status (true or false).
string
JSON array of fields to return; e.g., [“id”,“code”,“name”].
integer
Pagination offset; results are returned in pages of up to 50.
string
Filter UOMs created after this timestamp (ISO 8601).
string
Filter UOMs created before this timestamp (ISO 8601).
string
Response size control: ‘limited’ returns only IDs; ‘shallow’ returns attributes with one-level associations.
string
Filter UOMs updated after this timestamp (ISO 8601).
string
Filter UOMs updated before this timestamp (ISO 8601).
integer
Filter by allowable precision; supports comparison operators (gt, lt, etc.).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the budget line to update.
string
Additional notes or comments for the budget line.
number
Budget line amount (decimal). The total budgeted amount for this line.
number
Remaining budget amount (decimal). The amount left available to spend from this budget line.
string
Account segment 1 value for chart of accounts categorization.
string
Account segment 2 value for chart of accounts categorization.
string
Budget line description explaining the purpose or details of this budget line.
boolean
Whether the budget line owner is also an approver for transactions against this budget line.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_UPDATE_BUDGET_LINES_ADJUSTPerform an adjustment operation on an existing Coupa budget line identified by ID.

Input Parameters

integer
required
The ID of the budget line to adjust

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the business entity to update.
string
Unique name of the business entity.
string ("LegalBusinessEntity" | "OrganizationalBusinessEntity")
Type of business entity.
string
Status of the business entity.
object
Additional business entity attributes to update; use Coupa API hyphenated names as keys.
array
Collection of addresses associated with the business entity.
string
Display name for the business entity.
string
User email or login to perform the action on behalf of. Sent as ‘X-COUPA-ON-BEHALF-OF’ header.
string
Coupa business role to use when acting on behalf of a user. Sent as ‘X-COUPA-BUSINESS-ROLE’.
string ("none" | "limited" | "shallow")
Controls response verbosity: ‘none’, ‘limited’, or ‘shallow’.
string ("Organization" | "Person")
Formation type of the business entity.
object
Primary address reference for the business entity.
object
Primary contact details for the business entity.
object
Country where the business entity originates.
array
Relationships with other business entities.
array
Account owners for the business entity.
array
Alternate names for the business entity.
array
External system references for the business entity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_UPDATE_COMMODITIESTool to update an existing Coupa commodity. Use when modifying commodity attributes after confirming the commodity ID exists.

Input Parameters

integer
required
The Coupa unique identifier of the commodity to update
string
Unique commodity identifier (max 255 chars)
boolean
Controls availability to users - true makes it available, false inactivates it
string
JSON array of fields to return; e.g., [‘id’,‘name’,‘active’].
object
Additional commodity properties to update; use Coupa API hyphenated names as keys.
string ("goods" | "services" | "monetary" | "others")
Category options for commodities.
string ("Yes" | "No" | "Automatic" | "Always" | "Never")
Preferred options for commodities.
string ("raw_materials" | "investment_goods" | "services_exceptions")
Subcategory options for commodities.
string
User email or login to perform the action on behalf of. Sent as ‘X-COUPA-ON-BEHALF-OF’ header.
string
Coupa business role to use when acting on behalf of a user. Sent as ‘X-COUPA-BUSINESS-ROLE’.
string ("fully_deductible" | "partially_deductible" | "not_deductible")
Deductibility options for commodities.
string ("none" | "limited" | "shallow")
Controls response verbosity: ‘none’, ‘limited’, or ‘shallow’.
string
Localized name variant for the commodity

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_UPDATE_EXCHANGE_RATEUpdate a Coupa exchange rate by ID, including its value or effective date. Exchange rates are one-way, and referenced currencies must already exist in Coupa.

Input Parameters

integer
required
Coupa unique identifier of the exchange rate to update.
number
The exchange rate value between the source and target currencies. For example, if 1 USD = 0.85 EUR, the rate is 0.85.
string
JSON array of fields to return; e.g., [‘id’,‘rate’,‘rate-date’].
object
Additional exchange rate attributes to update directly; keys should use Coupa API hyphenated names.
string
The effective date when this exchange rate applies. Format: YYYY-MM-DD.
object
Currency reference object.
string
User email or login to perform the action on behalf of. Sent as ‘X-COUPA-ON-BEHALF-OF’ header.
string
Coupa business role to use when acting on behalf of a user. Sent as ‘X-COUPA-BUSINESS-ROLE’.
object
Currency reference object.
string ("none" | "limited" | "shallow")
Controls response verbosity: ‘none’, ‘limited’, or ‘shallow’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the address to update.
string
City name.
string
Address nickname for identification.
string
State or province abbreviation.
boolean
Controls whether address is available to users. Cannot update if address is already inactive.
string
JSON array of fields to return; e.g., [‘id’,‘name’,‘city’].
object
Country object reference. Must exist in system. Can specify by id, code, or name.
object
Additional address attributes to update directly; keys should use Coupa API hyphenated names.
string
Address line 1 (primary street address).
string
Address line 2 (suite, building, etc.).
string
Address line 3 (additional address information).
string
Address line 4 (additional address information).
string
Attention line for the address (recipient name or department).
string
VAT identifier for the address.
string
Postal or ZIP code.
object
VAT country reference. Must exist in system.
string
User email or login to perform the action on behalf of. Sent as ‘X-COUPA-ON-BEHALF-OF’ header.
string
Coupa business role to use when acting on behalf of a user. Sent as ‘X-COUPA-BUSINESS-ROLE’.
string
Location code for the address.
string ("none" | "limited" | "shallow")
Controls response verbosity: ‘none’ (no response), ‘limited’ (IDs only), or ‘shallow’ (all attributes + IDs of associations).
string
ISO format state code (CC-SSS format, e.g., US-CA for California).
string
Local tax identifier for the address.
string
Content group name for access control.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier for the commodity to update
string
Commodity name (max 255 characters)
boolean
A false value will inactivate the commodity making it no longer available to users
string ("goods" | "services" | "monetary" | "others")
Category options for commodities.
string ("Yes" | "No" | "Automatic" | "Always" | "Never")
Preferred options for commodities.
string ("raw_materials" | "investment_goods" | "services_exceptions")
Subcategory options for commodities.
string ("fully_deductible" | "partially_deductible" | "not_deductible")
Deductibility options for commodities.
string
Translated name of the commodity

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the lookup value to update.
string
The lookup value’s display name.
boolean
Controls visibility; setting to false inactivates the lookup value.
string
JSON array of fields to return; e.g., [‘id’,‘name’,‘active’].
object
External Ref Code of the parent element in hierarchy, e.g., {‘external-ref-code’: ‘123’}.
object
Additional lookup value properties to update; use Coupa API hyphenated names as keys.
integer
Associated lookup identifier to update the lookup for a lookup value.
boolean
Designates this as the default option.
string
Text describing the lookup value.
object
Reference to the associated account type, e.g., {‘id’: 1}.
string
User email or login to perform the action on behalf of. Sent as ‘X-COUPA-ON-BEHALF-OF’ header.
string
Coupa business role to use when acting on behalf of a user. Sent as ‘X-COUPA-BUSINESS-ROLE’.
string ("none" | "limited" | "shallow")
Controls response verbosity: ‘none’, ‘limited’, or ‘shallow’.
string
The actual account value used in accounting systems.
string
Hierarchical identifier for lookups; concatenates External Ref Num fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the payment term to update.
string
Payment term code identifier.
string ("DaysAfterNetPaymentTerm" | "SpecificDayPaymentTerm")
Payment term type: DaysAfterNetPaymentTerm or SpecificDayPaymentTerm.
boolean
Activation status; false inactivates, true activates the payment term.
string
JSON array of fields to return; e.g., [‘id’,‘code’,‘description’].
object
Additional payment term attributes to update directly; keys should use Coupa API hyphenated names.
string
Descriptive text for the payment term.
integer
Determines payment due date (1-31).
string
User email or login to perform the action on behalf of. Sent as ‘X-COUPA-ON-BEHALF-OF’ header.
string
Coupa business role to use when acting on behalf of a user. Sent as ‘X-COUPA-BUSINESS-ROLE’.
number
Discount percentage rate (as decimal).
integer
Determines payment due date (0-6).
string ("none" | "limited" | "shallow")
Controls response verbosity: ‘none’, ‘limited’, or ‘shallow’.
array
Associated content groups (business groups).
integer
Helps to determine payment due date if document (1-31).
integer
Used to calculate discount due date (1-31).
integer
Calculates discount due date with day (0-6).
integer
Documents before this day are eligible for discount (1-31).
integer
Days allowed for net payment.
integer
Days allowed for discount payment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the supplier item to update.
object
Item reference, e.g., {‘id’: 202}.
string
Item price as a decimal string.
object
Associated catalog reference, e.g., {‘id’: 5}.
object
Additional supplier item attributes to update directly; keys should use Coupa API hyphenated names.
object
Related contract reference, e.g., {‘id’: 10}.
object
Currency object reference, e.g., {‘code’: ‘USD’} or {‘id’: 1}.
object
Supplier reference, e.g., {‘id’: 3} or {‘name’: ‘Office Depot (USA)’}.
integer
Lead time value in days.
boolean
Preferred supplier indicator.
boolean
Whether the item is purchasable.
string
Savings percentage as a decimal string.
string
UNSPSC classification code.
string ("in_stock" | "out_of_stock" | "backordered")
Stock status: in_stock, out_of_stock, or backordered.
string
Manufacturer name.
string
User email or login to perform the action on behalf of. Sent as ‘X-COUPA-ON-BEHALF-OF’ header.
string
Price tier 1 as a decimal string.
string
Price tier 2 as a decimal string.
string
Price tier 3 as a decimal string.
string
Price tier 4 as a decimal string.
string
Price tier 5 as a decimal string.
string
Price tier 6 as a decimal string.
string
Price tier 7 as a decimal string.
string
Price tier 8 as a decimal string.
string
Price tier 9 as a decimal string.
string
Coupa business role to use when acting on behalf of a user. Sent as ‘X-COUPA-BUSINESS-ROLE’.
object
Contract term details reference.
string
Price tier 10 as a decimal string.
string
Price tier 11 as a decimal string.
string
Price tier 12 as a decimal string.
string
Price tier 13 as a decimal string.
string
Price tier 14 as a decimal string.
string
Price tier 15 as a decimal string.
string
Price tier 16 as a decimal string.
string
Price tier 17 as a decimal string.
string
Price tier 18 as a decimal string.
string
Price tier 19 as a decimal string.
string
Price tier 20 as a decimal string.
string ("none" | "limited" | "shallow")
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.
string
Order increment value as a decimal string.
string
Date of availability change in ISO 8601 format (YYYY-MM-DDTHH:MM:SS+HH:MM).
string
Supplier’s part number.
string
Auxiliary part number.
string
Minimum order amount as a decimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Task title.
string
JSON array of fields to return; e.g., [‘id’,‘title’,‘status’].
string
Current task state (e.g., ‘pending’, ‘in_progress’, ‘completed’).
object
Additional task attributes to update directly; keys should use Coupa API hyphenated names.
integer
required
The unique identifier of the task to update.
string
Task due date in ISO format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS).
number
Task duration in days.
integer
User ID to whom the task is assigned.
integer
Task completion percentage (0-100).
integer
required
The unique identifier of the project containing the task.
string
Task start date in ISO format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS).
string
Task description providing additional details.
string
User email or login to perform the action on behalf of. Sent as ‘X-COUPA-ON-BEHALF-OF’ header.
string
Coupa business role to use when acting on behalf of a user. Sent as ‘X-COUPA-BUSINESS-ROLE’.
string ("none" | "limited" | "shallow")
Controls response verbosity: ‘none’, ‘limited’, or ‘shallow’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the address to update.
string
City name.
string
Address ‘Nickname’ or label to identify this address.
string
State abbreviation.
boolean
Set to true to activate address or false to deactivate. Inactive addresses are not available to users.
string
JSON array of fields to return; e.g., [“id”,“name”,“city”,“state”,“country”].
object
Country information for the address.
string
Address Line 1 (primary street address).
string
Address Line 2 (apartment, suite, unit, etc.).
string
Address Line 3 (additional address information).
string
Address Line 4 (additional address information).
string
Address Default Attention Line / contact person name.
string
VAT number associated with this address.
string
Postal/ZIP code.
object
Country information for the address.
integer
required
ID of the user whose address to update.
string
Location code for the address.
string
Response verbosity: ‘none’ (no response), ‘limited’ (minimal fields), or ‘shallow’ (full attributes with one-level associations).
string
ISO Code for State in format CC-SSS (e.g., ‘US-CA’ for California).
string
External Source Reference identifier.
string
Local tax number for the address.
string
External Source Name.
string
Content Group Name for Address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa internal ID of the purchase order to update
array
required
List of order lines to update with their IDs and new values
integer
Order confirmation ID to associate with the purchase order
string
External reference number for the purchase order

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_UPDATE_IMAGE_SCAN_ON_AN_INVOICEUpdate an invoice’s image scan via PUT /api/invoices/:id/image_scan using a URL reference to the scanned document.

Input Parameters

integer
required
Coupa unique identifier of the invoice to update image scan for
string
required
URL of the image scan document. Must begin with ‘http://’ or ‘https://’
string
Type of image scan update: ‘url’ for providing a URL reference to the image scan document
string ("none" | "limited" | "shallow")
Controls response verbosity: ‘none’, ‘limited’, or ‘shallow’. Default varies by operation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the invoice to update.
string
JSON array of fields to return in response; e.g., [‘id’,‘invoice-number’,{‘currency’:[‘code’]}].
string
Invoice status (e.g., ‘pending_approval’, ‘approved’, ‘disputed’).
object
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’).
object
Currency reference object, e.g., {‘code’: ‘USD’}.
string
Invoice date (format: YYYY-MM-DD). IMPORTANT: Provide only the date, do not include timestamp to avoid credit note linking issues.
string
Date when payment was made (format: YYYY-MM-DD).
object
Payment term reference object, e.g., {‘id’: 1} or {‘code’: ‘NET30’}.
string
Exchange rate for currency conversion.
string
Internal notes for the invoice (visible to internal users only).
string
Notes related to payment processing.
string
Optional response verbosity control: ‘none’ (no response body), ‘limited’ (only IDs), ‘shallow’ (all attributes with one-deep association IDs).
string
Notes visible to the supplier.
string
Invoice number from the supplier.
object
Payment method reference object, e.g., {‘id’: 1}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Price as decimal string
integer
required
The ID of the item
object
Reference to a contract.
object
Reference to a currency.
integer
Lead time in days
boolean
Whether this supplier item is preferred
string
Savings percentage as decimal string
string
UNSPSC code
string
Availability status: in_stock, out_of_stock, or backordered
string
Manufacturer name
string
Price tier 1 as decimal string
string
Price tier 2 as decimal string
string
Price tier 3 as decimal string
string
Price tier 4 as decimal string
string
Price tier 5 as decimal string
object
Reference to a contract term.
string
Order increment as decimal string
integer
required
The ID of the supplier item to update
string
Availability date in ISO format
string
Supplier part number
string
Supplier auxiliary part number
string
Minimum order quantity as decimal string

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the invoice payable to start tracking in Coupa

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique Coupa identifier of the payable order to mark as ready to pay

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_UPDATE_PROJECT_MEMBER_AS_OWNERUpdate a Coupa project membership’s owner/administrator and participant statuses. Both statuses and the project ID must be supplied for the update.

Input Parameters

boolean
required
Whether the user is a project owner/administrator. Set to true to designate as owner.
string
JSON array of fields to return; e.g., [“id”,“owner”,“participant”]
integer
The ID of the user being updated. Can be null for certain membership types.
integer
required
The ID of the project.
boolean
required
Whether the user is a participant in the project.
string
Controls response verbosity: ‘none’, ‘limited’, or ‘shallow’.
integer
required
Coupa unique identifier of the project membership to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the task to update.
string
Task title.
string
JSON array of fields to return; e.g., [‘id’,‘title’,‘status’].
string
Current task state (e.g., ‘pending’, ‘in_progress’, ‘completed’).
object
Additional task attributes to update directly; keys should use Coupa API hyphenated names.
string
Task due date in ISO format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS).
number
Task duration in days.
integer
User ID to whom the task is assigned.
integer
Task completion percentage (0-100).
integer
required
The unique identifier of the project containing the task.
string
Task start date in ISO format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS).
string
Task description providing additional details.
string
User email or login to perform the action on behalf of. Sent as ‘X-COUPA-ON-BEHALF-OF’ header.
string
Coupa business role to use when acting on behalf of a user. Sent as ‘X-COUPA-BUSINESS-ROLE’.
string ("none" | "limited" | "shallow")
Controls response verbosity: ‘none’, ‘limited’, or ‘shallow’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Additional order header properties to update using Coupa API hyphenated names as keys
integer
required
Coupa internal ID of the purchase order change to update
string
required
The current approver’s login/username. Must exist in Coupa system.
integer
Purchase order header identifier
integer
Reason insight identifier
string
Reason insight code for the purchase order change
string
Comment body explaining the reason for the change

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Updated task title
string
Updated task status
integer
required
The ID of the task to update
string
Updated task due date in ISO format (YYYY-MM-DD)
integer
Updated task duration in days
integer
Updated owner user ID for the task
integer
Updated task completion percentage (0-100)
string
Updated task start date in ISO format (YYYY-MM-DD)
string
Updated task description
integer
required
The ID of the quote request containing the task
object
Attributes specific to sourcing event tasks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the requisition to update.
string
Transaction status of the requisition.
object
Additional requisition attributes to update; keys should use Coupa API hyphenated names.
boolean
Indicates if transaction has been exported.
string
Optional title of the requisition.
object
Requester user reference. Provide id, login, or email. Example: {‘id’: 5}
object
User who created the requisition. Provide id, login, or email. Example: {‘id’: 3}
array
List of attachments. Each attachment can have id, intent, type, and url.
string
Item need by date in ISO 8601 format (YYYY-MM-DDTHH:MM:SS+HH:MMZ).
string
Requisition justification comments.
object
Ship-to address reference. Provide id or full address details.
array
List of requisition line items. Each line should include description, item, and other required fields.
string
Ship to address attention field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_UPDATE_STATUS_OF_A_PROJECTUpdate a project’s status to draft, planned, in_progress, complete, or canceled. The result includes a success flag and the HTTP status code; a 304 response is reported as an invalid transition.

Input Parameters

integer
required
ID of the project to update status
string ("draft" | "planned" | "in_progress" | "complete" | "canceled")
required
Target status to transition the project to. Valid values: ‘draft’, ‘planned’, ‘in_progress’, ‘complete’, ‘canceled’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Coupa Internal ID of the supplier information site to update
string
Supplier code identifier (unique, max 20 chars)
string
Supplier Information name (max 255 chars)
boolean
True if the site is active
string
Comma-separated list of fields to return in the response; e.g., “id,code,name” or JSON array format [“id”,“code”,“name”]
object
Additional supplier information site attributes to update; keys should use Coupa API hyphenated names.
array
Supplier Information Site contacts
string
URL for PO transmission via cXML
string
Email destination for PO transmission
array
Supplier Information Site addresses
string
Purchase order transmission method
boolean
Hold all POs for buyer review
string
From domain identifier
string
Shared secret credentials
string
User email or login to perform the action on behalf of. Sent as ‘X-COUPA-ON-BEHALF-OF’ header.
object
Payment term reference, e.g., {‘id’: 1} or {‘code’: ‘Net 30’}
string
Coupa business role when acting on behalf of a user. Sent as ‘X-COUPA-BUSINESS-ROLE’.
string
From identity identifier
string
Transmission protocol
string ("none" | "limited" | "shallow")
Controls response verbosity: ‘none’, ‘limited’, or ‘shallow’.
object
Shipping term reference, e.g., {‘id’: 2} or {‘code’: ‘FOB’}
array
Content groups associated with the site, e.g., [{‘id’: 1}]
string
Default locale for emails
string
SSL version for cXML
string
Purchase order change transmission method
string
Supplier online store access credentials
boolean
Ignore SSL certificate mismatch errors
string
To supplier domain
boolean
Allows suppliers to create change requests from CSP
string
To supplier identity

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the supplier information site to update
string
Supplier site code identifier (max 20 characters)
string
Supplier information site name (max 255 characters)
boolean
Site operational status (true=active, false=inactive)
string
Email recipient for purchase order transmission when method is ‘email’
string
Purchase order transmission method (e.g., ‘email’, ‘cxml’)
object
Reference to a payment term.
string
Purchase order change transmission method
integer
required
ID of the supplier information record

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
City name (max 255 characters).
string
Name/description of the remit address (max 255 characters).
string
State/province abbreviation (max 255 characters).
boolean
Status flag (true for active, false for inactive). Setting to false deactivates the address.
object
Model for country details.
string
Primary street address line (max 255 characters).
string
Secondary street address line (max 255 characters).
string
Third street address line (max 255 characters).
string
Fourth street address line (max 255 characters).
integer
required
Coupa unique identifier of the remit-to address to update.
string
VAT registration identifier (max 255 characters).
string
Postal/zip code (max 255 characters).
integer
required
Coupa unique identifier of the supplier.
object
Model for country details.
string
Unique code identifying the remit address (max 255 characters).
string
Controls response format. Values: ‘none’ (no response body), ‘limited’ (only IDs), ‘shallow’ (full object with limited nested data).
string
Reference from originating system (max 255 characters).
string
Local tax identifier.
string
Source system identifier (max 255 characters).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_UPDATE_SUPPLIERS_SUPPLIER_SITESUpdate an existing supplier site’s configuration, including its name, active status and PO methods.

Input Parameters

integer
required
The supplier site’s unique identifier
integer
required
The supplier’s unique identifier
object
required
Supplier site update payload containing the fields to be updated

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the user group to update
string
Group name (max 255 chars)
boolean
Open membership status - whether the group is open for anyone to join
string
Type designation for the group (max 255 chars)
boolean
Active status of the user group
boolean
Approver capability - whether members of this group can approve requests
string
Group description
string
Mention name for the user group (max 255 chars)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the user group membership to update.
boolean
Indicates whether the user is admin or not.
string
JSON array of fields to return; e.g., [‘id’,‘owner’,‘participant’].
integer
User identifier.
boolean
Indicates whether the user is participant or not.
string
User email or login to perform the action on behalf of. Sent as ‘X-COUPA-ON-BEHALF-OF’ header.
string
Coupa business role when acting on behalf of a user. Sent as ‘X-COUPA-BUSINESS-ROLE’.
string ("none" | "limited" | "shallow")
Controls response verbosity: ‘none’, ‘limited’, or ‘shallow’.
integer
User group ID or Project ID.
string ("UserGroup" | "Project")
Type of the group: ‘UserGroup’ or ‘Project’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier for the user group
string
User group name
boolean
User group is open for everyone to join or owner must invite
string
Blank for Groups, Project for Projects
object
Reference to a user group owner.
array
Collection of users in the group
boolean
Active status indicator
boolean
User group has the ability to be an approver
string
User group description
string
Mention name for the group
string
URL for avatar thumbnail

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the task to update
string
Task title (max 255 characters)
string
Task status (max 255 characters)
string
Deadline in format YYYY-MM-DDTHH:MM:SS+HH:MMZ
number
Task duration in days
integer
Assigned user ID
integer
Completion percentage (0-100)
string
Start date in datetime format (YYYY-MM-DDTHH:MM:SS+HH:MMZ)
string
Task description providing additional details
integer
required
ID of the user group containing the task

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_USER_GROUPS_INDEXList user groups in Coupa, with optional filtering and pagination. Group information may include members, approval permissions, and metadata.

Input Parameters

string
Exact-match filter by user group name.
integer
Maximum number of records to return (1-50). Default is 50 records.
boolean
Filter by active status: true for active groups, false for inactive.
string
JSON array of fields to return; e.g., [“id”,“name”,“active”].
integer
Number of records to skip for pagination (default 0).
string
Field(s) to order results by (alphabetical/numeric order). E.g., ‘name’.
boolean
Filter by approval permission: true for groups that can approve.
string
Filter groups whose name contains the given text.
string
Response verbosity: ‘limited’ returns only IDs; ‘shallow’ returns full object attributes with one-level association IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_USERS_CREATETool to create a Coupa user. Use when you need to programmatically add a new user to your Coupa instance.

Input Parameters

string
required
User email address
string
required
User login/username
boolean
When true the user account is active
string
required
User last name
string
required
User first name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_USERS_INDEXTool to list users. Use when you need to retrieve multiple user records with optional pagination and filtering.

Input Parameters

integer
Maximum number of records to return (1-50). Coupa Core API returns up to 50 records per call.
string
JSON array of fields to return; e.g., [‘id’,‘login’,{‘roles’:[‘id’,‘name’]}].
integer
Number of records to skip for pagination (default 0).
string
Filter by user status; e.g., ‘active’.
string
Response verbosity: ‘limited’ or ‘shallow’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUPA_USERS_SHOWTool to retrieve a single user by ID. Use when you need detailed user information after knowing the user ID.

Input Parameters

integer
required
ID of the user to retrieve
string
JSON array of fields to return; e.g., [‘id’,‘login’,{‘roles’:[‘id’,‘name’]}].
string
Response verbosity: ‘limited’ or ‘shallow’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the invoice to void
array
JSON array of specific fields or associations to include in the response. Example: [‘id’, ‘invoice-number’]
string ("none" | "limited" | "shallow")
Controls the shape of the response: ‘none’ for no object, ‘limited’ for minimal fields, ‘shallow’ for shallow associations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa internal ID of the contract to withdraw signatures from. The contract must be in ‘pending_signatures’ status.
array
JSON array of specific fields/associations to include in the response. Example: [‘id’,‘status’]
integer
Impersonate as the given user id via X-COUPA-API-USER-ID header.
string
Perform the action on behalf of this user (email or login); sent as X-COUPA-ON-BEHALF-OF header.
string
Coupa business role to use when acting on behalf of a user; sent as X-COUPA-BUSINESS-ROLE header.
string ("none" | "limited" | "shallow")
Controls response verbosity: ‘none’, ‘limited’, or ‘shallow’
string
Impersonate as the given user email via X-COUPA-API-EMAIL header.
string
Impersonate as the given user login via X-COUPA-API-USER-LOGIN header.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Coupa unique identifier of the invoice to withdraw dispute from.
string
Optional response size control: none | limited | shallow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not