Servicio fiscal de RetailForce: descripción de la API

Contabiliza el saldo inicial para un informe de cierre de caja. Solo contabiliza un ingreso; no reajusta el saldo de caja.

Alternativa: Como alternativa, la caja registradora también puede contabilizar un documento: documentType [11] = PayIn.

Contabiliza una diferencia de caja en el sistema de fiscalización.

Alternativa: Como alternativa, la caja registradora también puede contabilizar un documento con BusinessTransactionType [91] = CashDifference.

Contabiliza una transferencia de fondos desde el sistema de caja registradora al banco (o cualquier otro destino).

Devuelve el saldo real de los pagos de un cliente específico. Este se calcula a partir de los documentos transmitidos (además de los recibos de ventas y devoluciones, los ingresos y las retiradas, etc.).

Verifica el saldo real de los pagos de esta caja registradora y devuelve una lista de pagos con diferencia (o una lista vacía si no hay diferencia).

Cierra la jornada actual con un informe de cierre.

El cierre se realiza en función de los documentos enviados al cliente desde el último cierre. El sistema de caja registradora no recibe ningún resumen de cierre a cambio.

Devuelve el documento de fin de jornada correspondiente al día actual.

El documento devuelto debe almacenarse (storeDocument > documentType 99).

Devuelve la fecha y la hora del último cierre de un cliente específico (terminal)

Devuelve información sobre si es necesario realizar un cierre diario en un terminal concreto. (Dependiendo de RetailForce.Fiscalisation.Implementation.
IFiscalCountryProperties.
MaximumHourIntervalForClosing).

Crea un nuevo cliente en el almacén de configuraciones. El objeto de configuración debe ser preparado por el sistema POS.

La configuración del cliente es necesaria para su funcionamiento. Utilice este punto final o bien:

• PUT /api/v1/management/clients, o
• 
  PUT /api/v1/management/clients/byCloud/ID.

Actualiza una configuración de cliente creada por el sistema de punto de venta en el almacén de configuraciones.

Devuelve todos los clientes que figuran en el almacén de configuración.

También puede utilizarse cuando se emplea la configuración en Cloud.

Crea un nuevo cliente con una configuración preparada en la nube o carga un cliente ya existente.

Se requiere la configuración de un client para su funcionamiento. Utilice cualquiera de los siguientes:

• este punto final, o
• PUT /api/v1/management/clients, o
• 
  PUT /api/v1/management/clients/byCloud/ID.

Crea un cliente cargando los datos de configuración desde la Cloud.

Alternativa: punto de conexión alternativo a PUT /api/v1/management/clients y PUT /api/v1/management/clients/byCloud.

Actualiza la configuración del cliente obteniendo dicha configuración de Cloud.

Se emplea cuando la configuración preparada en la Cloud se ha actualizado y el client fiscal debe descargarla de nuevo (actualización).

Crea un nuevo cliente en la gestión del módulo fiscal y añade dicho cliente a la configuración en la Cloud.

El cliente se crea en el almacén de configuración local y, a continuación, el objeto de configuración se carga en el sistema Cloud.

Nota: El distribuidor debe estar configurado en los datos del cliente y debe tener permiso para crear nuevos clientes.

Establece la conexión en la Cloud del cliente específico y carga el módulo fiscal de confianza en la caché.

Requerido para sistemas que utilizan funciones en la nube.

Es necesario tras cada reinicio del sistema TPV.

Actualiza la clave de licencia actual en la configuración del cliente fiscal (también en disco). Es obligatorio si se han modificado las licencias en la configuración de Cloud.

Método para iniciar o detener el procesamiento de la cola en la Cloud (para todos los clients).

El comando «Stop» detiene el procesamiento una vez finalizada la carga en curso.

La orden «Start» inicia el procesamiento de la cola de inmediato.

Si se detiene el procesamiento de la cola en Cloud, deberá reiniciarlo, a menos que se reinicie el servicio (en cuyo caso, el procesamiento en Cloud se activará de nuevo).

Devuelve la configuración de un cliente específico.

Elimina un cliente específico

Advertencia: utilizar con precaución.

Devuelve el ID único del cliente para los parámetros solicitados.

Se pueden utilizar diferentes parámetros para solicitar el «uniqueClientId».

Devuelve el ID de consumidor de la licencia correspondiente a la identificación de empresa indicada.

Solo se devuelven los «LicenseConsumerId» que ya se encuentran almacenados en el almacén de configuración.

Valida la información del cliente especificada para cumplir con la configuración específica del país necesaria.

Se emplea para validar una configuración generada por el sistema de punto de venta antes de invocar /api/v1/management/clients.

La validación de la configuración en la nube se realiza en el sistema de Cloud.

Inicializa la unidad de fiscalización (así como el hardware correspondiente y la posible declaración a las autoridades fiscales).

La inicialización se realiza mediante el recibo de inicio (recibo inicial), que puede consultarse mediante el punto final GET /api/v1/transactions/document/
{clientId}/start, o bien el documento de inicio es creado por el sistema de caja registradora.

