Exemples d'appels d'API de fournisseurs
OBTENIR les options de requête fournisseur
Voici d'autres exemples d'utilisation de l'API fournisseur pour interroger et obtenir le jeu de résultats souhaité.
Cette requête renverra tous les fournisseurs dont la méthode de commande d'achat est définie sur cXML : https :<instance url>///api/suppliers ? po-method =cxml
Cette requête renverra tous les fournisseurs dont le délai de paiement est de 30 jours nets :
https :<instance url>///api/suppliers ? payment-term [code]=Net+30
Cette requête renverra tous les fournisseurs pour lesquels une remise de paiement est accordée si dans les 10 jours suivant la facturation et que le fournisseur est actuellement actif dans le système : https :<instance url>///api/suppliers ? payment-term [days-for-discount-payment]=10&status=active
Cette requête renverra tous les fournisseurs qui ont été créés après le 1er janvier, 2010 12:00:00 : https ://<instance url>/api/suppliers ? created-at [gt]=2010-01-01T12:00:00
This query will return all suppliers whose PO method is set to cXML and where the buyer domain value contains the word "domain" : https ://<instance url>/api/suppliers ? po-method = cxml&cxml-domain [contains]=domain
This query will return all suppliers who are allowed cXML invoicing and where the cXML invoice setup of the supplier domain value contains the word "supplier" : https ://.coupahost.com/api/suppliers?allow-cxml-invoicing=true&cxml-supplier-domain<instance> [contains]=supplier
This query will return all suppliers whose primary contact email contains the value "coupa.com" et l'adresse du fournisseur où la ville est Charleston : https ://<instance url>/api/suppliers ? primary-contact [email][contains]= coupa.com&primary-address [city]=Charleston
Cette requête renverra tous les fournisseurs qui ont au moins 5 avis d'utilisateurs dans le système. https ://<instance url>/api/suppliers ?reviews-count[gt]=5
Obtenir le fournisseur
Dans cet exemple, nous avons demandé un seul dossier de fournisseur avec un ID de 6.
Nous avons accédé À l'URL :
https ://<instance url>/api/suppliers/6
ou
https ://<instance url>/api/suppliers ?id=6
Voici la réponse correspondant aux critères de recherche :
<?xml version="1.0" encoding="UTF-8"?>
<suppliers type="array">
<supplier>
<id type="integer">6</id>
<created-at type="datetime">27/10/2008T12:56:39-07:00</created-at>
<updated-at type="datetime">2009-07-01T11:59:33-07:00</updated-at>
<name>VWR</name>
<number></number>
<status>actif</status>
<website></website>
<po-method>cxml</po-method>
<cxml-url>http://www.dummy.com</cxml-url>
<cxml-domain>http://demo.coupahost.com</cxml-domain>
<cxml-identity>Coupa</cxml-identity>
<cxml-supplier-domain>http://www.vwr.com</cxml-supplier-domain>
<cxml-supplier-identity>Test VWR</cxml-supplier-identity>
<cxml-secret>test</cxml-secret>
<cxml-protocol>cXML</cxml-protocol>
<po-email>upgrade@coupa.com</po-email>
<account-number></account-number>
<duns></duns>
<tax-id></tax-id>
<coupa-connect-secret></coupa-connect-secret>
<invoice-matching-level>2 jours</invoice-matching-level>
<primary-contact>
<email>upgrade@coupa.com</email>
<id type="integer">6</id>
<name-additional nil="true"></name-additional>
<name-family>Façade</name-family>
<name-fullname nil="true"></name-fullname>
<name-given>Aube</name-given>
<name-prefix nil="true"></name-prefix>
<name-suffix nil="true"></name-suffix>
<notes nil="true"></notes>
</primary-contact>
<primary-address>
<attention nil="true"></attention>
<city>Portland</city>
<id type="integer">6</id>
<name>VWR</name>
<postal-code>82323</postal-code>
<state>OU</state>
<street1>09 Addison Ave</street1>
<street2></street2>
<country>
<code>États-Unis</code>
<id type="integer">223</id>
<name>États-Unis</name>
</country>
</primary-address>
<payment-term>
<code>2/10 Net 30</code>
<days-for-discount-payment type="integer">10</days-for-discount-payment>
<days-for-net-payment type="integer">30</days-for-net-payment>
<discount-rate type="float">2.0</discount-rate>
<id type="integer">3</id>
</payment-term>
</supplier>
</suppliers>Création de fournisseur - Actif et détaillé
Dans cet exemple, nous créons un fournisseur actif. Nous n'utilisons aucun ID système Coupa pour aucun des objets de référence.
Nous l'avons posté à l'URL : https ://<instance url>/api/suppliers.
<?xml version="1.0" encoding="UTF-8"?>
<supplier>
<name>CDW</name>
<number>cdw2323</number>
<status>actif</status>
<po-method>invite</po-method>
<po-email />
<account-number>2323</account-number>
<duns />
<tax-id>283923</tax-id>
<invoice-matching-level>à 3 entrées</invoice-matching-level>
<payment-term>
<code>30 jours nets</code>
</payment-term>
<primary-contact>
<email>joe.smith@cdw.com</email>
<name-family>Smith</name-family>
<name-given>Joe</name-given>
<name-prefix nil="true" />
<name-suffix nil="true" />
<notes nil="true" />
<phone-work>
<area-code>650</area-code>
<country-code>1</country-code>
<extension nil="true" />
<number>4442932</number>
</phone-work>
<phone-mobile>
<area-code nil="true" />
<country-code>1</country-code>
<extension nil="true" />
<number />
</phone-mobile>
<phone-fax>
<area-code nil="true" />
<country-code>1</country-code>
<extension nil="true" />
<number />
</phone-fax>
</primary-contact>
<primary_address>
<street1>1234 Concur Drive</street1>
<street2 />
<city>San Mateo</city>
<state>CA</state>
<postal_code>93325</postal_code>
<country>
<code>États-Unis</code>
</country>
</primary_address>
</supplier>Création du fournisseur - Brouillon et de base
Dans cet exemple, nous créons un brouillon de fournisseur. Nous n'utilisons aucun ID système Coupa pour aucun des objets de référence.
Nous l'avons posté à l'URL : https ://<instance url>/api/suppliers. Cela a créé le fournisseur dans un statut de brouillon.
<?xml version="1.0" encoding="UTF-8"?>
<supplier>
<name>CDW</name>
<po-method>invite</po-method>
<account-number>2323</account-number>
<duns />
<tax-id />
<invoice-matching-level>à 3 entrées</invoice-matching-level>
<payment-term>
<code>30 jours nets</code>
</payment-term>
</supplier> Mettre à jour le fournisseur - mise à jour complète
Dans ces exemples, nous mettons à jour différentes informations sur le dossier du fournisseur.
Nous avons fait une MISE à l'URL : https ://<instance url>/api/suppliers/<supplier id>
Par exemple, pour mettre à jour la méthode de BC du fournisseur en cXML pour l'ID 83 du fournisseur :
URL : https ://<instance url>/api/suppliers/83
<?xml version="1.0" encoding="UTF-8"?>
<supplier>
<po-method>cxml</po-method>
<cxml-url>https://testurl.com</cxml-url>
<cxml-domain>NetworkID</cxml-domain>
<cxml-identity>coupa</cxml-identity>
<cxml-supplier-domain>NetworkID</cxml-supplier-domain>
<cxml-supplier-identity>supplierID1</cxml-supplier-identity>
<cxml-secret>shhhhh</cxml-secret>
<cxml-protocol>cxml</cxml-protocol>
</supplier>Par exemple, pour mettre à jour les coordonnées principales du fournisseur et plusieurs autres informations de profil de fournisseur pour l'identifiant de fournisseur 83 :
URL : https ://<instance url>/api/suppliers/83
<?xml version="1.0" encoding="UTF-8"?>
<supplier>
<account-number>123456</account-number>
<duns>DUNS-123</duns>
<tax-id>taxid-123</tax-id>
<invoice-matching-level>aucun</invoice-matching-level>
<primary-contact>
<email>supplier@test.com</email>
<name-family>Donovan</name-family>
<name-given>Fred</name-given>
<phone-work>
<area-code>415</area-code>
<country-code>1</country-code>
<extension nil="true" />
<number>4471010</number>
</phone-work>
<phone-fax>
<area-code>415</area-code>
<country-code>1</country-code>
<extension nil="true" />
<number>4471012</number>
</phone-fax>
</primary-contact>
</supplier> Par exemple, pour mettre à jour le profil du fournisseur, y compris la mise à jour de l'adresse pour l'identifiant du fournisseur 83 :
URL : https ://<instance url>/api/suppliers/83
<?xml version="1.0" encoding="UTF-8"?>
<supplier>
<name>Petra (États-Unis)</name>
<number>1-112</number>
<primary-address>
<street1>425 Market Street # 2250</street1>
<street2 />
<city>San Francisco</city>
<state>CA</state>
<postal_code>94105</postal_code>
<country>
<code>États-Unis</code>
</country>
</primary-address>
</supplier>Par exemple, pour mettre à jour le délai de paiement et le délai d'expédition pour l'identifiant de fournisseur 83 :
URL : https ://<instance url>/api/suppliers/83
<supplier>
<shipping-term>
<id>1</id>
</shipping-term>
<payment-term>
<id>5<id>
</payment-term>
</supplier>Mettre à jour le fournisseur - mise à jour simple
Dans ces exemples, nous mettons à jour un seul attribut sur le dossier du fournisseur.
Nous avons fait une MISE à l'URL : https ://<instance url>/api/suppliers/<supplier id>
Par exemple, pour mettre à jour le statut du fournisseur à inactif pour le fournisseur avec l'identifiant de fournisseur 83 :
Mettre à jour le fournisseur - Définir sur Inactif
URL : https ://<instance url>/api/suppliers/83
<?xml version="1.0" encoding="UTF-8"?>
<supplier>
<status>inactif</status>
</supplier>Par exemple, pour mettre à jour la méthode du bon de commande du fournisseur à l'invite avec l'identifiant du fournisseur 83 :
Mettre à jour le fournisseur - Modifier la méthode de commande
URL : https ://<instance url>/api/suppliers/83
<?xml version="1.0" encoding="UTF-8"?>
<supplier>
<po-method>invite</po-method>
</supplier> Par exemple, pour mettre à jour l'adresse électronique du contact du fournisseur principal avec l'identifiant du fournisseur 83 :
Mettre à jour le fournisseur - Modifier l'adresse e-mail du contact
URL : https ://<instance url>/api/suppliers/83
<?xml version="1.0" encoding="UTF-8"?>
<supplier>
<primary-contact>
<email>test@test.com</email>
</primary-contact>
</supplier>