• Dernière modification le: 01 August 2022

API fournisseurs (/fournisseurs)

Utilisez l'API des fournisseurs pour créer, mettre à jour, interroger et supprimer les fournisseurs dans Coupa.

Aperçu

Utilisez l'API des fournisseurs pour créer, mettre à jour et interroger les fournisseurs dans Coupa.

L'URL pour accéder aux fournisseurs est : https ://<instance>/api/suppliers 

Voir les meilleures pratiques d'intégration pour plus d'informations.

Actions

L'API Fournisseurs vous permet de :

Verbe Chemin d'accès Action Description
PUBLIER /API/fournisseurs créer Créer un fournisseur
PUBLIER /api/suppliers/create_supplier_user_preferences create_supplier_user_preferences Créer des préférences d'utilisateur du fournisseur
OBTENIR /API/fournisseurs index Demander aux fournisseurs
SUPPRIMER /api/suppliers/logout_iframe_session logout_iframe_session Déconnexion (CSP) session iframe
OBTENIR /api/suppliers/:id afficher Afficher le fournisseur
PUBLIER /api/suppliers/sync_supplier_user_locale sync_supplier_user_locale Synchroniser les paramètres régionaux de l'utilisateur du fournisseur
METTRE /api/suppliers/:id mettre à jour Mettre à jour le fournisseur

Éléments

Les éléments suivants sont disponibles pour l'API Fournisseurs :

Élément Description Champ obligatoire ? Unique ? Valeur autorisée Api_In Field ? Api_Out Field ? Type de données
numéro-de-compte Numéro de compte       oui oui chaîne
types-de-compte Types de compte oui oui AccountType
allow-change-requests Permet aux fournisseurs de créer des demandes de changement à partir de CSP       oui oui boolean
allow-cn-no-backing-doc-from-connect Si oui, le fournisseur peut créer des notes de crédit sans facture justificative. oui oui boolean
allow-csp-access-without-two-factor Permet au fournisseur d'accéder aux données du client depuis le CSP sans l'authentification à deux facteurs       oui oui boolean
allow-cxml-invoicing Autoriser la facturation CXML pour le fournisseur       oui oui boolean
allow-inv-choose-billing-account Autoriser INV à choisir un compte de facturation       oui oui boolean
allow-inv-from-connect Si oui, le fournisseur peut créer des factures pour ses bons de commande ou ses contrats dans le CSP       oui oui boolean
allow-inv-no-backing-doc-from-connect Si oui, le fournisseur peut créer des factures sans bon de commande ni contrat soutenu dans le CSP.       oui oui boolean
allow-inv-unbacked-lines-from-connect Si oui, le fournisseur peut créer des factures non adossées sans bon de commande ou contrat soutenu dans le CSP.       oui oui boolean
business-groups groupes commerciaux       oui oui ContentGroup
acheteur-tireur Mettre tous les BC en attente pour révision de l'acheteur oui oui boolean
contacts   non non tout oui   Contacts des informations fournisseur
catégorie d'achat Produit par défaut, sélectionnable dans la liste déroulante       oui oui
corporate-url URL de la société       oui   chaîne
coupa-connect-secret Coupa Connect secret         oui chaîne
coupa-pay-financement uniquement Régler uniquement les factures financées au moyen de Coupa Pay       oui oui boolean
created-at Créé automatiquement par Coupa au format AAAA-MM-JJFHH :MM :SS+HH :MMZ         oui datetime
créé par Utilisateur qui a créé         oui Utilisateur
cxml-domain

« De » , notre domaine

domaine CXML

 

oui oui chaîne
cxml-http-password mot de passe HTTP et cXML       oui    
cxml-http-username nom d'utilisateur HTTP et cXML       oui oui chaîne
cxml-identity

« De », notre identité

identité cXML

 

oui oui chaîne
cxml-invoice-buyer-domain Domaine de l'acheteur pour la facturation cXML       oui oui chaîne
cxml-invoice-buyer-identity Identité de l'acheteur pour la facturation cXML       oui oui chaîne
cxml-invoice-secret Clé secrète pour l'authentification de facturation cXML       oui oui chaîne
cxml-invoice-supplier-domain Domaine du fournisseur pour la facturation cXML       oui oui chaîne
cxml-invoice-supplier-identity Identité du fournisseur pour la facturation cXML   oui   oui oui chaîne
cxml-protocol

Protocole de transmission

 

oui oui chaîne
cxml-secret Secret partagé

 

oui oui chaîne
cxml-ssl-version version SSL de cXML oui oui chaîne
cxml-supplier-domain

