Articles in this section

Available Coupa APIs

Naga Sri Hari Gonaboyina
Updated

When you configure an export, import, other type of flow step using the prebuilt Coupa connector, you can select any of the API operations attached below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Coupa API documentation. You can also create a composite endpoint for this application in HTTP mode.

Available DI objects

The following objects are available when using Coupa as a source in Celigo Data Integration (DI).

Primary key: All Coupa DI endpoints use id as the primary key. Coupa assigns a numeric id to every resource object with a consistent structure.

Note

Coupa soft deletes records. Records are deactivated via an active flag rather than physically removed. Some record types support hard delete. Celigo syncs all data returned by the source as-is.

Object API endpoint Available extract modes Delta field
Account types API Query chart of accounts Full, Incremental updated_at[gt]
Account validation rules API Query account validations Full, Incremental updated_at[gt]
Accounts API Query accounts Full, Incremental updated_at[gt]
Addresses API Query addresses Full, Incremental updated_at[gt]
Advance ship notices API Query advance ship notices Full, Incremental updated_at[gt]
Approvals API Query approvals Full, Incremental updated_at[gt]
Budget line adjustments API Query budget line adjustments Full, Incremental updated_at[gt]
Budget lines API Query budget lines Full, Incremental updated_at[gt]
Charges Get charges with fields query param not exported Full —
Comments API Query comments Full, Incremental updated_at[gt]
Commodities Get commodity by name Full —
Content groups API Query business groups Full, Incremental updated_at[gt]
Contracts API Query contracts Full, Incremental updated_at[gt]
Coupa Pay payments one time payment Get Coupa Pay invoice payments status and not exported Full —
Currencies API Query currencies Full —
Departments API Query departments Full, Incremental updated_at[gt]
Exchange rates API Query exchange rates Full, Incremental updated_at[gt]
Expense artifacts API Query expense artifacts Full, Incremental updated_at[gt]
Expense lines API Query expense lines Full, Incremental updated_at[gt]
Expense reports API Query expense reports Full, Incremental updated_at[gt]
Inventory transactions API Query inventory transactions Full, Incremental updated_at[gt]
Invoices API Query invoices Full, Incremental updated_at[gt]
Items API Query items Full, Incremental updated_at[gt]
Legal entity Read legal entity by ID Full —
Lookup values API Query lookup values Full, Incremental updated_at[gt]
Order list API Query order pads Full, Incremental updated_at[gt]
Payment terms API Query payment terms Full, Incremental updated_at[gt]
Purchase order change API Query purchase order changes Full, Incremental updated_at[gt]
Purchase order lines API Query purchase order lines Full, Incremental updated_at[gt]
Purchase orders API Query purchase orders Full, Incremental updated_at[gt]
Receiving transactions Retrieve goods receipts by po number Full —
Requisition lines Get requsition lines Full —
Requisitions API Query requisition headers Full, Incremental updated_at[gt]
Return to supplier transactions Get return to supplier transactions Full —
Shipping terms API Query shipping terms Full, Incremental updated_at[gt]
Supplier information API Query supplier informations Full, Incremental updated_at[gt]
Supplier items API Query supplier items Full, Incremental updated_at[gt]
Supplier sites Get supplier site by code Full —
Suppliers API Query suppliers Full, Incremental updated_at[gt]
Tax registration API Query tax registrations Full, Incremental updated_at[gt]
User group memberships API Query user group memberships Full, Incremental updated_at[gt]
User groups API Query user groups Full, Incremental updated_at[gt]
Users API Query users Full, Incremental updated_at[gt]

Response schemas

Click an object below to view its response fields and delta configuration.

Account types API — Query chart of accounts

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
name string
active boolean
dynamic_flag boolean
legal_entity_name string
currency object
currency.code string
primary_address object
primary_address.id number
created_at string
updated_at string
Account validation rules API — Query account validations

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
name string
description string
active boolean
created_at string
updated_at string
Accounts API — Query accounts

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
name string
code string
active boolean
segment_1 string
account_type object
account_type.id number
account_type.name string
created_at string
updated_at string
Addresses API — Query addresses

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
name string
active boolean
street1 string
city string
state string
postal_code string
country object
country.id number
country.code string
country.name string
vat_number string
created_at string
updated_at string
Advance ship notices API — Query advance ship notices

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
asn_number string
status string
ship_date string
delivery_date string
tracking_number string
carrier string
export_flag boolean
supplier object
supplier.id number
supplier.name string
ship_to_address object
ship_to_address.id number
ship_to_address.city string
lines objectarray
lines.id number
lines.line_num string
lines.quantity number
updated_at string
Approvals API — Query approvals

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
approvable_id number
approvable_type string
approval_chain_id number
position number
status string
type string
approval_date string
note string
approver object
approver.id number
approver.login string
created_at string
updated_at string
Budget line adjustments API — Query budget line adjustments

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
accounting_total number
budget_remaining number
description string
reason string
quantity number
price number
budget_line object
budget_line.id number
created_at string
Budget lines API — Query budget lines

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
amount number
description string
remaining number
pending_requisitions_amount number
currency object
currency.code string
period object
period.id number
period.name string
owner object
owner.id number
owner.login string
updated_at string
Charges — Get charges with fields query param not exported

