Skip to main content

 

 

Coupa Success Portal

Release 20 Outbound API Changes

All attributes are new unless otherwise specified.

Contracts

Contract

Attribute Description Req'd Unique Type Allowable Values Feature
type Contract type false false string(255) MasterContract, AmendmentContract Contract Hierarchy
used_for_buying Used for Buying false false boolean any Contract Hierarchy
strict_invoicing_rules Strict Invoicing Rules false false boolean any Contract Hierarchy
term_type Term type false false string(255) fixed, auto_renew, perpetual Contract Hierarchy
termination_notice Termination Notice false false string(255) yes, no Contract Hierarchy
consent Notice to Consent false false string(255) notice, consent, not_required, not_assignable Contract Hierarchy
no_of_renewals No of Renewals false false string(255) any Contract Hierarchy
renewal_length_unit Unit of Renewal Length(Days/Years) false false string(255) days, years Contract Hierarchy
renewal_length_value Value of Renewal Length false false string(255) any Contract Hierarchy
length_of_notice_unit Unit of Length of Termination notice(Days/Years) false false string(255) days, years Contract Hierarchy
length_of_notice_value Value of Length of Termination notice false false string(255) any Contract Hierarchy
quote_response_id Id of Quote Response false false integer any Contract Hierarchy

Inventory

Cycle Count Line Count (NEW)

Attribute Description Req'd Unique Type Allowable Values Feature
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  
quantity   true false decimal(30,6) any  
on_hand_balance   false false   any  
discrepancy   false false   any  
inventory_balance   true false   any  
cycle_count_line_adjustments   false false   any  
non_voided_inventory_transactions   false false   any  

Warehouse Location

Data type for the Inventory Transactions API.

Attribute Description Req'd Unique Type Allowable Values Feature
warehouse_name   FALSE FALSE string any  
warehouse_id   FALSE FALSE integer any  

Expenses 

We've updated the Expense APIs with some new elements and data types, shown below.

Expense Reports

Attribute Description Req'd Unique Type Allowable Values Feature
expense_preapprovals Applied expense preapprovals false false   any Travel Expense Preapprovals

Expense Preapproval (NEW)

This is a new data type for the Expenses added for future functionality of the new Travel Expense Preapprovals feature.

Attribute 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
description Additional information for preapproval request true false string(255) any
type Type of preapproval request (trip, cash advance, gifts, entertainment) true false string(255) any
available A flag to show the availability & validity of this preapproval false false boolean any
amount Original preapproved amount true false decimal(32,4) any
available_amount Remaining preapproved amount false false decimal(32,4) any
start_date   false false datetime any
end_date   false false datetime any
for_user User who requested expense preapproval false false integer any
currency Original preapproved currency false false   any
available_amount_currency Remaining preapproved currency false false   any
created_by User who created preapproval request false false integer any
updated_by User who last updated preapproval request false false integer any

Expense Category

Attribute Description Req'd Unique Type Allowable Values Feature
attendee_tracking_enabled   false false boolean any Advanced Mileage Reimbursement
expense_mileage_config   false false   any Advanced Mileage Reimbursement
expense_attendee_types   false false   any Advanced Mileage Reimbursement

Expense Line

Attribute Description Req'd Unique Type Allowable Values Feature
parent_external_src_name Parent External Source Name false false string any  
parent_external_src_data Parent External Source Data false false string any  
parent_external_src_ref Parent External Source Ref false false string any  
expense_preapproval Applied expense preapproval false false

Expense Preapproval

any  
expense_line_mileage   false false   any Advanced Mileage Reimbursement

Expense Line Preapproval (NEW)

This is a new data type for the Expenses added for future functionality of the new Travel Expense Preapprovals feature.

Attribute 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   FALSE FALSE decimal(32,4) any
currency   FALSE FALSE   any
expense_report_preapproval   FALSE FALSE   any

Expense Attendee

These changes added for future functionality of the new Travel Expense Preapprovals feature.

Attribute Description Req'd Unique Type Allowable Values
expense_attendee_type_id   false false integer any
user_id   false false integer any
active   false false boolean any
expense_attendee_type_name   false false   any
expense_attendee_type Field is no longer supported
user Field is no longer supported

Expense Line Attendee (NEW)

This is a new data type for the Expenses added for future functionality of the new Travel Expense Preapprovals feature.

Attribute 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
expense_line_id   false false integer any
expense_attendee_id   false false integer any

Expense Attendee Type

These changes added for future functionality of the new Travel Expense Preapprovals feature.

Attribute Description Req'd Unique Type Allowable Values
active_dependent_fields   false false   any

Expense Line Mileage (NEW)

Added as part of Advanced Mileage Reimbursement.

