Compartilhar via


Coupa (Independent Publisher) (Preview)

Provides robust access to read, edit, or integrate your data with the Coupa platform.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name NovaGL
URL https://www.coupa.com
Email gl1@live.om
Connector Metadata
Publisher NovaGL
Website https://www.coupa.com
Privacy policy https://www.coupa.com/privacy-policy
Categories Commerce

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Coupa Instance name string Enter Coupa Instance name excluding coupahost.com True
Coupa Scope string Enter Coupa Oidc scopes with no commas True
Coupa Client Id string Enter Coupa Client Id True
Coupa Client Secret securestring Enter Coupa Client Secret True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Addresses - Create Address

Create Address

Addresses - Get Address by ID

Get Address

Addresses - Query Addresses

Query Address

Addresses - Update Existing Address

Update Existing Address

Attachments - Add Attachment (URL) to a Comment

Add an Attachment (URL) to a Comment

Attachments - Add Attachment (URL) to a Purchase Order

Add Attachment (URL) to a Purchase Order

Attachments - Get Attachments from a Purchase Order

Get Attachments from a Purchase Order

Comments - Add Purchase Order Comment

POST a comment on Purchase Order

Contracts - Add a contract term

Add a contract term

Contracts - Create a Contract

Create contract

Contracts - Get Contract by ID

Get Contract by ID

Contracts - Get Contracts

Get Contracts

Integration - Show integration errors

Show integration errors

Integrations - Query integrations

Query integrations

Integrations - Show integration run

Show integration run

Integrations - Show Integration Runs

Query Integration Runs

Invoice - Get Invoices

Get Invoices

Invoices - Create Invoice

Create Invoice

Invoices - Delete Invoice by ID

Delete Invoices by ID

Invoices - Get Invoice by ID

Get Invoices by ID

Invoices - Update Invoice

Update Invoice

Invoices - Void an Invoice

Void an Invoice

Items - Create Item

Create Item

Items - Get Item by ID

Get Item by ID

Items - Get Supplier Item by ID

Get Supplier Items by ID

Items - Query Items

Query Items

Lookup - Query lookup values

Query lookup values

Lookup - Query lookups

Query lookups

Order Lists - Create Order List

Create Order List

Order Lists - Get Order List by ID

Show Order List

Order Lists - Query Order Lists

Query Order Lists

Purchase Orders - Cancel Purchase Order

Purchase Orders - Cancel Purchase Order

Purchase Orders - Close Purchase Order

Purchase Orders - Close Purchase Order

Purchase Orders - Get Purchase Order by ID

Get Purchase Order by ID

Purchase Orders - Get Purchase Orders

Get Purchase Orders

Purchase Orders - Reopen Purchase Order

Purchase Orders - Reopen Purchase Order

Receipts - Create or Partial Void a goods receipt

Create a new goods receipt

Receipts - Void a receipt

Void Receipts by ID

Requisitions - Add To Cart (Free Text)

Add a free text requistion to the cart

Requisitions - Create Requisition

Create Requisition

Requisitions - Get Requisition by ID

Get Requisition by ID

Requisitions - Get Requisitions

Get Requisitions

Requisitions - Update Requisition

Update Requisition

Suppliers - Query suppliers

Query suppliers

Users - Query users

Query users

Addresses - Create Address

Create Address

Parameters

Name Key Required Type Description
name
name string

name

Location Code
location-code string

location-code

street1
street1 string

street1

street2
street2 string

street2

city
city string

city

State
state string

state

Postcode
postal-code string

postal-code

code
code True string

code

id
id integer

Coupa unique identifier

name
name string

name

ID
id integer

id

Returns

Body
Address

Addresses - Get Address by ID

Get Address

Parameters

Name Key Required Type Description
id
id True string

id

Returns

Body
Address

Addresses - Query Addresses

Query Address

Parameters

Name Key Required Type Description
limit
limit integer

limit

offset
offset integer

offset

dir
dir string

dir

return_object
return_object string

return_object

Returns

response
array of Address

Addresses - Update Existing Address

Update Existing Address

Parameters

Name Key Required Type Description
id
id True string

id

name
name string

name

Location Code
location-code string

location-code

street1
street1 string

street1

street2
street2 string

street2

city
city string

city

State
state string

state

Postcode
postal-code string

postal-code

code
code True string

code

id
id integer

Coupa unique identifier

name
name string

name

ID
id integer

id

Returns

Body
Address

Attachments - Add Attachment (URL) to a Comment

Add an Attachment (URL) to a Comment

Parameters

Name Key Required Type Description
Comment id
id True string

Comment id

id
id integer

id

type
type string

type

Intent
intent string

intent

url
url string

url

Returns

Attachments - Add Attachment (URL) to a Purchase Order

Add Attachment (URL) to a Purchase Order

Parameters

Name Key Required Type Description
id
id True string

id

id
id integer

id

type
type string

type

Intent
intent string

intent

url
url string

url

Returns

Attachments - Get Attachments from a Purchase Order

Get Attachments from a Purchase Order

Parameters

Name Key Required Type Description
id
id True string

id

Returns

Comments - Add Purchase Order Comment

POST a comment on Purchase Order

Parameters

Name Key Required Type Description
po_id
po_id True string

Purchase Order ID

commentable-id
commentable-id integer

commentable-id

comments
comments string

comments

Returns

Body
Comments

Contracts - Add a contract term

Add a contract term

Parameters

Name Key Required Type Description
id
id True string

id

contract-term-type
contract-term-type string

contract term type

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

id
id integer

Coupa unique identifier

name
name string

name

tier-1-disc-pct
tier-1-disc-pct string

tier_1_disc_pct

tier-1-upper-bound
tier-1-upper-bound string

tier_1_upper_bound

tier-2-disc-pct
tier-2-disc-pct string

tier_2_disc_pct

tier-2-upper-bound
tier-2-upper-bound string

tier_2_upper_bound

tier-3-disc-pct
tier-3-disc-pct string

tier_3_disc_pct

tier-3-upper-bound
tier-3-upper-bound string

tier_3_upper_bound

type
type string

type

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

use-pct-discounts
use-pct-discounts string

use_pct_discounts

Returns

Contracts - Create a Contract

Create contract

Parameters

Name Key Required Type Description
contract-term-type
contract-term-type string

contract term type

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

id
id integer

Coupa unique identifier

name
name string

name

tier-1-disc-pct
tier-1-disc-pct string

tier_1_disc_pct

tier-1-upper-bound
tier-1-upper-bound string

tier_1_upper_bound

tier-2-disc-pct
tier-2-disc-pct string

tier_2_disc_pct

tier-2-upper-bound
tier-2-upper-bound string

