Skip to main content

 

 

Coupa Success Portal

Release 21 Inbound API Changes

Overview

These are the changes we made to Coupa's inbound APIs in R21. Everything listed below are newly added attributes unless stated otherwise.

Commodities

Element Description Hidden Req'd Unique Type Allowable Values Feature
deductibility Allowable values: fully_deductible, partially_deductible, not_deductible NO NO NO string(255)   New Commodity Attributes
category Allowable values: goods, services NO NO NO string(255)   New Commodity Attributes
subcategory Allowable values: raw_materials, investment_goods, services_exceptions NO NO NO string(255)   New Commodity Attributes

Contracts

Element Description Hidden Req'd Unique Type Allowable Values Feature
terminated Terminated NO NO NO boolean true, false Contract Hierarchy
termination_notice_length_unit Unit of Termination Notice Length(Days/Months/Years) NO NO NO string(255) days, months, years Contract Hierarchy
termination_notice_length_value Value of Termination Notice Length NO NO NO integer(11) any Contract Hierarchy
reason_insight_code Termination Reason Code NO NO NO string(255) any Contract Hierarchy
reason_insight_comment Termination Comment NO NO NO text any Contract Hierarchy
amended_contract_type Amended Contract Type NO NO NO string(255) any Contract Hierarchy
parent   NO NO NO   any Contract Hierarchy
master_contract Master Contract number or name NO NO NO Contract any Contract Hierarchy
used_for_buying Used for Buying NO NO NO boolean any Contract Hierarchy
strict_invoicing_rules Strict Invoicing Rules NO NO NO boolean any Contract Hierarchy
term_type Term type NO NO NO string(255) fixed, auto_renew, perpetual Contract Hierarchy
termination_notice Termination Notice NO NO NO string(255) yes, no Contract Hierarchy
consent Notice to Consent NO NO NO string(255) notice, consent, not_required, not_assignable Contract Hierarchy
no_of_renewals No of Renewals NO NO NO string(255) any Contract Hierarchy
renewal_length_unit Unit of Renewal Length(Days/Months/Years) NO NO NO string(255) days, months, years Contract Hierarchy
renewal_length_value Value of Renewal Length NO NO NO string(255) any Contract Hierarchy
length_of_notice_unit Unit of Length of Notice(Days/Months/Years) NO NO NO string(255) days, months, years Contract Hierarchy
length_of_notice_value Value of Length of Notice NO NO NO string(255) any Contract Hierarchy
contract_owner Contract owner NO NO NO user any Contract Hierarchy

Easy Form Widgets

Element Change
easy_form_id Now a required element

Invoicing

Invoice Lines

Element Description Hidden Req'd Unique Type Allowable Values Feature
category Category NO NO NO string(255) any Deductibility and Item Types
subcategory Subcategory NO NO NO string(255) any Deductibility and Item Types
deductibility Deductibility NO NO NO string(255) any Deductibility and Item Types
bulk_price Bulk Price NO NO NO string(255) any Bulk Pricing

Bulk Price

This is a new API type. See Bulk Pricing fore more info.

Element Description Req'd Unique Allowable Value In Out Data Type
id Coupa unique identifier         yes integer
price Price       yes yes decimal(30,6)
qty Qty       yes yes decimal(30,6)
uom Unit of Measure       yes yes UoM

Purchase Orders

Bulk Price

See Bulk Price for Invoices

Purchase Order Changes

This is a new API endpoint. See PO Change API Endpoint for more info and Purchase Order Change API for full details.

Actions

Verb Path Action Description
PUT /api/purchase_order_changes/:id/add_approver add_approver Manually add an approver for an order header change
POST /api/purchase_order_changes create Create purchase order change
GET /api/purchase_order_changes index Query purchase order changes
PUT /api/purchase_order_changes/:id/remove_approval remove_approval Remove an approver who was manually added
GET /api/purchase_order_changes/:id show Show purchase order change
PATCH /api/purchase_order_changes/:id update Update purchase order change
PUT /api/purchase_order_changes/:id update Update purchase order change

Elements

Element Description Req'd Unique Allowable Value In Out Data Type
acknowledged-at acknowledged_at         yes date
approvals Approvals         yes Approval 
attachments Attachments         yes Attachment 
created-at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ   yes datetime
created-by User who created         yes User 
current-approval Current/Pending Approval         yes Approval 
department department       yes   Department 
exported Indicates if transaction has been exported         yes boolean
id Coupa unique identifier         yes integer
justification justification         yes Order Change Request
order-header-id id of the order that is being changed       yes yes integer
order-line-changes Order line changes       yes yes Order Line Change 
payment-method payment_method       yes   string(255)
payment-term payment terms       yes yes Payment Term 
pcard pcard       yes yes Pcard 
po-number PO Number         yes string(20)
price-hidden Hide Price from supplier. True or False         yes boolean
reject-reason Reject reason         yes Comment 
requester Requesting Account's login         yes User 
requisition-header-id requisition_header_id         yes integer
ship-to-address Ship to address         yes Address 
ship-to-user Ship to user       yes yes User 
shipping-term shipping terms       yes yes Shipping Term 
status PO Status         yes string(255)
supplier Supplier         yes Supplier 
updated-at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ   yes datetime
version PO Supplier Version Number - Increase each time a PO is changed and triggers a resend to the supplier.   yes integer

