Skip to main content

 

 

Coupa Success Portal

R29 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 outbound APIs

Announcement

Added to support Coupa Mobile Announcements.

Element Description Hidden Req'd Unique Type Allowable Values
id Coupa unique identifier false false false integer any
created_at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ false false false datetime any
updated_at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ false false false datetime any
subject Announcement subject false true false string(255) any
message Announcement message false true false text any
short_description Announcement short message false false false   any
announceable_type Announceable type false false false string(255) any
announceable_id Announceable ID false false false integer any
start_at Announcement start date false true false datetime any
new New announcement false false false boolean any
created_by User who created false false false   any
updated_by User who updated false false false   any

Diversity Category

Element Description Hidden Req'd Unique Type Allowable Values Feature
id Coupa unique identifier. false false false integer any Added as part of a future functionality. For more information, see Other SIM Enhancements.
code Code false true true string(255) any Added as part of a future functionality. For more information, see Other SIM Enhancements.
created_at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ false false false datetime any Added as part of a future functionality. For more information, see Other SIM Enhancements.
updated_at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ false false false datetime any Added as part of a future functionality. For more information, see Other SIM Enhancements.
category Category false false false   any Added as part of a future functionality. For more information, see Other SIM Enhancements.
parent_category Parent Category false false false   any Added as part of a future functionality. For more information, see Other SIM Enhancements.

Legal Entity

Added to support Receipt Digitization.

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

Policy

Added to support Mobile Announcements

Element Description Hidden Req'd Unique Type Allowable Values
id Coupa unique identifier false false false integer any
created_at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ false false false datetime any
updated_at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ false false false datetime any
name Policy name false true true string(100) any
text Policy description false true false text any
created_by User who created false false false   any
updated_by User who updated false false false   any

Proxy Supplier 

Added to support Supplier Sync Enhancements.

Element Description Hidden Req'd Unique Type Allowable Values
id Coupa unique identifier false false false integer any
created_at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ false false false datetime any
updated_at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ false false false datetime any
name   false false false   any
display_name   false false false   any
status   false false false   any
owner_id   false false false   any
owner_login   false false false   any
website   false false false   any
duns   false false false   any
tax_id   false false false   any
reference_number   false false false   any
provider_reference_number   false false false   any
primary_address   false false false   any
primary_contact   false false false   any
default_commodity   false false false   any
created_by User who created false false false   any
updated_by User who updated false false false   any

Requisition Line Template

Added to support Contract-backed Requisition Approvals.

Element Description Hidden Req'd Unique Type Allowable Values
id Coupa unique identifier false false false integer any
created_at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ false false false datetime any
updated_at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ false false false datetime any
name RequisitionLineTemplate name false true true string(100) any
created_by User who created false false false   any
updated_by User who updated false false false   any

Updated outbound APIs

Commodity

Element Description Hidden Req'd Unique Type Allowable Values Feature
translated_name   false false false   any Globalization Enhancements

Contract

These changes were made in support of Supplier Sync Enhancements.

Fields added
Element Description Hidden Req'd Unique Type Allowable Values
proxy_supplier_id Identifier for a proxy supplier false false false integer any
Fields changed
Element Description
start_date This element is no longer required
auto_extend_end_date_for_renewal This element is no longer required
contract_type This element is no longer required

Expense Artifact

Added as part of Receipt Digitization.

Element Description Hidden Req'd Unique Type Allowable Values
digitization_status digitization status false false false string(25) any
digitization_error digitization error false false false string any
digitized_receipt_file_name digitized_receipt_file_name false false false string(255) any
digitized_receipt_content_type digitized_receipt_content_type false false false string(255) any
digitized_receipt_file_size digitized_receipt_file_size false false false integer any

Expense Line

Added as part of Simplified Expense Line Display.

Fields changed
Element Description
description This element is no longer required.
employee_reimbursable_editable This element is no longer required and the type is now boolean

Expense Line Imported Data

Added in support of display of Receipt Amount.

Element Description Hidden Req'd Unique Type Allowable Values
local_amount_different   false false false boolean any
local_amount   false false false decimal(32,4) any
local_amount_currency   false false false   any

Invoice Header

Changed as part of Create Invoices with the API.

Fields changed
Element Description
self_billing_reference This type is now string(191)
customs_declaration_number This type is now string(60)
series This type is now string(30)
folio_number This type is now string(20)
use_of_invoice This type is now string(10)
form_of_payment This type is now string(10)
type_of_receipt This type is now string(10)
payment_method This type is now string(10)
issuance_place This type is now string(50)
confirmation This type is now string(50)
coupa_accelerate_status This type is now string(40)
type_of_relationship This type is now string(10)
payment_channel This type is now string(40)
endorsement_on_invoices This type is now string(10)
new_means_of_transport This type is now string(10)
place_of_issuance This type is now string(100)
transaction_uuid This type is now string(50)

Invoice Line

Element Description Hidden Req'd Unique Type Allowable Values Feature
adjustment_type Adjustment Type false false false string(255) price, quantity, other Extended Invoicing API Coverage for Invoice Creation
supp_aux_part_num   false false false text any Extended Invoicing API Coverage for Invoice Creation

Itemized Expense Line

Added as part of Simplified Expense Line Display.

Fields changed
Element Description
description This element is no longer required

Order Amount Line

Element Description Hidden Req'd Unique Type Allowable Values Feature
receipt_approval_required Receipt Approval Required false false false boolean any Receipt Approval
milestones   false false false [] any Receipt Approval

Order Line

Element Description Hidden Req'd Unique Type Allowable Values Feature
receipt_approval_required Receipt approval required false false false boolean any Receipt Approval

Punchout Site

Element Description Hidden Req'd Unique Type Allowable Values Feature
description   false false false string(255) any Recent Documents and Expanded Search Scope
title   false false false   any Recent Documents and Expanded Search Scope

Registered Company

Element Description Hidden Req'd Unique Type Allowable Values Feature
permanent_account_number   false false false string(255) any Extended Invoicing API Coverage for Invoice Creation.

Supplier

Element Description Hidden Req'd Unique Type Allowable Values Feature
diversities List of Supplier Diversities false false false [] any Other SIM Enhancements

Supplier Information

Element Description Hidden Req'd Unique Type Allowable Values Feature
diversities List of Supplier Information Diversities false false false [] any Other SIM Enhancements

Task

Added as part of Enhanced Task Management.

Element Description Hidden Req'd Unique Type Allowable Values
status status of task false false false string(255) any
owner_id User id to whom the task is assigned false false false integer any
linkable_id Id of the User group or Project that the task is linked to false false false integer any
linkable_type linked object type.Task cn be linked to User group or a Project false false false string(255) any
resolved_at Timestamp the task was resolved in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ false false false datetime any
owner   false true false   any
linkable Association to which the task is linked to. Possible values are UserGroup/Project false true false   any
resolved_by User who resolved the task false false false   any

User

Element Description Hidden Req'd Unique Type Allowable Values Feature
account-groups Account groups that the user should have access to (for account-based document security) false false false   any Account Groups column in the User table
allow_employee_payment_account_creation Allow the user to create an Employee Payment Account, regardless of the Employee Payment Channel. false false false boolean Yes/No Employee Payment Account
legal_entity Assigns user to legal entity to set requirements for expense report receipt retention. false false false   any Receipt Digitization
invoice_self_approval_limit Maximum amount allowed for Invoice self approvals false false false   any  
  • Was this article helpful?