Changelog de API

​

Insight de accionistas

• Se agregó documentación de referencia de la API para el insight de accionistas.
• El endpoint devuelve relaciones de accionistas para una entidad y soporta relations.relationType=shareholders y relations.relationType=shareholder_of.
• El insight de accionistas puede exportarse mediante GET /entities/{entityId}/insights/{insight}/export usando shareholders como nombre del insight.

​

Insight de accionistas RPC

• La documentación del insight de accionistas RPC ahora está marcada como obsoleta a favor del insight de accionistas.
• Esta actualización de documentación no cambia el comportamiento de las respuestas de la API.

​

Recursos de Verificación de Sociedad

• Se agregó documentación para listar las entidades encontradas en un reporte de Verificación de Sociedad.
• Se agregó documentación para recuperar una entidad encontrada específica con sus participaciones en la tabla de capital y sus poderes.
• Se agregó documentación para la línea de tiempo de poderes de una entidad encontrada.
• Se agregó documentación para la línea de tiempo de la tabla de capital de un reporte.

​

Insight de accionistas RPC

• Cuando la entidad tiene al menos un accionista ingresado desde un reporte de Verificación de Sociedad, la respuesta ahora devuelve únicamente los accionistas provenientes de Verificación de Sociedad. Anteriormente, las filas provenientes del RPC para la misma tabla de capital se devolvían en paralelo y podían entrar en conflicto con el snapshot de verificación.
• Cuando hay datos de Verificación de Sociedad, los porcentajes de propiedad ahora reflejan los valores registrados en el reporte de verificación. Anteriormente, la respuesta siempre devolvía un valor sintético shares / sum(shares) * 100, lo que producía porcentajes incorrectos para estructuras de partes sociales donde el número de acciones es cero.
• Cuando la entidad no tiene accionistas provenientes de Verificación de Sociedad, el comportamiento no cambia: se devuelven las filas provenientes del RPC y los porcentajes se calculan a partir del número de acciones.
• Acción requerida: las integraciones que muestran el campo sources deben estar preparadas para renderizar company_verification además de rpc_socio y manual. Las integraciones que recalculan los porcentajes a partir de shares deben cambiar al campo percentage devuelto por la API.

​

Webhooks

• La referencia de la API ahora incluye una descripción general de Webhooks que explica los endpoints de webhook, las solicitudes de webhook, el estado de las entregas y la verificación de firmas.
• La documentación de endpoints de webhook ahora describe los requisitos de la URL del endpoint, los eventos suscritos, el estado habilitado, el tipo de contenido y los secretos de firma.
• La documentación de solicitudes de webhook ahora describe los intentos de entrega, los códigos de estado de respuesta, el tiempo de respuesta, las referencias al endpoint y los filtros de eventos.

​

Insights

• La referencia de la API ahora incluye una descripción general de Insights que explica cómo están organizados los endpoints de insights y cómo se usan los parámetros de consulta options[...].
• La referencia de la API ahora documenta el endpoint de exportación de insights basado en entidad para descargar los insights soportados como archivos CSV o XLSX.
• La referencia de la API ahora incluye los endpoints de insight de distribución del Syntage Score y de resumen de Buró de Crédito.

​

Syntage Score

• La referencia de la API ahora explica los datos de declaración anual y de cumplimiento fiscal requeridos antes de calcular el Syntage Score para una entidad.
• La documentación del endpoint de cálculo ahora deja claro que el endpoint inicia la generación del score y devuelve 201 Created cuando el cálculo queda en cola.

​

Recursos de Buró de Crédito

• La referencia de la API ahora explica cómo se crean los reportes de Buró de Crédito con el extractor buro_de_credito_report.
• La documentación de reportes de Buró de Crédito ahora describe los principales campos de respuesta, incluidos el proveedor, el tipo de producto, el ID de reporte del proveedor, los datos del reporte parseados, el score, los archivos generados y las marcas de tiempo.
• La referencia de la API ahora incluye el endpoint a nivel de organización para listar autorizaciones de Buró de Crédito.
• La documentación de autorizaciones de Buró de Crédito ahora describe los campos de consentimiento, RFC, domicilio, vigencia, origen e identidad de la entidad devueltos por la API.
• El endpoint para crear autorizaciones ahora documenta con más detalle los cuerpos de solicitud para persona y empresa.

​

Recursos del RPC