Response schema:

Field Type
id number (Primary key)
amount number
description string
status string
created_at string
updated_at string
currency object
currency.id number
currency.code string
supplier object
supplier.id number
supplier.name string
supplier.number string
Comments API — Query comments

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
commentable_id number
commentable_type string
comments string
reason_code string
to_supplier boolean
created_by object
created_by.id number
created_by.login string
attachments objectarray
attachments.id number
attachments.file_name string
created_at string
updated_at string
Commodities — Get commodity by name

Response schema:

Field Type
id number (Primary key)
name string
active boolean
created_at string
updated_at string
parent object
parent.id number
parent.name string
Content groups API — Query business groups

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
name string
description string
created_by object
created_by.id number
created_by.login string
updated_by object
updated_by.id number
updated_by.login string
created_at string
updated_at string
Contracts API — Query contracts

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
name string
status string
type string
start_date string
end_date string
supplier object
supplier.id number
supplier.name string
payment_term object
payment_term.code string
shipping_term object
shipping_term.code string
updated_at string
Coupa Pay payments one time payment — Get Coupa Pay invoice payments status and not exported

Response schema:

Field Type
id number (Primary key)
amount number
status string
created_at string
updated_at string
currency object
currency.id number
currency.code string
Currencies API — Query currencies

Response schema:

Field Type
id number (Primary key)
code string
name string
symbol string
decimals number
enabled_flag boolean
created_by object
created_by.id number
updated_by object
updated_by.id number
Departments API — Query departments

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
name string
active boolean
created_by object
created_by.id number
updated_by object
updated_by.id number
created_at string
updated_at string
Exchange rates API — Query exchange rates

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
rate number
rate_date string
from_currency object
from_currency.id number
from_currency.code string
to_currency object
to_currency.id number
to_currency.code string
created_by object
created_by.id number
created_at string
updated_at string
Expense artifacts API — Query expense artifacts

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
source_file_name string
source_content_type string
source_file_size number
image_file_name string
image_content_type string
image_rotation number
ocr_status string
external_src_ref string
created_at string
updated_at string
Expense lines API — Query expense lines

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
expense_report_id number
description string
status string
amount number
approved_amount number
expense_date string
merchant string
employee_reimbursable boolean
expense_category object
expense_category.id number
expense_category.name string
currency object
currency.code string
account object
account.id number
account.code string
updated_at string
Expense reports API — Query expense reports

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
title string
status string
reimbursable_total_amount number
submitted_at string
start_date string
end_date string
paid boolean
currency object
currency.code string
expense_lines objectarray
expense_lines.id number
expense_lines.amount number
updated_at string
Inventory transactions API — Query inventory transactions

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
type string
status string
quantity number
price number
exported boolean
uom object
uom.code string
order_line object
order_line.id number
order_line.order_header_number string
created_at string
updated_at string
Invoices API — Query invoices

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
invoice_number string
status string
invoice_date string
currency object
currency.code string
supplier object
supplier.id number
supplier.name string
payment_term object
payment_term.code string
invoice_lines objectarray
invoice_lines.id number
invoice_lines.line_num number
invoice_lines.description string
invoice_lines.quantity number
invoice_lines.price number
exported boolean
created_at string
updated_at string
comments string
Items API — Query items

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
item_number string
name string
description string
active boolean
manufacturer_name string
uom object
uom.code string
commodity object
commodity.id number
commodity.name string
storage_quantity number
created_at string
updated_at string
Lookup values API — Query lookup values

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
name string
external_ref_num string
external_ref_code string
active boolean
created_at string
updated_at string
parent object
parent.id number
parent.name string
lookup object
lookup.id number
lookup.name string
created_by object
created_by.id number
created_by.login string
created_by.name string
updated_by object
updated_by.id number
updated_by.login string
updated_by.name string
Order list API — Query order pads

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
name string
locked boolean
any_supplier boolean
base_value number
use_base_value boolean
base_value_currency object
base_value_currency.code string
suppliers objectarray
suppliers.id number
suppliers.name string
order_pad_lines objectarray
order_pad_lines.id number
order_pad_lines.amount number
created_at string
updated_at string
Payment terms API — Query payment terms

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
code string
description string
type string
active boolean
days_for_net_payment number
days_for_discount_payment number
discount_rate number
net_due_day number
updated_at string
Purchase order change API — Query purchase order changes

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
order_header_id number
po_number string
status string
version number
exported boolean
pending_cancel boolean
supplier object
supplier.id number
supplier.name string
payment_term object
payment_term.code string
order_line_changes objectarray
order_line_changes.id number
order_line_changes.line_num string
order_line_changes.quantity number
created_at string
updated_at string
Purchase order lines API — Query purchase order lines

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
line_num string
description string
status string
quantity number
price number
need_by_date string
order_header_id number
account object
account.id number
account.code string
item object
item.id number
item.item_number string
currency object
currency.code string
updated_at string
Purchase orders API — Query purchase orders

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
po_number string
status string
version number
exported boolean
invoice_stop boolean
payment_method string
supplier object
supplier.id number
supplier.number string
supplier.name string
payment_term object
payment_term.code string
ship_to_address object
ship_to_address.id number
ship_to_address.city string
order_lines objectarray
order_lines.id number
order_lines.line_num string
order_lines.description string
order_lines.quantity number
order_lines.price number
created_at string
updated_at string
Receiving transactions — Retrieve goods receipts by po number