"À", domaine fournisseur

domaine du fournisseur cXML

 

oui oui chaîne
cxml-supplier-identity

« À », identité du fournisseur

identité du fournisseur cXML

 

oui oui chaîne
cxml-url URL où les BdC sont envoyés si la transmission des BdC est "cxml"

 

oui oui chaîne
default-locale Paramètres régionaux par défaut pour l'envoi d'e-mails à ce fournisseur non non any oui   string(255)
désactiver-cert-vérifier

Désactiver la vérification de certificat

oui oui boolean
display-name Nom d'affichage       oui oui chaîne
dUNS Numéro DUNS du fournisseur       oui oui chaîne
entreprise Entreprise True     oui oui Entreprise
hold-invoices-for-ap-review Empêchez les factures de ce fournisseur d'être approuvées avant que les comptes payables d'avance ne les passent en revue.       oui   boolean
iD ID interne de Coupa         oui nombre entier
facture-mails Adresses e-mail enregistrées autorisées à envoyer des factures par e-mail à l'adresse invoices@yourhost.coupahost.com.       oui oui
niveau de correspondance des factures Niveau de correspondance de la facture oui   2-way, 3-way, 3-way-direct, none oui oui chaîne
nom Nom du fournisseur oui oui   oui oui string(100)
nombre Numéro du fournisseur   oui   oui oui chaîne
en attente Le fournisseur est en attente       oui oui boolean
boutique en ligne Site web du fournisseur oui     oui oui
parent parent       oui oui Gestion des Fournisseurs
mode-de-paiement Mode de paiement par défaut, sélectionnable dans la liste déroulante oui   facture, pcard, invoice_only, pcard_only, virtual_card oui oui string(255)
délai de paiement Modalités de paiement par défaut, sélectionnables dans la liste déroulante       oui oui

PaymentTerm

délai-de-paiement-id-pour-api ID du terme de paiement pour l'API       oui    
po-change-method

Méthode de transmission de modification de bon de commande

true false cxml, xml, courriel, invite, mark_as_sent, buy_online oui oui string(255)
po-email E-mail où les bons de commande sont envoyés si la transmission du bon de commande est « e-mail »

 

oui oui string(255)
po-method Mode DE transmission DU bon DE commande cxml, xml, courriel, invite, mark_as_sent, buy_online oui oui string(255)
price-amount Montant du prix oui     oui    
adresse principale Adresse principale oui   Adresse du fournisseur oui oui Informations relatives à l'adresse fournisseur
contact primaire Adresse e-mail du contact du fournisseur principal oui     oui oui
remit-to-adresses Adresses de paiement       oui oui RemitToAddress
types de comptes restreints Types de comptes avec restrictions       oui oui AccountType
savings-pct Économies pour utiliser ce fournisseur       oui oui décimale
envoyer-factures-à-approbations Si oui, les factures seront toutes envoyées par le biais d'approbations, quel que soit le montant total.       oui oui boolean
scf-configs Configurations de financement de la chaîne d'approvisionnement en liste blanche pour le fournisseur       oui oui chaîne
délai d'expédition Modalité d'expédition du fournisseur, sélectionnable dans la liste déroulante       oui oui

ShippingTerm

statut Statut du fournisseur         oui chaîne
storefront-url Site web du fournisseur       oui   chaîne
adresses-fournisseur   non non tout oui   []
  oui SupplierSite
