Serviço Fiscal da RetailForce - Descrição da api

Regista o saldo inicial para um balanço de encerramento da caixa registadora. Regista apenas um depósito, não reajusta o saldo de caixa.

Alternativa: Em alternativa, a caixa registadora também pode lançar um documento: documentType [11] = PayIn.

Regista uma diferença de caixa no sistema de fiscalização.

Alternativa: Em alternativa, a caixa registadora também pode registar um documento com BusinessTransactionType [91] = CashDifference.

Regista uma transferência de fundos do sistema de caixa para o banco (ou qualquer outro destino).

Devolve o saldo real dos pagamentos de um cliente específico. Este é calculado com base nos documentos transmitidos (para além de recibos de vendas e devoluções, depósitos e levantamentos, etc.).

Verifica o saldo real dos pagamentos desta caixa registadora e devolve uma lista de pagamentos com diferença (ou uma lista vazia, caso não haja diferença).

Encerra o dia atual com um extrato de fecho.

O encerramento é efetuado com base nos documentos enviados ao client desde o último encerramento. O sistema de caixa registadora não recebe o extrato de encerramento em resposta!

Devolve o documento de fim de dia relativo ao dia em questão.

O documento devolvido deve ser armazenado (storeDocument > documentType 99)

Devolve a data e a hora do último encerramento de um client específico (terminal)

Devolve informação sobre se deve ou não ser efetuado um fecho diário num determinado terminal. (Dependendo de RetailForce.Fiscalisation.Implementation.
IFiscalCountryProperties.
MaximumHourIntervalForClosing).

Cria um novo client no repositório de configuração. O objeto de configuração deve ser preparado pelo sistema POS.

A configuração de um client é necessária para o funcionamento. Utilize este ponto de extremidade ou:

• PUT /api/v1/management/clients, ou
• 
  PUT /api/v1/management/clients/byCloud/ID.

Atualiza uma configuração de cliente criada pelo sistema de caixa registadora no repositório de configurações.

Devolve todos os clientes listados no repositório de configuração.

Também pode ser utilizado quando se recorre à configuração na Cloud.

Cria um novo client com uma configuração preparada na Cloud / ou carrega um client existente.

A configuração de um client é necessária para o funcionamento. Utilize:

• este ponto de extremidade, ou
• PUT /api/v1/management/clients, ou
• PUT /api/v1/management/clients/
  byCloud/ID.

Cria um client, carregando os dados de configuração a partir da Cloud.

Alternativa: ponto de extremidade alternativo para PUT /api/v1/management/clients e PUT /api/v1/management/clients/byCloud.

Atualiza a configuração do client, obtendo-a da Cloud.

É utilizado quando a configuração preparada na Cloud foi atualizada e deve ser descarregada novamente pelo client fiscal (atualização).

Cria um novo client na gestão do módulo fiscal e adiciona esse client à configuração na Cloud.

O client é criado no repositório de configuração local e o objeto de configuração é, em seguida, carregado para o sistema da Cloud.

Nota: O distribuidor deve estar definido nos dados do client e deve ter permissão para criar novos clientes.

Estabelece a ligação à Cloud do client específico e carrega o módulo fiscal de confiança na cache.

Obrigatório para sistemas que utilizam funções na Cloud.

Necessário após cada reinício do sistema POS.

Atualiza a chave de licença atual na configuração do client fiscal (também no disco). Obrigatório, caso as licenças na configuração da Cloud tenham sido alteradas.

Método para iniciar ou parar o processamento da fila na Cloud (para todos os clientes).

O comando «Stop» interrompe o processamento após a conclusão do carregamento em curso.

O comando «Start» inicia imediatamente o processamento da fila.

Se o processamento da fila na Cloud for interrompido, terá de o reiniciar, a menos que o serviço seja reiniciado (caso em que o processamento na Cloud é ativado novamente).

Retorna a configuração de um client específico.

Elimina um client específico

Atenção: utilize com precaução!

Devolve o ID único do cliente para os parâmetros solicitados.

Podem ser utilizados diferentes parâmetros para solicitar o uniqueClientId.

Devolve o ID do consumidor da licença para a identificação da empresa indicada.

Apenas são devolvidos os LicenseConsumerId que já se encontram armazenados no repositório de configuração.

Valida as informações do cliente fornecidas para garantir que cumprem a configuração específica do país necessária.

É utilizado para validar uma configuração criada pelo sistema de caixa registadora antes de utilizar /api/v1/management/clients.

A validação da configuração na Cloud é efetuada no sistema na Cloud.

Inicializa a unidade de fiscalização (bem como o eventual hardware e a eventual declaração às autoridades fiscais).

A inicialização é efetuada através do recibo de início (recibo inicial), que pode ser consultado utilizando o ponto de extremidade GET /api/v1/transactions/document/
{clientId}/start, ou o documento de início é criado pelo sistema de caixa registadora.