Attribute 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
passenger_count   false false integer any
start_address   true false string(255) any
end_address   true false string(255) any
distance   true false decimal(32,4) any
distance_unit   true false string(255) any
round_trip   false false boolean any
expense_mileage_vehicle_type   false false   any
expense_mileage_region   false false   any
expense_line_mileage_allocations   false false   any

Expense Line Mileage Allocation (NEW)

Added as part of Advanced Mileage Reimbursement.

Attribute Description Req'd Unique Type Allowable Values
id Coupa unique identifier false false integer(11) 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
expense_mileage_rate_type_id Coupa's unique identifier for the Expense Mileage Rate Type false false integer(4) any
applied_distance   false false decimal(32,4) any
applied_rate   false false decimal(32,4) any

Itemized Expense Line

Attribute Description Req'd Unique Type Allowable Values Feature
parent_external_src_name Parent External Source Name false false string any

Corporate Card Itemization

parent_external_src_data Parent External Source Data false false string any Corporate Card Itemization
parent_external_src_ref Parent External Source Ref false false string any Corporate Card Itemization

Platform

Custom Field Attribute

Attribute Description Req'd Unique Type Allowable Values Feature
api_global_namespace   FALSE FALSE boolean any  

Integration History Record

Field Name Details
document_type Now a required attribute
document_id Now a required attribute

Item

Field Name Description
reorder_alerts Attribute is supported

In earlier release notes, we erroneously listed reorder_alerts as no longer supported.

Invoicing

Invoice Header

Attribute Description Req'd Unique Type Allowable Values Feature
payment_order_reference Payment Order Reference false false string(255) any 20.0 Resolved Issues
withholding_tax_lines   false false   any Withholding Tax
clearance_document Clearance document attachment file name. Accessible via /retrieve_clearance_document false false string any Mexico Compliance
coupa_accelerate_status Status indicating whether the invoice has discount payment terms via Coupa Accelerate false false string(255) accelerated Coupa Accelerate: Early Payment Discount Terms at Transaction Level
inbound_invoice Attribute is no longer supported  
Withholding Tax Override Attribute is no longer supported Mexico Compliance

Invoice Line

Attribute Description Req'd Unique Type Allowable Values Feature
withholding_tax_lines   false false [] any Withholding Tax
unspsc UNSPSC false false string(255) any Mexico Compliance

Tax Line

Attribute Description Req'd Unique Type Allowable Values Feature
type WithholdingTaxLine or TaxLine false false string(255) WithholdingTaxLine, TaxLine Withholding Tax
base Base to Calculate Withholding false false decimal(30,4) any Withholding Tax
withholding_amount Withholding Amount false false decimal(30,4) any Withholding Tax
supplier_rate Supplier Withholding Rate Suggestion false false decimal(30,4) any Withholding Tax
basis Supplier Withholding Base Suggestion false false decimal(30,6) any Withholding Tax

Tax Code

Field Name Details
country Now a required field

Tax Rate

Attribute Description Req'd Unique Type Allowable Values Feature
reverse_charge Whether Tax Rate is Reverse Charge or not false true boolean any Withholding Tax

Purchase Orders

Order Header

Attribute Description Req'd Unique Type Allowable Values Feature
invoice_stop Invoice Stop flag false false boolean any Soft Close Purchase Orders
coupa_accelerate_status Status indicating whether the invoice has discount payment terms via Coupa Accelerate false false string(255) accelerated Coupa Accelerate: Early Payment Discount Terms at Transaction Level

Order Line

Attribute Description Req'd Unique Type Allowable Values Feature
invoice_stop Invoice Stop flag false false boolean any Soft Close Purchase Orders
service_type Service type false false non_service any  
extra_line_attribute   false false   any  
invoiced Field precision improved from decimal(32,4) to decimal(32,6)  

Order Amount Line

Attribute Description Req'd Unique Type Allowable Values Feature
service_type Service type false false non_service any  
extra_line_attribute   false false   any  
invoiced Field precision improved from decimal(32,4) to decimal(32,6)  

Sourcing

Quote Request

Field Name Details
commodity No longer a required field
quote_suppliers No longer a required field

Registered Company

Field Name Details
registration_authority Registration Authority was renamed to QST Registration Number

Suppliers

Supplier User

Field Name Details
default_locale New locales added: en-ME, en-PH,

User

Field Name Details
Default Locale New locales added: en-ME, en-PH,

User Group Membership (NEW)

This object type was added as part of the 19.2 Maintenance Update.

Attribute Description Req'd Unique Type Allowable Values
user_group_id User group Id false false integer any
user_id User Id false false integer any
owner Indicates whether the user is admin or not false false boolean any
participant Indicates whether the user is participant or not false false boolean any
user   true false User any
user_group   true false User Group 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

 

  • Was this article helpful?