POST /api/v1/archive/de/{clientId} – RetailForce

A área ARCHIVE da API do middleware (swagger) é utilizada para transmitir (e descarregar) dados para o RetailForce Secure Archive sem recorrer à fiscalização.

A utilização das funções/pontos finais nesta área só é necessária se a fiscalização estiver desativada através do RetailForce Middleware, ou seja, se NÃO for utilizada.

Para o arquivo de dados no âmbito da fiscalização, é necessária apenas uma licença correspondente (atribuição através da configuração). O envio de dados fiscais para o arquivo na Cloud é, então, tratado automaticamente pelo middleware fiscal.

POST /api/v1/archive/de/{clientId}

é utilizado para transferir dados para o arquivo na RetailForce Cloud.

Resultado

Uma chamada bem-sucedida ao ponto de extremidade (200) transmitiu os dados correspondentes para o Arquivo Seguro.

Utilização

Sempre que for necessário transmitir dados para o arquivo para efeitos de cópia de segurança.

Pré-requisitos

O middleware RetailForce (Fiscal) deve estar instalado e
o Client tiver sido inicializado,

Pedido

Campos do formulário

Devem ser enviados os seguintes parâmetros:

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

Request body

Os dados a transmitir para o arquivo devem ser especificados em conformidade. Isto é feito através da payload descrita abaixo na solicitação.

Exemplo:

[
  {
    "type": 0,
    "container": "string",
    "entity": "string",
    "recursive": true
  }
]

Informações na coluna «Tipo»:

M ... obrigatório / exigido
M* ... obrigatório / exigido em determinados países ou sob determinadas condições
R ... recomendado
O... opcional

Elementos	Tipo	Descrição
tipo	M	Definição do tipo de dados a transferir para o arquivo. Tipos: 0 ... DSFinV-K (JSON) 1 ... DSFinV-K (CSV) 2 ... Dados de cópia de segurança (diversos) Nota: Os tamanhos dos ficheiros estão limitados da seguinte forma: Tipo 0: 200 kB Tipo 1: 200 kB Tipo 2: 10 MB
contentor	M*	O nome (designação) do contentor (ficheiro .zip) Nota: APENAS se Tipo = 2 («type»: 2,)
entidade	M*	Dados a transferir para o arquivo (ficheiro ou pasta!).
recursivo	M*	true se as subpastas também tiverem de ser transmitidas; caso contrário, falso. Não aplicável se a entidade NÃO for uma pasta! Nota: APENAS se Tipo = 2 («type»: 2,)

Resposta

Respostas possíveis:

Código	Descrição	Exemplo
200	Os dados foram transmitidos com sucesso	-

Este artigo foi traduzido automaticamente.