Interface de programmation avec intégration d'image pour les FACTURES

Emburse Enterprise offre un interface de programmation qui vous permet de télécharger des images sur votre système interne après avoir exporté les factures. 

API REST pour les images de factures

L’API SOAP d’image de facture détaillée ci-dessous sera remplacée à terme par l’API REST pour les images de factures REST. 

Les avantages de la version REST de l’API comprennent des performances améliorées et des contrôles d’accès standardisés. De plus, le format des documents PDF disponibles via l’API est désormais cohérent avec la mise en page des documents PDF disponibles dans Emburse Invoice Enterprise.

Les administrateurs peuvent activer l'accès à l'API d'image de facture REST via l'écran d'administration Gestion des clés API. De plus amples détails sont disponibles dans la boîte à outils de mise en œuvre.

Cliquez ici pour accéder à la nouvelle API d’image de facture REST.

Validations

• Valider l’ID de la facture : 12 caractères
• Valider l’existence de la facture
• Valider que la facture contient des images
• Valider que le nombre d’images de la facture ne dépasse pas 100
• Valider que le statut de la facture n’est pas Supprimé

Instructions pour la plateforme d’intégration ou les processus d’image personnalisés

Si votre organisation utilise une plateforme d’intégration telle que SAP PI, CPI ou Webmethods, veuillez contacter l’équipe SAP de Chrome River pour obtenir de l’aide en vue d’activer l’API REST. 

Si votre organisation dispose de processus d’image personnalisés, veuillez contacter l’équipe SAP de Chrome River pour discuter des changements éventuels pour cette mise en œuvre.

La documentation de service de l’API REST est disponible sur swagger.io. La méthode HTTP passe de POST à GET.

API SOAP d’image de facture SOAP héritée

• Remarque : L’interface de programmation d’image de Chrome River exige que l’application du client fournisse un protocole de sécurité TLS 1.2 ou supérieur pour se connecter.

Comment accéder au Service

<environment_url>/receipts/doitenvironment_url (depending on querying PROD or QA/UAT server)

• Utilisez l’URL d’AQ ou de production fournie par l’administrateur Emburse Enterprise de votre organisation.

Arguments POST obligatoires (toujours obligatoires pour chaque méthode d'exécution ci-dessous)

method=getInvoices

Cette méthode génère une liste de factures exportées pendant une période spécifiée. Les dates sont basées sur la date d'exportation de Emburse Enterprise. La plupart des clients choisissent d'exécuter ce service après minuit pour la journée précédente. Votre entreprise développe un programme qui répète la liste de factures et fait appel à la méthode getInvoiceImages pour chacun d'eux. Veuillez prendre note que les caractères non ASCII comme les symboles de devises et les tirets conditionnels ne sont pas entièrement pris en charge actuellement, et peuvent entraîner des problèmes avec cette méthode.

Arguments POST obligatoires

• Remarque : Pour optimiser la requête, la période de dates se limite à 32 jours.
• Remarque : Les dossiers fournis se limitent aux dates d'exportation comprises dans les 90 derniers jours civils. Si la facture a été exportée il y a plus de 90 jours, ses données XML ne seront pas fournis.

Réussite XML :

<?xml version="1.0" encoding="utf-8" ?><list><com.chromeriver.servlet.InvoiceTO><invoiceID>010000008475</invoiceID><invoiceNumber>0003698602242029</invoiceNumber><invoiceDate>1236293857500</invoiceDate><invoiceDateString>2009-03-05 22:57:37</invoiceDateString><vendorUniqueID>12345</vendorUniqueID><addressUniqueID>3</addressUniqueID></com.chromeriver.servlet.InvoiceTO><com.chromeriver.servlet.InvoiceTO><invoiceID>010000008490</invoiceID><invoiceNumber>0003698602987777</invoiceNumber><invoiceDate>1236293857500</invoiceDate><invoiceDateString>2009-03-05 22:57:37</invoiceDateString><vendorUniqueID>12345</vendorUniqueID><addressUniqueID>3</addressUniqueID></com.chromeriver.servlet.VoucherInvoiceTO>...</list>ou<list/>

Erreur XML :

<?xml version="1.0" encoding="utf-8"?><com.chromeriver.ws.CrRestHeaderOutput><errorMessage> </errorMessage></com.chromeriver.ws.CrRestHeaderOutput>

Remarques concernant les éléments de données

• invoiceID : ID de la facture
• invoiceNumber : Numéro de la facture
• invoiceDate : Date de la facture formatée en quelques secondes à partir de 1970
• invoiceDateString : Date de la facture
• vendorUniqueID : ID unique du fournisseur
• addressUniqueID : ID unique de l'adresse du fournisseur

method=getInvoiceImages

Cette méthode fournit un fichier en format PDF de toutes les images et/ou rapports en format PDF associés à une facture. Chaque action génère un seul fichier en format PDF, identifié par l'ID de la facture. Les rapports en format PDF seront ajoutés au fichier d'image.

Arguments POST obligatoires

Arguments POST facultatifs

Renvois

• En temps normal, l’interface de programmation fournira l’image consolidée et/ou le fichier PDF.
• Si une erreur survient, l’interface de programmation fournira un fichier XML contenant les données de l’erreur.

Remarque : Il n’y a aucune date limite pour exécuter cette fonction.

Messages de prise de décision et messages renvoyés en détails

• S'il n'existe aucune facture pour l'ID de facture donné, le message sera : « Aucun enregistrement de facture ne correspond à cette requête. »
• Si les formats PDF et JPG de l'image sont disponibles, les JPG seront récupérés; si aucun format JPG n'est disponible, le format PDF sera récupéré.
• Si « getPDFReport » est sélectionné, le PDF original sera récupéré en premier (s'il est disponible).
• Si cette facture ne comporte aucune image en pièce jointe, le message sera : « Aucune image n'est associée à cette facture. »

• INVOICE Image Integration APIs.pdf200 ko