Response schema:

Field Type
id number (Primary key)
quantity number
status string
created_at string
updated_at string
order_line object
order_line.id number
uom object
uom.id number
uom.name string
uom.code string
Requisition lines — Get requsition lines

Response schema:

Field Type
id number (Primary key)
description string
quantity number
status string
total string
created_at string
updated_at string
account object
account.id number
account.name string
commodity object
commodity.id number
commodity.name string
currency object
currency.id number
currency.code string
supplier object
supplier.id number
supplier.name string
supplier.number string
Requisitions API — Query requisition headers

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
req_title string
status string
justification string
need_by_date string
submitted_at string
created_at string
requester object
requester.id number
requester.login string
ship_to_address object
ship_to_address.id number
ship_to_address.city string
currency object
currency.code string
requisition_lines objectarray
requisition_lines.id number
requisition_lines.line_num number
requisition_lines.description string
approvals objectarray
approvals.id number
approvals.status string
Return to supplier transactions — Get return to supplier transactions

Response schema:

Field Type
id number (Primary key)
quantity number
status string
created_at string
updated_at string
Shipping terms API — Query shipping terms

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
code string
description string
active boolean
content_groups objectarray
content_groups.id number
content_groups.name string
created_by object
created_by.id number
created_at string
updated_at string
Supplier information API — Query supplier informations

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
name string
status string
supplier_id number
supplier_number string
buyer_hold boolean
payment_term object
payment_term.id number
payment_term.code string
shipping_term_id number
supplier_information_addresses objectarray
supplier_information_addresses.id number
supplier_information_addresses.street_address string
supplier_information_addresses.postal_code string
updated_at string
Supplier items API — Query supplier items

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
supplier_part_num string
supplier_aux_part_num string
price number
preferred boolean
lead_time number
availability string
currency object
currency.code string
item object
item.id number
item.item_number string
supplier object
supplier.id number
supplier.number string
updated_at string
Supplier sites — Get supplier site by code

Response schema:

Field Type
id number (Primary key)
name string
code string
active boolean
created_at string
updated_at string
supplier object
supplier.id number
supplier.name string
supplier.number string
address object
address.id number
address.street1 string
address.city string
Suppliers API — Query suppliers

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
name string
number string
status string
buyer_hold boolean
payment_method string
po_method string
allow_cxml_invoicing boolean
primary_address object
primary_address.id number
primary_address.city string
payment_term object
payment_term.code string
shipping_term object
shipping_term.code string
updated_at string
Tax registration API — Query tax registrations

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
number string
owner_id number
owner_type string
active boolean
local boolean
country object
country.id number
country.code string
created_at string
updated_at string
User group memberships API — Query user group memberships

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
created_at string
updated_at string
user object
user.id number
user.login string
user.name string
user_group object
user_group.id number
user_group.name string
User groups API — Query user groups

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
name string
description string
active boolean
created_at string
updated_at string
created_by object
created_by.id number
created_by.login string
created_by.name string
updated_by object
updated_by.id number
updated_by.login string
updated_by.name string
Users API — Query users

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at[gt] = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
login string
email string
firstname string
lastname string
active boolean
authentication_method string
department object
department.id number
department.name string
default_currency object
default_currency.code string
roles objectarray
roles.id number
roles.name string
created_at string
updated_at string