API des bons de commande (/purchase_orders)
Utilisez l'API de bon de commande pour créer, mettre à jour ou interroger les bons de commande.
Aperçu
Lorsque vous travaillez avec l'API des bons de commande, vous disposez de quelques points de terminaison de ressources à partir desquels vous pouvez travailler :
| Ressource | Chemin d'accès | Description |
|---|---|---|
| En-têtes de BC | /api/purchase_orders |
Bons de commande complets contenant des lignes de BC, des conditions de paiement, des adresses et plus encore. |
| Lignes de BdC | /api/purchase_order_lines |
Informations détaillées sur les lignes de BC, telles que les informations sur les articles et les détails comptables. Voir l'API des lignes de commande et l'API des allocations de ligne de commande pour plus de détails. |
| Changements de BC | /api/purchase_order_changes |
Créez et gérez les demandes de changement de BdC, qu'elles génèrent des approbations ou non. |
| Reason insights | /api/reason_insights/ |
Indiquez les raisons de la réouverture d'une commande. |
Actions
L'API des bons de commande vous permet de :
| Verbe | Chemin d'accès | Action | Description |
|---|---|---|---|
| METTRE | /api/purchase_orders/:id/cancel |
annuler | Annuler |
| METTRE | /api/purchase_orders/:id/close |
close | Clore un bon de commande. Reportez-vous à la section Clôture des bons de commande pour plus d'informations. |
| PUBLIER | /api/purchase_orders |
créer | Créer un bon de commande dans le cadre de la fonctionnalité des bons de commande externes. Ne pas utiliser pour les bons de commande à base de Coupa. |
| METTRE | /api/purchase_orders/:id/ignore_window_and_issue |
ignore_window_and_issue | Ignorer les fenêtres et le problème |
| OBTENIR | /api/purchase_orders |
index | Recherche de bons de commande |
| METTRE | /api/purchase_orders/:id/issue |
problème | Émettez et envoyez le bon de commande au fournisseur. |
| METTRE | /api/purchase_orders/:id/issue_without_send |
issue_without_send | Émettre sans envoyer le bon de commande au fournisseur. |
| METTRE | /api/purchase_orders/:id/release_from_buyer_hold |
release_from_buyer_hold | Libérer le bon de commande en attente de l'acheteur |
| METTRE | /api/purchase_orders/:id/reopen |
rouvrir | Rouvrir un bon de commande fermé en douceur. Reportez-vous à la section Clôture des bons de commande pour plus d'informations sur la clôture en douceur. |
| OBTENIR | /api/purchase_orders/:id |
afficher | Afficher le bon de commande |
| PATCH | /api/purchase_orders/:id |
mettre à jour | Mettre à jour le bon de commande |
| METTRE | /api/purchase_orders/:id |
mettre à jour | Mettre à jour le bon de commande |
Éléments
| Élément | Description | Dem. | Unique | Valeur autorisée | Dans | Sortie | Type de données |
|---|---|---|---|---|---|---|---|
| acknowledged-at | reconnu_à | oui | datetime | ||||
| acknowledged-flag | Le fournisseur a-t-il accusé réception de la commande ? | oui | oui | boolean | |||
| pièces jointes | pièces jointes | oui | oui | Pièce jointe | |||
| change-type | Dernier type de modification du bon de commande, il indique si le bon de commande a été modifié via une demande de modification ou via une révision | modification, révision, confirmation | oui | string(255) | |||
| coupa-accélérer-statut | Statut indiquant si la facture est assortie de conditions de paiement avec remise via la remise statique. | accéléré | oui | string(255) | |||
| created-at | Date de création de l'enregistrement dans Coupa. | oui | datetime | ||||
| créé par | ID Coupa de l'utilisateur qui a créé la facture | oui | Utilisateur | ||||
| devise | Devise de la transaction | oui | oui | Devise | |||
| enregistrements-histoire-intégration-courant | Dossiers d'historique d'intégration actuels | oui | Enregistrement de l'historique d'intégration | ||||
| exportée | Indique si la transaction a été exportée | oui | boolean | ||||
| hide-price | Masquer le prix du fournisseur. Vrai ou Faux | non | non | oui | boolean | ||
| iD | ID interne de Coupa | oui | nombre entier | ||||
| révision-interne | Numéro de révision interne - Augmente chaque fois qu'une modification est apportée à un BC, que cette modification soit interne ou qu'elle entraîne le renvoi du BC au fournisseur. | oui | nombre entier | ||||
| invoice-stop | Drapeau d'arrêt de facture | oui | boolean | ||||
| last-exported-at | Date et heure de la dernière exportation de la transaction au format AAAA-MM-JJFHH :MM :SS+HH :MMZ | oui | datetime | ||||
| jalons | Jalons | oui | oui | Approvisionnement : :Jalon | |||
| lignes de commande | lignes_de_commande | oui | oui | oui | Ligne de commande | ||
| mode-de-paiement | mode_de_paiement | oui | oui | string(255) | |||
| délai de paiement | Modalités de paiement | oui | oui | Modalité de paiement | |||
| pcard | pcard | oui | oui | Carte d'achat | |||
| po-number | Numéro du BC | oui | oui | oui | oui | string(20) | |
| prix masqué | Masquer le prix du fournisseur. Vrai ou Faux | oui | boolean | ||||
| reason-insight-events | Événements d'aperçu des raisons pour les changements, les réouvertures, etc. | oui | Événement Reason Insight | ||||
| demandeur | Demande d'accès au compte | oui | Utilisateur | ||||
| en-tête de demande | En-tête de la demande | oui | En-tête de la demande | ||||
| adresse d'expédition | ship_to_address | non | non | tout | oui | oui | Adresse |
| ship-to-attention | L'utilisateur pour lequel la commande sera adressée. Expédier à l'attention. | non | non | tout | oui | oui | string(255) |
| expédier à l'utilisateur | ship_to_user | oui | oui | oui | Utilisateur | ||
| délai d'expédition | Modalités de paiement | oui | oui | ShippingTerm | |||
| statut | Statut du BC | buyer_hold, cancelled, closed, currency_hold, draft, error, depensed, issued, supplier_hold, supplier_window_hold, exported | oui | string(50) | |||
| fournisseur | Numéro d'ID interne Coupa du fournisseur | oui | oui | oui | Fournisseur | ||
| site fournisseur | Site fournisseur | non | non | tout | oui | oui | Site fournisseur |
| transmission-mails | Liste des e-mails de transmission séparés par une virgule | non | non | tout | oui | oui | texte |
| transmission-méthode-override | Remplacement de la méthode de transmission | non | non | supplier_default, email, ne_pas_transmettre | oui | oui | string(30) |
| état de la transmission | État de la transmission | non | non | created, deferred, deferred_processing, pending_manual, pending_manual_cancel, awaiting_online_purchase, scheduled_for_email, sent_via_email, scheduled_for_cxml, scheduled_for_xml, sent_via_cxml, sent_via_xml, sent_manuellement, purchased_online, transmission_failure | oui | chaîne | |
| type | Type de commande | ExternalOrderHeader | oui | string(255) | |||
| mis-à-jour à | Dernière mise à jour le (date) | oui | datetime | ||||
| mis à jour par | ID Coupa de l'utilisateur qui a créé la facture | oui | Utilisateur | ||||
| version | Numéro de version du fournisseur de la commande - Augmente chaque fois qu'une commande est modifiée et déclenche un nouvel envoi au fournisseur. | oui | oui | nombre entier | |||
| classification | Classification | msp, fournisseur, vms | oui | oui | string(255) | ||
| devise | Devise de la transaction | oui | |||||
| confirmer-par-hrs | Confirmer par | oui | nombre entier | ||||
| niveau de confirmation-de-commande | Niveau de confirmation | oui | int(11) | ||||
| membres-utilisateurs | Membres utilisateurs | oui | Utilisateur | ||||
| membres-groupes-utilisateurs | Membres du groupe d'utilisateurs | oui | Utilisateur | ||||
Remarques
- Il existe des champs dépendants qui deviennent 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 grand ensemble de données et pour l'optimisation des performances, vous devez toujours limiter votre résultat avec certains critères GET.
- Les changements de BC n'incrémentent pas toujours le numéro de version. Voir les champs qui provoquent une révision de bon de commande pour plus d'informations. Le
champupdated-at peut toujours être utilisé pour déterminer si des modifications ont été apportées.
Exemples de code
Supprimer une ligne de commande à l'aide de PUT
<?xml version="1.0" encoding="UTF-8"?>
<order-header>
<order-lines>
<order-line>
<id>coupa_line_id</id>
<_delete>true</_delete>
</order-line>
</order-lines>
</order-header> Rouvrir un bon de commande fermé en douceur
Reportez-vous à la section Clôture des bons de commande pour plus d'informations sur la clôture en douceur.
Utilisation d'un ID d'aperçu de motif
<?xml version="1.0" encoding="UTF-8"?>
<order-header>
<reason-insight-id>1</reason-insight-id>
<reason-insight-event-comment>corps du commentaire</reason-insight-event-comment>
</order-header>Utilisation d'un code de motif Insight
<?xml version="1.0" encoding="UTF-8"?>
<order-header>
<reason-insight-code>code</reason-insight-code>
<reason-insight-event-comment>corps du commentaire</reason-insight-event-comment>
</order-header>