Saltar al contenido principal
Las extracciones son tareas que recuperan datos de una entidad desde una fuente de datos. Se utilizan para recopilar facturas, declaraciones fiscales, situación fiscal, opiniones de cumplimiento, registros del RPC, garantías del RUG, reportes de Buró de Crédito y otros registros respaldados por fuentes de datos. Una extracción se ejecuta de forma asíncrona. Crear una inicia o encola el trabajo, y el recurso Extraction devuelto rastrea su estado, opciones, tiempos, errores y la cantidad de recursos creados o actualizados.

Cómo funcionan las extracciones

  1. Crea o recupera la entidad de la que quieres extraer datos.
  2. Inicia la extracción con la fuente de datos y las opciones seleccionadas.
  3. Almacena el ID de extracción devuelto.
  4. Consulta la extracción hasta que su status sea finished o failed.
  5. Lee los datos extraídos desde los endpoints de recursos relacionados, como facturas o declaraciones fiscales.
Si la misma extracción ya está pendiente o en ejecución para la misma entidad, extractor y opciones, Syntage devuelve una respuesta de extracción duplicada en lugar de iniciar el mismo trabajo nuevamente. Para detalles de implementación, consulta los Ejemplos de solicitudes de extracción o Crear una extracción.

Extracciones programadas

Usa los planificadores cuando la misma extracción deba ejecutarse repetidamente, como una extracción diaria de facturas o una extracción mensual de declaraciones fiscales. Un planificador controla si la automatización está habilitada, y las reglas del planificador definen el extractor, las opciones y la expresión cron. Los nombres y opciones de los extractores son específicos de los datos que estás extrayendo. Para recursos respaldados por extracciones, usa la página del recurso para entender qué datos se recopilan y los ejemplos para desarrolladores para los cuerpos de las solicitudes.

Estado de la extracción

EstadoDescripción
pendingEl estado inicial de la extracción. La extracción está encolada y esperando ser procesada.
waitingLa extracción no cumple los requisitos para comenzar.
runningEl proceso de extracción comenzó y actualmente está en ejecución. El tiempo de ejecución varía dependiendo del tipo de extractor y el volumen transaccional de la entidad. Pueden estar disponibles datos parciales desde los endpoints de recursos relacionados durante este tiempo.
finishedLa extracción finalizó exitosamente. Los datos extraídos están disponibles desde los endpoints de recursos relacionados.
failedLa extracción no pudo iniciar o falló durante el proceso. Nuestras políticas internas de reintento no lograron finalizar la extracción exitosamente. Puede haber datos parciales disponibles, pero se deben crear nuevas extracciones para garantizar que todos los datos de la entidad estén disponibles. Puedes revisar el código de error de la extracción para entender por qué falló y determinar si puede reintentarse o no.
stoppingEl usuario solicitó detener la extracción. Está en proceso de ser detenida.
stoppedLa extracción fue detenida por el usuario después de iniciar su ejecución. Esta extracción se incluye en la facturación.
cancelledLa extracción fue detenida por el usuario antes de iniciar su ejecución. Esta extracción no se incluye en la facturación.

Códigos de error de extracción

CódigoDescripciónReintentable
invalid_credentialsLa Credential del contribuyente ya no es válida.No
login_failedNo pudimos autenticar al contribuyente con la fuente de datos.
unrecoverableEl proceso de extracción falló muchas veces y se alcanzó el número máximo de reintentos.
sat_unavailableDetectamos que el SAT está caído o no responde.
internal_errorDetectamos un error interno en nuestra propia infraestructura.
undefinedNo pudimos determinar la causa del error y nuestro equipo interno lo investigará.