Punchout Sites

Element Description Hidden Req'd Unique Type Allowable Values Feature
contract_id Coupa's unique identifier for the contract NO YES NO integer any  

Sourcing

Three new API endpoints: /quote_requests/quote_responses and /quote_suppliers.

See New Sourcing API Endpoints fore more info.

Quote Requests

Actions

Verb Path Action Description
POST /api/quote_requests create Create a Sourcing event
POST /api/quote_requests/create_from_source create_from_source Create Sourcing event from Requisition, Contract, Catalog, Order pad, Order lines, Invoice lines and items
PATCH /api/quote_requests/:id/end_event end_event End production event
PATCH /api/quote_requests/:id/go_to_production go_to_production Submit event to production
PATCH /api/quote_requests/:id/go_to_test go_to_test Submit event to production as tests event
GET /api/quote_requests index Returns all Sourcing events
GET /api/quote_requests/:id show Get information about the particular event
PATCH /api/quote_requests/:id update Update a Sourcing event
PUT /api/quote_requests/:id update Update a Sourcing event

Elements

Element Description Req'd Unique Allowable Value In Out Data Type
allow-award-individual-line-items Ability to award individual line items       yes   boolean
allow-multiple-response Allow multiple responses from one supplier       yes   boolean
attachments Attachments - there can be event details, terms and conditions, regular attachments yes   Attachment 
automatic-bid-unsealing If checked, bids will be unsealed automatically true, false yes   boolean
business-partners Business partners       yes   QuoteRequestsUser 
comments Comments       yes   text
commodity Commodity       yes   Commodity 
currency Currency       yes   Currency 
description Event name       yes   text
end-time Time when event should end, format: %m/%d/%y %I:%M %p %z yes   datetime
event-type Type of event yes     yes   string(255)
forms Forms       yes   Form 
lines Lines       yes   QuoteRequestLine 
lots Lots       yes   QuoteRequestsLot 
quote-request-attachments Quote request attachments       yes   QuoteRequestAttachment 
quote-suppliers Quote suppliers       yes   QuoteSupplier 
sealed-bids If checked, bids will be sealed       yes   boolean
start-on-submit Flag that indicates whether to start event on submit or not yes   boolean
start-time Time when event should start, format: %m/%d/%y %I:%M %p %z yes   datetime
tags Tags       yes   Tag 
timezone Event timezone       yes   string(255)

Quote Responses

Actions

Verb Path Action Description
POST /api/quote_responses/:id/award award Award the quote response
GET /api/quote_requests/:quote_request_id/quote_responses index Get all responses of specific Sourcing event
GET /api/quote_responses index Get all responses of specific Sourcing event
DELETE /api/quote_responses/:id/award remove_award Remove award from the quote response
GET /api/quote_responses/:id show Get information about the particular response

Elements

Element Description Req'd Unique Allowable Value In Out Data Type
comments comments         yes text
created-at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ   yes datetime
created-by User who created         yes User 
id Coupa unique identifier         yes integer
position position         yes integer
quote-request-id quote_request_id         yes integer
quote-supplier quote_supplier yes       yes QuoteSupplier 
state state         yes string(255)
submitted-at submitted_at yes       yes datetime
updated-at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ   yes datetime
updated-by User who updated         yes User 

Quote Suppliers

Actions

Verb Path Action Description
GET /api/quote_suppliers/:id show Get information about the quote supplier

Elements

Element Description Req'd Unique Allowable Value In Out Data Type
contact-name Quote supplier contact name yes     yes yes string(255)
created-at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ   yes datetime
created-by User who created         yes User 
display-name Name that we display to buyer       yes yes string(255)
email Quote supplier email yes yes   yes yes string(255)
id Coupa unique identifier         yes integer
name Quote supplier name yes     yes yes string(255)
supplier Supplier which is linked to quote supplier       yes yes Supplier 
updated-at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ   yes datetime
updated-by User who updated         yes User 

Tax Code Rules

Attribute Description Hidden Req'd Unique Type Allowable Values
id Coupa unique identifier NO NO NO integer any
name   NO NO NO string(255) any
jurisdiction   NO NO NO string(255) any
subcategory   NO NO NO string(255) any
deductibility   NO NO NO string(255) any
tax_rate   NO NO NO string(255) any
account_segment_1   NO NO NO string(255) any
account_segment_2   NO NO NO string(255) any
account_segment_3   NO NO NO string(255) any
account_segment_4   NO NO NO string(255) any
account_segment_5   NO NO NO string(255) any
active   NO NO NO boolean true, false
priority   NO YES NO integer(11) any
effective_date   NO YES NO datetime any
end_date   NO NO NO datetime any
tax_code   NO YES NO string(255) any
account_type   NO YES NO varchar(50) any
buyer_tax_registration   NO NO NO string(255) any
tax_rate_type   NO NO NO string(255) any
supplier_fiscal_rep_country   NO NO NO string(100) any
buyer_fiscal_rep_country   NO NO NO string(100) any
created_at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ NO NO NO datetime any
updated_at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ NO NO NO datetime any
created_by User who created NO NO NO user any
updated_by User who updated NO NO NO user any

User

Column Name Change Feature
Default Locale New regions: en-CN, en-TW New Languages and Currencies
  • Was this article helpful?