Neste artigo, irá aprender a carregar recibos digitais na RetailForce Cloud utilizando o FiscalClient (quando utilizado sem fiscalização) e a obter um link para o seu client descarregar.

Esta funcionalidade está disponível a partir da versão 1.2 do client e oferece uma capacidade offline correspondente para o recibo digital.

Para utilizar esta função, a licença do Recibo Digital (produto completo) deve estar ativada na configuração do respetivo client.

Utilização através do FiscalClient/FiscalService

Ao utilizar o FiscalClient, estão disponíveis os seguintes dois métodos para transferir recibos digitais:

Método utilizando o nome do ficheiro

/// <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 função permite-lhe carregar o recibo digital utilizando um ficheiro no disco rígido (nome do ficheiro).

Parâmetros

• uniqueClientId: o ID único do cliente fiscal.
• filename: o nome do ficheiro (incluindo o caminho) do ficheiro PDF a carregar.
• ReceiptMetaData: os metadados do recibo digital.

Valor de retorno: URL para visualização.

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 função permite-lhe carregar o recibo digital através da transferência de um fluxo de ficheiros (ou streams).

Parâmetros

• uniqueClientId: o ID único do cliente fiscal.
• file: o stream com o conteúdo do ficheiro PDF (o stream deve estar no início)
• ReceiptMetaData: os metadados do recibo digital

Valor de retorno: URL para visualização.

Utilização através da implementação do nuget

Ao utilizar a implementação direta do Fiskaclient (TrustedFiscalModule) com o nuget, está disponível apenas um método com 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)

Com esta função, pode carregar o recibo digital através da transferência de um stream de ficheiros (ou streams).

Parâmetros

• file: o stream com o conteúdo do ficheiro PDF (o stream deve estar no início)
• ReceiptMetaData: os metadados do recibo digital

Valor de retorno: URL para visualização.

ReceiptMetaData

O objeto ReceiptMetaData contém os metadados do recibo digital, incluindo os seguintes dados:

• DocumentType: o tipo de documento (fatura, recibo, depósito, etc.)
• DocumentGuid: o DocumentGuid do recibo (não confundir com o DocumentGuid do sistema de fiscalização)
• BookDate: a data do documento
• Amount: o valor bruto do comprovativo
• Partner: no caso de um documento de vendas, o cliente; no caso de outros documentos, o parceiro correspondente (fornecedor, cliente, ...)

A descrição do objeto pode ser consultada na documentação do Modelo de Objeto de Documento (na secção de downloads das releases).

Este artigo foi traduzido automaticamente.