GET /api/v1/transactions/document/ {clientId}/start – RetailForce

Utilização do ponto de extremidade

GET /api/v1/transactions/document/{clientId}/start,

é gerado pelo serviço fiscal um documento denominado «documento inicial» (documento de início) e devolvido ao sistema a montante.

Os documentos iniciais são documentos específicos de cada país que são utilizados para inicializar (colocar em funcionamento) a unidade fiscal.

Alguns países exigem, por lei, a existência de um documento inicial, conforme ilustrado na tabela abaixo.

País	Designação	DocumentType
Áustria	«Startbeleg» — recibo inicial	[1000] = Recibo nulo
Lituânia	relatório inicial (Z)	[99] = EndOfDay

A chamada GET /api/v1/transactions/document/{clientId}/start gera sempre o documento inicial exigido no respetivo país.

Importante: No que diz respeito à interface normalizada, a inicialização de um client fiscal ocorre sempre através do processo descrito no artigo em ligação. Por conseguinte, deve ser transmitido um documento de início ao serviço fiscal de cada país.

Nota: em alternativa à utilização do ponto de extremidade GET /api/v1/transactions/document/{clientId}/start, o respetivo documento de início também pode ser gerado pelo próprio sistema a montante (sistema de registo eletrónico).

Resultado

Se o processamento for bem-sucedido (200), o respetivo client fiscal devolve um documento inicial ao sistema anterior.

Utilização

Uma única vez, no âmbito da ativação de um Cliente Fiscal.

Pré-requisitos

Middleware fiscal instalado,
Fiscal Client criado e configurado, quer através de
- PUT /api/v1/management/clients ou
- PUT /api/v1/management/clients/byCloud
CloudConnect executado com sucesso (apenas para sistemas ligados à RetailForce Cloud).

Campos do formulário

Devem ser enviadas as seguintes informações:

Designação	Descrição	Exemplo
clientId	O uniqueClientId da caixa registadora (do RetailForce system).	c1062c55-57c4-4ed2-9c53-aff1762326a4
BookDate	Opcional: a data de lançamento do documento inicial	2023-05-19T10:30:04.297Z

Resposta

Respostas possíveis:

Código	Descrição	Exemplo
200	Documento inicial específico do país	-

Este artigo foi traduzido automaticamente.