tier_2_upper_bound

tier-3-disc-pct
tier-3-disc-pct string

tier_3_disc_pct

tier-3-upper-bound
tier-3-upper-bound string

tier_3_upper_bound

type
type string

type

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

use-pct-discounts
use-pct-discounts string

use_pct_discounts

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

description
description string

Descriptive notes about the contract

end-date
end-date string

Expiry Date

id
id integer

Coupa unique identifier

maximum-value
maximum-value string

Maximum Commit Amount

minimum-value
minimum-value string

Minimum Commit Amount

name
name string

Contract Name

number
number string

Contract Number

start-date
start-date string

Start Date

status
status string

Status of the Contract

account-number
account-number string

Account number

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

display-name
display-name string

display_name

id
id integer

Coupa Internal ID

name
name string

Supplier name

number
number string

Supplier number

status
status string

Supplier status

supplier-account
supplier-account string

Supplier Account Number

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

version
version integer

version

return_object
return_object string

return_object

filter
filter string

filter

Returns

Body
Contract

Contracts - Get Contract by ID

Get Contract by ID

Parameters

Name Key Required Type Description
id
id True string

id

offset
offset integer

Offset

return_object
return_object string

return_object

dir
dir string

dir

Returns

Body
Contract

Contracts - Get Contracts

Get Contracts

Parameters

Name Key Required Type Description
offset
offset integer

Offset

limit
limit integer

Limit

return_object
return_object string

return_object

filter
filter string

filter

dir
dir string

dir

Returns

Integration - Show integration errors

Show integration errors

Parameters

Name Key Required Type Description
limit
limit integer

limit

offset
offset integer

offset

order_by
order_by string

order_by

dir
dir string

dir

return_object
return_object string

return_object

filter
filter string

filter

Returns

Integrations - Query integrations

Query integrations

Parameters

Name Key Required Type Description
limit
limit integer

limit

offset
offset integer

offset

order_by
order_by string

order_by

dir
dir string

dir

return_object
return_object string

return_object

filter
filter string

filter

Returns

Integrations - Show integration run

Show integration run

Parameters

Name Key Required Type Description
id
id True integer

id

limit
limit integer

limit

offset
offset integer

offset

order_by
order_by string

order_by

dir
dir string

dir

return_object
return_object string

return_object

filter
filter string

filter

Returns

Integrations - Show Integration Runs

Query Integration Runs

Parameters

Name Key Required Type Description
limit
limit integer

limit

offset
offset integer

offset

order_by
order_by string

order_by

dir
dir string

dir

return_object
return_object string

return_object

filter
filter string

filter

Returns

Invoice - Get Invoices

Get Invoices

Parameters

Name Key Required Type Description
dir
dir string

dir

Invoice Date Less than
invoice_date[lt] date-time

Invoice Date <

return_object
return_object string

return_object

limit
limit string

limit

offset
offset string

offset

status
status string

status

filter
filter string

filter

Returns

Invoices - Create Invoice

Create Invoice

Parameters

Name Key Required Type Description
invoice-date
invoice-date string

invoice-date

invoice-number
invoice-number string

invoice-number

line-level-taxation
line-level-taxation boolean

line-level-taxation

total-with-taxes
total-with-taxes string

total-with-taxes

document-type
document-type string

document-type

login
login string

login

active
active boolean

A false value will inactivate the COA

code
code string
enabled
enabled string

Enabled

id
id integer

Coupa unique identifier

name
name string

name

id
id integer

Coupa unique identifier

name
name string

name

code
code string

code

account-number
account-number string

Account number

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

display-name
display-name string

display_name

id
id integer

Coupa Internal ID

name
name string

Supplier name

number
number string

Supplier number

status
status string

Supplier status

location-code
ship-to-address string

location-code

active
active boolean

A false value will inactivate the COA

code
code string
enabled
enabled string

Enabled

id
id integer

Coupa unique identifier

name
name string

name

id
id integer

Coupa unique identifier

name
name string

name

account-type-id
account-type-id integer

Account Type Id

active
active boolean

Active\Inactive flag

code
code string

All segments concatenated with a hyphen ( - )

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

active
active boolean

Active\Inactive

active
active boolean

Active

can-approve
can-approve boolean

User group has the ability to be an approver

description
description string

description

id
id integer

Coupa unique identifier

name
name True string

name

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

description
description string

Description

id
id integer

Coupa unique identifier

business-group-security-type
business-group-security-type integer

business_group_security_type

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

email
email string

email

login
login string

employee number

fullname
fullname string

full name

id
id integer

Coupa unique identifier

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

id
id integer

Coupa unique identifier

name
name string

This is the nickname for the account.

segment-1
segment-1 string

Each segment represents the segment of the account code

segment-2
segment-2 string

Each segment represents the segment of the account code

segment-3
segment-3 string

Each segment represents the segment of the account code

segment-4
segment-4 string

Each segment represents the segment of the account code

segment-5
segment-5 string

Each segment represents the segment of the account code

segment-6
segment-6 string

Each segment represents the segment of the account code

accounting-total
accounting-total string

accounting-total

description
description string

description

line-num
line-num integer

line-num

line-id
id integer

Coupa Internal Order Line ID

order-header-num
order-header-num integer

order-header-num

po-number
po-number string

po-number

order-line-num
order-line-num string

order-line-num

price
price string

price

quantity
quantity string

quantity

total
total string

total

type
type string

type

contract-term-type
contract-term-type string

contract term type

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

id
id integer

Coupa unique identifier

name
name string

name

tier-1-disc-pct
tier-1-disc-pct string

tier_1_disc_pct

tier-1-upper-bound
tier-1-upper-bound string

tier_1_upper_bound

tier-2-disc-pct
tier-2-disc-pct string

tier_2_disc_pct

tier-2-upper-bound
tier-2-upper-bound string

tier_2_upper_bound

tier-3-disc-pct
tier-3-disc-pct string

tier_3_disc_pct

tier-3-upper-bound
tier-3-upper-bound string

tier_3_upper_bound

type
type string

type

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

use-pct-discounts
use-pct-discounts string

use_pct_discounts

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

description
description string

Descriptive notes about the contract

end-date
end-date string

Expiry Date

id
id integer

Coupa unique identifier

maximum-value
maximum-value string

Maximum Commit Amount

minimum-value
minimum-value string

Minimum Commit Amount

name
name string

Contract Name

number
number string

Contract Number

start-date
start-date string

Start Date

status
status string

Status of the Contract

account-number
account-number string

Account number

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

display-name
display-name string

display_name

id
id integer

Coupa Internal ID

name
name string

Supplier name

number
number string

Supplier number

status
status string

