8. Webhooks

Sistema de notificaciones y WebHook
En FEBOS TODO lo que ocurre sobre un documento genera registros y su respectiva bitácora,
por lo que para que los sistemas externos a FEBOS que
utilice la empresa se enteren de estos eventos sé ha desarrollado un sistema de WebHook

¿Que es un WebHook?

Los WebHook son un termino adoptado en el desarrollo para realizar callbacks HTTP de usuario
, cuando esto ocurre, el sistema envía una petición HTTP a una url configurada, en donde ademas se puede adjuntar un
token de acceso o autenticación básica (Usuario / contraseña)

¿Como funcionan esto WebHook?

Dentro de FEBOS se pueden configurar reglas de notificación para ciertos tipos de eventos generados,
estas reglas pueden verificar si ciertos campos del documento cumplen con los valores requeridos, EJ:

DOCUMENTO CON MONTO MAYOR A 2.000.000 DONDE EL EMISOR ESTE EN MI LISTA DE CLIENTES VIP

Si la anterior regla se cumple es momento de que se ejecute u la regla tiene configurado un WebHook
se realiza un llamado REST a la url configurado en donde el sistema externo puede por ejemplo enviar
un correo al emisor solicitando información extra.

Ciclo de Vida del WebHook

Estructura de solicitud

DESCARGAR ESQUEMA DE SOLICITUD PARA RECONSTRUCCION DE DTO|

{
    "evento": {
      "id": "30f1c65227cde041c11b7942cebe3540bbc4",
      "tipoCodigo": 33,
      "tipoDescripcion": "VISUALIZACION PDF",
      "tipoVistaCodigo": 12,
      "tipoVistaDescripcion": "EMPRESA_RECEPTORA",
      "mensaje": "Descripción de evento",
      "seguimientoId": "30f1c65227cde041c11b7942cebe3540bbc4",
      "fechaEvento": "2018-01-18 14:23:12.956",
      "ambiente": "pruebas"
    },
    "usuario": {
      "id": "30f1c65227cde041c11b7942cebe3540bbc4",
      "nombre": "Juan Perez",
      "correo": "usuario@dominio.tld",
      "rut": "12345678-5"
    },
    "documento": {
      "clasificacion": "DTE",
      "febosid": "30f1c65227cde041c11b7942cebe3540bbc4",
      "linkXmlOriginal": "https://archivos.febos.io/temporal/30f1c65227cde041c11b7942cebe3540bbc4.xml",
      "linkXmlAlterado": "https://archivos.febos.io/temporal/30f1c65227cde041c11b7942cebe3540bbc4.cpsf.xml",
      "linkJson": "https://archivos.febos.io/temporal/30f1c65227cde041c11b7942cebe3540bbc4.json",
      "datos": {
        "tipoCodigo": "1",
        "tipoDescripcion": "Factura Electrónica",
        "fechaEmision": "2018-01-01",
        "montoNeto": 100,
        "montoExento": 900,
        "iva": 19,
        "montoTotal": 1000
      },
      "estado": {
        "fechaRecepcion": "2018-01-01",
        "fechaRecepcionSii": "2018-01-01",
        "estadoComercial": "0",
        "estadoComercialDescripcion": "Sin Accion",
        "estadoSii": "4",
        "estadoSiiDescripcion": "Aceptado",
        "siiFechaAceptacion": "2018-01-01",
        "siiFechaRechazo": "2018-01-01",
        "siiFechaDevolucionParcial": "2018-01-01",
        "siiFechaDevolucionTotal": "2018-01-01"
      },
      "emisor": {
        "rut": "98765432-1",
        "razonSocial": "Servicios Informaticos IA Solutions Ltda."
      },
      "receptor": {
        "rut": "98765432-1",
        "razonSocial": "Comercial Serena 400"
      }
    }
  }

Evento

La sección evento dentro de el objeto enviado representa el evento registrado en FEBOS que gatillo la acción a notificar.

Ver tabla de campos

CAMPO	EJEMPLO	DESCRIPCION
id	30f1c65227cde041c11b7942cebe3540bbc4	UUID que identifica el evento notificado
tipoCodigo	33 (Ver tabla abajo)	Codigo del Tipo de evento notificado
tipoDescripcion	VISUALIZACION PDF	Descripción del tipo evento notificado
tipoVistaCodigo	12	Tipo de visualización del evento en la bitácora
tipoVistaDescripcion	EMPRESA_RECEPTORA	Descripción de tipo de visualización
mensaje	Descripción de evento	Mensaje escrito registrado para el evento
seguimientoId	30f1c65227cde041c11b7942cebe3540bbc4	Id de seguimiento donde se registro el evento
fechaEvento	2018-01-18 14:23:12.956	Fecha y Hora en que se registro el evento
ambiente	pruebs	Ambiente donde se produjo el evento