statut de fournisseur Statut du fournisseur       oui   brouillon
code fiscal Code fiscal du fournisseur       oui oui
tax-id Numéro DUNS du fournisseur       oui oui chaîne
mis-à-jour à Créé automatiquement par Coupa au format AAAA-MM-JJFHH :MM :SS+HH :MMZ         oui datetime
mis à jour par Utilisateur ayant réalisé la mise à jour         oui Utilisateur
site web Site web du fournisseur       oui oui chaîne
whitelist-dd Liste blanche des fournisseurs pour l'escompte dynamique false false tout oui oui boolean
dd-settings Paramètres d'escompte dynamique mis en liste blanche pour le fournisseur       oui oui chaîne
contact-assistance-client Contient la liste des titulaires de compte fournisseur (contacts du support client) avec leur objectif       oui oui []
diversités Liste des Diversités du Fournisseur.     Reportez-vous aux codes marqueurs de diversité oui oui []
business-entity-id Entité commerciale       oui oui nombre entier
conditions-de-paiement           oui chaîne
produits préférés Liste des marchandises préférées       oui oui chaîne
étiquettes Liste des étiquettes       oui oui chaîne
étiquetages Liste d'étiquettes         oui []
type Type         oui string(255)
diversity-categories Catégories de diversité         oui []
inventaire-organisation Organisation des stocks         oui  
order_confirmation_level Niveau de confirmation de la commande     not_applicable, en-tête, ligne oui   nombre entier
confirm_by_hrs Confirmer par (en heures)     , oui oui décimale(10,0)
one_time_supplier Indique si le fournisseur est un fournisseur unique       oui oui boolean
scope_three_emissions Indique si le fournisseur assure le suivi des émissions de portée trois       oui oui boolean
do_not_acceler N'accélérez pas les délais de paiement. Ce champ correspond à « Ne pas offrir d'escompte statique ».  non       oui boolean
Remarque
  • Il existe des champs dépendants qui peuvent devenir interrogeables en fonction de la valeur du champ source. Par exemple, si vous effectuez une requête contrepo-method =email, alors po-email peut être ajouté comme critère de requête supplémentaire. Veuillez consulter les champs avec Oui*.
  • Pour un ensemble de données volumineux et une optimisation des performances, limitez toujours votre résultat avec certains critères GET.
  • Si vous ne définissez pas d'état pour le fournisseur, le système affiche par défaut le brouillon.
  • Si vous ne définissez pas de mode de paiement par défaut, le système facture par défaut.
  • Pour que l'API reconnaisse les champs personnalisés, les champs doivent être définis comme API modifiable dans la configuration.
  • Si le Coupa Supplier Portal (CSP) est activé dans votre environnement, le champ Autoriser le fournisseur à créer une facture est coché par défaut. 
  • Lors de la mise à jour de l'adresse principale du fournisseur, vous pouvez mettre à jour chaque attribut sur l'objet d'adresse, mais vous ne pouvez pas associer un ID d'adresse différent à l'enregistrement du fournisseur.
  • Lors de la mise à jour du contact principal sur l'enregistrement du fournisseur, vous pouvez mettre à jour chaque attribut sur les informations de contact, mais vous ne pouvez pas attribuer un ID de contact complètement différent à l'enregistrement du fournisseur.

Codes de marqueur de diversité

Code marqueur de diversité Description
MBE Entreprise détenue par un membre d'une minorité
WBE Entreprise appartenant à une femme
SBE Petite entreprise
LGBTBE Entreprise commerciale appartenant à un membre de la communauté LGBTQ
Date de naissance Entreprises appartenant à des personnes handicapées
OBNL Organisation à but non lucratif
DBE Entreprise commerciale défavorisée
SDB Petite entreprise défavorisée
SDVBE Entreprise commerciale appartenant à un ancien combattant handicapé par le service
WOSB PME appartenant à une femme
VOB Entreprise appartenant à un ancien combattant
DVBE Entreprise commerciale appartenant à un ancien combattant handicapé
SDVOSB Petite entreprise détenue par un ancien combattant invalide de guerre
HUBZone Zone d'affaires historiquement sous-utilisée
SBA8A SBA-8(A)
ACDBE Entreprise défavorisée de concession aéroportuaire
ANC Entreprise d'un natif de l'Alaska
HBCU Collège ou université historiquement pour la communauté noire/Institution minoritaire
LSA Zone de surplus de main-d' œuvre
VVO Propriété d'un ancien combattant du Vietnam
ABILITYONE Programme Ability One
EDWOSB Petites entreprises appartenant à des femmes économiquement défavorisées
NAO Propriétaire amérindien
IOB Entreprise détenue par un autochtone
AMS Fournisseur autochtone ou appartenant à une minorité
BOB Entreprise appartenant à des Noirs
MGOB Entreprise appartenant à un groupe minoritaire
EMB Entreprises appartenant à des minorités ethniques (OGE)

Articles associés


API Coupa Core

Notre API RESTful fournit un accès fiable pour lire, modifier ou intégrer vos données à la plateforme Coupa.

Démarrez avec l'API

Informations générales sur l'utilisation de l'API Coupa et quand vous devez envisager d'utiliser CSV.

Transition vers OAuth 2.0 et OIDC

Coupa désapprouve les API Keys héritées et nécessite l'utilisation d'OAuth 2.0 / OIDC. À partir de R34, aucune nouvelle clé API ne sera émise et les clés API ne seront plus prises en charge avec R35.

Ressources

Nous avons organisé nos points de terminaison API par type d'objet : données de référence, données transactionnelles et ressources partagées.