Supplier status

supplier-account
supplier-account string

Supplier Account Number

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

version
version integer

version

code
code string
enabled
enabled string

Enabled

id
id integer

Coupa unique identifier

name
name string

name

name
name string

name

code
code string

code

active
active boolean

Active\Inactive

id
id integer

Coupa unique identifier

Returns

Body
Invoices

Invoices - Delete Invoice by ID

Delete Invoices by ID

Parameters

Name Key Required Type Description
id
id True string

Invoice ID

Invoices - Get Invoice by ID

Get Invoices by ID

Parameters

Name Key Required Type Description
id
id True integer

id

Returns

Body
Invoices

Invoices - Update Invoice

Update Invoice

Parameters

Name Key Required Type Description
id
id True string

Invoice ID

invoice-date
invoice-date string

invoice-date

invoice-number
invoice-number string

invoice-number

line-level-taxation
line-level-taxation boolean

line-level-taxation

total-with-taxes
total-with-taxes string

total-with-taxes

document-type
document-type string

document-type

login
login string

login

active
active boolean

A false value will inactivate the COA

code
code string
enabled
enabled string

Enabled

id
id integer

Coupa unique identifier

name
name string

name

id
id integer

Coupa unique identifier

name
name string

name

code
code string

code

account-number
account-number string

Account number

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

display-name
display-name string

display_name

id
id integer

Coupa Internal ID

name
name string

Supplier name

number
number string

Supplier number

status
status string

Supplier status

location-code
ship-to-address string

location-code

active
active boolean

A false value will inactivate the COA

code
code string
enabled
enabled string

Enabled

id
id integer

Coupa unique identifier

name
name string

name

id
id integer

Coupa unique identifier

name
name string

name

account-type-id
account-type-id integer

Account Type Id

active
active boolean

Active\Inactive flag

code
code string

All segments concatenated with a hyphen ( - )

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

active
active boolean

Active\Inactive

active
active boolean

Active

can-approve
can-approve boolean

User group has the ability to be an approver

description
description string

description

id
id integer

Coupa unique identifier

name
name True string

name

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

description
description string

Description

id
id integer

Coupa unique identifier

business-group-security-type
business-group-security-type integer

business_group_security_type

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

email
email string

email

login
login string

employee number

fullname
fullname string

full name

id
id integer

Coupa unique identifier

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

id
id integer

Coupa unique identifier

name
name string

This is the nickname for the account.

segment-1
segment-1 string

Each segment represents the segment of the account code

segment-2
segment-2 string

Each segment represents the segment of the account code

segment-3
segment-3 string

Each segment represents the segment of the account code

segment-4
segment-4 string

Each segment represents the segment of the account code

segment-5
segment-5 string

Each segment represents the segment of the account code

segment-6
segment-6 string

Each segment represents the segment of the account code

accounting-total
accounting-total string

accounting-total

description
description string

description

line-num
line-num integer

line-num

line-id
id integer

Coupa Internal Order Line ID

order-header-num
order-header-num integer

order-header-num

po-number
po-number string

po-number

order-line-num
order-line-num string

order-line-num

price
price string

price

quantity
quantity string

quantity

total
total string

total

type
type string

type

contract-term-type
contract-term-type string

contract term type

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

id
id integer

Coupa unique identifier

name
name string

name

tier-1-disc-pct
tier-1-disc-pct string

tier_1_disc_pct

tier-1-upper-bound
tier-1-upper-bound string

tier_1_upper_bound

tier-2-disc-pct
tier-2-disc-pct string

tier_2_disc_pct

tier-2-upper-bound
tier-2-upper-bound string

tier_2_upper_bound

tier-3-disc-pct
tier-3-disc-pct string

tier_3_disc_pct

tier-3-upper-bound
tier-3-upper-bound string

tier_3_upper_bound

type
type string

type

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

use-pct-discounts
use-pct-discounts string

use_pct_discounts

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

description
description string

Descriptive notes about the contract

end-date
end-date string

Expiry Date

id
id integer

Coupa unique identifier

maximum-value
maximum-value string

Maximum Commit Amount

minimum-value
minimum-value string

Minimum Commit Amount

name
name string

Contract Name

number
number string

Contract Number

start-date
start-date string

Start Date

status
status string

Status of the Contract

account-number
account-number string

Account number

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

display-name
display-name string

display_name

id
id integer

Coupa Internal ID

name
name string

Supplier name

number
number string

Supplier number

status
status string

Supplier status

supplier-account
supplier-account string

Supplier Account Number

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

version
version integer

version

code
code string
enabled
enabled string

Enabled

id
id integer

Coupa unique identifier

name
name string

name

name
name string

name

code
code string

code

active
active boolean

Active\Inactive

id
id integer

Coupa unique identifier

Returns

Body
Invoices

Invoices - Void an Invoice

Void an Invoice

Parameters

Name Key Required Type Description
id
id True string

Invoice ID

Returns

Body
Invoices

Items - Create Item

Create Item

Parameters

Name Key Required Type Description
name
name string

Item name

description
description string

Item desciption

item-number
item-number string

Unique item number

active
active boolean

Active\Inactive

active
active boolean

Active\Inactive

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

id
id integer

Coupa unique identifier

name
name True string

name

updated-at
updated-at date-time

updated-at

name
name string

name

code
code string

code

active
active boolean

Active\Inactive

id
id integer

Coupa unique identifier

id
id integer

Coupa unique identifier

image-url
image-url string

URL for item image (will be copied into Coupa on item create/update)

Returns

Body
Item

Items - Get Item by ID

Get Item by ID

Parameters

Name Key Required Type Description
id
id True string

id

return_object
return_object string

return_object

Returns

Body
Item

Items - Get Supplier Item by ID

Get Supplier Items by ID

Parameters

Name Key Required Type Description
id
id True string

id

offset
offset integer

Offset

return_object
return_object string

return_object

dir
dir string

dir

Returns

Items - Query Items

Query Items

Parameters

Name Key Required Type Description
limit
limit integer

limit

offset
offset integer

offset

order_by
order_by string

order_by

dir
dir string

dir

return_object
return_object string

return_object

filter
filter string

filter

Returns

response
array of Item

Lookup - Query lookup values

Query lookup values

Parameters

Name Key Required Type Description
Lookup Name
lookup[name] string

Lookup Name

limit
limit integer

limit

offset
offset integer

offset

order_by
order_by string

order_by

dir
dir string

dir

return_object
return_object string

return_object

filter
filter string

filter

Returns

Lookup - Query lookups

Query lookups

Parameters

Name Key Required Type Description
Lookup Name
name string

Lookup Name

limit
limit integer

limit

offset
offset integer

