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

Chrome River 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. Si vous souhaitez utiliser l'interface de programmation avec intégration d'images, veuillez communiquer avec le service d'assistance de Chrome River pour que votre accès soit activé.

Cliquez ici pour télécharger l'interface de programmation avec intégration d'images en format de document Word.

  • 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 (selon que la requête est envoyée au serveur PROD ou QA)

  • 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=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 Chrome River. 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

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 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>10 000 008 475</invoiceID><invoiceNumber>3 698 602 242 029</invoiceNumber><invoiceDate>1 236 293 857 500</invoiceDate><invoiceDateString>2009-03-05 22:57:37</invoiceDateString><vendorUniqueID>12 345</vendorUniqueID><addressUniqueID>3</addressUniqueID></com.chromeriver.servlet.InvoiceTO><com.chromeriver.servlet.InvoiceTO><invoiceID>10 000 008 490</invoiceID><invoiceNumber>3 698 602 987 777</invoiceNumber><invoiceDate>1 236 293 857 500</invoiceDate><invoiceDateString>2009-03-05 22:57:37</invoiceDateString><vendorUniqueID>12 345</vendorUniqueID><addressUniqueID>3</addressUniqueID></com.chromeriver.servlet.VoucherInvoiceTO>...</list>or<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

IDFacture ID de la facture

Arguments POST facultatifs

Argument Action Valeurs possibles Valeur par défaut
getImage Fournit l'image de la facture true/false true
getPDFReport Fournit le rapport en format PDF complet true/false false
imageFirst Fournit l'image de la facture avant 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é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. »

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