API des demandes (/demandes)
Utilisez l'API des demandes pour créer, mettre à jour et interroger les demandes.
L'URL pour accéder aux demandes est : https ://{your_instance_name}/api/réquisitions
Voir les meilleures pratiques d'intégration pour plus d'informations.
Objets API des demandes
Il s'agit de la liste complète des objets de dépense disponibles via l'interface utilisateur. Cependant, tous les objets répertoriés ici n'ont pas de points de terminaison. Certains ne sont référencés que par des objets et ne peuvent pas être mis à jour directement.
Note
- Si vous soumettez cette API à l'aide d'un plan comptable statique, toutes les valeurs de segment incluses doivent provenir d'un compte existant.
- Si vous soumettez cette API à l'aide d'un plan comptable dynamique, toutes les valeurs de segment incluses doivent correspondre aux segments de compte existants ou aux valeurs de recherche. Si un compte n'existe pas pour une valeur de segment donnée, l'API le crée automatiquement.
Actions
L'API Demandes vous permet de :
| Verbe | Chemin d'accès | Action | Description |
|---|---|---|---|
| METTRE | /api/réquisitions/:id/add_approver |
add_approver | Ajouter manuellement un approbateur pour une demande |
| PUBLIER |
|
add_to_cart | Ajouter au panier |
| PUBLIER | /api/réquisitions |
créer | Créer une demande en statut de brouillon, qui devra ensuite être soumise manuellement |
| OBTENIR | /api/réquisitions/current_cart |
current_cart | Envoyer le panier actuel pour l'utilisateur, s'il n'y a pas de panier actuel, créer et envoyer |
| OBTENIR | /API/demandes |
index | Demandes de requête |
| OBTENIR | /api/réquisitions/mine |
mine | /api/réquisitions/mine |
| METTRE | /api/réquisitions/:id/remove_approval |
remove_approval | Supprimer un approbateur ajouté manuellement |
| METTRE | /api/réquisitions/:id/save_for_later |
save_for_later | Enregistrer pour plus tard (demandes API) |
| OBTENIR | /api/réquisitions/:id |
afficher | Afficher la demande |
| PUBLIER | /api/réquisitions/submit_for_approval |
submit_for_approval | Créer une demande et tenter de la soumettre pour approbation /action de l'acheteur |
| METTRE | /api/réquisitions/:id |
mettre à jour | Actualiser la demande |
| METTRE | /api/réquisitions/:id/update_and_submit_for_approval |
update_and_submit_for_approval | Mettre à jour la demande et la soumettre aux fins d'approbation |
Éléments
| Élément | Description | Req'd | Unique | Valeur autorisée | Dans | Sortie | Type de données |
|---|---|---|---|---|---|---|---|
| approbations | approbations | oui | Approbation | ||||
| approbations-parallèles-actuelles | Approbations parallèles actuelles | oui | Approbation | ||||
| approbateur | approbateur | oui | Utilisateur | ||||
| pièces jointes | pièces jointes | oui | Pièce jointe | ||||
| buyer-note | Tout commentaire ou note de l'acheteur | oui | oui | texte | |||
| created-at | Créé automatiquement par Coupa au format AAAA-MM-JJFHH :MM :SS+HH :MMZ | oui | datetime | ||||
| créé par | Utilisateur qui a créé | oui | oui | oui | Utilisateur | ||
| devise | Code de la devise | oui | USD | ||||
| approbation-actuelle | Approbation en cours/en attente | oui | Approbation | ||||
| département | Catégorie d'achat de département | oui | oui | Département | |||
| exportée | Indique si la transaction a été exportée | oui | boolean | ||||
| external-po-reference | Une référence de BC externe qui permet aux clients de fournir des numéros de BC qui remplaceraient les numéros de BC générés automatiquement | non | oui | any | oui | string(255) | |
| hide-price | Masquer le prix du fournisseur. Vrai ou Faux | non | non | oui | RequisitionHeader | ||
| iD | Identifiant unique Coupa | oui | nombre entier | ||||
| justification | Commentaires sur la justification de la demande | oui | oui | texte | |||
| line-count | Nombre de lignes de l'en-tête de la demande | non | non | tout | oui | nombre entier | |
| jalons | Jalons | oui | oui | Approvisionnement : :Jalon | |||
| mobile-currency | Devise par défaut utilisée | oui | USD | ||||
| mobile-total | total | oui | décimale | ||||
| besoin par date | Date de livraison souhaitée de l'article | oui | oui | datetime | |||
| pcard | Nom de la carte d'achat | oui | oui | Carte d'achat | |||
| prix masqué | Masquer le prix du fournisseur. Vrai ou Faux | oui | boolean | ||||
| reception-entrepôt-id | ID de l'entrepôt de réception | non | non | tout | oui | oui | nombre entier |
| règles-récurrentes | Règles récurrentes | oui | |||||
| rejection-reason-comment | dernier commentaire motif rejet | oui | chaîne | ||||
| req_title | Titre facultatif de la demande | oui | oui | string(50) | |||
| demandé par | requested_by | oui | oui | Utilisateur | |||
| demandeur | requested_by | oui | oui | Utilisateur | |||
| lignes de demande | demandation_Lines | oui | oui | oui | RequisitionLine | ||
| adresse d'expédition | Nom de l'adresse | oui | oui | oui | Adresse | ||
| ship-to-attention | Attention à l'adresse de livraison | oui | oui | string(255) | |||
| statut | Statut de la transaction. Pour en savoir plus sur les états des demandes, voir Définitions des états des demandes. | oui |
draft, cart, pending_buyer_action, pending_approval,
approuvé commandé partiellement_reçu, reçu,
abandonné, en arrière-plan, retiré
|
oui | string(50) | ||
| sent-at | sent_at | oui | datetime | ||||
| étiquettes | oui | oui | [] | ||||
| étiquetages | oui | oui | [] | ||||
| total | Total dans sa propre devise | oui | décimale | ||||
| 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 | ||||
| user_members | Membres utilisateurs | oui | Utilisateur | ||||
| user_group_members | Membres du groupe d'utilisateurs | oui | Utilisateur |
Remarque
L'élément created_by est défini par défaut à partir de la clé utilisateur de l'API, mais il peut être remplacé par l'API de demande. Communiquez avec le support Coupa pour permettre à l'API de demande de remplacer la valeur de la clé utilisateur de l'API.
Remarque
- Dans une ligne de demande, vous pouvez utiliser une description (forme libre) ou un article (article de catalogue). Si un ID d'article est utilisé, l'article doit exister. Le n'<source-type></source-type>est pas utilisé et ignoré.
- Les devises, les utilisateurs du par-demandé et les fournisseurs doivent être dans le système avec un statut actif.
- Article : Si un fournisseur et un prix préférés sont disponibles pour un article, ils seront utilisés à moins que le prix unitaire ne soit spécifié. Si un prix unitaire est spécifié, il annulera le prix par défaut disponible pour l'article. Bien que ce ne soit pas une erreur de spécifier une description et un élément, l'utilisation d'un élément définira la description sur la description de l'élément, en ignorant ce qui a été passé dans le champ de description.
- Par défaut : Sauf indication contraire dans le XML, le système respectera les valeurs par défaut pertinentes dans le système. Par exemple, les conditions de paiement et d'expédition par défaut à partir du dossier du fournisseur.
- Numérotation des lignes : L'API s'attend à ce que le numéro de ligne augmente d'une unité pour chaque nouveau numéro de ligne. Si vous utilisez le même numéro de ligne, le système ignorera toutes les autres lignes avec le même numéro.
- Dans le cadre de la mise à jour de la version 30.2.2, nous avons résolu un problème qui vous empêchait de créer une demande pour les utilisateurs en dehors du groupe de contenu du demandeur. Maintenant, l'API de demande reflète la fonctionnalité de l'interface utilisateur.
- Dans le cadre de la mise à jour de la version 34.4.0, l'API de demande peut être utilisée pour créer une nouvelle demande en insérant une ligne à partir d'une autre demande - uniquement si le statut de la demande source est Brouillon. Si le statut de la demande n'est pas Brouillon, aucune ligne de la demande ne peut être référencée pour créer une autre nouvelle demande.
Lorsque l'utilisateur « créé par » est défini via l'API, l'accès au groupe de contenu de cet utilisateur est validé pour la création de la demande. Voir le tableau ci-dessous pour référence :
| allow_created_by_override_via_api | Le créateur a accès via le groupe de contenu | Le demandeur a accès via le groupe de contenu | Autoriser la création via API |
|---|---|---|---|
| TRUE | O | S/O | O |
| TRUE | N | S/O | N |
| FAUX | S/O | S/O | O |
Comportement par défaut de l'article du fournisseur
Lorsqu'une demande avec des lignes basées sur la quantité est créée via API,l'article fournisseur par défaut sur la ligne de demande en utilisant les règles suivantes :
| API payload | Résultat attendu |
|---|---|
| ID de l'article | Article fournisseur préféré ou au prix le plus bas |
| Identifiant de l'article, fournisseur | Article du fournisseur préféré ou au prix le plus bas correspondant à l'identifiant du fournisseur fourni |
| Identifiant de l'article, fournisseur, numéro de référence de la source | Article du fournisseur préféré ou au prix le plus bas correspondant à l'identifiant du fournisseur et au numéro de référence de la source fournis |
| Identifiant de l'article, fournisseur, numéro de référence de la source, numéro de référence du fournisseur aux | Article fournisseur préféré ou au prix le plus bas correspondant à l'identifiant fournisseur et au numéro de pièce source et au numéro de pièce aux fournisseur fournis |
| Identifiant de l'article, fournisseur, contrat | Article de fournisseur préféré ou au prix le plus bas correspondant à l'identifiant de fournisseur et à l'identifiant de contrat fournis |
| Identifiant de l'article, fournisseur, contrat, prix | Article de fournisseur préféré ou au prix le plus bas correspondant à l'identifiant de fournisseur et à l'identifiant de contrat fournis (le prix n'est pas utilisé en correspondance) |
| Identifiant de l'article, fournisseur, contrat, numéro de pièce source | Article du fournisseur préféré ou au prix le plus bas correspondant à l'identifiant du fournisseur, à l'identifiant du contrat et au numéro de référence de la source fournis |
| Identifiant de l'article, fournisseur, contrat, numéro de référence de la source, numéro de référence du fournisseur aux | Article du fournisseur préféré ou au prix le plus bas correspondant à l'identifiant du fournisseur et à l'identifiant du contrat, au numéro de pièce source et au numéro de pièce aux du fournisseur fournis |
Remarque
- Si l'article fournisseur est associé à un catalogue, le catalogue doit être au statut « accepté » et la date actuelle se trouve dans les dates de début et de fin du catalogue.
- Si l'article fournisseur est associé à un contrat, le contrat doit être en statut « publié » et la date du jour se situe dans les dates de début et de fin de catalogue.