offset

order_by
order_by string

order_by

dir
dir string

dir

return_object
return_object string

return_object

filter
filter string

filter

Returns

response
array of Lookup

Order Lists - Create Order List

Create Order List

Parameters

Name Key Required Type Description
add-all-items
add-all-items string

Flag indicating to add all items

any-supplier
any-supplier string

any_supplier

base-value
base-value

base_value

code
code string
enabled
enabled string

Enabled

id
id integer

Coupa unique identifier

name
name string

name

id
id integer

Coupa unique identifier

name
name True string

name

name
name string

Item name

description
description string

Item desciption

item-number
item-number string

Unique item number

active
active boolean

Active\Inactive

active
active boolean

Active\Inactive

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

id
id integer

Coupa unique identifier

name
name True string

name

updated-at
updated-at date-time

updated-at

name
name string

name

code
code string

code

active
active boolean

Active\Inactive

id
id integer

Coupa unique identifier

id
id integer

Coupa unique identifier

image-url
image-url string

URL for item image (will be copied into Coupa on item create/update)

order-amount-method
order-amount-method True string

order_amount_method

supplier-id
supplier-id True integer

supplier_id

par-level
par-level number

par_level

amount
amount number

amount

id
id integer

Coupa unique identifier

Returns

Body
OrderPad

Order Lists - Get Order List by ID

Show Order List

Parameters

Name Key Required Type Description
id
id True integer

id

limit
limit integer

limit

offset
offset integer

offset

order_by
order_by string

order_by

dir
dir string

dir

return_object
return_object string

return_object

filter
filter string

filter

Returns

Body
OrderPad

Order Lists - Query Order Lists

Query Order Lists

Parameters

Name Key Required Type Description
limit
limit integer

limit

offset
offset integer

offset

order_by
order_by string

order_by

dir
dir string

dir

return_object
return_object string

return_object

filter
filter string

filter

Returns

Purchase Orders - Cancel Purchase Order

Purchase Orders - Cancel Purchase Order

Parameters

Name Key Required Type Description
id
id True string

id

Returns

Purchase Orders - Close Purchase Order

Purchase Orders - Close Purchase Order

Parameters

Name Key Required Type Description
id
id True string

id

Returns

Purchase Orders - Get Purchase Order by ID

Get Purchase Order by ID

Parameters

Name Key Required Type Description
id
id True string

id

filter
filter string

filter

limit
limit integer

limit

offset
offset integer

offset

order_by
order_by string

order_by

dir
dir string

dir

return_object
return_object string

return_object

Returns

Purchase Orders - Get Purchase Orders

Get Purchase Orders

Parameters

Name Key Required Type Description
filter
filter string

filter

limit
limit integer

limit

offset
offset integer

offset

order_by
order_by string

order_by

dir
dir string

dir

return_object
return_object string

return_object

Returns

Purchase Orders - Reopen Purchase Order

Purchase Orders - Reopen Purchase Order

Parameters

Name Key Required Type Description
id
id True string

id

reason_insight_code
reason_insight_code string

Reason Code

reason-insight-event-comment
reason-insight-event-comment string

Reason Comment

Returns

Receipts - Create or Partial Void a goods receipt

Create a new goods receipt

Parameters

Name Key Required Type Description
quantity
quantity integer

quantity

type
type string

type

original-transaction-id
original-transaction-id number

Receipt transaction ID to void

Coupa Interal Line ID
id integer

Order Line ID

Returns

Receipts - Void a receipt

Void Receipts by ID

Parameters

Name Key Required Type Description
id
id True string

id

fields
fields string

fields

Returns

Requisitions - Add To Cart (Free Text)

Add a free text requistion to the cart

Parameters

Name Key Required Type Description
id
id integer

id

type
type string

type

Intent
intent string

intent

url
url string

url

exported
exported boolean

Indicates if transaction has been exported

id
id integer

Coupa unique identifier

justification
justification string

Requisition Justification Comments

need-by-date
need-by-date date-time

Item Need By Date

req-title
req-title string

Optional title of the Requisition

active
active boolean

Active\Inactive

active
active boolean

Active

can-approve
can-approve boolean

User group has the ability to be an approver

description
description string

description

id
id integer

Coupa unique identifier

name
name True string

name

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

description
description string

Description

id
id integer

Coupa unique identifier

business-group-security-type
business-group-security-type integer

business_group_security_type

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

email
email string

email

login
login string

employee number

fullname
fullname string

full name

id
id integer

Coupa unique identifier

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

active
active boolean

Active\Inactive

active
active boolean

Active

can-approve
can-approve boolean

User group has the ability to be an approver

description
description string

description

id
id integer

Coupa unique identifier

name
name True string

name

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

description
description string

Description

id
id integer

Coupa unique identifier

business-group-security-type
business-group-security-type integer

business_group_security_type

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

email
email string

email

login
login string

employee number

fullname
fullname string

full name

id
id integer

Coupa unique identifier

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

active
active boolean

A false value will inactivate the COA

code
code string
enabled
enabled string

Enabled

id
id integer

Coupa unique identifier

name
name string

name

id
id integer

Coupa unique identifier

name
name string

name

account-type-id
account-type-id integer

Account Type Id

active
active boolean

Active\Inactive flag

code
code string

All segments concatenated with a hyphen ( - )

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

active
active boolean

Active\Inactive

active
active boolean

Active

can-approve
can-approve boolean

User group has the ability to be an approver

description
description string

description

id
id integer

Coupa unique identifier

name
name True string

name

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

description
description string

Description

id
id integer

Coupa unique identifier

business-group-security-type
business-group-security-type integer

business_group_security_type

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

email
email string

email

login
login string

employee number

fullname
fullname string

full name

id
id integer

Coupa unique identifier

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

id
id integer

Coupa unique identifier

name
name string

This is the nickname for the account.

segment-1
segment-1 string

Each segment represents the segment of the account code

segment-2
segment-2 string

Each segment represents the segment of the account code

segment-3
segment-3 string

Each segment represents the segment of the account code

segment-4
segment-4 string

Each segment represents the segment of the account code

segment-5
segment-5 string

Each segment represents the segment of the account code

segment-6
segment-6 string

Each segment represents the segment of the account code

id
id integer

id

type
type string

type

Intent
intent string

intent

url
url string

url

active
active boolean

Active\Inactive

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

id
id integer

Coupa unique identifier

name
name True string

name

updated-at
updated-at date-time

updated-at

contract-term-type
contract-term-type string

contract term type

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

id
id integer

Coupa unique identifier

name
name string

name

tier-1-disc-pct
tier-1-disc-pct string

tier_1_disc_pct

tier-1-upper-bound
tier-1-upper-bound string

