Skip to main content

 

 

Coupa Success Portal

Release 24 Inbound API Changes

Introduction

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

Check out the Coupa API documentation to learn more.

New API inbound objects

Contract Type

Added as part of Contract Types.

Element Description Req'd Unique Type Allowable Values
name Name of the custom type true true string(255) any
description Brief description of use case or intention false false text any
active Controls availability in contract type field false false boolean any
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
created_by User who created false false User any
updated_by User who updated false false User any

Project

Added as part of R24 Projects and Groups Enhancements.

Element Description Req'd Unique Type Allowable Values
name Name true true string(255) any
active Active false false boolean any
open Project is open for everyone to join or owner must invite others false false boolean any
can_approve Project has the ability to be an approver false false boolean any
description Description false false text any
start_date Start date false false datetime any
end_date End date false false datetime any
display_date_range_warning Provide a warning if task dates fall outside of project dates false false boolean any
owner   false false User any
users   false false User any
commodity   false false Commodity any
template_group   false false   any
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
mention_name Mention name false true string(255) any
created_by User who created false false User any
updated_by User who updated false false User any

Supplier Risk Aware Feed

This API was added as part of Supplier Risk Aware Feed API.

Element Description Req'd Unique Type Allowable Values
number_field_01 Number field 1 false false decimal(32,4) any
number_field_02 Number field 2 false false decimal(32,4) any
number_field_03 Number field 3 false false decimal(32,4) any
number_field_04 Number field 4 false false decimal(32,4) any
number_field_05 Number field 5 false false decimal(32,4) any
number_field_06 Number field 6 false false decimal(32,4) any
number_field_07 Number field 7 false false decimal(32,4) any
number_field_08 Number field 8 false false decimal(32,4) any
number_field_09 Number field 9 false false decimal(32,4) any
number_field_10 Number field 10 false false decimal(32,4) any
supplier When performing a POST specify any one of these supplier elements idname, or number. to positively identify the supplier. false false Supplier  any
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

Updated API inbound objects

Address

Element Change Feature
vat_number Type changed from string(47) to string(255)  

Charge

Element Change Feature
external_ref_id Now a required element  
virtual_card Now a required element  
supplier Now a required element  

Contract

This API was added as part of New Standard Fields for Contracts

Element Description Req'd Unique Type Allowable Values Feature
description Descriptive notes about the contract false false string(1024) any New Standard Fields for Contracts
published_date Date when the contract was published false false datetime any New Standard Fields for Contracts
execution_date Date when the contract is completed and legally binding false false datetime any New Standard Fields for Contracts
department Owner Department false false   any New Standard Fields for Contracts
contract_type Custom-defined label for categorization true false   any New Standard Fields for Contracts
contract_type_custom_field_1 Contract type custom field 1 false false string(255) any Contract Types
contract_type_custom_field_2 Contract type custom field 2 false false string(255) any Contract Types
contract_type_custom_field_3 Contract type custom field 3 false false string(255) any Contract Types
contract_type_custom_field_4 Contract type custom field 4 false false string(255) any Contract Types
contract_type_custom_field_5 Contract type custom field 5 false false string(255) any Contract Types
contract_type_custom_field_6 Contract type custom field 6 false false string(255) any Contract Types
contract_type_custom_field_7 Contract type custom field 7 false false string(255) any Contract Types
contract_type_custom_field_8 Contract type custom field 8 false false string(255) any Contract Types
contract_type_custom_field_9 Contract type custom field 9 false false string(255) any Contract Types
contract_type_custom_field_10 Contract type custom field 10 false false string(255) any Contract Types
 

Inventory Adjustment

Element Description Req'd Unique Type Allowable Values Feature
adjustment_code   false false   any Inventory Transaction API/CSV
type Now a required element  


Inventory Manage Transaction

Element Change Feature
type Now a required element Inventory Transaction API/CSV

Inventory Transaction

Element Change Feature
type Now a required element Inventory Transaction API/CSV

Item

Element Description Req'd Unique Type Allowable Values Feature
item_type Item Type false false Item any  

Order Header

Element Description Req'd Unique Type Allowable Values Feature
hide_price Hide Price from supplier. True or False false false boolean any  
transmission_method_override Transmission Method Override false false string(30) supplier_default, email, do_not_transmit PO Transmission Method Override
transmission_emails Tranmission Email comma seperated list false false text any  

