Skip to main content

 

 

Coupa Success Portal

Release 19 Outbound API Changes

Resources

Approvals

Resource path: /api/approvals

Column Name Description Hidden Required Unique Type Allowable Value
delegates Delegate approvals FALSE FALSE FALSE User, Approval Group any

Easy Form Responses

Resource paths: /api/users/{id}/easy_form_responses and /api/supplier_information/{id}/easy_form_responses/

Column Name Description Hidden Required Unique Type Allowable Value
approvals   FALSE FALSE FALSE   any

Expense Reports

Resource path: /api/expense_reports

Column Name Description Hidden Required Unique Type Allowable Value
report_due_date Corporate Card Expense Report Due Date FALSE FALSE FALSE datetime any
past_due true if a Expense Report with Corporate Card Lines is past due FALSE FALSE FALSE boolean true / false

Expense Lines

Resource path: /api/expense_lines

Column Name Description Hidden Required Unique Type Allowable Value
integration Corp card integration name FALSE FALSE FALSE Integration any
expense_attendees list of expense_attendee FALSE FALSE FALSE list of ExpenseAttendee any

Integrations

Resource path: /api/integrations

Attribute Change
document_type New allowable value: ExternalOrderHeader

Integration Errors

Resource path: /api/integration_errors

Attribute Change
document_type New allowable value: ExternalOrderHeader

Integration History Record

Resource path: /api/integration_history_records

Attribute Change
document_type New Allowable Value: ExternalOrderHeader

Invoice Header

Resource path: /api/invoices

Column Name Description Hidden Required Unique Type Allowable Value
lock_version_key Lock Version FALSE FALSE FALSE integer any
series The serial number used by the Company for internal control of the information. FALSE FALSE FALSE string(255) any
folio_number The internal folio number used by the Company. FALSE FALSE FALSE string(255) any
use_of_invoice The purpose invoice is going to be used for. FALSE FALSE FALSE string(255) any
form_of_payment The specific code in accordance with a catalogue: cash, check, transfer of funds, etc. FALSE FALSE FALSE string(255) any
type_of_receipt Type of the invoice: income, expense, transfer, payroll or payment. FALSE FALSE FALSE string(255) any
payment_method Installments or lump sum payments. FALSE FALSE FALSE string(255) any
issuance_place Issuance Place FALSE FALSE FALSE string(255) any
confirmation This is a unique number provided by the Tax Authorities or the PAC. FALSE FALSE FALSE string(255) any
withholding_tax_override Withholding Tax Override FALSE FALSE FALSE decimal(30,3) any
dispute_reason Dispute Reason FALSE FALSE FALSE DisputeReason any

Supplier

Resource path: /api/suppliers

Column Name Description Hidden Required Unique Type Allowable Value
enterprise   FALSE TRUE FALSE   any

Supplier Information

Resource path: /api/supplier_information

Column Name Description Hidden Required Unique Type Allowable Value
cxml_http_username cXML HTTP Username FALSE FALSE FALSE string(255) any
payment_term Payment terms used by the supplier FALSE FALSE FALSE Payment Term any
created_by User who created the supplier information record. FALSE FALSE FALSE User any
updated_by User who last updated the supplier information record. FALSE FALSE FALSE User any
preferred_language The preferred language of the supplier. FALSE FALSE FALSE Language any
preferred_currency The preferred currency of the supplier. FALSE FALSE FALSE Currency any
default_commodity The default commodity assigned to the supplier's items. FALSE FALSE FALSE Commodity any
country_of_operation The supplier's country of operation for tax purposes. FALSE FALSE FALSE Country any

Users

Resource path: /api/users

Attribute Description Hidden Required Unique Type Allowable Value
analytics_user Does the user have an Analytics License? FALSE FALSE FALSE boolean any
Attribute Change
default_locale New allowable values: de-BE, de-LU, en-HK, en-MY, en-NZ, fr-LU, ro, sr, de-BE, de-LU, en-HK, en-MY, en-NZ, fr-LU, ro, sr

Associations

Dispute Reason (New)

This REST object was added as a new attribute, <dispute-reason> as part of the /invoices resource. 

Column Name Description Hidden Required Unique Type Allowable Value
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
code Dispute Reason Code FALSE TRUE TRUE string(255) any
description Dispute Reason Description FALSE TRUE FALSE text any
created_by User who created FALSE FALSE FALSE integer any
updated_by User who updated FALSE FALSE FALSE integer any

Endpoint

Associated resource: 

Attribute Change
name name is now a required field

Expense Attendee (New)

This REST object was added as a new attribute, <expense-attendee> as part of the /expense_reports and /expense_report_lines resources. 