tier_1_upper_bound

tier-2-disc-pct
tier-2-disc-pct string

tier_2_disc_pct

tier-2-upper-bound
tier-2-upper-bound string

tier_2_upper_bound

tier-3-disc-pct
tier-3-disc-pct string

tier_3_disc_pct

tier-3-upper-bound
tier-3-upper-bound string

tier_3_upper_bound

type
type string

type

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

use-pct-discounts
use-pct-discounts string

use_pct_discounts

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

description
description string

Descriptive notes about the contract

end-date
end-date string

Expiry Date

id
id integer

Coupa unique identifier

maximum-value
maximum-value string

Maximum Commit Amount

minimum-value
minimum-value string

Minimum Commit Amount

name
name string

Contract Name

number
number string

Contract Number

start-date
start-date string

Start Date

status
status string

Status of the Contract

account-number
account-number string

Account number

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

display-name
display-name string

display_name

id
id integer

Coupa Internal ID

name
name string

Supplier name

number
number string

Supplier number

status
status string

Supplier status

supplier-account
supplier-account string

Supplier Account Number

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

version
version integer

version

description
description True string

description

id
id integer

Coupa unique identifier

updated-at
updated-at date-time

Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

id
id integer

Coupa unique identifier

image-url
image-url string

Image url

name
name string

Item name

description
description string

Item desciption

item-number
item-number string

Unique item number

active
active boolean

Active\Inactive

name
name string

name

code
code string

code

active
active boolean

Active\Inactive

id
id integer

Coupa unique identifier

id
id integer

Coupa unique identifier

image-url
image-url string

URL for item image (will be copied into Coupa on item create/update)

line-num
line-num integer

line_num

line-type
line-type string

line type

order-line-id
order-line-id integer

order_line_id

status
status string

transaction status

total
total number

total

transmission-emails
transmission-emails string

Transmission emails

transmission-method-override
transmission-method-override string

Transmission method override

unit-price
unit-price number

line item price

name
name string

name

Location Code
location-code string

location-code

street1
street1 string

street1

street2
street2 string

street2

city
city string

city

State
state string

state

Postcode
postal-code string

postal-code

code
code True string

code

id
id integer

Coupa unique identifier

name
name string

name

ID
id integer

id

ship-to-attention
ship-to-attention string

Ship to Address Attention

status
status True string

transaction status

Returns

Requisitions - Create Requisition

Create Requisition

Parameters

Name Key Required Type Description
id
id integer

id

type
type string

type

Intent
intent string

intent

url
url string

url

exported
exported boolean

Indicates if transaction has been exported

id
id integer

Coupa unique identifier

justification
justification string

Requisition Justification Comments

need-by-date
need-by-date date-time

Item Need By Date

req-title
req-title string

Optional title of the Requisition

active
active boolean

Active\Inactive

active
active boolean

Active

can-approve
can-approve boolean

User group has the ability to be an approver

description
description string

description

id
id integer

Coupa unique identifier

name
name True string

name

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

description
description string

Description

id
id integer

Coupa unique identifier

business-group-security-type
business-group-security-type integer

business_group_security_type

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

email
email string

email

login
login string

employee number

fullname
fullname string

full name

id
id integer

Coupa unique identifier

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

active
active boolean

Active\Inactive

active
active boolean

Active

can-approve
can-approve boolean

User group has the ability to be an approver

description
description string

description

id
id integer

Coupa unique identifier

name
name True string

name

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

description
description string

Description

id
id integer

Coupa unique identifier

business-group-security-type
business-group-security-type integer

business_group_security_type

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

email
email string

email

login
login string

employee number

fullname
fullname string

full name

id
id integer

Coupa unique identifier

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

active
active boolean

A false value will inactivate the COA

code
code string
enabled
enabled string

Enabled

id
id integer

Coupa unique identifier

name
name string

name

id
id integer

Coupa unique identifier

name
name string

name

account-type-id
account-type-id integer

Account Type Id

active
active boolean

Active\Inactive flag

code
code string

All segments concatenated with a hyphen ( - )

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

active
active boolean

Active\Inactive

active
active boolean

Active

can-approve
can-approve boolean

User group has the ability to be an approver

description
description string

description

id
id integer

Coupa unique identifier

name
name True string

name

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

description
description string

Description

id
id integer

Coupa unique identifier

business-group-security-type
business-group-security-type integer

business_group_security_type

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

email
email string

email

login
login string

employee number

fullname
fullname string

full name

id
id integer

Coupa unique identifier

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

id
id integer

Coupa unique identifier

name
name string

This is the nickname for the account.

segment-1
segment-1 string

Each segment represents the segment of the account code

segment-2
segment-2 string

Each segment represents the segment of the account code

segment-3
segment-3 string

Each segment represents the segment of the account code

segment-4
segment-4 string

Each segment represents the segment of the account code

segment-5
segment-5 string

Each segment represents the segment of the account code

segment-6
segment-6 string

Each segment represents the segment of the account code

id
id integer

id

type
type string

type

Intent
intent string

intent

url
url string

url

active
active boolean

Active\Inactive

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

id
id integer

Coupa unique identifier

name
name True string

name

updated-at
updated-at date-time

updated-at

contract-term-type
contract-term-type string

contract term type

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

id
id integer

Coupa unique identifier

name
name string

name

tier-1-disc-pct
tier-1-disc-pct string

tier_1_disc_pct

tier-1-upper-bound
tier-1-upper-bound string

tier_1_upper_bound

tier-2-disc-pct
tier-2-disc-pct string

tier_2_disc_pct

tier-2-upper-bound
tier-2-upper-bound string

tier_2_upper_bound

tier-3-disc-pct
tier-3-disc-pct string

tier_3_disc_pct

tier-3-upper-bound
tier-3-upper-bound string

tier_3_upper_bound

type
type string

type

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

use-pct-discounts
use-pct-discounts string

use_pct_discounts

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

description
description string

Descriptive notes about the contract

end-date
end-date string

Expiry Date

id
id integer

Coupa unique identifier

maximum-value
maximum-value string

Maximum Commit Amount

minimum-value
minimum-value string

Minimum Commit Amount

name
name string

Contract Name

number
number string

Contract Number

start-date
start-date string

Start Date

status
status string

Status of the Contract

account-number
account-number string

Account number

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

display-name
display-name string

display_name

id
id integer

Coupa Internal ID

name
name string

Supplier name

number
number string

Supplier number

status
status string

Supplier status

supplier-account
supplier-account string

Supplier Account Number

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

version
version integer

version

description
description True string

description

id
id integer

Coupa unique identifier

updated-at
updated-at date-time

Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

id
id integer

