Intégration d’images API pour DÉPENSE

API REST d'image de dépense

L'API SOAP d'image de dépense détaillée ci-dessous sera remplacée à terme par l'API REST pour les images de dépenses

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 Chrome River EXPENSE.

Les administrateurs peuvent activer l'accès à l'API REST d'image de dépense 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 REST d'image de dépense.

Ancienne API SOAP d’image de dépense

Chrome River propose une API qui vous permet de télécharger des images après avoir exporté des dépenses. 

  • 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 (selon que la requête est envoyée au serveur PROD ou AQ)
  • Utilisez l’URL d’AQ ou de production fournie par l’administrateur Chrome River de votre organisation.

Arguments POST obligatoires 

(toujours obligatoires pour chaque méthode d’exécution ci-dessous)
un Nom d'utilisateur (utilisateur FTP)
pw Mot de passe (mot de passe FTP)
méthode méthode d’exécution

method=getVoucherInvoices

Cette méthode génère une liste de tous les rapports de dépenses exportés pendant une période spécifiée qui comportent des images jointes au rapport ou aux lignes de poste contenues dans le rapport, selon les dates d’exportation de Chrome River. La plupart des utilisateurs 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 numéros de rapports et fait appel à la méthode getReceipts 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

fromDate Format MM/JJ/AAAA
toDate Format MM/JJ/AAAA
  • 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 les postes de dépenses ont été exportés il y a plus de 90 jours, leurs données en format XML ne seront pas fournies.

Réussite XML :

<list><com.chromeriver.servlet.VoucherInvoiceTO><reportID>0001234567891234</reportID><voucherInvoice>0003698602242029</voucherInvoice><invoiceDate>1236293857500</invoiceDate><invoiceDateString>2016-03-05 22:57:37</invoiceDateString><vendorNumber>1234</vendorNumber><isReceiptUpdatedAfterExport>false</isReceiptUpdatedAfterExport></com.chromeriver.servlet.VoucherInvoiceTO><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

  • voucherInvoice : Numéro de facture du bon créé par le système des finances
  • invoiceDate : Formaté en quelques secondes à partir de 1970
  • invoiceDateString : Date formatée lisible pour les humains
  • vendorNumber : Valeur Fournisseur 1 ou Fournisseur 2 dans Chrome River

method=getReceipts

Cette méthode fournit un fichier en format PDF de toutes les images associées à un rapport de dépenses, ou avec les lignes de postes contenues dans le rapport. Chaque exécution génère un seul fichier en format PDF identifié par le numéro de rapport. Vous pouvez également choisir de fournir le rapport en format PDF associé à un rapport de dépenses et qui sera ajouté au reçu en format PDF.

Arguments POST obligatoires

Vous pouvez utiliser le numéro de facture du bon OU l’ID du rapport.
voucherInvoice Numéro de la facture du bon qui a été fourni à partir de la méthode getVoucherInvoices.
IDRapport
L’ID du rapport est un numéro à douze chiffres généré par Chrome River et qui commence par 0100. Faites en sorte d’omettre les tirets.
Exemple : 010012345678

Arguments POST facultatifs

Argument Action Valeurs possibles Valeur par défaut
getImage Fournit l’image associée à la dépense true/false true
getMileageDetails Fournit la page couverture des détails sur le kilométrage true/false false
getPDFReport Fournit le rapport en format PDF complet true/false false
getPDFReportWithNotes Fournit le rapport en format PDF complet avec les notes true/false false
imageFirst Fournit l’image précédent le rapport en format PDF complet true/false true

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étail

  • S’il n’existe aucune donnée correspondant à l’ID de la facture du bon, le message sera : « Invalid voucherInvoice ».
  • Si les formats PDF et JPG de l’image sont disponibles, les JPG seront récupérés en premier. 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 aucun format JPG ou PDF n’est associé à cette facture, le message sera : « Les reçus ne peuvent être récupérés. Veuillez renvoyer les reçus pour ce bon. »
  • Si ce rapport de dépenses ne comporte aucune image en pièce jointe, le message sera : « Aucun reçu n’est associé à ce rapport de dépenses. »

method=getReceiptsWithCoverPage()

Cette méthode fournit un fichier en format PDF de la page couverture ainsi que toutes les images associées à un rapport de dépenses, ou avec les lignes de poste contenues dans le rapport. Chaque exécution génère un seul fichier en format PDF identifié par le numéro de facture du bon. Vous pouvez également choisir de fournir le rapport en format PDF associé à un rapport de dépenses et qui sera ajouté au reçu en format PDF.

Argument POST obligatoire

voucherInvoiceFor Pdf Numéro de la facture du bon qui a été fourni à partir de la méthode getVoucherInvoices.
reportIDForPdf
L’ID du rapport est un numéro à douze chiffres généré par Chrome River et qui commence par 0100. Faites en sorte d’omettre les tirets.
Exemple : 010012345678

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étail

  • S’il n’existe aucune donnée correspondant à l’ID de la facture du bon, le message sera : « Invalid voucherInvoice ».
  • Si les formats PDF et JPG de l’image sont disponibles, les JPG seront récupérés en premier. Si aucun format JPG n’est disponible, le format PDF sera récupéré.
  • Si aucun format JPG ou PDF n’est associé à cette facture, le message sera : « Les reçus ne peuvent être récupérés. Veuillez renvoyer les reçus pour ce bon. »
  • Si ce rapport de dépenses ne comporte aucune image en pièce jointe, le message sera : « Aucun reçu n’est associé à ce rapport de dépenses. »

