Dans cet article, vous apprendrez comment télécharger des reçus numériques vers le RetailForce Cloud à l’aide de FiscalClient (lorsqu’il est utilisé sans fiscalisation) et obtenir un lien de téléchargement pour votre client.
Cette fonctionnalité est disponible à partir de la version 1.2 du client et offre une fonctionnalité hors ligne correspondante pour le ticket de caisse numérique.
Pour utiliser cette fonction, la licence « Digital Receipt » (produit complet) doit être activée dans la configuration du client concerné.
Utilisation via FiscalClient/FiscalService
Lorsque vous utilisez FiscalClient, les deux méthodes suivantes sont disponibles pour transférer des reçus numériques :
Méthode utilisant le nom de fichier
/// <summary>
/// Uploads digital receipt with digital receipt metadata.
/// </summary>
/// <param name="uniqueClientId">The client id of the client where the digital receipt should be uploaded.</param>
/// <param name="filename">The name of the file to be uploaded. The file must exist and must be readable.</param>
/// <param name="receiptMetaData">The metadata of the file.</param>
/// <returns>A unique url to download the file for the customer.</returns>
/// <exception cref="ArgumentNullException">Thrown if parameter <paramref name="uniqueClientId"/> is set to <see cref="Guid.Empty"/>.</exception>
/// <exception cref="ArgumentNullException">Thrown if parameter <paramref name="filename"/> is null or <see cref="string.Empty"/>.</exception>
/// <exception cref="FileNotFoundException">Thrown if given filename is not found.</exception>
/// <exception cref="UnauthorizedAccessException"><paramref name="filename" /> specified a directory.-or- The caller does not have the required permission. </exception>
/// <exception cref="IOException">An I/O error occurred while opening the file. </exception>
public string UploadDigitalReceipt(Guid uniqueClientId, string filename, ReceiptMetaData receiptMetaData)
Cette fonction permet de charger le reçu numérique à partir d’un fichier stocké sur le disque dur (nom de fichier).
Paramètres
- uniqueClientId : l'ID unique du client fiscal.
- filename : le nom du fichier (chemin d'accès compris) du fichier PDF à télécharger.
- ReceiptMetaData : les métadonnées du reçu numérique.
Valeur de retour : URL d'affichage.
Méthode de streaming
/// <summary>
/// Uploads digital receipt with digital receipt metadata.
/// </summary>
/// <param name="uniqueClientId">The client id of the client where the digital receipt should be uploaded.</param>
/// <param name="file">The stream of the file to be uploaded.</param>
/// <param name="receiptMetaData">The metadata of the file.</param>
/// <returns>A unique url to download the file for the customer.</returns>
/// <exception cref="ArgumentNullException">Thrown if parameter <paramref name="uniqueClientId"/> is set to <see cref="Guid.Empty"/>.</exception>
/// <exception cref="ArgumentNullException">Thrown if parameter <paramref name="file"/> is set to null.</exception>
public string UploadDigitalReceipt(Guid uniqueClientId, Stream file, ReceiptMetaData receiptMetaData)
Cette fonction permet de télécharger le reçu numérique en transférant un flux de fichiers (ou plusieurs flux).
Paramètres
- uniqueClientId : l’ID unique du client fiscal.
- file : le stream contenant le contenu du fichier PDF (le stream doit se trouver au début)
- ReceiptMetaData : les métadonnées du reçu numérique
Valeur renvoyée : URL d'affichage.
Utilisation via l’implémentation NuGet
Lorsque vous utilisez l’implémentation directe de Fiskaclient (TrustedFiscalModule) via NuGet, une seule méthode acceptant un FileStream est exposée :
/// <summary>
/// Uploads digital receipt (if proper license exists).
/// </summary>
/// <param name="receiptMetaData">The metadata for the receipt.</param>
/// <param name="file">The pdf file as stream.</param>
/// <returns>An url to request the file in the cloud.</returns>
/// <remarks>If <paramref name="receiptMetaData"/> is set to null, only bookDate is set to Now, other values are not set.</remarks>
/// <exception cref="ArgumentNullException">Thrown if parameter <paramref name="file"/> is set to null.</exception>
public string UploadDigitalReceipt(Stream file, ReceiptMetaData receiptMetaData)
Cette fonction permet de télécharger le reçu numérique en transférant un stream de fichiers (ou plusieurs streams).
Paramètres
- file : le stream contenant le contenu du fichier PDF (le stream doit se trouver au début)
- ReceiptMetaData : les métadonnées du reçu numérique
Valeur de retour : URL d'affichage.
ReceiptMetaData
L’objet ReceiptMetaData contient les métadonnées du reçu numérique ; celles-ci comprennent les données suivantes :
- DocumentType : le type de document (facture, reçu, versement, etc.) ; pour les documents qui ne sont pas des documents fiscaux, utilisez [1100] MiscellaneousNonFiscal
- CustomDocumentType : un type de document personnalisé facultatif pour le reçu numérique (il ne s’agit pas d’un type de document de fiscalisation)
- DocumentGuid : le DocumentGuid du reçu (à ne pas confondre avec le DocumentGuid du système de fiscalisation). Le Cloud l’utilise comme identifiant du reçu : un nouveau téléchargement avec le même DocumentGuid remplace le reçu précédent. S’il n’est pas défini, le reçu se voit attribuer un identifiant aléatoire et ne peut pas être référencé par CancelledDocumentGuid.
- retailForceReceiptId : l’ID unique court (8 caractères) du ticket de caisse
- DocumentNumber : le numéro du document
- DocumentId : l’identifiant unique du document
- BookDate : la date du document
- Amount : le montant brut du justificatif
- Partner : pour un document de vente, le client ; pour les autres documents, le partenaire correspondant (fournisseur, client, etc.)
- Utilisateurs : les utilisateurs du document (ID, libellé) ; utilisés par la recherche « Utilisateur » dans le Cloud
- ItemIdArray : les identifiants des articles figurant sur le ticket de caisse ; utilisé par la recherche « Article » dans le Cloud
- ItemCodeArray : les codes d'article (par ex. EAN) figurant sur le ticket de caisse ; utilisé par la recherche « Article » dans le Cloud
- PaymentCardNumberMaskedArray : les numéros de carte masqués des paiements (les numéros de carte en clair ne doivent pas être envoyés)
- ProcessId : relie plusieurs reçus ; les reçus portant le même ProcessId sont marqués dans le Cloud comme étant liés et peuvent être consultés ensemble
- CancelledDocumentGuid : en cas d’annulation, le DocumentGuid du ticket annulé. Le Cloud marque alors ce ticket comme annulé.
La description de l’objet figure dans la documentation relative au Document Object Model (dans la section « Téléchargements » des releases).
Cet article a été traduit automatiquement.
Commentaires
0 commentaire
Vous devez vous connecter pour laisser un commentaire.