Coupa unique identifier

image-url
image-url string

Image url

name
name string

Item name

description
description string

Item desciption

item-number
item-number string

Unique item number

active
active boolean

Active\Inactive

name
name string

name

code
code string

code

active
active boolean

Active\Inactive

id
id integer

Coupa unique identifier

id
id integer

Coupa unique identifier

image-url
image-url string

URL for item image (will be copied into Coupa on item create/update)

line-num
line-num integer

line_num

line-type
line-type string

line type

order-line-id
order-line-id integer

order_line_id

status
status string

transaction status

total
total number

total

transmission-emails
transmission-emails string

Transmission emails

transmission-method-override
transmission-method-override string

Transmission method override

unit-price
unit-price number

line item price

name
name string

name

Location Code
location-code string

location-code

street1
street1 string

street1

street2
street2 string

street2

city
city string

city

State
state string

state

Postcode
postal-code string

postal-code

code
code True string

code

id
id integer

Coupa unique identifier

name
name string

name

ID
id integer

id

ship-to-attention
ship-to-attention string

Ship to Address Attention

status
status True string

transaction status

Returns

Requisitions - Get Requisition by ID

Get Requisition by ID

Parameters

Name Key Required Type Description
id
id True string

id

Returns

Requisitions - Get Requisitions

Get Requisitions

Parameters

Name Key Required Type Description
limit
limit string

limit

offset
offset string

offset

Returns

Requisitions - Update Requisition

Update Requisition

Parameters

Name Key Required Type Description
id
id True string

id

id
id integer

id

type
type string

type

Intent
intent string

intent

url
url string

url

exported
exported boolean

Indicates if transaction has been exported

id
id integer

Coupa unique identifier

justification
justification string

Requisition Justification Comments

need-by-date
need-by-date date-time

Item Need By Date

req-title
req-title string

Optional title of the Requisition

active
active boolean

Active\Inactive

active
active boolean

Active

can-approve
can-approve boolean

User group has the ability to be an approver

description
description string

description

id
id integer

Coupa unique identifier

name
name True string

name

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

description
description string

Description

id
id integer

Coupa unique identifier

business-group-security-type
business-group-security-type integer

business_group_security_type

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

email
email string

email

login
login string

employee number

fullname
fullname string

full name

id
id integer

Coupa unique identifier

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

active
active boolean

Active\Inactive

active
active boolean

Active

can-approve
can-approve boolean

User group has the ability to be an approver

description
description string

description

id
id integer

Coupa unique identifier

name
name True string

name

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

description
description string

Description

id
id integer

Coupa unique identifier

business-group-security-type
business-group-security-type integer

business_group_security_type

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

email
email string

email

login
login string

employee number

fullname
fullname string

full name

id
id integer

Coupa unique identifier

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

active
active boolean

A false value will inactivate the COA

code
code string
enabled
enabled string

Enabled

id
id integer

Coupa unique identifier

name
name string

name

id
id integer

Coupa unique identifier

name
name string

name

account-type-id
account-type-id integer

Account Type Id

active
active boolean

Active\Inactive flag

code
code string

All segments concatenated with a hyphen ( - )

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

active
active boolean

Active\Inactive

active
active boolean

Active

can-approve
can-approve boolean

User group has the ability to be an approver

description
description string

description

id
id integer

Coupa unique identifier

name
name True string

name

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

description
description string

Description

id
id integer

Coupa unique identifier

business-group-security-type
business-group-security-type integer

business_group_security_type

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

email
email string

email

login
login string

employee number

fullname
fullname string

full name

id
id integer

Coupa unique identifier

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

id
id integer

Coupa unique identifier

name
name string

This is the nickname for the account.

segment-1
segment-1 string

Each segment represents the segment of the account code

segment-2
segment-2 string

Each segment represents the segment of the account code

segment-3
segment-3 string

Each segment represents the segment of the account code

segment-4
segment-4 string

Each segment represents the segment of the account code

segment-5
segment-5 string

Each segment represents the segment of the account code

segment-6
segment-6 string

Each segment represents the segment of the account code

id
id integer

id

type
type string

type

Intent
intent string

intent

url
url string

url

active
active boolean

Active\Inactive

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

id
id integer

Coupa unique identifier

name
name True string

name

updated-at
updated-at date-time

updated-at

contract-term-type
contract-term-type string

contract term type

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

id
id integer

Coupa unique identifier

name
name string

name

tier-1-disc-pct
tier-1-disc-pct string

tier_1_disc_pct

tier-1-upper-bound
tier-1-upper-bound string

tier_1_upper_bound

tier-2-disc-pct
tier-2-disc-pct string

tier_2_disc_pct

tier-2-upper-bound
tier-2-upper-bound string

tier_2_upper_bound

tier-3-disc-pct
tier-3-disc-pct string

tier_3_disc_pct

tier-3-upper-bound
tier-3-upper-bound string

tier_3_upper_bound

type
type string

type

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

use-pct-discounts
use-pct-discounts string

use_pct_discounts

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

description
description string

Descriptive notes about the contract

end-date
end-date string

Expiry Date

id
id integer

Coupa unique identifier

maximum-value
maximum-value string

Maximum Commit Amount

minimum-value
minimum-value string

Minimum Commit Amount

name
name string

Contract Name

number
number string

Contract Number

start-date
start-date string

Start Date

status
status string

Status of the Contract

account-number
account-number string

Account number

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

display-name
display-name string

display_name

id
id integer

Coupa Internal ID

name
name string

Supplier name

number
number string

Supplier number

status
status string

Supplier status

supplier-account
supplier-account string

Supplier Account Number

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

version
version integer

version

description
description True string

description

id
id integer

Coupa unique identifier

updated-at
updated-at date-time

Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

id
id integer

Coupa unique identifier

image-url
image-url string

Image url

name
name string

Item name

description
description string

Item desciption

item-number
item-number string

Unique item number

active
active boolean

Active\Inactive

name
name string

name

code
code string

code

active
active boolean

Active\Inactive

id
id integer

Coupa unique identifier

id
id integer

Coupa unique identifier

image-url
image-url string

URL for item image (will be copied into Coupa on item create/update)

line-num
line-num integer

line_num

line-type
line-type string

line type

order-line-id
order-line-id integer

order_line_id

status
status string

transaction status

total
total number

total

transmission-emails
transmission-emails string

Transmission emails

transmission-method-override
transmission-method-override string

Transmission method override

unit-price
unit-price number

line item price

name
name string

name

Location Code
location-code string

location-code

street1
street1 string

street1

street2
street2 string

street2

city
city string

city

State
state string

state

Postcode
postal-code string

postal-code

code
code True string

code

