COcoupa
Supplier

Create background job to invite many suppliers

Create background job to invite many suppliers

post/supplier_invites

Request

  • Base URL
    https://r38.coupadev.com/api
  • Auth
    • OAuth 2
      Authorization codehttps://r38.coupadev.com/oauth2/authorizations/new
      Token URLhttps://r38.coupadev.com/oauth2/token
    • or OAuth 2
      Client credentials
      Token URLhttps://r38.coupadev.com/oauth2/access_tokens
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

return_object'limited' | 'shallow' | 'none'
filterstring

Request body

account-numberstring string(255)

Account number

allow-change-requestsboolean

Allows suppliers to create change requests from CSP

allow-cn-no-backing-doc-from-connectboolean

If yes, then the supplier can create Credit Notes without backing invoice.

allow-csp-access-without-two-factorboolean

Allows supplier to access Customer's data from CSP without Two Factor

allow-cxml-invoicingboolean

Allow cXML invoicing for Supplier

allow-inv-choose-billing-accountboolean

allow_inv_choose_billing_account

allow-inv-from-connectboolean

If yes, then the supplier can create invoices against their POs or Contracts in CSP

allow-inv-no-backing-doc-from-connectboolean

If yes, then the supplier can create invoices without a backing PO or Contract in CSP.

allow-inv-unbacked-lines-from-connectboolean

If yes, then the supplier can create unbacked invoices without a backing PO or Contract in CSP.

allow-order-confirmation-item-substitutionsboolean

Allow supplier to propose item substitute on Order Confirmations

business-entity-idinteger

Business Entity

buyer-holdboolean

Hold all POs for buyer review

confirm-by-hrsnumber

Confirm By (In Hours)

corporate-urlstring string(255)

corporate_url

coupa-connect-secretstring string(255)

coupa_connect_secret

coupa-pay-financing-onlyboolean

Only pay financed invoices via Coupa Pay

created-atstring datetime

Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

cxml-domainstring string

"From" , our domain

cxml-http-passwordstring string(255)

Password required to access the Supplier's online store

cxml-http-usernamestring string

User name required to access the Supplier's online store

cxml-identitystring string

"From", our identity

cxml-invoice-buyer-domainstring string

Buyer Domain for cXML Invoicing

cxml-invoice-buyer-identitystring string

Buyer Identity for cXML Invoicing

cxml-invoice-secretstring string

Secret Key for cXML Invoicing Authentication

cxml-invoice-supplier-domainstring string

Supplier Domain for cXML Invoicing

cxml-invoice-supplier-identitystring string

Supplier Identity for cXML Invoicing

cxml-protocolstring string

Transmission protocol

cxml-secretstring string

Shared secret

cxml-ssl-versionstring string

Specify the SSL version used for cXML communication with the supplier

cxml-supplier-domainstring string

"To", supplier domain

cxml-supplier-identitystring string

"To", supplier identity

cxml-urlstring string

URL where POs are sent if PO transmission is "cxml"

dd-settingsstring string

Dynamic Discounting Settings whitelisted for supplier

default-localestring string(255)

Default Locale for sending emails to this supplier

disable-cert-verifyboolean

Specify whether to ignore SSL certificate mismatch errors

display-namestring string(255)

display_name

diversity-categoriesSupplier[] circular
do-not-accelerateboolean

Do not accelerate the payment terms

dunsstring string

Supplier DUNS number

hold-invoices-for-ap-reviewboolean

Prevent invoices from this supplier from being approved before AP reviews them.

idinteger

Coupa Internal ID

invoice-matching-level'2-way' | '3-way' | '3-way-direct' | 'none' string(255)

Invoice matching level

namestring string(100) required

Supplier name

numberstring string(255)

Supplier number

on-holdboolean

Supplier On Hold

one-time-supplierboolean

Indicates whether the supplier is a One Time Supplier

order-confirmation-levelinteger

Order Confirmation Level

parentSupplier circular
payment-methodstring string(255) required

Default payment method, selectable from drop down

payment-term-idinteger

Payment Term ID

po-change-method'cxml' | 'xml' | 'email' | 'prompt' | 'mark_as_sent' | 'buy_online' string(255)

Purchase order change transmission method

po-emailstring string(255)

Email where POs are sent if PO transmission is "email"

po-method'cxml' | 'xml' | 'email' | 'prompt' | 'mark_as_sent' | 'buy_online' string(255)

Purchase order transmission method

remit-to-requirementinteger

Remit-To Requirements

savings-pctnumber

Savings for using this supplier

scf-configsstring string

Supply Chain Finance Configurations whitelisted for supplier

scope-three-emissionsboolean

Indicates whether the supplier tracks Scope Three Emissions

send-invoices-to-approvalsboolean

If yes, then invoices will all be sent thru approvals, regardless of total amount.

statusstring string

Supplier status

storefront-urlstring string(255)

Supplier website

supplier-account-typesSupplier[] circular
supplier-community-enablementinteger

Indicates community enablement status for the supplier