Column Name Description Hidden Required Unique Type Allowable Value
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
first_name First name of the Expense Attendee FALSE TRUE FALSE string(255) any
last_name Last name of the Expnese Attendee FALSE TRUE FALSE string(255) any
title Job Title / Designation of the Expense Attendee FALSE FALSE FALSE string(255) any
company Company of the Expense Attendee FALSE FALSE FALSE string(255) any
expense_attendee_type_custom_field_1 custom field 1 FALSE FALSE FALSE string(255) any
expense_attendee_type_custom_field_2 custom field 2 FALSE FALSE FALSE string(255) any
expense_attendee_type_custom_field_3 custom field 3 FALSE FALSE FALSE string(255) any
expense_attendee_type_custom_field_4 custom field 4 FALSE FALSE FALSE string(255) any
expense_attendee_type_custom_field_5 custom field 5 FALSE FALSE FALSE string(255) any
expense_attendee_type_custom_field_6 custom field 6 FALSE FALSE FALSE string(255) any
expense_attendee_type_custom_field_7 custom field 7 FALSE FALSE FALSE string(255) any
expense_attendee_type_custom_field_8 custom field 8 FALSE FALSE FALSE string(255) any
expense_attendee_type_custom_field_9 custom field 9 FALSE FALSE FALSE string(255) any
expense_attendee_type_custom_field_10 custom field 10 FALSE FALSE FALSE string(255) any
expense_attendee_type one of the Attendee Type name as defined in the setup eg. Employee, Customer, Contractor FALSE TRUE FALSE ExpenseAttendeeType any
user a Company User that is referenced by this Expense Attendee record FALSE FALSE FALSE User any
created_by User who created FALSE FALSE FALSE integer any

Expense Attendee Type (New)

This REST object was added as a new attribute, <expense-attendee-type> as part of the /expense_reports and /expense_report_lines resources. 

Column Name Description Hidden Required Unique Type Allowable Value
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 true false string(255) any

Tax Rate Type

Associated resource: /api/invoices (via Tax Line association)

Field name Description Hidden Required Unique Type Allowable Value
description Description of the tax rate type FALSE FALSE TRUE string(255) any
country Country where the tax rate type is applied FALSE FALSE FALSE   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
created_by User who created FALSE FALSE FALSE integer any
updated_by User who updated FALSE FALSE FALSE integer any

Invoice Line

Associated resource: /api/invoices

Column Name Description Hidden Required Unique Type Allowable Value
source_part_num Supplier Part Number FALSE FALSE FALSE string(255) any
commodity Commodity Name FALSE FALSE FALSE string(255) any
discount_amount Discount Amount FALSE FALSE FALSE decimal(30,3) any
company_uom Company UOM FALSE FALSE FALSE string(255) any
property_tax_account Property Tax Account FALSE FALSE FALSE string(255) any
customs_declaration_number Customs Declaration Number FALSE FALSE FALSE string(255) any

Itemized Expense Line

Associated resource: /api/expense_lines

Column Name Description Hidden Required Unique Type Allowable Value
expense_line_taxes Expense line taxes FALSE FALSE FALSE ExpenseLineTaxes any
integration Corp card integration name FALSE FALSE FALSE Integration any

Matching Allocation

Associated resource: TBD

Column Name Description Hidden Required Unique Type Allowable Value
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
status   FALSE FALSE FALSE string(50) any
inventory_transaction_id   FALSE FALSE FALSE integer any
quantity   FALSE TRUE FALSE decimal(32,4) any
amount   FALSE TRUE FALSE decimal(32,4) any
invoice_line_total   FALSE FALSE FALSE decimal any
asn_line_id   FALSE FALSE FALSE integer(11) any
invoice_line_id   FALSE FALSE FALSE integer(11) any
order_line_id   FALSE FALSE FALSE integer(11) any
manual_match   FALSE FALSE FALSE integer(11) any
status_reason   FALSE FALSE FALSE string(512) any
inventory_transaction_match_reference   FALSE FALSE FALSE   any
uom   FALSE FALSE FALSE UoM any

Registered Company

Associated resource: /invoices (via Supplier Remit To)

Column Name Description Hidden Required Unique Type Allowable Value
sole_registration_code Sole Registration Code FALSE FALSE FALSE string(255) any

Supplier Information Address

Associated resource: /api/supplier_information

Column Name Description Hidden Required Unique Type Allowable Value
supplier_information_id   FALSE FALSE FALSE integer any
csp_rta_id Coupa Supplier Portal Remit-to Address ID FALSE FALSE FALSE integer any

Supplier Information Artifact

Associated resource: /api/supplier_information

Column Name Description Hidden Required Unique Type Allowable Value
type   FALSE FALSE FALSE string(255) any
description Description FALSE FALSE FALSE string(255) any

Supplier Information Contact

Associated resource: /api/supplier_information

Column Name Description Hidden Required Unique Type Allowable Value
supplier_information_id   FALSE FALSE FALSE integer any

Tax Line

Associated resource: /api/invoices

Column Name Description Hidden Required Unique Type Allowable Value
basis The base amount of the invoice or line item to which you must apply the withholding tax FALSE FALSE FALSE decimal(30,6) any
kind_of_factor The specific type of Withholding which applies to the line item FALSE FALSE FALSE string(255) any
nature_of_tax The specific type of tax which applies to the line item e.g. VAT or Withholding FALSE FALSE FALSE string(255) any
  • Was this article helpful?