id
id integer

Coupa unique identifier

name
name string

name

ID
id integer

id

ship-to-attention
ship-to-attention string

Ship to Address Attention

status
status True string

transaction status

Returns

Suppliers - Query suppliers

Query suppliers

Parameters

Name Key Required Type Description
limit
limit integer

limit

offset
offset integer

offset

order_by
order_by string

order_by

dir
dir string

dir

return_object
return_object string

return_object

filter
filter string

filter

Returns

Users - Query users

Query users

Parameters

Name Key Required Type Description
login
login string

login

limit
limit integer

limit

offset
offset integer

offset

order_by
order_by string

order_by

dir
dir string

dir

return_object
return_object string

return_object

filter
filter string

filter

Returns

Definitions

RequisitionHeader

Name Path Type Description
attachments
attachments array of Attachments
exported
exported boolean

Indicates if transaction has been exported

id
id integer

Coupa unique identifier

justification
justification string

Requisition Justification Comments

need-by-date
need-by-date date-time

Item Need By Date

req-title
req-title string

Optional title of the Requisition

requester
requester UserSimple
created-by
created-by UserSimple
requisition-lines
requisition-lines array of RequisitionLine
ship-to-address
ship-to-address Address
ship-to-attention
ship-to-attention string

Ship to Address Attention

status
status string

transaction status

RequisitionLine

Name Path Type Description
account
account Account
attachments
attachments array of Attachments
commodity
commodity Commodity
contract
contract Contract
currency
currency Currency
description
description string

description

form-response
form-response FormResponse
id
id integer

Coupa unique identifier

image-url
image-url string

Image url

item
item Item
line-num
line-num integer

line_num

line-owner
line-owner UserSimple
line-type
line-type string

line type

order-line-id
order-line-id integer

order_line_id

status
status string

transaction status

supplier
supplier Supplier
total
total number

total

transmission-emails
transmission-emails string

Transmission emails

transmission-method-override
transmission-method-override string

Transmission method override

unit-price
unit-price number

line item price

uom
uom Uom

Invoices

Name Path Type Description
invoice-date
invoice-date string

invoice-date

invoice-number
invoice-number string

invoice-number

line-level-taxation
line-level-taxation boolean

line-level-taxation

total-with-taxes
total-with-taxes string

total-with-taxes

document-type
document-type string

document-type

login
requested-by.login string

login

account-type
account-type AccountType
code
currency.code string

code

supplier
supplier Supplier
location-code
ship-to-address string

location-code

invoice-lines
invoice-lines array of object
account
invoice-lines.account Account
accounting-total
invoice-lines.accounting-total string

accounting-total

description
invoice-lines.description string

description

line-num
invoice-lines.line-num integer

line-num

line-id
invoice-lines.id integer

Coupa Internal Order Line ID

order-header-num
invoice-lines.order-header-num integer

order-header-num

po-number
invoice-lines.po-number string

po-number

order-line-num
invoice-lines.order-line-num string

order-line-num

price
invoice-lines.price string

price

quantity
invoice-lines.quantity string

quantity

total
invoice-lines.total string

total

type
invoice-lines.type string

type

contract
invoice-lines.contract Contract
currency
invoice-lines.currency Currency
uom
invoice-lines.uom Uom

PurchaseOrder

Name Path Type Description
id
id integer

id

created-at
created-at string

created-at

status
status string

status

ship-to-attention
ship-to-attention string

ship-to-attention

id
ship-to-address.id integer

id

name
ship-to-address.name string

name

order-lines
order-lines array of OrderLine

Attachments

Name Path Type Description
id
id integer

id

type
type string

type

Intent
intent string

intent

url
url string

url

Address

Name Path Type Description
name
name string

name

Location Code
location-code string

location-code

street1
street1 string

street1

street2
street2 string

street2

city
city string

city

State
state string

state

Postcode
postal-code string

postal-code

country
country Country
ID
id integer

id

Country

Name Path Type Description
code
code string

code

id
id integer

Coupa unique identifier

name
name string

name

OrderPad

Name Path Type Description
add-all-items
add-all-items string

Flag indicating to add all items

any-supplier
any-supplier string

any_supplier

base-value
base-value

base_value

base-value-currency
base-value-currency Currency
id
id integer

Coupa unique identifier

name
name string

name

order-pad-lines
order-pad-lines array of OrderPadLine

OrderPadLine

Name Path Type Description
item
item Item
order-amount-method
order-amount-method string

order_amount_method

supplier-id
supplier-id integer

supplier_id

par-level
par-level number

par_level

amount
amount number

amount

id
id integer

Coupa unique identifier

Comments

Name Path Type Description
commentable-id
commentable-id integer

commentable-id

comments
comments string

comments

Currency

Name Path Type Description
code
code string
enabled
enabled string

Enabled

id
id integer

Coupa unique identifier

name
name string

name

Contract

Name Path Type Description
contract-terms
contract-terms array of ContractTerm
created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

description
description string

Descriptive notes about the contract

end-date
end-date string

Expiry Date

id
id integer

Coupa unique identifier

maximum-value
maximum-value string

Maximum Commit Amount

minimum-value
minimum-value string

Minimum Commit Amount

name
name string

Contract Name

number
number string

Contract Number

start-date
start-date string

Start Date

status
status string

Status of the Contract

supplier
supplier Supplier
supplier-account
supplier-account string

Supplier Account Number

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

version
version integer

version

ContractTerm

Name Path Type Description
contract-term-type
contract-term-type string

contract term type

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

id
id integer

Coupa unique identifier

name
name string

name

tier-1-disc-pct
tier-1-disc-pct string

tier_1_disc_pct

tier-1-upper-bound
tier-1-upper-bound string

tier_1_upper_bound

tier-2-disc-pct
tier-2-disc-pct string

tier_2_disc_pct

tier-2-upper-bound
tier-2-upper-bound string

tier_2_upper_bound

tier-3-disc-pct
tier-3-disc-pct string

tier_3_disc_pct

tier-3-upper-bound
tier-3-upper-bound string

tier_3_upper_bound

type
type string

type

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

use-pct-discounts
use-pct-discounts string

use_pct_discounts

Supplier

Name Path Type Description
account-number
account-number string

Account number

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

display-name
display-name string

display_name

id
id integer

Coupa Internal ID

name
name string

Supplier name

number
number string

Supplier number

status
status string

Supplier status

UserSimple

Name Path Type Description
active
active boolean

Active\Inactive

approval-groups
approval-groups array of UserGroup
business-group-security-type
business-group-security-type integer

business_group_security_type

content-groups
content-groups array of BusinessGroup
created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

email
email string

email

login
login string

employee number