• Se agregó una página de descripción general del RPC que explica cómo se relacionan los registros del RPC con entidades, extracciones, actos, socios y descargas de archivos.
• Se agregaron páginas de descripción general para entidades, actos y socios del RPC.
• Se agregó documentación para listar los actos del RPC extraídos para una entidad.
• Se agregó documentación para recuperar un acto del RPC por ID.
• Se agregó documentación para recuperar un socio del RPC por ID.
• Se actualizó la documentación de los endpoints de entidades del RPC para usar las rutas actuales /datasources/mx/rpc/entidades y /entities/{entityId}/datasources/mx/rpc/entidades.
• Se ampliaron las descripciones de los campos de respuesta de entidad, acto y socio del RPC.

​

Recursos del RUG

• Se agregó una página de descripción general del RUG que explica cómo encajan las garantías, operaciones, extracciones y descargas de archivos del RUG.
• Se agregaron páginas de descripción general para operaciones y garantías del RUG.
• Se ampliaron las descripciones de los endpoints de operaciones y garantías del RUG.
• Se ampliaron las descripciones de los campos de respuesta de operaciones y garantías del RUG.

​

Recursos del SAT

• Se agregó una página de descripción general del SAT que explica cómo se relacionan los recursos del SAT con entidades, extracciones y descargas de archivos.
• Se agregaron páginas de descripción general para credenciales, conceptos de factura, relaciones de factura, notas de crédito, retenciones de impuestos, declaraciones de impuestos, opinión de cumplimiento, registros contables electrónicos y certificados del SAT.
• Se agregaron guías de extracción a las descripciones generales de los recursos del SAT para que cada recurso respaldado por una extracción explique el extractor a usar y dónde leer los registros extraídos.
• Se actualizó la descripción general de extracciones para enfocarse en el flujo de extracción en lugar de duplicar listas de opciones específicas por extractor.
• Se ampliaron las descripciones generales existentes de facturas, pagos de facturas, pagos en lote de facturas y verificaciones de cumplimiento fiscal con descripciones de recursos más claras.
• Se actualizaron los resúmenes y descripciones de endpoints para usar de manera consistente las palabras List y Retrieve y un lenguaje basado en entidades.
• Se agregó documentación para listar las notas de crédito extraídas para una entidad.
• Se agregó documentación para relaciones de factura, descargas de PDF de declaraciones de impuestos, recuperación de CFDI parseado del SAT y el listado superior de opinión de cumplimiento.
• Se corrigió la ruta documentada para recuperar notas de crédito para que use /invoices/credit-notes/{id}.
• Se corrigió la ruta documentada para recuperar conceptos de factura para que use /invoices/line-items/{id}.
• Se agregaron descripciones de campos para los campos de respuesta de certificado del SAT, credencial, pago de factura, pago en lote de factura, concepto de factura, retención de impuestos, declaración de impuestos, verificación de cumplimiento fiscal, opinión de cumplimiento y régimen fiscal.
• Se renombraron las páginas de documentación de certificados del SAT de slugs get a slugs list y retrieve, con redirecciones desde las URLs de documentación anteriores.

​

Agrupación de utilidad/pérdida en el estado de resultados

• En el formato 2022 y en los formatos auditados del estado de resultados, cada par coincidente de Utilidad (ganancia) y Pérdida ahora se devuelve bajo una única fila padre de agrupación en lugar de como dos filas de nivel superior. El par aparece como dos entradas dentro del arreglo children del padre, y el Total por año del padre refleja el lado poblado.
• Los cuatro pares que se agrupan coinciden con el comportamiento de larga data del formato 2014: bruta, de operación, antes de impuestos y neta. El par operaciones continuas se deja plano intencionalmente.
• Cambio incompatible para consumidores de las exportaciones JSON, CSV y XLSX de los formatos 2022 y auditados. Las integraciones que leen las filas de utilidad/pérdida por nombre de categoría en el nivel superior ahora deben leerlas desde el arreglo children del padre de agrupación, o sumar el Total del padre directamente. La respuesta del formato 2014 no cambia.
• El padre de agrupación en sí no tiene una ruta de concepto subyacente del SAT. Su Total se calcula a partir de sus hijos y las filas hijas conservan sus categorías y totales originales.

​

Convención de signo para salidas en el estado de resultados