Migración de un cliente desde otro proveedor de fiscalización.

Se emplea al migrar desde un proveedor de middleware fiscal distinto a RetailForce.

Tenga en cuenta los sistemas compatibles.

Migración de un cliente desde otro proveedor de servicios de fiscalización y realización de una importación de archivos.

Tenga en cuenta los sistemas compatibles.

Darse de baja como cliente fiscal (y, en su caso, el hardware correspondiente, así como la posible notificación a las autoridades fiscales).

Carga un Support Package (archivos de registro) en la Cloud para el cliente indicado.

Este punto final es necesario para poder utilizar la función «Subir Support Package» en el sistema Cloud.

Realiza una copia de seguridad del cliente con el nombre de archivo especificado (copia de seguridad en formato ZIP).

Si se está utilizando la carga a Cloud, el procesamiento de la cola de Cloud se detendrá y se reiniciará (y la cola de Cloud se reinicializará).

Importante: Si el cliente no se elimina, el procesamiento de la cola en Cloud se reanudará tras la copia de seguridad. Si existen archivos que no se hayan incluido en la copia de seguridad, estos también formarán parte de ella y es posible que se carguen dos veces en caso de restaurar el cliente.

Restaura un cliente (con todos sus datos) a partir del archivo ZIP de copia de seguridad especificado.

Crea un nuevo cliente con la configuración de la nube o carga un cliente ya existente.

Crea un nuevo cliente con la configuración de la Cloud o carga un cliente ya existente.

Genera un nuevo ID global único para el cliente en cuestión, o devuelve uno ya existente. Además, se activa la emisión del «retailForceReceiptId» para dicho cliente.

Almacena un certificado externo en el almacén de certificados del módulo fiscal.

Requerido para sistemas que NO utilicen las funciones de RetailForce Cloud en países con régimen fiscal en los que se utilicen certificados de software en el contexto de la fiscalización (Eslovenia, Croacia, España, etc.)

Devuelve si el cliente solicitado dispone de la licencia de acceso solicitada.

Indica si el cliente solicitado dispone de la licencia solicitada.

Genera una clave de usuario AES para este cliente y la devuelve. La clave AES también se almacenará en la configuración del cliente.

Nota: La clave de usuario AES la generará automáticamente el cliente fiscal. Este punto de acceso solo es necesario si la clave AES debe generarse manualmente.

Devuelve la clave AES para el cliente indicado.

Exporta todas las líneas de recibos de los datos almacenados en el Registro de Recopilación de Datos local (DEP §7 RKSV).

Requerido para sistemas fuera de línea (sistemas que NO utilizan el archivo en la Cloud de datos fiscales).

Exporta todos los datos solicitados para el protocolo DEP131 (DEP §131 BAO) a partir de los datos almacenados localmente.

Devuelve el recibo inicial de este cliente.

El sistema de caja registradora debe poder proporcionar el recibo inicial (recibo de inicio) previa solicitud durante una auditoría fiscal; si el sistema de punto de venta no ha almacenado dicho recibo, este puede solicitarse mediante este punto de acceso.

Devuelve todos los recibos mensuales correspondientes al periodo solicitado.

El sistema de caja registradora debe poder facilitar los recibos mensuales cuando se soliciten durante una auditoría fiscal; si el sistema de punto de venta no ha almacenado dichos documentos, pueden solicitarse mediante este punto final.

Devuelve todos los dispositivos de firma e indica si están activados en FinanzOnline (Fon) o no.

Registra el dispositivo de firma configurado en FON (si existe alguno configurado) o el dispositivo de firma identificado mediante certificateSerial.

Nota: Si se utilizan los servicios en la nube de RetailForce, los certificados se registran automáticamente en el portal FinanzOnline (Fon) (¡se requieren credenciales para el usuario del servicio web del punto de venta!); el punto final solo es necesario si el registro debe realizarse de forma manual.

Da de baja el dispositivo de firma configurado en Fon (si hay alguno configurado) o el dispositivo de firma identificado con certificateSerial.

Atención: utilizar con precaución.

Valida el último documento firmado en DEP en FinanzOnline (Fon).

Valida el documento DEP (código QR) especificado en Fon.

Devuelve si la caja registradora del cliente actual está activada en Fon.

Requerido para sistemas sin conexión.

Registro del sistema de caja registradora en FON para el cliente actual.

Obligatorio para sistemas sin conexión.

Darse de baja de la caja registradora en Fon para el cliente en cuestión.

Requerido para sistemas sin conexión.

Advertencia: utilizar con precaución.

Envía el comando de cierre (Z) a la impresora fiscal.

Envía el comando de sincronización de la hora (L) a la impresora fiscal.

Esta función puede utilizarse para generar el denominado informe KLEN.

(a partir de la versión 1.8.3)

Esta función se utiliza para generar

• informes detallados y
• resumidos de un periodo determinado.

(a partir de la versión 1.8.3)

Este punto de entrada se emplea para generar lo que se denomina informe BLOCK.

