Saltar al contenido principal
Las entidades representan a las personas y empresas con las que tu organización trabaja en Syntage. Usa el ID de una entidad para solicitar datos, iniciar extracciones, gestionar identificadores, asignar etiquetas de entidad y revisar eventos para esa persona o empresa. Una entidad se puede crear con un nombre, tipo, RFC opcional, identificadores opcionales y fuentes de datos opcionales para iniciar la extracción. Si falta información requerida, Syntage devuelve una URL de onboarding que puede usarse para recopilar la información faltante de la entidad.

​
Cómo se usan las entidades

  1. Crea o recupera una entidad.
  2. Almacena el ID de la entidad devuelto por Syntage.
  3. Usa el ID de la entidad al solicitar registros de fuentes de datos, crear extracciones, listar eventos, asignar etiquetas o agregar identificadores.
  4. Si Syntage devuelve un onboardingUrl, envía a la entidad a esa URL o incrusta la experiencia de onboarding en tu propio sitio.
El ID de la entidad es estable entre fuentes de datos. Una sola entidad puede conectarse a credenciales del SAT, datos del RPC, datos del RUG, reportes de Buró de Crédito, datos del Infonavit y más.

​
IDs de entidad

Usa el ID de la entidad en nuevas integraciones: 
/entities/{entityId}
/entities/{entityId}/tax-status
/entities/{entityId}/invoices
Algunos endpoints antiguos también aceptan URLs basadas en RFC por compatibilidad. Los nuevos endpoints y funcionalidades solo se agregan bajo URLs basadas en entidad. Para detalles de endpoints, consulta la Referencia de API de Entidades.

​
Identificadores

Los identificadores almacenan valores específicos de cada país que pueden ser utilizados por las fuentes de datos y los flujos de trabajo del producto. México actualmente soporta:
PaísIdentificadorEjemplo
mxrfcXAXX010101000
mxcurpBADD110313HCMLNS09
Los identificadores pueden proporcionarse al crear una entidad o agregarse posteriormente con el endpoint de identificadores de entidad.

​
Etiquetas de entidad

Las etiquetas de entidad son etiquetas definidas por la organización para agrupar y filtrar entidades. Son útiles cuando tu integración necesita tratar a un conjunto de entidades de la misma manera. Casos de uso comunes:
Caso de usoEjemplo
Planificadores de extraccionesEjecutar una extracción diaria de facturas para cada entidad etiquetada con Daily invoices.
MonitoreoHacer seguimiento de entidades de alta prioridad por separado del resto de tu organización.
Filtrado en SyntageFiltrar la lista de entidades en el dashboard de Syntage.
Segmentación en tu productoUsar etiquetas para construir tus propios dashboards, colas de revisión o flujos de soporte alrededor de entidades etiquetadas.
Primero crea las etiquetas de entidad y luego asígnalas a una entidad actualizando la colección tags de la entidad. Al actualizar las etiquetas de una entidad, envía la lista completa de IRIs de etiquetas de entidad que debe tener la entidad. La lista enviada reemplaza las asignaciones anteriores.