Skip to main content

 

 

Coupa Success Portal

Release 23 Outbound API Changes

Introduction

This list shows the changes we've made to our API outbound formats across the Coupa platform. Unless otherwise stated, all elements are new.

Check out the Coupa API documentation to learn more.

New API outbound objects

These are the new outbound API formats in R23:

Contract template (new)

Added as part of Contract Template Management.

Element Description Req'd Unique Type Allowable Values
id Coupa unique identifier false false integer any
created_at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ false false datetime any
updated_at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ false false datetime any
name Name true false string(255) any
description Description false false string(255) any
hierarchy_type Hierarchy Type false false string(255) any
authoring_method Authoring Method false false string(255) msword, msword_and_online
content_groups Business Groups false false [] any
created_by User who created false false   any
updated_by User who updated false false   any

Inventory transaction valuation (new)

Added as part of Inventory Adjustment API.

Element Description Req'd Unique Type Allowable Values
id Coupa unique identifier false false integer any
inventory_transaction_id inventory transaction id false false integer any
quantity quantity true false decimal(30,6) any
uom unit of measure true false   any
price price false false decimal(30,6) any
currency Currency false false   any

Invoice payment receipt (new)

Added as part of Coupa Pay.

Element Description Req'd Unique Type Allowable Values
id Coupa unique identifier false false integer any
created_at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ false false datetime any
updated_at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ false false datetime any
amount Payed amount false false decimal any
exchange_rate Exchange rate false false decimal any
payment_method Rayment method false false string any
clearance_document File name of payment receipt's clearance document. Accessible via api/invoices/:id/payment_receipts/:uuid/retrieve_clearance_document false false string any
currency Currency false false Currency any
legal_payment_receipt General information of payment receipt false false LegalPaymentReceipt any

Legal payment receipt (new)

Added as part of Mexico payment receipt support.

Element Description Req'd Unique Type Allowable Values
id Coupa unique identifier false false integer any
created_at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ false false datetime any
updated_at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ false false datetime any
uuid UUID of payment receipt document false false string any
payment_received_date Date payment receipt was received false false dateTime any
document_date Date payment receipt was created false false dateTime any
amount Total amount which was payed false false decimal any
form_of_payment Form of payment false false string any
check_number Identification number of payment receipt false false string any
buyer_tax_number Buyer tax registration number false false string any
buyer_bank_name Buyer bank name false false string any
buyer_bank_reference Buyer bank reference false false string any
supplier_tax_number Supplier tax registration number false false string any
supplier_bank_reference Supplier bank reference false false string any
currency Currency false false Currency any

Object instance (new)

Added as part of R23 Custom Objects Enhancements.

Element Description Req'd Unique Type Allowable Values
id Coupa Internal ID false false integer any
created_at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ false false datetime any
updated_at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ false false datetime any
created_by User who created false false   any
updated_by User who updated false false   any

Purpose (new)

Added as part of Multiple Contacts and Addresses for Suppliers.

Element Description Req'd Unique Type Allowable Values
id Coupa unique identifier false false integer any
created_at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ false false datetime any
updated_at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ false false datetime any
name   false false string(255) any

Updated API outbound objects

These are the existing API outbound formats that were updated in R23: 

Address

Element Description Req'd Unique Type Allowable Values Feature
street3 Address Line 3 false false string(100) any  
street4 Address Line 4 false false string(100) any  
purposes   false false [] any Multiple Contacts and Addresses for Suppliers

The JSON output for /api/addresses and /api/suppliers/<id>/addresses now fully resolves the created_by and updated_by user records instead of just specifying the user ID. This change in output behavior is consistent with the existing XML output behavior. 

Charges

Element Description Req'd Unique Type Allowable Values Feature
account_type_id Chart of Accounts ID associated with the charge false false integer any  
statement_name Name of the Statement that this Charge belongs to false false string any  
supplier_name Supplier in Coupa that made the charge false false string any  
last_exported_at Date and time transaction was last exported in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ false false datetime any  
exported Indicates if transaction has been exported false false boolean any  
order_header_id Purchase Order ID associated with the charged card false false integer any  
order_header_number Purchase Order Number associated with the charged card false false string any  
order_header_total Total amount on the charged card's Purchase Order false false string any  
order_header_currency Currency from the charged card's Purchase Order false false string any  

Contact

Element Description Req'd Unique Type Allowable Values Feature
purposes   false false [] any Multiple Contacts and Addresses for Suppliers

Easy form widget 