fullname
fullname string

full name

id
id integer

Coupa unique identifier

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

user-groups
user-groups array of UserGroup

UserGroup

Name Path Type Description
active
active boolean

Active

can-approve
can-approve boolean

User group has the ability to be an approver

content-groups
content-groups array of BusinessGroup
description
description string

Description

id
id integer

Coupa unique identifier

BusinessGroup

Name Path Type Description
description
description string

description

id
id integer

Coupa unique identifier

name
name string

name

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

Commodity

Name Path Type Description
active
active boolean

Active\Inactive

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

id
id integer

Coupa unique identifier

name
name string

name

updated-at
updated-at date-time

updated-at

Item

Name Path Type Description
name
name string

Item name

description
description string

Item desciption

item-number
item-number string

Unique item number

active
active boolean

Active\Inactive

commodity
commodity Commodity
uom
uom Uom
id
id integer

Coupa unique identifier

image-url
image-url string

URL for item image (will be copied into Coupa on item create/update)

Uom

Name Path Type Description
name
name string

name

code
code string

code

active
active boolean

Active\Inactive

id
id integer

Coupa unique identifier

SupplierItem

Name Path Type Description
price
price string

price

currency
currency Currency
contract
contract Contract
contract-term
contract-term ContractTerm
created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

item
item Item
id
id integer

Coupa unique identifier

lead-time
lead-time integer

lead_time

manufacturer
manufacturer string

manufacturer

minimum-order-quantity
minimum-order-quantity string

minimum_order_quantity

order-increment
order-increment string

order_increment

price-tier-1
price-tier-1 string

price_tier_1

price-tier-2
price-tier-2 string

price_tier_2

price-tier-3
price-tier-3 string

price_tier_3

supplier
supplier Supplier
preferred
preferred boolean

Indicates preferred supplier for this item

supplier-aux-part-num
supplier-aux-part-num string

supplier_aux_part_num

supplier-part-num
supplier-part-num string

supplier_part_num

unspsc-code
unspsc-code string

UNSPSC code

IntegrationRun

Name Path Type Description
id
id integer

Coupa unique identifier

integration
integration Integration
integration-errors
integration-errors array of IntegrationError
records-processed
records-processed integer

records_processed

start-time
start-time string

start_time

status
status string

transaction status

total-records
total-records integer

total_records

updated-at
updated-at date-time

YYYY-MM-DDTHH:MM:SS+HH:MMZ

IntegrationError

Name Path Type Description
contact-alert-type
contact-alert-type string

contact_alert_type

created-by
created-by UserSimple
creation-method
creation-method string

creation_method

document-id
document-id integer

document_id

document-status
document-status string

document_status

document-type
document-type string

document_type

id
id integer

Coupa unique identifier

integration-filename
integration-filename string

filename that is associated with integration error

status
status string

transaction status

updated-at
updated-at date-time

Automatically created by Coupa

updated-by
updated-by UserSimple

Integration

Name Path Type Description
business-object
business-object string

Business Object

code
code string

Unique Integration Code

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

direction
direction string

Direction

end-system
end-system string

End System

end-system-type
end-system-type string

End System Type

id
id integer

Coupa unique identifier

name
name string

Integration Name

standard
standard boolean

Standard

OrderLine

Name Path Type Description
account
account Account
accounting-total
accounting-total number

accounting_total

attachments
attachments array of Attachments
commodity
commodity Commodity
contract
contract Contract
description
description string

description

id
id integer

Coupa unique identifier

invoiced
invoiced number

invoiced

item
item Item
line-num
line-num string

line_num

order-header-id
order-header-id integer

order_header_id

price
price number

price

quantity
quantity number

quantity

received
received string

Quantity/Amount received

requester
requester UserSimple
source-part-num
source-part-num string

source_part_num

status
status string

transaction status

supplier
supplier Supplier
total
total number

total

type
type string

type

uom
uom Uom

InventoryTransaction

Name Path Type Description
account
account Account
attachments
attachments array of Attachments
id
id integer

Coupa's Internal Inventory Transaction ID

item
item Item
order-line
order-line OrderLine
price
price number

Item Price

quantity
quantity number

Receipt Quantity

receipt
receipt Receipt
requester
requester UserSimple
status
status string

Inventory Transaction Status

total
total number

Receipt Total

transaction-date
transaction-date date-time

Actual date of transaction

type
type string

Inventory Transaction Type

uom
uom Uom
updated-at
updated-at date-time

Time of Inventory Transaction Updation

Account

Name Path Type Description
account-type
account-type AccountType
account-type-id
account-type-id integer

Account Type Id

active
active boolean

Active\Inactive flag

code
code string

All segments concatenated with a hyphen ( - )

created-at
created-at string

YYYY-MM-DDTHH:MM:SS+HH:MMZ

created-by
created-by UserSimple
id
id integer

Coupa unique identifier

name
name string

This is the nickname for the account.

segment-1
segment-1 string

Each segment represents the segment of the account code

segment-2
segment-2 string

Each segment represents the segment of the account code

segment-3
segment-3 string

Each segment represents the segment of the account code

segment-4
segment-4 string

Each segment represents the segment of the account code

segment-5
segment-5 string

Each segment represents the segment of the account code

segment-6
segment-6 string

Each segment represents the segment of the account code

updated-by
updated-by UserSimple

AccountType

Name Path Type Description
active
active boolean

A false value will inactivate the COA

currency
currency Currency
id
id integer

Coupa unique identifier

name
name string

name

Receipt

Name Path Type Description
created-at
created-at string

Automatically created by Coupa in the format

id
id integer

Coupa unique identifier

quantity
quantity number

quantity

receipt-date
receipt-date date-time

receipt_date

total
total number

total

unit-price
unit-price number

line item price

uom
uom Uom
updated-at
updated-at date-time

Automatically created by Coupa in the format

LookupValue

Name Path Type Description
active
active boolean

Active\Inactive

name
name string

Name of the lookup value

description
description string

Description of the lookup value

external-ref-num
external-ref-num string

External Ref Num (actual account value when used in accounting)

id
id integer

Coupa unique identifier

is-default
is-default boolean

is_default

lookup
lookup Lookup
lookup-id
lookup-id integer

lookup_id

Lookup

Name Path Type Description
active
active boolean

Active\Inactive Flag

description
description string

description

id
id integer

Coupa unique identifier

level-1-name
level-1-name string

level_1_name

level-2-name
level-2-name string

level_2_name

level-3-name
level-3-name string

level_3_name

level-4-name
level-4-name string

level_4_name

name
name string

name

FormResponse

Name Path Type Description
id
id integer

Coupa unique identifier

updated-at
updated-at date-time

Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