Skip to main content

 

 

Coupa Success Portal

Suppliers API

Use the suppliers API to create, update, and query the suppliers in Coupa.

The URL to access suppliers is: https://<instance>/api/suppliers 

See Integration Best Practices for more info.

Actions

The Suppliers API allows you to:

Verb Path Action Description
POST /api/suppliers create Create supplier
POST /api/suppliers/create_supplier_user_preferences create_supplier_user_preferences Create supplier user preferences
GET /api/suppliers index Query suppliers
GET /api/suppliers/:id show Show supplier
POST /api/suppliers/sync_supplier_user_locale sync_supplier_user_locale Sync supplier user locale
PATCH /api/suppliers/:id update Update supplier
PUT /api/suppliers/:id update Update supplier

Elements

The following elements are available for the Suppliers API:

Element Description Required Field? Unique? Allowable Value Api_In Field? Api_Out Field? Data Type
account-number Account number       yes yes string
allow-csp-access-without-two-factor Allows supplier to access Customer's data from CSP without Two Factor       yes yes boolean
allow-cxml-invoicing Allow cXML invoicing for Supplier       yes yes boolean
allow-inv-choose-billing-account allow_inv_choose_billing_account       yes yes boolean
allow-inv-from-connect If yes, then the supplier can create invoices against their POs or Contracts in the CSP       yes yes boolean
allow-inv-no-backing-doc-from-connect If yes, then the supplier can create invoices without a backing PO or Contract in the CSP.       yes yes boolean
allow-inv-unbacked-lines-from-connect If yes, then the supplier can create unbacked invoices without a backing PO or Contract in the CSP.       yes yes boolean
business-groups business_groups       yes yes ContentGroup
buyer-hold Hold all POs for buyer review yes yes boolean
commodity Default commodity, selectable from drop down       yes yes
corporate-url corporate_url       yes   string
coupa-connect-secret coupa_connect_secret         yes string
created-at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ         yes datetime
created-by User who created         yes User
currency_id Currency ID false false any     integer
cxml-domain

"From" , our domain

cXML domain

yes

yes yes string(255)
cxml-http-password cxml_http_password       yes    
cxml-http-username cxml_http_username       yes yes string
cxml-identity

"From", our identity

cXML identity

yes

yes yes string(255)
cxml-invoice-buyer-domain Buyer Domain for cXML Invoicing yes     yes yes string
cxml-invoice-buyer-identity Buyer Identity for cXML Invoicing yes     yes yes string
cxml-invoice-secret Secret Key for cXML Invoicing Authentication yes     yes yes string
cxml-invoice-supplier-domain Supplier Domain for cXML Invoicing yes     yes yes string
cxml-invoice-supplier-identity Supplier Identity for cXML Invoicing yes yes   yes yes string
cxml-protocol

Transmission protocol

yes

yes yes string(255)
cxml-secret Shared secret

yes

yes yes string(940)
cxml-ssl-version cXML SSL version yes yes string
cxml-supplier-domain

"To", supplier domain

cXML supplier domain

yes

yes yes string(255)
cxml-supplier-identity

"To", supplier identity

cXML supplier identity

yes

yes yes string(255)
cxml-url URL where POs are sent if PO transmission is "cxml"

yes

yes yes string(255)
disable-cert-verify

disable_cert_verify

yes yes boolean
display-name display_name       yes yes string
duns Supplier DUNS number       yes yes string
enterprise Enterprise True     yes yes Enterprise
   
hold-invoices-for-ap-review Prevent invoices from this supplier from being approved before AP reviews them.       yes   boolean
id Coupa Internal ID         yes integer
invoice-emails Registered email addresses allowed to send invoices via email to invoices@yourhost.coupahost.com.       yes yes
invoice-matching-level Invoice matching level     2-way, 3-way, 3-way-direct, none yes yes string
name Supplier name yes yes   yes yes string(100)
number Supplier number   yes   yes yes string
on-hold Supplier On Hold       yes yes boolean
online-store Supplier website yes     yes yes
parent parent       yes yes Supplier
payment-method Default payment method, selectable from drop down yes   invoice, pcard, invoice_only, pcard_only yes yes string
payment-term Default payment term, selectable from drop down       yes yes

PaymentTerm

payment-term-id-for-api payment_term_id_for_api       yes    
po-change-method

Purchase order change transmission method

false false cxml, xml, email, prompt, mark_as_sent, buy_online yes yes string(255)
po-email Email where POs are sent if PO transmission is "email"

yes

yes yes string(255)
po-method Purchase order transmission method cxml, xml, email, prompt, mark_as_sent, buy_online yes yes string(255)
primary-address primary_address yes     yes yes Address
primary-contact Primary supplier contact email yes     yes yes
remit-to-addresses remit_to_addresses       yes yes RemitToAddress
restricted-account-types restricted_account_types       yes yes AccountType
savings-pct Savings for using this supplier       yes yes decimal
send-invoices-to-approvals If yes, then invoices will all be sent thru approvals, regardless of total amount.       yes yes boolean
shipping-term Supplier shipping term, selectable from drop down       yes yes

ShippingTerm

status Supplier status         yes string
storefront-url Supplier website       yes   string
  yes SupplierSite
supplier-status supplier_status       yes   draft
tax-code Supplier tax code       yes yes
tax-id Supplier DUNS number       yes yes string
updated-at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ         yes datetime
updated-by User who updated         yes User
   
website Supplier website       yes yes string
  • There are dependent fields that can become queryable based on the value from the source field. For example, if you query against po-method=email, then po-email can be added as an additional query criteria. Please see fields with Yes*.
  • For large data set and performance optimization, always limit your result with some GET criteria.
  • If you do not set a status for the supplier, the system defaults to draft.
  • If you do not set a default payment method, the system defaults to invoice.
  • For the API to recognize custom fields, the fields must be set as API editable in the setup.
  • If you have Coupa Supplier Portal (CSP) enabled in your environment, the Allow Supplier to Create Invoice field defaults to checked. 
  • When updating the primary address of the supplier, you can update every attribute on the address object, but you cannot associate a different address ID to the supplier record.
  • When updating the primary contact on the supplier record, you can update every attribute on the contact information, but you cannot assign a completely different contact ID to the supplier record.
  • Was this article helpful?