Este ponto de extremidade constitui o primeiro passo na transmissão de transações do sistema de registo eletrónico («caixa registadora») para o Serviço Fiscal. O processo consiste sempre em duas etapas. Este processo de transmissão de transações em duas etapas baseia-se nos requisitos do Regulamento contra a Adulteração de Caixas Registadoras na Alemanha e deve ser executado em todos os países com regime fiscal, no sentido de uma interface padronizada. Na Alemanha, quando é chamada a chamada PUT /api/v1/transactions/createDocument, uma transação é registada no chamado Dispositivo Técnico de Segurança (TSE/TSS).
Registo da transação
Uma transação/documento é registada na unidade fiscal:
- PUT /api/v1/transactions/createDocument e
- POST /api/v1/transactions/storeDocument
Anulação da transação
Isto regista a conclusão de uma transação na unidade fiscal:
- PUT /api/v1/transactions/createDocument e
- POST /api/v1/transactions/cancelDocument
Nota: todas as transações iniciadas com PUT /api/v1/transactions/createDocument devem ser encerradas com POST /api/v1/transactions/storeDocument ou POST /api/v1/transactions/cancelDocument! Tenha em atenção listTransactions (DELETE).
Resultado
Uma chamada bem-sucedida ao ponto de extremidade (200)
- regista o início de uma transação na unidade fiscal e
- retorna uma «fiscalResponse» ao sistema a montante (sistema de registo eletrónico).
Utilização
- sempre que for necessário enviar uma nova transação para a unidade fiscal, antes de executar POST /api/v1/transactions/storeDocument ou POST /api/v1/transactions/cancelDocument.
Pré-requisitos
- Fiskal Client inicializado
Campos do formulário
Devem ser enviadas as seguintes informações:
| Designação | Tipo | Descrição | Exemplo |
| clientId | M |
O uniqueClientId da caixa registadora (do RetailForce system). | c1062c55-57c4-4ed2-9c53-aff1762326a4 |
| documentType | M |
O tipo de documento a registar. Enumeração:
|
- |
| DocumentGuid | R |
O GUID/UUID atribuído à transação pelo sistema POS. Comportamento do «DocumentGuid» incluído no pedido:
Comportamento SEM «DocumentGuid» na solicitação:
Nota: O mesmo «DocumentGuid» deve também ser utilizado na chamada subsequente para POST /api/v1/transactions/storeDocument. |
b5744d8c-71ec-4ea0-a340-53070da8b5a1 |
Resposta
Respostas possíveis:
| Código | Descrição | Exemplo |
| 200 | A transação foi iniciada e foi devolvida uma «fiscalResponse» ao sistema a montante | - |
Este artigo foi traduzido automaticamente.
Comentários
0 comentários
iniciar sessão para comentar.