method=getLineItemVoucherInvoices

Cette méthode fournit une liste des factures de bons des lignes de poste, en fonction de la facture du bon remis.
  • SI une ligne de poste est associée à une image, ALORS ajoutez sa facture de bon de ligne de poste à la liste fournie.
  • SI certaines images de l’en-tête ne sont associées à aucune ligne de poste et ne font qu’être disposées sur l’en-tête, ALORS ajoutez l’entrée 00000000 à la liste fournie (qui devrait inclure toutes les images non associées).

Format du justificatif de facture de la ligne de poste : 

<VoucherInvoice> + "_" + <LineNumber> + <HotelNumber>

Argument POST obligatoire

lineItemVoucherInvoice Numéro de la facture du bon qui a été fourni à partir de la méthode getVoucherInvoices.

Réussite XML :

<list><lineItemVoucherInvoice>0860631509020301_00020000</lineItemVoucherInvoice><lineItemVoucherInvoice>0860631509020301_00010000</lineItemVoucherInvoice><lineItemVoucherInvoice>0860631509020301_00000000</lineItemVoucherInvoice></list>

method=getLineItemReceipts

Cette méthode fournit les reçus des lignes de poste en format PDF, en fonction de la facture du bon de la ligne de poste remise. Cela fonctionne également pour fournir toutes les images restantes qui ne sont associées à aucune ligne de poste (00000000).

Format du justificatif de facture de la ligne de poste : 

<VoucherInvoice> + "_" + <LineNumber> + <HotelNumber>

Argument POST obligatoire

voucherInvoiceForReceipt Numéro de facture du bon lié à une ligne de poste en particulier, fourni à partir de la méthode getLineItemVoucherInvoices.

Renvois

  • En temps normal, l’interface de programmation fournira l’image consolidée et/ou le fichier PDF. Ce fichier comportera soit les images liées à cette ligne de poste en particulier, ou les images restantes du rapport de dépenses non associées à une ligne de poste (00000000).
  • 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.

method=getLineItemReceiptsWithMileageDetails

Si une image de Google Maps est liée à un poste de dépense devant contenir des images, vous avez la possibilité de fournir une liste en page couverture de toutes les données des dépenses qui y sont associées, y compris d’ID de rapport, le nom du rapport, la personne à rembourser, l’allocation, le taux, la distance et les montants à déduire. Seule la méthode diffère de getLineItemReceipts — tous les autres paramètres sont les mêmes que ceux indiqués ci-dessus pour method=getLineItemReceipts.
Remarque : s’il n’y a aucune image de facture associée au poste de dépense demandé, un message d’erreur s’affichera — même si des données de kilométrage sont associées à la ligne de poste.

method=getVoucherInvoicesForXML()

Cette méthode fournit une liste de tous les rapports de dépenses exportés pendant une période spécifiée comportant des images XML en pièce jointe aux postes de dépenses contenus dans le rapport, selon les dates d’exportation de Chrome River. La plupart des utilisateurs 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 numéros de rapports et fait appel à la méthode getReceiptsForXML pour chacun d’eux.

Arguments POST obligatoires

fromDateforXml Format MM/JJ/AAAA
toDateforXml Format MM/JJ/AAAA
  • 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 les postes de dépenses ont été exportés il y a plus de 90 jours, leurs données en format XML ne seront pas fournies.

Réussite XML :

<list><com.chromeriver.servlet.VoucherInvoiceTO><reportID>0001234567891234</reportID><voucherInvoice>0003698602242029</voucherInvoice><invoiceDate>1236293857500</invoiceDate><invoiceDateString>2016-03-05 22:57:37</invoiceDateString><vendorNumber>1234</vendorNumber><isReceiptUpdatedAfterExport>false</isReceiptUpdatedAfterExport></com.chromeriver.servlet.VoucherInvoiceTO><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

  • voucherInvoice : Numéro de facture du bon créé par le système des finances
  • invoiceDate : Formaté en quelques secondes à partir de 1970
  • invoiceDateString : Date formatée lisible pour les humains
  • vendorNumber : Valeur Fournisseur 1 ou Fournisseur 2 dans Chrome River

method=getReceiptsForXML()

Cette méthode fournit un fichier en format ZIP de tous les fichiers XML associés à un rapport de dépenses, ou avec les postes de dépense contenus dans le rapport. Chaque exécution génère un seul fichier en format ZIP identifié par le numéro de rapport.
Tous les fichiers XML contenus dans le fichier ZIP seront nommés selon le format suivant : 
<ReportID>_<UUID>.xml

Argument POST obligatoire

voucherInvoiceForXml Numéro de facture du bon qui a été fourni à parti de la méthode getVoucherInvoicesForXML.

Renvois

  • En temps normal, l’interface de programmation fournira le fichier en format ZIP contenant tous les fichiers XML.
  • 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étail

  • Si aucune facture de bon n’est saisie : « VoucherInvoice is required. »
  • S’il n’existe aucune donnée correspondant à l’ID de la facture du bon, le message sera : « Invalid voucherInvoice ».
  • Si ce rapport de dépenses ne comporte aucune image en pièce jointe, le message sera : « Aucun fichier XML n’est associé à ce rapport de dépenses. »

Cet article vous a-t-il été utile ?