Migrar um client de um fornecedor de fiscalização diferente.

É utilizado ao mudar de um fornecedor de middleware fiscal diferente para o RetailForce

Por favor, consulte os sistemas suportados.

Migrar um client de um fornecedor de fiscalização diferente e efetuar uma importação de ficheiros.

Por favor, tenha em atenção os sistemas suportados!

Desativação de um client fiscal (e, se for o caso, do hardware, bem como eventual declaração às autoridades fiscais).

Carrega um Support Package (ficheiros de registo) para a Cloud para o client indicado.

Este ponto de extremidade é necessário para utilizar a função «Carregar Support Package» no sistema da Cloud.

Efetua uma cópia de segurança de um client para o filename indicado (cópia de segurança em ficheiro ZIP).

Se o carregamento para a Cloud estiver em uso, o processamento da fila da Cloud será interrompido e reiniciado (e a fila da Cloud será reinicializada).

Atenção: Tenha em atenção que, caso o client não seja removido, o processo da fila na Cloud será retomado após o backup. Se houver ficheiros que não tenham sido incluídos no backup, estes também farão parte do backup e poderão ser carregados duas vezes, caso o client seja restaurado.

Restaura um client (com todos os dados) a partir do ficheiro ZIP de cópia de segurança indicado.

Cria um novo client com a configuração da Cloud ou carrega um client existente.

Cria um novo client com a configuração da Cloud ou carrega um client já existente.

Gera um novo ID globalmente único, ou devolve um já existente, para o respetivo client. Além disso, a emissão do «retailForceReceiptId» é ativada para o respetivo client.

Armazena um certificado externo no repositório de certificados do módulo fiscal.

Obrigatório para sistemas que NÃO utilizam as funções do RetailForce Cloud em países com regime fiscal em que são utilizados certificados de software no contexto da fiscalização (Eslovénia, Croácia, Espanha,…)

Indica se o client solicitado possui a licença de acesso solicitada.

Indica se o client solicitado possui a licença solicitada.

Cria uma chave de utilizador AES para este cliente e devolve-a. A chave AES será também armazenada na configuração do cliente.

Nota: A chave de utilizador AES será criada automaticamente pelo client fiscal. Este ponto de acesso só é necessário se a chave AES tiver de ser criada manualmente.

Devolve a chave AES para o client indicado.

Exporta todas as linhas de recibos dos dados armazenados no Registo de Recolha de Dados local (DEP §7 RKSV).

Obrigatório para sistemas offline (sistemas que NÃO utilizam o arquivo na Cloud de dados fiscais).

Exporta todos os dados solicitados para o protocolo DEP131 (DEP §131 BAO) a partir dos dados armazenados localmente.

Devolve o recibo inicial deste client.

O sistema de caixa registadora deve poder fornecer o recibo inicial (recibo de início) mediante pedido durante uma auditoria fiscal; caso o sistema POS não tenha armazenado o recibo inicial, este pode ser solicitado através deste ponto de extremidade.

Devolve todos os recibos mensais no intervalo de datas solicitado.

O sistema de caixa registadora deve poder fornecer os recibos mensais mediante solicitação durante uma auditoria fiscal; caso o sistema POS não tenha armazenado esses documentos, estes podem ser solicitados através deste ponto de extremidade.

Devolve todos os dispositivos de assinatura e indica se estão ou não ativados no FinanzOnline (Fon).

Regista o dispositivo de assinatura configurado no Fon (caso exista algum configurado) ou o dispositivo de assinatura identificado pelo «certificateSerial».

Nota: Se forem utilizados os Serviços Cloud da RetailForce, os certificados são registados automaticamente no portal FinanzOnline (Fon) (à são necessárias credenciais para o utilizador do serviço web da caixa registadora!); o ponto de extremidade só é necessário se o registo tiver de ser efetuado manualmente.

Cancela o registo do dispositivo de assinatura configurado no Fon (caso exista algum configurado) ou do dispositivo de assinatura identificado com o certificateSerial.

Atenção: utilize com precaução!

Valida o último documento assinado em DEP no FinanzOnline (Fon).

Valida o documento DEP (código QR) indicado no Fon.

Indica se a caixa registadora do cliente em questão está ativada no Fon.

Obrigatório para sistemas offline.

Registo do sistema de caixa registadora no Fon para o client em questão.

Obrigatório para sistemas offline.

Cancelar o registo da caixa registadora na Fon para o client em questão.

Necessário para sistemas offline.

Atenção: utilize com precaução!

Envia o comando de encerramento (Z) para a impressora fiscal.

Envia o comando de sincronização da hora (L) para a impressora fiscal.

Esta função pode ser utilizada para gerar o chamado relatório KLEN.

(a partir da v1.8.3)

Esta função é utilizada para imprimir

• relatórios detalhados e
• resumidos.

(a partir da v1.8.3)

Esta função é utilizada para gerar o chamado relatório BLOCK.

(a partir da v1.8.3)