(a partir de la v1.8.3)

Exporta el formato SAF-T de Dinamarca al stream indicado.

Devuelve todas las entradas del registro de auditoría solicitadas por fecha.

Devuelve los archivos almacenados localmente para su cierre.

Método para verificar el archivo francés.

Devuelve una matriz con los dispositivos TSE locales conectados y su estado.

Ejecuta una autocomprobación sincrónica para la caja registradora indicada en el TSE (la caja registradora es opcional).

Realiza una prueba de conexión con el TSE especificado.

Devuelve todos los clientes registrados en el TSE del cliente especificado.

Devuelve el estado del TSE. Si no se encuentra ningún módulo fiscal, se devuelve el estado RetailForce.Fiscalisation.Implementation.
Germany.Tse.TseStatus.Critical.

Actualiza la hora del TSE a la hora real del ordenador.

Exporta los archivos tar desde el TSE principal.

Imprescindible para sistemas sin conexión.

Exporta la taxonomía (DSFinV-K export) y la devuelve como un archivo de descarga (formato zip).

Imprescindible para sistemas sin conexión.

Devuelve todas las transacciones activas (iniciadas) en la TSE.

Se recomienda para realizar un seguimiento de las transacciones abiertas (todas las transacciones iniciadas deben almacenarse o cancelarse).

Cancela las transacciones activas (iniciadas) en el TSE.

Devuelve el número de transacciones fuera de línea (= transacciones que no se han enviado a TSE debido a que TSE se encuentra fuera de línea —no disponible—).

Devuelve todas las firmas fuera de línea pendientes almacenadas para el TSE actual.

Procesa las firmas fuera de línea abiertas.

Sustituye un TSE actual del cliente determinado por uno nuevo (por ejemplo, si el TSE antiguo está dañado o el certificado ha caducado).

Ejecuta una autocomprobación sincrónica para la caja registradora indicada en el TSE (la caja registradora es opcional).

Actualiza el firmware del dispositivo SWISSBIT HARDWARE TSE.

Devuelve los archivos «TicketBAI» almacenados (archivos enviados, archivos de respuesta y archivos de error) en un archivo ZIP.

Devuelve los archivos «TicketBAI» almacenados correspondientes al número de documento solicitado (archivos enviados, archivos de respuesta y archivos de error) en un archivo zip.

Carga un archivo de recibo digital en el sistema Cloud.

Alternativa: utilice este punto final o el punto final alternativo que figura en esta sección para enviar datos de recibos digitales.

Carga un archivo digital en el sistema de Cloud. Utilizando los Metadata de fiscalización.

Alternativa: utilice este punto final o el punto final alternativo que figura en esta sección para enviar datos de recibos digitales.

Crea un documento en la unidad de fiscalización. Este método no genera el documento en sí, sino que simplemente inicia el proceso, por ejemplo, en la TSE.

Almacena un documento en la unidad de fiscalización.

Cancela un documento en la unidad de fiscalización.

Método para persistir el recuento de reimpresiones de un documento utilizando el documento almacenado (referencia: DocumentGuid).

Alternativa: también puede utilizar PUT /api/v1/transactions/reprintDocument

Método para almacenar el recuento de reimpresiones de un documento reenviando dicho documento. El usuario del documento reenviado debe ser el usuario que realiza la reimpresión (no el usuario del documento original).

Alternativa: también puede utilizar PUT /api/v1/transactions/reprintDocument/
{clientId}/{DocumentGuid}.

Revierte un documento (convierte todos los valores en negativos).

Valida el documento y devuelve todos los errores de validación (o una lista vacía si no existen errores).

Envía el documento JSON al servicio para su validación.

Devuelve un documento de inicio para el cliente indicado.

El documento de inicio se emplea para inicializar tanto al cliente como a la unidad fiscal (/api/v1/management/clients/initialize).

Muestra el texto en la pantalla fiscal del cliente.

Solo es compatible en países que utilizan una pantalla fiscal para clientes. En otros países, esta llamada no tiene ningún efecto (aunque se puede realizar).

Abre el cajón si este está conectado a la impresora fiscal.

Devuelve los datos del código QR como una string codificada en base 64 a partir de los datos.

Añade un registro de auditoría al cliente fiscal.

Devuelve todos los registros de auditoría filtrados por fromDate/tillDate.

Devuelve el documento solicitado si se encuentra almacenado en el almacenamiento interno.

Indica si el documento solicitado existe en el almacén interno de documentos.

Devuelve el documento solicitado si se encuentra almacenado en el almacén interno.

Indica si el documento solicitado existe en el almacén interno de documentos.

Devuelve el último documento almacenado en el almacén de documentos.

Devuelve el documento solicitado si se encuentra almacenado en el almacenamiento interno.

Devuelve la respuesta del documento solicitado si se encuentra almacenado en el almacenamiento interno.

Devuelve la respuesta del documento solicitado si se encuentra almacenado en el almacenamiento interno.

Devuelve el documento solicitado si se encuentra almacenado en el almacenamiento interno.