In diesem Artikel lernen Sie wie Sie digitale Belege mittels des FiskalClients (bei Verwendung ohne Fiskalisierung) in die RetailForce Cloud uploaden können und einen Link zum Download für Ihren Kunden erhalten.
Dieses Funktionalität steht ab der Version 1.2 des Clients zur Verfügung und stellt eine entsprechende Offline-Fähigkeit für den digitalen Beleg zur Verfügung.
Um diese Funktion nutzen zu können, muss in der Konfiguration für den jeweiligen Client die Lizenz Digital Receipt (full product) aktiviert sein.
Verwendung mittels FiscalClient/FiscalService
Bei Verwendung des FiscalClients stehen Ihnen folgende 2 Methoden zur Übertragung von digitalen Belegen zur Verfügung:
Methode mit Dateiname
/// <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)
Mit dieser Funktion können Sie den digitalen Beleg anhand einer Datei auf der Festplatte (Dateiname) uploaden.
Parameter
- uniqueClientId: die Id des Fiskalclients.
- filename: der Dateiname (inkl. Pfad) zur PDF Datei die upgeloaded werden soll.
- receiptMetaData: die Metadaten für den digitalen Beleg.
Rückgabe: URL zur Anzeige.
Methode mit Stream
/// <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)
Mit dieser Funktion können Sie den digitalen Beleg mittels Übergabe eines Filestreams (oder Streams) uploaden.
Parameter
- uniqueClientId: die Id des Fiskalclients.
- file: der Stream mit dem Inhalt der PDF Datei (Stream muss am Beginn stehen)
- receiptMetaData: die Metadaten für den digitalen Beleg
Rückgabe: URL zur Anzeige.
Verwendung mittels nuget Implementierung
Bei der Verwendung der direkten Implementierung des Fiskaclients (TrustedFiscalModule) mit nuget steht nur eine Methode mit FileStream zur Verfügung:
/// <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)
Mit dieser Funktion können Sie den digitalen Beleg mittels Übergabe eines Filestreams (oder Streams) uploaden.
Parameter
- file: der Stream mit dem Inhalt der PDF Datei (Stream muss am Beginn stehen)
- receiptMetaData: die Metadaten für den digitalen Beleg
Rückgabe: URL zur Anzeige.
ReceiptMetaData
Das Objekt ReceiptMetaData beinhaltet die Metadaten für den digitalen Beleg, diese beinhalten folgende Daten:
- DocumentType: der Dokumententyp (Rechnung, Beleg, Einzahlung, etc.)
- DocumentGuid: die DocumentGuid des Beleges (vgl. mit der DocumentGuid des Fiskalisierungssystems)
- BookDate: das Belegdatum
- Amount: der Bruttobetrag des Beleges
- Partner: bei einem Verkaufsbeleg der Kunde, bei anderen Belegen der entsprechende Partner (Lieferant, Kunde, ...)
Die Objektbeschreibung finden Sie in der Document Object Model documentation. (Im Downloads Bereich der Releases).
Kommentare
0 Kommentare
Bitte melden Sie sich an, um einen Kommentar zu hinterlassen.