DELETE /api/v1/management/germany/ {clientId}/TSE/listTransactions – RetailForce

DELETE /api/v1/management/germany/{clientId}/TSE/listTransactions

pode ser utilizado para encerrar transações TSE em aberto.

Como regra geral, as transações não devem ser deixadas em aberto. Recomendamos que todas as transações em aberto sejam encerradas antes do encerramento diário, utilizando

POST /api/v1/transactions/storeDocument — caso tenha ocorrido uma venda, ou
POST /api/v1/transactions/cancelDocument — caso não tenha ocorrido qualquer venda.

Atenção: tenha em conta que os cancelamentos de documentos são (devem ser) também registados no TSE. Por conseguinte, é igualmente necessário concluir cada transação iniciada com PUT /api/v1/transactions/createDocument através de «storeDocument » ou «cancelDocument ». No caso de cancelamentos frequentes de documentos, não podemos excluir a possibilidade de as autoridades fiscais questionarem os motivos dos cancelamentos no âmbito de uma inspeção à caixa registadora .

Resultado

As transações TSE em aberto são encerradas coletivamente com o comando POST /api/v1/transactions/cancelDocument, sem necessidade de as encerrar individualmente.

Utilização

Recomendamos que utilize este ponto de extremidade com cautela e apenas em caso de erro.

A chamada gera, em primeiro lugar, uma consulta ao TSE para saber quais as transações em aberto. Os diferentes tipos de TSE (Cloud TSE, hardware TSE) não devolvem uma lista completa das transações em aberto, mas apenas «pacote a pacote»:

SWISSBIT HARDWARE TSE: 8 transações cada,
fiskal Cloud TSE: 100 transações cada

Após o TSE ter devolvido o pacote de transações em aberto, as transações nele contidas são encerradas através de um documento vazio, com as seguintes informações:

DocumentId: Guid gerado pelo serviço
DocumentNr: GUID gerado pelo serviço
DocumentGuid: GUID gerado pelo serviço
DocumentType: Recibo
documentTypeCaption: CancelTransaction

Caso existam mais transações em aberto para além das acima referidas, o ponto de extremidade deve ser chamado mais do que uma vez.

Todas as transações encerradas são igualmente armazenadas nos dados DSFinV-K.

Pré-requisitos

Existem transações em aberto (iniciadas), ou seja, não encerradas, na TSE.

Se for atingido um determinado número de transações em aberto, não é possível iniciar mais transações na TSE e a TSE reporta um erro. Pode encontrar mais informações sobre este assunto no artigo «Erro de ligação à TSE».

Pode obter o número de transações em aberto através do endpoint:

GET /api/v1/management/germany/{clientId}/TSE/listTransactions

Exemplo:

O TSE devolve o número de transações iniciadas no campo «startedTransactions».

{
   ...
   "startedTransactions": 512,
   "maxStartedTransactions": 512,
   ...
}

Nota: funciona apenas para hardware TSEs. O limite de transações abertas simultaneamente no Fiskaly Cloud TSE é de 2 000.

Campos do formulário

Devem ser transmitidas as seguintes informações:

Designação	Descrição	Exemplo
clientId	O uniqueClientId da caixa registadora (do RetailForce system).	c1062c55-57c4-4ed2-9c53-aff1762326a4

Respostas

Respostas possíveis:

Código	Descrição	Exemplo
200	fiscalResponse — as transações em aberto foram encerradas com sucesso (cancelDocument)	-
400	«TSE não ligado» — Não existe nenhum TSE ligado ao sistema nem atribuído ao client correspondente. Resolução de problemas: Verificar se o TSE está ligado ao sistema , por exemplo: com GET /api/v1/management/germany/tse	-
404	«Cliente não encontrado» — não existe qualquer configuração neste sistema com o clientId especificado Resolução de problemas: Verificar o clientId especificado Verifique se o clientId especificado está configurado no middleware (no ficheiro fiscalService.config.json, em C:\Program Files\RetailForce\Fiscal Webservice\Config)	-
422	«O clientId foi definido como Guid.Empty» Resolução de problemas:	-
500	«Erro interno do servidor» — Outro erro. Resolução de problemas: repita a chamada, reinicie o serviço, se necessário, execute CloudConnect.	-

Atenção: Independentemente da forma como o erro foi resolvido, recomendamos que analise cuidadosamente a razão pela qual as transações TSE permanecem em aberto. No processo normal de encerramento, todas as transações em aberto devem ser encerradas antes do encerramento diário.

Este artigo foi traduzido automaticamente.

Resultado

Utilização

Pré-requisitos

Campos do formulário

Respostas

Artigos relacionados