Propósito:
Este servicio web permite extraer datos de las bóvedas de bFiskur de forma programática. Es un servicio con costo extra.
Punto Final (Endpoint):
https://bfiskurapp.bitam.com/robots/bFiskurDwnAPI/index.php
Parámetros Requeridos:
- rfc:(cadena) RFC de la empresa cuyos datos se extraerán.
- NOTA: solo se pueden extraer datos de un RFC al que el usuario utilizado en la autentificación tenga acceso.
- boveda: (cadena) Tipo de bóveda (emitidos o recibidos) de donde se extraerán los datos.
- Apikey: La llave de acceso expedida por bFiskur. Ejemplo:
- 7a3b1c9d-ef01-2g3h-4i5j-klm6nopqrstuvwxyz (llave invalida con propósito ilustrativo)
Parámetros Opcionales:
- fechaIni: (cadena) Fecha inicial del rango de fechas a extraer (formato ISO 8601, ej: 2024-01-01). Si se omite, se utilizan los últimos 2 días por defecto.
- fechaFin: (cadena) Fecha final del rango de fechas a extraer (formato ISO 8601). Si se omite, se utilizan los últimos 2 días por defecto.
- filtrorfc: (cadena) RFC del proveedor (para bóveda de recibidos) o del cliente (para bóveda de emitidos) para filtrar resultados.
Autenticación:
- Autenticación: para poder acceder a la información debe de proporcionarse un usuario válido de bFiskur. Este usuario y contraseña se deben enviar en el header del llamado.
- Concurrencia: Debido a las licencias de bFiskur, solo se puede tener una sesión activa por usuario. Para evitar conflictos, programa el servicio para que se ejecute fuera de las horas pico o utiliza una licencia dedicada.
Formato de Respuesta:
El formato de respuesta es JSON
Respuesta del Web Service
La respuesta del Web Service será en formato JSON y contendrá los siguientes campos para cada registro encontrado:
Para la bóveda de Emitidos:
- RFC Emisor
- Empresa
- UUID
- Estatus
- Tipo Documento
- Fecha Emisión
- Serie
- Folio
- Fecha Timbrado
- Fecha Cancelación
- Causa Cancelación
- UUID DR
- Lugar de Expedición
- Método de Pago
- Forma de Pago
- Uso CFDI
- Régimen Fiscal
- RFC Receptor
- Razon Social
- Tipo de Cambio DOF
- Tipo de Cambio
- Moneda
- Subtotal
- IVA Trasladado
- ISR Retenido
- IVA Retenido
- Total
Para la bóveda de Recibidos:
- RFC Receptor
- Empresa
- UUID
- Estatus
- Tipo Documento
- Fecha
- Serie
- Folio
- Fecha Timbrado
- Fecha Cancelación
- Causa Cancelación
- UUID DR
- Estatus Pago
- Lugar de Expedición
- Método de Pago
- Forma de Pago
- Uso CFDI
- Régimen Fiscal
- RFC Emisor
- Razon Social Emisor
- Tipo de Cambio DOF
- Tipo de Cambio
- Moneda
- Subtotal
- IVA Trasladado
- ISR Retenido
- IVA Retenido
- IEPS Trasladado
- Imp Local Retenido
- Imp Local Trasladado
- Total
Nota: Todos los campos fecha se manejaran en el formato internacional (formato ISO 8601).
Ejemplos del llamado al WebService
- Extraer todos los datos de la bóveda de emitidos para la empresa "SOLC980809D90" del 1 de enero de 2024 al 5 de enero de 2024, filtrando por el cliente "RESA150893E78":
https://bfiskurapp.bitam.com/robots/bFiskurDwnAPI/index.php?rfc=SOLC980809D90&boveda=emitidos&fechaIni=2024-01-01&fechaFin=2024-01-05&filtrorfc=RESA150893E78&apikey=7a3b1c9d-ef01-2g3h-4i5j-klm6nopqrstuvwxyz
- Extraer todos los datos de la bóveda de emitidos para la empresa "SOLC980809D90 " de los últimos 2 días, filtrando por el cliente "RESA150893E78 ":
https://bfiskurapp.bitam.com/robots/bFiskurDwnAPI/index.php?rfc=SOLC980809D90 &boveda=emitidos&filtrorfc=RESA150893E78 &apikey=7a3b1c9d-ef01-2g3h-4i5j-klm6nopqrstuvwxyz
- Se extrae toda la información de la bóveda de emitidos para la empresa con RFC=SOLC980809D90 en el rango comprendido del 1º de enero del 2024 al 5 de enero del 2024
https://bfiskurapp.bitam.com/robots/bFiskurDwnAPI/index.php?rfc=SOLC980809D90&boveda=emitidos&fechaIni=2024-01-01&fechaFin=2024-01-05 &apikey=7a3b1c9d-ef01-2g3h-4i5j-klm6nopqrstuvwxyz
Consideraciones Adicionales:
- Manejo de Errores: En caso de omitir un parámetro obligatorio o usar un valor inadecuado el servicio contestara con un “error”:”resource not found”
- Limitación de Tasa: El máximo número de días que se pueden extraer son 30.
- Seguridad: Se utiliza el protocolo HTTPS durante la transmisión. El resultado devuelto no lleva encriptación adicional.
- Pruebas: Para probar el servicio puede usarse Postman.