Guide du développeur de l’API de facture AP

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 4 minutes de lecture
  • Ce guide du développeur explique comment définir des champs de facture personnalisés qui ne sont pas fournis par défaut avec l’API de facture AP pour Traitement des factures des comptes fournisseurs. Des instructions sont également fournies pour définir l’authentification lors de l’utilisation de cXML comme charge utile.

    Vous pouvez définir des champs de facture personnalisés pour le corps de la demande. Utilisez le flux suivant pour ajouter des champs personnalisés, les mapper aux tables cibles et les formater pour leur disponibilité dans la charge utile :
    1. Ajouter des champs personnalisés pour l’importation de facture
    2. Mapper les champs personnalisés entre les tables source et cible
    3. Mapper les champs personnalisés à un format source de charge utile

    Définissez les informations d’identification pour les charges utiles cXML dans la table Informations d’identification du système source [sn_spend_intg_source_system_credential]. Pour obtenir des instructions, consultez Définition des informations d’identification pour l’authentification dans la charge utile cXML.

    Ajouter des champs personnalisés pour l’importation de facture

    Utilisez la procédure suivante pour ajouter des champs personnalisés pour les factures, les lignes de facture et les lignes de taxe de facture à utiliser avec l’API de facture AP .

    Avant de commencer

    • Rôle requis : admin
    • Périmètre de l'application :

    Procédure

    1. Accédez à la Tout > Définition du système > Tables.
    2. Sélectionnez une des tables d’importation de facture suivantes :
      • Importation de facture [sn_spend_intg_imp_invoice]
      • Importation de ligne de facture [sn_spend_intg_imp_invoice_line]
      • Importation de la ligne fiscale de facture [sn_spend_intg_imp_invoice_tax_line]
    3. Dans l’onglet Colonnes de table , sélectionnez Nouveau.
    4. Sélectionnez un type associé à la valeur du champ (par exemple, Entier) dans le menu Type .
      Remarque :
      Pour obtenir la liste des types valides, reportez-vous à la section Field types reference.
    5. Entrez un nom significatif dans le champ Étiquette de colonne .
      Le texte incluant l’étiquette est automatiquement renseigné dans le champ Nom de colonne .
    6. Sélectionnez Enregistrer ou Envoyer.
    7. Ajouter une colonne du même nom et du même type à la table Facture [sn_shop_invoice].
      Remarque :
      Pour plus d’informations sur les colonnes et les champs, reportez-vous à Exploring field administration.
    8. Mappez les champs entre les tables source et cible.

    Mapper les champs personnalisés entre les tables source et cible

    Utilisez la procédure suivante pour mapper des champs personnalisés entre les tables source et cible pour l’API de facture AP.

    Avant de commencer

    • Rôle requis : admin
    • Périmètre de l'application :

    Créez des colonnes de table pour mapper le nouveau champ de la table source à la table cible. Suivez les étapes de la section Ajouter des champs personnalisés pour l’importation de facture.

    Procédure

    1. Accédez à la Tout > Ensembles de données à importations système > Cartes de transformation.
    2. Ouvrez la carte de transformation de la table d’importation de factures.
    3. Cliquez sur Nouveau dans l’onglet Cartes de champs .
    4. Sélectionnez le nom du champ personnalisé dans le menu Champ source .
    5. Sélectionnez le nom du champ personnalisé dans le menu Champ cible .
    6. Sélectionnez Enregistrer ou Envoyer.
    7. Mapper les champs personnalisés à un format source de charge utile.

    Mapper les champs personnalisés à un format source de charge utile

    Utilisez la procédure suivante pour mapper des champs personnalisés à une entrée de charge utile dans JSON, cXML ou XML pour l’API de facture AP.

    Avant de commencer

    Procédure

    1. Accédez à la Tout > Intégrations d'approvisionnement > Fournisseurs > Mappages de champs d'intégration de facture.
    2. Sélectionnez Nouveau.
    3. Ajoutez le nom du système source au champ Système source .
      • Si ce mappage de champs s’applique à tous les systèmes sources, entrez Par défaut.
      • Si le mappage est spécifique à un système source particulier, cette valeur doit correspondre à la valeur du paramètre d’en-tête du système source reçu dans l’API.
        Remarque :
        Tous les mappages de champs restants doivent être configurés spécifiquement pour ce système source.
    4. Sélectionnez le format du système source pour lequel le mappage est créé dans la liste de choix Format source (cXML ou JSON).
    5. Fournissez un nom (propriété JSON) ou un chemin d’accès (attribut ou élément cXML/XML) pour l’entrée de charge utile dans le champ Source .
      Vous pouvez consulter la table Mappage de champ d’intégration de facture [sn_spend_intg_invoice_intg_field_mapping] pour obtenir des exemples de paramètres cXML et de chemin XML.
    6. Ajoutez le nom d’un attribut si le champ doit être défini en tant qu’attribut d’élément pour les charges utiles cXML, sinon laissez le champ vide.
    7. Sélectionnez le nom de la table cible contenant votre champ personnalisé dans la liste Table connexe .
    8. Sélectionnez le nom du champ personnalisé dans la liste Champ cible .
    9. Sélectionnez Enregistrer ou Envoyer.
      Le champ mappé est ajouté à la table Mappage de champ d’intégration de facture [sn_spend_intg_invoice_intg_field_mapping].

    Définition des informations d’identification pour l’authentification dans la charge utile cXML

    Le point de terminaison sn_spend_intg/ap_invoice/cxml est authentifié dans la charge utile à l’aide des informations d’identification stockées dans la table Informations d’identification du système source [sn_spend_intg_source_system_credential].

    Avant de commencer

    Rôle requis : admin

    Identifiez le système source de la charge utile répertorié dans la table Mappages de champs d’intégration de facture [sn_spend_intg_invoice_intg_field_mapping].

    Voir aussi Facture AP – POST sn_spend_intg/ap_invoice/cxml.

    Procédure

    1. Accédez à la Tout > Intégrations d'approvisionnement > Informations d'identification du système source.
    2. Sélectionnez Nouveau.
    3. Ajoutez le nom du système source répertorié dans la table Mappages de champs d’intégration de facture [sn_spend_intg_invoice_intg_field_mapping] dans le champ Système source .
      Le nom du système source doit correspondre au paramètre d’en-tête du système source.
    4. Ajoutez le nom d’utilisateur à extraire dans le champ Nom d’utilisateur .
      Utilisez cette valeur dans l’élément /cXML/Header/To/Credential [@domain='NetworkID']/Identity .
    5. Ajoutez une combinaison forte de lettres, de chiffres et de caractères spéciaux au champ Mot de passe .
      Utilisez cette valeur dans l’élément /cXML/Header/Sender/Credential [@domain='NetworkID']/SharedSecret .
    6. Sélectionnez Soumettre.