Element Description Req'd Unique Type Allowable Values Feature
is_internal   false false boolean any Updated Design of Questionnaires
prompt Type changed from string(255) to text Updated Design of Questionnaires

Easy form widget response

Element Change Feature
answer encrypted_answer renamed to answer; type changed from string(20000) to text Updated Design of Questionnaires

Internal supplier 

Element Change Feature
primary_address Type changed from Address to SupplierAddress Multiple Contacts and Addresses for Suppliers

Inventory adjustment

Element Description Req'd Unique Type Allowable Values Feature
inventory_transaction_valuations   false false [] any  

Inventory transaction

Element Description Req'd Unique Type Allowable Values Feature
inventory_transaction_valuations Inventory Transaction Valuations false false [] any  

Invoice header

Element Description Req'd Unique Type Allowable Values Feature
delivery_number Delivery Number false false string(255) any  
date_received Date Received in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ false false datetime any Add AP inbox email details to invoice records
sender_email Sender Email false false string any Add AP inbox email details to invoice records
inbox_name Inbox Name false false string any Add AP inbox email details to invoice records
invoice_payment_receipts Invoice related payment receipts information false false InvoicePaymentReceipt any Mexico payment receipt support
amount_due Amount due to the supplier - Invoice Total without withholding and customer accounting taxes false false decimal any Customer accounting rate for Singapore
tax_due_to_supplier Tax due to the supplier false false decimal any Customer accounting rate for Singapore
customer_accounting_tax Customer accounting tax false false decimal any Customer accounting rate for Singapore

Quote request

Element Description Req'd Unique Type Allowable Values Feature
easy-forms Forms false false easyform any Updated Design of Questionnaires
forms This field is deprecated. Use easy-forms instead. Updated Design of Questionnaires

Quote request line

Element Description Req'd Unique Type Allowable Values Feature
need_by_date Date by which the line item is required false false datetime any New Fields - Need by Date and Lead Time
weight Type is now a decimal instead of an integer Weighting of Responses for Scoring

Remit to address

Element Description Req'd Unique Type Allowable Values Feature
external_src_ref Reference number from source system. false false string(255) any  
external_src_name Name of the source system. false false string(255) any  

Supplier

Element Description Req'd Unique Type Allowable Values Feature
default_locale Default Locale for sending emails to this supplier false false string(255) any    
supplier_addresses   false false [] any Multiple Contacts and Addresses for Suppliers  
contacts   false false [] any Multiple Contacts and Addresses for Suppliers  
primary_address Type changed from Address to SupplierAddress         Multiple Contacts and Addresses for Suppliers
payment_method New allowable values: "invoice", "pcard", "invoice_only", "pcard_only", "virtual_card"  

Supplier site

Element Description Req'd Unique Type Allowable Values Feature
default_locale Default Locale for sending emails to this supplier site false false string(255) any  

Tax rate

Element Description Req'd Unique Type Allowable Values Feature
tax_description Tax Rate Description false false string(255) any Customer accounting rate for Singapore
customer_accounting   false false boolean any Customer accounting rate for Singapore

Tax rate type

Element Description Req'd Unique Type Allowable Values Feature
active   false false boolean any Resolved Issue in R22 
effective_date   false false datetime any Resolved Issue in R22 
expiration_date   false false datetime any Resolved Issue in R22 

User

Element Description Req'd Unique Type Allowable Values Feature
spend_guard_user Does the user have a Spend Guard License? false false boolean any Entitlement, Licenses, and Roles
aic_user Does the user have an AI Classification License? false false boolean any AI Classification Spend Visualization in Coupa
default_locale New allowable values: ["en", "tr", "ja", "bg", "cs", "da", "de-AT", "de-BE", "de-CH", "de-LU", "de", "el", "en-AU", "en-CA", "en-CN", "en-GB", "en-HK", "en-IE", "en-IN", "en-ME", "en-MT", "en-MY", "en-NZ", "en-PH", "en-SG", "en-TW", "en-ZA", "es-CO", "es-IC", "es-MX", "es-PR", "es", "et", "fi", "fr-BE", "fr-CA", "fr-CH", "fr-LU", "fr", "hr", "hu", "it-CH", "it", "ko", "lt", "lv", "nl", "no", "sv", "zh-CN", "zh-TW", "mt", "nl-BE", "pl", "pt-BR", "pt", "ro", "ru", "sk", "sl", "sr", "vi", "zh-HK"]

 

  • Was this article helpful?