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

El área ARCHIVE de la API de middleware (Swagger) se utiliza para transmitir (y descargar) datos al RetailForce Secure Archive sin utilizar la fiscalización.

El uso de las funciones o puntos finales de esta área solo es necesario si la fiscalización está desactivada a través del RetailForce Middleware, es decir, si NO se utiliza.

Para el archivo de datos en el marco de la fiscalización, solo se requiere la licencia correspondiente (asignación mediante configuración). La carga de los datos fiscales al archivo en la nube la gestiona entonces automáticamente el middleware fiscal.

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

se utiliza para transferir datos al archivo en la nube de RetailForce Cloud.

Resultado

Una llamada correcta al punto final (200) ha transmitido los datos correspondientes al archivo seguro.

Uso

Cada vez que se deban transmitir datos al archivo para su copia de seguridad.

Requisitos previos

RetailForce Middleware (Fiscal) instalado y
el cliente haya sido inicializado,

Solicitud

Campos del formulario

Deben enviarse los siguientes parámetros:

Cargo	Descripción	Ejemplo
clientId	El «uniqueClientId» de la caja registradora (del RetailForce system).	c1062c55-57c4-4ed2-9c53-aff1762326a4

Cuerpo de la solicitud

Los datos que se van a transmitir al archivo deben especificarse adecuadamente. Esto se realiza mediante la payload que se describe a continuación en la solicitud.

Ejemplo:

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

Información de la columna «Tipo»:

M ... obligatorio / requerido
M* ... obligatorio / requerido en determinados países o bajo determinadas condiciones
R ... recomendado
O... opcional

Elementos	Tipo	Descripción
tipo	M	Definición del tipo de datos que se van a transferir al archivo. Tipos: 0 ... DSFinV-K (JSON) 1 ... DSFinV-K (CSV) 2 ... Datos de copia de seguridad (varios) Nota: Los tamaños de los archivos están limitados de la siguiente manera: Tipo 0: 200 kB Tipo 1: 200 kB Tipo 2: 10 MB
contenedor	M*	El nombre (denominación) del contenedor (archivo .zip) Nota: SOLO si Tipo = 2 («type»: 2,)
entidad	M*	Datos que se van a transferir al archivo (¡archivo o carpeta!).
recursivo	M*	«true» si también se deben transmitir las subcarpetas; en caso contrario, «false». No aplicable si la entidad no es una carpeta. Nota: SOLO si Tipo = 2 («type»: 2,)

Respuesta

Respuestas posibles:

Código	Descripción	Ejemplo
200	Los datos se han transmitido correctamente	-

Este artículo ha sido traducido automáticamente.