En este artículo se explica cómo cargar recibos digitales en la RetailForce Cloud mediante FiscalClient (cuando se utiliza sin fiscalización) y cómo obtener un enlace de descarga para el cliente.
Esta funcionalidad está disponible a partir de la versión 1.2 del cliente y ofrece la correspondiente capacidad de funcionamiento sin conexión para el recibo digital.
Para utilizar esta función, debe estar activada la licencia de «Recibo digital (producto completo)» en la configuración del cliente correspondiente.
Uso mediante FiscalClient/FiscalService
Al utilizar FiscalClient, se dispone de los dos métodos siguientes para transferir recibos digitales:
Método mediante nombre de archivo
/// <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)
Esta función permite cargar el recibo digital mediante un archivo almacenado en el disco duro (nombre de archivo).
Parámetros
- uniqueClientId: el ID único del cliente fiscal.
- filename: ruta completa del archivo PDF que se va a cargar.
- ReceiptMetaData: los metadatos del recibo digital.
Valor de retorno: URL para su visualización.
Método 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)
Esta función permite cargar el recibo digital mediante la transferencia de un stream de archivos (o varios streams).
Parámetros
- uniqueClientId: el ID único del cliente fiscal.
- file: el stream con el contenido del archivo PDF (el stream debe comenzar desde el principio)
- ReceiptMetaData: los metadatos del recibo digital
Valor de retorno: URL para su visualización.
Uso mediante la implementación de nuget
Al utilizar la implementación directa de Fiskaclient (TrustedFiscalModule) con NuGet, solo está disponible un método con FileStream:
/// <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)
Mediante esta función puede cargar el recibo digital transfiriendo un stream (o varios streams).
Parámetros
- file: el stream con el contenido del archivo PDF (el stream debe estar al principio)
- ReceiptMetaData: los metadatos del recibo digital
Valor de retorno: URL para su visualización.
ReceiptMetaData
El objeto ReceiptMetaData contiene los metadatos del recibo digital, lo que incluye los siguientes datos:
- DocumentType: el tipo de documento (factura, recibo, ingreso, etc.); para los documentos que no sean documentos fiscales, utilice [1100] MiscellaneousNonFiscal
- CustomDocumentType: un tipo de documento personalizado opcional para el recibo digital (no es un tipo de documento de fiscalización)
- DocumentGuid: el DocumentGuid del recibo (que no debe confundirse con el DocumentGuid del sistema de fiscalización). La Cloud lo utiliza como identidad del recibo: si se vuelve a cargar con el mismo DocumentGuid, se sustituye el recibo anterior. Si no se establece, el recibo recibe una identidad aleatoria y no puede ser referenciado mediante CancelledDocumentGuid.
- retailForceReceiptId: el ID único corto (8 caracteres) del recibo
- DocumentNumber: el número de documento
- DocumentId: la identificación única del documento
- BookDate: la fecha del documento
- Amount: el importe bruto del comprobante
- Partner: en el caso de un documento de venta, el cliente; en el caso de otros documentos, el interlocutor correspondiente (proveedor, cliente, etc.)
- Usuarios: los usuarios asociados al documento (ID, rótulo); se emplea en la búsqueda «Usuario» en la nube
- ItemIdArray: los identificadores de artículo que figuran en el recibo; se utiliza en la búsqueda de «Artículo» en la Cloud
- ItemCodeArray: los códigos de artículo (p. ej., EAN) que figuran en el recibo; se utiliza en la búsqueda «Artículo» en la Cloud
- PaymentCardNumberMaskedArray: los números de tarjeta enmascarados de los pagos (no deben enviarse números de tarjeta sin enmascarar)
- ProcessId: vincula varios recibos; los recibos con el mismo ProcessId se marcan en la Cloud como recibos vinculados y pueden visualizarse conjuntamente
- CancelledDocumentGuid: en caso de anulación, el DocumentGuid del recibo anulado. A continuación, la Cloud marca dicho recibo como anulado.
La descripción del objeto se puede consultar en la documentación del Modelo de Objetos de Documento (en la sección de descargas de las releases).
Este artículo ha sido traducido automáticamente.
Comentarios
0 comentarios
Inicie sesión para dejar un comentario.