Flujo: Nómina (Payroll Lending) vía API
Contexto
El caso de uso de nómina permite verificar ingresos laborales (recibos de nómina), pensiones, historial de pagos, descuentos de ley (salud, pensión, retención), y créditos/embargos registrados en el comprobante. Trébol extrae de forma estructurada los campos clave del recibo: ingresos recurrentes y no recurrentes, descuentos, créditos, embargos e ingreso neto.
Estado: Beta. El item payroll_receipt está marcado como Beta en la API hoy.
Endpoint base
Items disponibles
Documento específico (requiere file_url)
Globales aplicables
person_id (identificación del empleado/pensionado), proof_address, bank_statement, generic.
Ejemplo — Clasificación automática + extracción
Reglas de oro para Nómina
- Item country-agnóstico —
payroll_receiptaplica a cualquier país. La estructura de respuesta incluye campos de identificación comunes a varios países (CC Colombia, RFC México, pasaporte, etc.). countryconfigurable — usa"mx"o"co"según el origen del recibo. Para otros países,"not_specified".- Item en Beta — puede cambiar campos sin previo aviso. Validar contra el OpenAPI antes de cada release de tu integración.
- Combina con
person_id— el flujo típico para payroll lending incluye verificar la identidad del empleado/pensionado además de extraer el recibo. - Campos extraídos típicos — ingreso bruto, ingreso neto, descuentos de ley (salud, pensión, retención), descuentos voluntarios (créditos, embargos), periodo del pago. Ver detalle exacto en la doc canónica.
- Recibos digitales vs físicos — Trébol acepta PDFs digitales o escaneos. Calidad del escaneo afecta la confianza de extracción.
Fuente canónica (más detalle)
- Overview, variaciones de creación y ejemplos completos:
guia-devs/uso-nomina/overview.mdx - Items de nómina (estructura de respuesta detallada):
guia-devs/uso-nomina/items.mdx - Reglas de validación (
vr_trebol_*):guia-devs/crear-verificaciones/via-api/reglas-validacion.mdx
reference/openapi.yaml.