• Las líneas de costo, gasto, pérdida, impuesto y cargo financiero ahora se devuelven como valores negativos, coincidiendo con el comportamiento de larga data del formato 2014. Anteriormente, estas líneas de salida se devolvían como positivas en los formatos 2022 y audited-financial-statements.
• Las líneas de ingresos, utilidades y otras entradas siguen siendo positivas. Las secciones netas o mixtas conservan su signo natural.
• Acción requerida: las integraciones que consumían estos formatos como magnitudes positivas y aplicaban su propio signo deben dejar de negar las salidas por sí mismas. Los valores ya llevan el signo correcto. La magnitud absoluta de cada línea no cambia.

​

Otros recursos

• La búsqueda de direcciones de México se movió de Miscellaneous a Otros recursos.
• Accionistas, verificaciones de antecedentes y reportes de Verificación de Sociedad ahora incluyen páginas de descripción general que explican el propósito de cada grupo de recursos.
• Los títulos de endpoints de accionistas, verificaciones de antecedentes y reportes de Verificación de Sociedad ahora usan de manera consistente las palabras List, Retrieve y Download, con descripciones ampliadas de endpoints y campos.
• La documentación de búsqueda de direcciones de México ahora explica que las direcciones de Buró de Crédito y Buró Empresas deben coincidir con el catálogo de direcciones por código postal, que un código postal puede devolver varias colonias y describe los campos de dirección devueltos por el endpoint.

​

Insight de Intereses Moratorios

• Se agregó el endpoint del insight de Intereses Moratorios.
• El endpoint devuelve los cargos por intereses moratorios para una entidad, incluyendo KPIs de resumen, totales mensuales, totales mensuales por institución financiera y totales a nivel de institución.
• Los indicadores de riesgo del insight de Resumen pueden incluir moratoryInterest cuando el insight de Intereses Moratorios está habilitado.

​

Insights de Egresos e Ingresos por Ventas

• El valor products se eliminó de los valores permitidos del parámetro de consulta options[type] en ambos endpoints. Las solicitudes que anteriormente enviaban options[type]=products ya devolvían la misma respuesta que options[type]=total, por lo que las integraciones existentes que dependen de esa respuesta siguen funcionando sin cambios.
• Para desgloses a nivel de producto, usa los endpoints del insight de Productos y Servicios (GET /entities/{entityId}/insights/products-and-services-bought y GET /entities/{entityId}/insights/products-and-services-sold).
• Las descripciones de los campos dimension y label en los esquemas de respuesta se actualizaron para reflejar que products ya no es una agrupación soportada.

​

Reportes BIL

• La referencia de la API ahora incluye el endpoint para listar los reportes BIL generados para una entidad.
• La referencia de la API ahora incluye el endpoint para recuperar un único reporte BIL por ID de reporte.
• La documentación de reportes BIL ahora describe los principales campos de respuesta, incluidos el folio del reporte, el nombre buscado, la calificación máxima, la respuesta parseada del proveedor, el archivo XML y el archivo PDF.

​

Entidades, identificadores, etiquetas y eventos

• La referencia de la API ahora incluye páginas de descripción general y endpoints de entidades que explican cómo se crean, recuperan, actualizan, eliminan y se usan como recurso padre de los registros de las fuentes de datos.
• La documentación de identificadores de entidad ahora explica cómo se pueden proporcionar identificadores RFC y CURP al crear una entidad o agregarse posteriormente.
• La documentación de etiquetas de entidad y etiquetas ahora explica cómo se pueden usar las etiquetas para segmentación, segmentación del planificador de extracciones, monitoreo y filtrado de entidades en tu propio producto.
• La documentación de eventos de entidad ahora explica cómo recuperar eventos de una entidad específica además de usar la entrega por webhook.

​

Archivos y exportaciones

• La documentación de archivos ahora explica los metadatos de archivos, los tipos de archivo, los nombres de archivo, los tipos MIME y cuándo usar el endpoint de descarga para el contenido del archivo.
• La documentación de exportaciones ahora explica el flujo de exportación asíncrona desde la creación hasta los estados terminales.
• La documentación de exportaciones ahora muestra que las exportaciones completadas devuelven una referencia de archivo que puede descargarse mediante el endpoint de descarga de archivos.

​

Extracciones, planificadores y reglas del planificador