supplier-sitesSupplier[] circular
tax-idstring string(255)

Supplier DUNS number

typestring string(255)

Type

updated-atstring datetime

Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

websitestring string(255)

Supplier website

whitelist-ddboolean

Whitelist suppliers for Dynamic Discounting

Response

Created

account-numberstring string(255)

Account number

allow-change-requestsboolean

Allows suppliers to create change requests from CSP

allow-cn-no-backing-doc-from-connectboolean

If yes, then the supplier can create Credit Notes without backing invoice.

allow-csp-access-without-two-factorboolean

Allows supplier to access Customer's data from CSP without Two Factor

allow-cxml-invoicingboolean

Allow cXML invoicing for Supplier

allow-inv-choose-billing-accountboolean

allow_inv_choose_billing_account

allow-inv-from-connectboolean

If yes, then the supplier can create invoices against their POs or Contracts in CSP

allow-inv-no-backing-doc-from-connectboolean

If yes, then the supplier can create invoices without a backing PO or Contract in CSP.

allow-inv-unbacked-lines-from-connectboolean

If yes, then the supplier can create unbacked invoices without a backing PO or Contract in CSP.

allow-order-confirmation-item-substitutionsboolean

Allow supplier to propose item substitute on Order Confirmations

business-entity-idinteger

Business Entity

buyer-holdboolean

Hold all POs for buyer review

confirm-by-hrsnumber

Confirm By (In Hours)

corporate-urlstring string(255)

corporate_url

coupa-connect-secretstring string(255)

coupa_connect_secret

coupa-pay-financing-onlyboolean

Only pay financed invoices via Coupa Pay

created-atstring datetime

Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

cxml-domainstring string

"From" , our domain

cxml-http-passwordstring string(255)

Password required to access the Supplier's online store

cxml-http-usernamestring string

User name required to access the Supplier's online store

cxml-identitystring string

"From", our identity

cxml-invoice-buyer-domainstring string

Buyer Domain for cXML Invoicing

cxml-invoice-buyer-identitystring string

Buyer Identity for cXML Invoicing

cxml-invoice-secretstring string

Secret Key for cXML Invoicing Authentication

cxml-invoice-supplier-domainstring string

Supplier Domain for cXML Invoicing

cxml-invoice-supplier-identitystring string

Supplier Identity for cXML Invoicing

cxml-protocolstring string

Transmission protocol

cxml-secretstring string

Shared secret

cxml-ssl-versionstring string

Specify the SSL version used for cXML communication with the supplier

cxml-supplier-domainstring string

"To", supplier domain

cxml-supplier-identitystring string

"To", supplier identity

cxml-urlstring string

URL where POs are sent if PO transmission is "cxml"

dd-settingsstring string

Dynamic Discounting Settings whitelisted for supplier

default-localestring string(255)

Default Locale for sending emails to this supplier

disable-cert-verifyboolean

Specify whether to ignore SSL certificate mismatch errors

display-namestring string(255)

display_name

diversity-categoriesSupplier[] circular
do-not-accelerateboolean

Do not accelerate the payment terms

dunsstring string

Supplier DUNS number

hold-invoices-for-ap-reviewboolean

Prevent invoices from this supplier from being approved before AP reviews them.

idinteger

Coupa Internal ID

invoice-matching-level'2-way' | '3-way' | '3-way-direct' | 'none' string(255)

Invoice matching level

namestring string(100) required

Supplier name

numberstring string(255)

Supplier number

on-holdboolean

Supplier On Hold

one-time-supplierboolean

Indicates whether the supplier is a One Time Supplier

order-confirmation-levelinteger

Order Confirmation Level

parentSupplier circular
payment-methodstring string(255) required

Default payment method, selectable from drop down

payment-term-idinteger

Payment Term ID

po-change-method'cxml' | 'xml' | 'email' | 'prompt' | 'mark_as_sent' | 'buy_online' string(255)

Purchase order change transmission method

po-emailstring string(255)

Email where POs are sent if PO transmission is "email"

po-method'cxml' | 'xml' | 'email' | 'prompt' | 'mark_as_sent' | 'buy_online' string(255)

Purchase order transmission method

remit-to-requirementinteger

Remit-To Requirements

savings-pctnumber

Savings for using this supplier

scf-configsstring string

Supply Chain Finance Configurations whitelisted for supplier

scope-three-emissionsboolean

Indicates whether the supplier tracks Scope Three Emissions

send-invoices-to-approvalsboolean

If yes, then invoices will all be sent thru approvals, regardless of total amount.

statusstring string

Supplier status

storefront-urlstring string(255)

Supplier website

supplier-account-typesSupplier[] circular
supplier-community-enablementinteger

Indicates community enablement status for the supplier

supplier-sitesSupplier[] circular
tax-idstring string(255)

Supplier DUNS number

typestring string(255)

Type

updated-atstring datetime

Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

websitestring string(255)

Supplier website

whitelist-ddboolean

Whitelist suppliers for Dynamic Discounting

Changes

No recorded changes to this operation across all 1 revision of this API.