tipoCodigo

La sección tipoCodigo dentro de el objeto enviado representa el tipo de evento que ocurre con el documento

Ver tabla de tipos de codigo

id	DESCRIPCION
4	Cuando se recepciona una Boleta de Honorario Electrónica
6	Cuando el documento fue enviado al SII
10	Cuando el documento fue aceptado por el SII
11	Cuando el documento fue aceptado con reparos por el SII
12	Cuando el documento fue rechazado por el SII
13	Cuando el documento fue enviado al receptor electrónico
14	Cuando el documento fue enviado a un receptor personalizado
15	Cuando el receptor emite un acuse de recibo
16	Cuando el receptor indica que no recibió el documento
17	Cuando el receptor ACEPTA comercialmente el documento
19	Cuando el receptor RECHAZA comercialmente el documento
20	Cuando el receptor acusa recibo de mercaderías o servicios
21	Cuando el receptor acuse recibo PARCIAL de mercaderías
22	Cuando el receptor hace DEVOLUCIÓN TOTAL de mercaderías
23	Cuando el receptor hace DEVOLUCIÓN PARCIAL de mercaderías
38	Cuando se recepciona un documento, pero aún no está verificado en el SII
39	Cuando se recepciona un documento y está APROBADO por el SII
40	Cuando se recepciona un documento NO APROBADO por el SII
42	Cuando el documento fue consultado y encontrado en el SII
44	Cuando un documento fue CEDIDO
45	Cuando la cesión de un documento fue RECHAZADA
46	Cuando se actualiza la información de pago de un documento
63	Envió ERP Manual
65	Vencimiento Boleta Garantía
100	Cuando un documento es marcado como PAGADO
109	Cuando se integra un DTE

Usuario

Identificación del usuario que registra la acción del evento

CAMPO	EJEMPLO	DESCRIPCION
id	30f1c65227cde041c11b7942cebe3540bbc4	UUID que identifica al usuario dentro del sistema
nombre	Juan Perez	Nombre registrado para el usuario
correo	correo@dominio.io	Correo registrado para el usuario
rut	12345678-5	Rut registrado para el usuario

Documento

Datos del documento afectado en el evento

CAMPO	EJEMPLO	DESCRIPCION
febosid	30f1c65227cde041c11b7942cebe3540bbc4	UUID que identifica el documento dentro del sistema
clasificacion	DTE	Clasificación del documento (DTE o DNT)
linkXml	https://archivos.febos.io/temporal/...4.xml	Ruta donde se puede obtener el xml del documento si esta disponible
linkJson	https://archivos.febos.io/temporal/...4.json	Ruta donde se puede obtener el json del documento si esta disponible

Inportante: Las URL de archivos disponibles solo son validas por un periodo de 24 horas desde su creación

Datos

CAMPO	EJEMPLO	DESCRIPCION
tipoCodigo	33	Código del tipo de documento
tipoDescripcion	Factura electronica Afecta	Descripción del tipo de documento
fechaEmision	2018-01-01	Fecha de emisión del documento
montoNeto	123456	Monto afecto a iva del documento
montoExento	12345	Monto exento de iva del documento
iva	12345	Monto del iva del documento
montoTotal	12345	Monto total del documento

Emisor

CAMPO	EJEMPLO	DESCRIPCION
rut	98765432-1	RUT de la empresa emisora
razonSocial	Febos S.A.	Razón Social de la empresa emisora

Receptor

CAMPO	EJEMPLO	DESCRIPCION
rut	98765432-1	RUT de la empresa receptora
razonSocial	Comercial Serena 400	Razón Social de la empresa receptora

8. Webhooks

¿Que es un WebHook?#

¿Como funcionan esto WebHook?#

Ciclo de Vida del WebHook#

Estructura de solicitud#

Evento#

tipoCodigo#

Usuario#

Documento#

Inportante: Las URL de archivos disponibles solo son validas por un periodo de 24 horas desde su creación#

Datos#

Emisor#

Receptor#