Skip to main content
GET
Estado de sincronización de una entidad

¿Para qué se usa?

Permite saber cuándo fue la última sincronización de cada tipo de dato de una entidad, y qué frecuencia de sincronización tiene contratada (sync_frequency_hours: 24, 12 o 3).

Qué hace

  • Devuelve una fila por tipo de scrape en types, con scrape_type, last_success_at (última carga exitosa) y last_status (in_progress, completed o failed).
  • Solo aparecen los tipos que se han sincronizado al menos una vez para la entidad.
  • La entidad se indica con el query param master_entity_id, igual que en /documents. Acepta el id opaco (eid_..., campo opaque_id de /master-entities?rut=) o el id entero.

Ejemplos de uso

  • Mostrar en tu producto “datos actualizados hace X horas” para cada empresa conectada.
  • Antes de operar cobranza o cesiones, verificar que last_success_at de ISSUED_DOCS sea reciente; si no, crear una solicitud de sincronización a demanda.
  • Detectar tipos con last_status: "failed" y alertar (por ejemplo, credenciales SII vencidas).

Authorizations

Authorization
string
header
required

API Key para autenticación. Debe proporcionarse en el header Authorization con el formato: 'Api-Key YOUR-API-KEY' (incluye el prefijo 'Api-Key ' seguido de tu API key)

Query Parameters

master_entity_id
string
required

ID de la entidad maestra. Acepta el id opaco (eid_..., campo opaque_id de /master-entities?rut=) o el id entero.

Example:

"eid_NDgyMTM6c2lnbmF0dXJl"

Response

Estado de sincronización de la entidad

master_entity_id
integer

ID entero de la entidad

Example:

48213

sync_frequency_hours
enum<integer>

Frecuencia de sincronización contratada, en horas. 24 es el plan por defecto; 12 y 3 (casi tiempo real) son planes de mayor frecuencia.

Available options:
24,
12,
3
Example:

24

types
object[]

Última actualización por tipo de scrape