Exporta o formato SAF-T da Dinamarca para o stream indicado.

Devolve todas as entradas do registo de auditoria solicitadas por data.

Devolve os arquivos armazenados localmente para encerramento.

Método para verificar o arquivo francês.

Devolve um conjunto de dispositivos TSE locais ligados e o respetivo estado.

Executa um autoteste síncrono para a caixa registadora indicada no TSE (a caixa registadora é opcional).

Efetua um teste de ligação ao TSE indicado.

Devolve todos os clientes registados no TSE do cliente indicado.

Devolve o estado do TSE. Caso não seja encontrado nenhum módulo fiscal, é devolvido o estado RetailForce.Fiscalisation.Implementation.
Germany.Tse.TseStatus.Critical.

Atualiza a hora no TSE para a hora real do computador.

Exporta os ficheiros tar do TSE principal.

Necessário para sistemas offline.

Exporta a taxonomia (DSFinV-K export) e devolve-a como um ficheiro para descarregar (formato zip).

Necessário para sistemas offline.

Devolve todas as transações ativas (iniciadas) no TSE.

Recomendado para acompanhar transações em aberto (todas as transações iniciadas têm de ser guardadas ou canceladas).

Cancela as transações ativas (iniciadas) no TSE.

Devolve o número de transações offline (= transações que não foram enviadas para o TSE devido a um TSE offline – avariado ou indisponível).

Devolve todas as assinaturas offline em aberto armazenadas para o TSE atual.

Processa as assinaturas offline em aberto.

Substitui um TSE atual do client indicado por um novo (por exemplo, se o TSE antigo estiver danificado ou se o certificado tiver expirado).

Executa um autoteste síncrono para a caixa registadora indicada no TSE (a caixa registadora é opcional).

Atualiza o firmware no dispositivo hardware TSE da Swissbit.

Devolve os ficheiros TicketBAI armazenados (ficheiros enviados, ficheiros de resposta, ficheiros de erro) num ficheiro zip.

Devolve os ficheiros TicketBAI armazenados relativos ao número de documento solicitado (ficheiros enviados, ficheiros de resposta, ficheiros de erro) num ficheiro zip.

Carrega um ficheiro de recibo digital para o sistema da Cloud.

Alternativa: Utilize este ponto de extremidade ou o ponto de extremidade alternativo apresentado nesta secção para enviar dados de recibos digitais.

Carrega um ficheiro digital para o sistema da Cloud. Utilizando Metadata de fiscalização.

Alternativa: Utilize este ponto de extremidade ou o ponto de extremidade alternativo nesta secção para enviar dados de recibos digitais.

Cria um documento na unidade de fiscalização. Este método não cria o documento propriamente dito, limitando-se a iniciar o processo, por exemplo, na TSE.

Armazena um documento na unidade de fiscalização.

Cancela um documento na unidade de fiscalização.

Método para registar o número de reimpressões de um documento utilizando o documento armazenado (referência: DocumentGuid).

Alternativa: em alternativa, utilize PUT /api/v1/transactions/reprintDocument

Método para armazenar a contagem de reimpressões de um documento, enviando novamente o documento. O utilizador do documento transferido deve ser o utilizador que efetua a reimpressão (não o utilizador do documento original).

Alternativa: em alternativa, utilize PUT /api/v1/transactions/reprintDocument/
{clientId}/{DocumentGuid}.

Reverte um documento (torna todos os valores negativos).

Valida o documento e devolve todos os erros de validação (e uma lista vazia, caso não haja erros de validação).

Envia o documento JSON ao serviço para validação do documento.

Devolve um documento inicial para o client indicado.

O documento de início é utilizado para inicializar o client, bem como a unidade fiscal (/api/v1/management/clients/initialize).

Apresenta texto no ecrã do cliente fiscal.

Apenas suportado em países que utilizam o visor fiscal do cliente. Noutros países, esta chamada não tem qualquer efeito (mas pode ser efetuada).

Abre a gaveta, caso esta esteja ligada à impressora fiscal.

Devolve os dados do código QR como uma string codificada em base 64 a partir dos dados.

Adiciona um registo de auditoria ao client fiscal.

Devolve todos os registos de auditoria consultados por fromDate/tillDate.

Devolve o documento solicitado, caso este se encontre armazenado no armazenamento interno.

Indica se o documento solicitado existe no repositório interno de documentos.

Devolve o documento solicitado, caso este se encontre armazenado no armazenamento interno.

Indica se o documento solicitado existe no repositório interno de documentos.

Devolve o último documento armazenado no repositório de documentos.

Devolve o documento solicitado, caso este se encontre armazenado no armazenamento interno.

Devolve a resposta do documento solicitado, caso este se encontre armazenado no armazenamento interno.

Devolve a resposta do documento solicitado, caso este se encontre armazenado no armazenamento interno.

Devolve o documento solicitado, caso este se encontre armazenado no armazenamento interno.