Release 24 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
Adjustment Code
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 |
code | true | true | string(255) | any | |
name | true | true | string(255) | any |
Contract Type
Added as part of Contract Types.
Element | Description | Req'd | Unique | Type | Allowable Values |
---|---|---|---|---|---|
name | Name of the custom-defined contract type | true | true | string(255) | any |
description | Brief description | false | false | text | any |
active | Flag to indicate if in use or not | 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 |
Expense Trip
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 |
expense_trip_segments | false | false | [] | any | |
errors | false | false | any |
Expense Trip Segment
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 |
start_at | false | false | any | ||
start_location | true | false | string(255) | any | |
start_location_id | true | false | string(255) | any | |
end_at | false | false | any | ||
end_location | true | false | string(255) | any | |
end_location_id | true | false | string(255) | any | |
is_travel_segment | false | false | boolean | any | |
errors | false | false | 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 id , name , 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 outbound objects
Account Type
Element | Description | Req'd | Unique | Type | Allowable Values | Feature |
---|---|---|---|---|---|---|
legal_entity_name | Legal entity or entities that are associated with this chart of accounts | false | false | string | any |
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 | |
statement_id | Now a required element |
Contract
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 |
Contract Template
Element | Description | Req'd | Unique | Type | Allowable Values | Feature |
---|---|---|---|---|---|---|
active | Is Template Active | false | false | boolean | any | Import Published Contracts |
Easy Form Widget Response
Element | Description | Req'd | Unique | Type | Allowable Values | Feature |
---|---|---|---|---|---|---|
field_name | false | false | any |
Expense Category
Element | Description | Req'd | Unique | Type | Allowable Values | Feature |
---|---|---|---|---|---|---|
scope | false | false | string(255) | any |
Expense Line
Element | Description | Req'd | Unique | Type | Allowable Values | Feature |
---|---|---|---|---|---|---|
expense_trip | Expense trip | false | false | ExpenseTrip | any | |
expense_line_daily_per_diems | Daily per diems with amount information for each day | false | false | ExpenseLineDailyPerDiem | any |
Expense Line Daily Per Diem
Element | Description | Req'd | Unique | Type | Allowable Values | Feature |
---|---|---|---|---|---|---|
locations | false | false | [] | any | ||
rate_destination | false | false | any | |||
max_rate | false | false | decimal | any |
Inventory Adjustment
Element | Description | Req'd | Unique | Type | Allowable Values | Feature |
---|---|---|---|---|---|---|
adjustment_code | false | false | any | |||
currency | Currency of transaction | false | false | any | ||
type | Now a required element |
Inventory Manage Transaction
Element | Change | Feature |
---|---|---|
type | Now a required element |
Inventory Transaction
Element | Change | Feature |
---|---|---|
type | Now a required element |
Invoice Header
Element | Description | Req'd | Unique | Type | Allowable Values | Feature |
---|---|---|---|---|---|---|
payment_channel | How the invoice payment will be handled - ERP (default), Coupa Pay Virtual Card, Coupa Pay Invoice Payment | false | false | string(255) | any | |
abandon_reason | false | false | any |
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 |
---|---|---|---|---|---|---|
transmission_method_override | Transmission Method Override | false | false | string(30) | supplier_default, email, do_not_transmit | |
transmission_emails | Tranmission Email comma seperated list | false | false | text | any |
Order Header Change
Element | Description | Req'd | Unique | Type | Allowable Values | Feature |
---|---|---|---|---|---|---|
transmission_method_override | Transmission Method Override | false | false | string(30) | supplier_default, email, do_not_transmit | |
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 Header
Element | Description | Req'd | Unique | Type | Allowable Values | Feature |
---|---|---|---|---|---|---|
receiving_warehouse_id | Receiving Warehouse ID | false | false | integer | any | 24.0 Resolved Issue |
line_count | Requisition Header Line Count | false | false | integer | any |
Requisition Line
Element | Description | Req'd | Unique | Type | Allowable Values | Feature |
---|---|---|---|---|---|---|
transmission_method_override | false | false | string(30) | supplier_default, email, do_not_transmit | ||
transmission_emails | false | false | text | any | ||
unspsc_code | UNSPSC code | false | false | string(255) | any | |
supplier_site | false | false | any | |||
period | Budget Period | false | false | any | ||
order_pad_line | Order Pad Line | false | false | any |
Supplier
Fields removed
Element | Change | Feature |
---|---|---|
virtual_card_email | Email Virtual P-Cards are sent when payment method is "Virtual Card" |
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 Item
Element | Description | Req'd | Unique | Type | Allowable Values | Feature |
---|---|---|---|---|---|---|
unspsc_code | UNSPSC code | false | false | string(255) | any |
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 |
User Metric
Element | Change | Feature |
---|---|---|
metric_value | Type changed from integer to decimal(30,15) |