Order Header Change

Element Description Req'd Unique Type Allowable Values Feature
hide_price Hide Price from supplier. True or False false false boolean any  
transmission_method_override Transmission Method Override false false string(30) supplier_default, email, do_not_transmit PO Transmission Method Override
transmission_emails Tranmission Email comma seperated list false false text any  

Remit To Address

Element Change Feature
vat_number Type changed from string(47) to string(255)  

Requisition Amount Line

Element Description Req'd Unique Type Allowable Values Feature
source Source false false string(255) any  
source_details Source Details false false string(255) any  
transmission_method_override   false false string(30) supplier_default, email, do_not_transmit PO Transmission Method Override
transmission_emails   false false text any  

Requisition Header

Element Description Req'd Unique Type Allowable Values Feature
receiving_warehouse_id Receiving Warehouse ID false false integer any 24.0 Resolved Issue
hide_price Hide Price from supplier. True or False false false boolean any  

Requisition Line

Element Description Req'd Unique Type Allowable Values Feature
source Source false false string(255) any  
source_details Source Details false false string(255) any  
transmission_method_override   false false string(30) supplier_default, email, do_not_transmit  
transmission_emails   false false text any  

Supplier

Element Change Feature
virtual_card_email The element was removed from the API Supplier Payment Account Setup

Supplier Information Address

Element Description Req'd Unique Type Allowable Values Feature
custom-field-1 Custom fields only available when kind=RTA     string(255) Any Custom Fields for SIM Addresses
custom-field-2 Custom fields only available when kind=RTA     string(255) Any Custom Fields for SIM Addresses
custom-field-3 Custom fields only available when kind=RTA     string(255) Any Custom Fields for SIM Addresses
custom-field-4 Custom fields only available when kind=RTA     string(255) Any Custom Fields for SIM Addresses
custom-field-5 Custom fields only available when kind=RTA     string(255) Any Custom Fields for SIM Addresses
custom-field-6 Custom fields only available when kind=RTA     string(255) Any Custom Fields for SIM Addresses
custom-field-7 Custom fields only available when kind=RTA     string(255) Any Custom Fields for SIM Addresses
custom-field-8 Custom fields only available when kind=RTA     string(255) Any Custom Fields for SIM Addresses
custom-field-9 Custom fields only available when kind=RTA     string(255) Any Custom Fields for SIM Addresses
custom-field-10 Custom fields only available when kind=RTA     string(255) Any Custom Fields for SIM Addresses
custom-field-11 Custom fields only available when kind=RTA     string(255) Any Custom Fields for SIM Addresses
custom-field-12 Custom fields only available when kind=RTA     string(255) Any Custom Fields for SIM Addresses
custom-field-13 Custom fields only available when kind=RTA     string(255) Any Custom Fields for SIM Addresses
custom-field-14 Custom fields only available when kind=RTA     string(255) Any Custom Fields for SIM Addresses
custom-field-15 Custom fields only available when kind=RTA     string(255) Any Custom Fields for SIM Addresses
custom-field-16 Custom fields only available when kind=RTA     string(255) Any Custom Fields for SIM Addresses
custom-field-17 Custom fields only available when kind=RTA     string(255) Any Custom Fields for SIM Addresses
custom-field-18 Custom fields only available when kind=RTA     string(255) Any Custom Fields for SIM Addresses
custom-field-19 Custom fields only available when kind=RTA     string(255) Any Custom Fields for SIM Addresses
custom-field-20 Custom fields only available when kind=RTA     string(255) Any Custom Fields for SIM Addresses

Custom fields are only available for Remit-to Addresses. The address type is specified with the kind element. 

Supplier User

Element Description Req'd Unique Type Allowable Values Feature
ccw_user Does the user have a Contingent Workforce License? false false boolean any  
country_of_residence   false false   any  
escalation_threshold   false false   any  

Tax Code Rule

Element Description Req'd Unique Type Allowable Values Feature
commodity   false false   any  
supplier   false false   any  
cash_accounting_scheme_reference   false false   any  
tax_reference   false false   any  

Tax Registration

Element Change Feature
number Type changed from string(255) to string(47)  

User

Element Description Req'd Unique Type Allowable Values Feature
ccw_user Does the user have a Contingent Workforce License? false false boolean any  
country_of_residence   false false   any  
escalation_threshold   false false   any  
  • Was this article helpful?