• La documentación de extracciones ahora cubre el ciclo de vida de la extracción, los estados, el comportamiento de reintento, el comportamiento de extracciones duplicadas y las descripciones de extractores específicos por fuente de datos.
• BIL ahora se incluye en la lista documentada de extractores.
• La documentación de planificadores y reglas del planificador ahora explica con más detalle el comportamiento de las extracciones recurrentes.

​

Guías

• Las guías ahora incluyen orientación sobre URLs basadas en entidades que explica los IDs de entidad y la compatibilidad con URLs heredadas basadas en RFC.
• La guía de entornos ahora describe el comportamiento de Sandbox y Producción a través de las fuentes de datos de Syntage.
• Las guías de ID de solicitud y de limitación de tasa ahora incluyen ejemplos de encabezados de respuesta y casos de uso para solución de problemas.
• La orientación sobre filtrado de propiedades ahora incluye ejemplos de sintaxis para seleccionar campos de recursos y objetos relacionados.
• La documentación del catálogo del SAT ahora incluye las áreas del catálogo cubiertas por la API y ejemplos de valores comunes del catálogo CFDI.
• La orientación de validación de webhooks ahora incluye ejemplos en PHP, JavaScript/TypeScript y Python para verificar firmas de solicitudes.
• Se actualizó la guía de flujo de integración para explicar la validación de credenciales, la creación de extracciones, el seguimiento del estado de las extracciones, la entrega por webhook y la recuperación de archivos como un flujo conectado.
• Se aclaró que el onboarding embebido de entidades es para integraciones que necesitan la experiencia de onboarding dentro de su propio sitio en lugar de redirigir a Syntage.
• Se mantuvo disponible la documentación obsoleta del widget para los usuarios existentes del widget mientras se dirige a las nuevas integraciones hacia el onboarding embebido de entidades.
• Se actualizó la documentación introductoria para describir la API de Syntage a través de SAT, RUG, RPC, BIL, Buró de Crédito, Buró Empresas, Infonavit y más.

​

Factura

• La propiedad amount se eliminó de las respuestas de la API. Usa la propiedad total en su lugar.
• Se eliminó la recuperación por uuid de la factura en /invoices/{id}. Para recuperar una factura, usa el id de la factura en el endpoint especificado. Para encontrar una factura usando su uuid, filtra la colección de facturas en /taxpayers/{taxpayerId}/invoices?uuid[]={uuid}.
• Anteriormente, la propiedad @iri de una factura apuntaba al recurso usando uuid, como /invoices/{uuid}. Ahora apunta usando su id, como /invoices/{id}.

​

Vínculo

• Se eliminó el filtrado de vínculos por status. Usa credential.status en su lugar. Por ejemplo, usa GET /links?credential.status[]=active en lugar de GET /links?status[]=active.

​

Declaración de impuestos

• Se eliminó la recuperación por operationNumber de la declaración de impuestos en /tax-returns/{id}. Para recuperar una declaración de impuestos, usa el id de la declaración en el endpoint especificado. Para encontrar una declaración de impuestos usando su operationNumber, filtra la colección en /taxpayers/{taxpayerId}/tax-returns?operationNumber[]={operationNumber}.
• Anteriormente, la propiedad @iri de una declaración de impuestos apuntaba al recurso usando operationNumber, como /tax-returns/{operationNumber}. Ahora apunta a su id, como /tax-returns/{id}.

​

Evento

• Para los eventos asociados a una tax-return, la propiedad @iri ahora apunta a /tax-returns/{id} en lugar del anterior /tax-returns/{operationNumber}.
• Para los eventos asociados a una invoice, la propiedad @iri ahora apunta a /invoices/{id} en lugar del anterior /invoices/{uuid}.

​

Extracción

• La propiedad periodFrom se eliminó. Usa options.period.from en su lugar.
• La propiedad periodTo se eliminó. Usa options.period.to en su lugar.

​

Archivo

• Para los archivos asociados a una tax-return, la propiedad @iri ahora apunta a /tax-returns/{id} en lugar del anterior /tax-returns/{operationNumber}.
• Para los archivos asociados a una invoice, la propiedad @iri ahora apunta a /invoices/{id} en lugar del anterior /invoices/{uuid}.

​

Prueba esta versión

curl -i 'https://api.syntage.com/taxpayers/{taxpayerId}/invoices' \
  --header 'Accept-Version: 2020-06-28' \
  --header 'X-Api-Key: {apiKey}'