ENUMs de la API

En esta página encontrarás los valores predefinidos (ENUMs) de la API de Koncili.

---

Esta documentación describe todos los tipos enumerados (ENUMs) usados en la API Marketplace, incluidos sus valores posibles, significados y endpoints relacionados.

Visión general de los ENUMs

Los ENUMs se usan para estandarizar:

• Estados de pedidos
• Métodos de pago
• Tipos de movimientos financieros
• Clasificación de los movimientos en la taxonomía financiera
• Otros campos con valores predefinidos

Cómo usarlos

Haz referencia siempre a los valores exactos tal como están documentados a continuación, incluidas mayúsculas y guiones bajos.

Importante

Al integrar con la API:

• Consulta esta documentación para conocer los valores de ENUMs aceptados en cada endpoint
• Valida los valores antes de enviarlos a la API
• Implementa un manejo adecuado para respuestas con ENUMs desconocidos
• Actualiza periódicamente tu implementación conforme a las nuevas versiones de los ENUMs

Descripción de los ENUMs

Estado del pedido

Valor ENUM	Descripción	Endpoints relacionados
INVOICED	Pedido facturado	POST /order GET /order POST /reconciliation
PAID_WAITING_DELIVERY	Enviado	POST /order GET /order POST /reconciliation
CONCLUDED	Entregado	POST /order GET /order POST /reconciliation
CANCELED	Pedido cancelado	POST /order GET /order POST /reconciliation

Formas de pago

Valor ENUM	Descripción	Endpoints relacionados
IN_CASH	Pago al contado	POST /order GET /order

Tipos de movimientos financieros

Valor ENUM	Descripción	Endpoints relacionados
COMISSION	Comisión sobre la venta	POST /order GET /order POST /reconciliation
SHIP	Envío	POST /order GET /order POST /reconciliation
RETURN_COMISSION	Devolución de comisión	POST /order GET /order POST /reconciliation
RETURN_SHIP	Devolución de envío	POST /order GET /order POST /reconciliation
SALE	Venta directa	POST /order GET /order POST /reconciliation
ADJUSTMENT	Ajuste	POST /order GET /order POST /reconciliation

Taxonomía financiera

La taxonomía financiera clasifica cada movimiento en cuatro niveles anidados, derivados del tipo de liquidación (extractType) del propio movimiento. Los cuatro campos se devuelven, siempre completos, en:

• GET /releasetype/{channelName}
• GET /orderextract/unresolveds
• GET /orderextract/concilieds
• PUT /orderextract/resolve/{id}

Campo JSON	Nivel	Qué representa	Valor ENUM	Etiqueta devuelta (es)
functionGrouper	Nv0 — Agrupador de Función	Naturaleza más amplia del movimiento: ingreso, gasto, otros o legado	REVENUE_ROOT	Ingreso
financialFunction	Nv1 — Función Financiera	Papel del movimiento dentro del agrupador, por ejemplo ingreso frente a deducción de ingreso	REVENUE	Ingreso
financialGrouping	Nv2 — Agrupación Financiera	Nivel ancla: identifica de forma única la clasificación y determina los otros tres	REVENUE_SALE	Ingreso - Venta
category	Nv3 — Categoría	Naturaleza contable del movimiento: venta, comisión, envío, impuesto y similares	SALE	Venta

Valores traducidos según el idioma

Al igual que el campo description del tipo de liquidación, los cuatro campos de la taxonomía se traducen: la API devuelve la etiqueta en el idioma de la solicitud, y no el valor ENUM. Las tablas de esta página listan el ENUM porque es la enumeración canónica de la taxonomía — lo que viaja en el JSON es la etiqueta correspondiente, mostrada en la columna "Etiqueta devuelta (es)".

Cuando no hay una traducción registrada para un valor, la API devuelve la propia clave de traducción: taxonomy.<VALOR> para Nv0, Nv1 y Nv2, y taxonomyCategory.<VALOR> para Nv3 — por ejemplo, taxonomy.FOO. Trata ese formato como un valor desconocido.

Cómo usarlos

Los cuatro campos de la taxonomía son para visualización y lectura humana: como se traducen, no sirven como clave de integración. Para el mapeo automático de la clasificación contable en tu ERP, usa los códigos técnicos invariables — extractType en los ítems de unresolveds/concilieds y code en releasetype.

Sigue siendo válido que el Nv2 es el nivel ancla: conociendo la agrupación financiera, los otros tres niveles quedan determinados. Los demás campos evitan que necesites la tabla de combinaciones para totalizar en niveles más altos.

Nv0 — Agrupador de Función (functionGrouper)

Valor ENUM	Descripción	Etiqueta devuelta (es)
REVENUE_ROOT	Movimientos vinculados al ingreso del seller	Ingreso
EXPENSE_ROOT	Movimientos vinculados a gastos cobrados por el marketplace	Gasto
OTHER_ROOT	Movimientos que no son ingreso ni gasto (transferencias, bloqueos, informativos)	Otros
LEGACY_ROOT	Tipos aún no reclasificados en la taxonomía actual	Legado

Nv1 — Función Financiera (financialFunction)

Valor ENUM	Agrupador (Nv0)	Descripción	Etiqueta devuelta (es)
REVENUE	REVENUE_ROOT	Ingreso — monto a favor del seller	Ingreso
REVENUE_REDUCTION	REVENUE_ROOT	Deducción de ingreso — reversión o devolución que reduce el ingreso	Reducción de Ingreso
EXPENSE_OPERATIONAL	EXPENSE_ROOT	Gasto operativo cobrado al seller	Gastos Operacionales
EXPENSE_COMPENSATION	EXPENSE_ROOT	Compensación de gasto — reversión de un gasto cobrado anteriormente	Compensación de Gastos
OTHER_INCOMING	OTHER_ROOT	Entrada de un monto que no es ingreso	Otros - Entradas
OTHER_OUTGOING	OTHER_ROOT	Salida de un monto que no es gasto	Otros - Salidas
OTHER_NEUTRAL	OTHER_ROOT	Movimiento neutro — ni entrada ni salida	Otros
LEGACY	LEGACY_ROOT	Clasificación legada, mantenida para tipos aún no reclasificados	Legado

Nv3 — Categoría (category)

Valor ENUM	Descripción	Etiqueta devuelta (es)
SALE	Venta de producto	Venta
COMMISSION	Comisión cobrada por el marketplace	Comisión
SHIPPING	Envío y logística	Flete y Logística
CAMPAIGN	Campañas, cupones y acciones promocionales	Campaña
TAX	Impuestos y tributos	Impuestos
WITHHOLDING_AND_RELEASE	Retención y liberación de montos	Retenciones y Liberaciones
PURCHASE	Compra de productos o servicios al marketplace	Compras
ANTICIPATION	Anticipación de cuentas por cobrar	Anticipaciones
LEGAL	Montos de origen judicial	Judicial
PENALTY	Multas y penalidades	Multas
NOTICE	Movimiento informativo	Informativos
SUBSCRIPTION	Suscripciones y mensualidades	Mensualidad
TRANSACTION	Transferencias y movimientos financieros	Transacciones
OTHER	Demás movimientos	Otros
LEGACY	Categoría legada	Legado

Combinaciones válidas

Cada Agrupación Financiera (Nv2) pertenece exactamente a una Función Financiera, a un Agrupador de Función y a una Categoría. La tabla siguiente muestra todas las combinaciones que existen hoy.

financialGrouping (Nv2)	financialFunction (Nv1)	functionGrouper (Nv0)	category (Nv3)	Etiqueta del Nv2 (es)
REVENUE_SALE	REVENUE	REVENUE_ROOT	SALE	Ingreso - Venta
REVENUE_SHIPPING	REVENUE	REVENUE_ROOT	SHIPPING	Ingreso - Flete
REVENUE_CAMPAIGN	REVENUE	REVENUE_ROOT	CAMPAIGN	Ingreso - Campaña
REVENUE_TAX	REVENUE	REVENUE_ROOT	TAX	Ingreso - Impuestos
REVENUE_TRANSACTION	REVENUE	REVENUE_ROOT	TRANSACTION	Ingreso - Transacciones
REVENUE_OTHER	REVENUE	REVENUE_ROOT	OTHER	Ingreso - Otros
REVENUE_REDUCTION_SALE	REVENUE_REDUCTION	REVENUE_ROOT	SALE	Reducción de Ingreso - Venta
REVENUE_REDUCTION_SHIPPING	REVENUE_REDUCTION	REVENUE_ROOT	SHIPPING	Reducción de Ingreso - Flete
REVENUE_REDUCTION_CAMPAIGN	REVENUE_REDUCTION	REVENUE_ROOT	CAMPAIGN	Reducción de Ingreso - Campaña
REVENUE_REDUCTION_TRANSACTION	REVENUE_REDUCTION	REVENUE_ROOT	TRANSACTION	Reducción de Ingreso - Transacciones
REVENUE_REDUCTION_TAX	REVENUE_REDUCTION	REVENUE_ROOT	TAX	Reducción de Ingreso - Impuestos
REVENUE_REDUCTION_OTHER	REVENUE_REDUCTION	REVENUE_ROOT	OTHER	Reducción de Ingreso - Otros
EXPENSE_OPERATIONAL_COMMISSION	EXPENSE_OPERATIONAL	EXPENSE_ROOT	COMMISSION	Gastos - Comisión
EXPENSE_OPERATIONAL_SHIPPING	EXPENSE_OPERATIONAL	EXPENSE_ROOT	SHIPPING	Gastos - Flete y Logística
EXPENSE_OPERATIONAL_CAMPAIGN	EXPENSE_OPERATIONAL	EXPENSE_ROOT	CAMPAIGN	Gastos - Publicidad y Campañas
EXPENSE_OPERATIONAL_TAX	EXPENSE_OPERATIONAL	EXPENSE_ROOT	TAX	Gastos - Impuestos
EXPENSE_OPERATIONAL_PENALTY	EXPENSE_OPERATIONAL	EXPENSE_ROOT	PENALTY	Gastos - Multas
EXPENSE_OPERATIONAL_PURCHASE	EXPENSE_OPERATIONAL	EXPENSE_ROOT	PURCHASE	Gastos - Compras
EXPENSE_OPERATIONAL_ANTICIPATION	EXPENSE_OPERATIONAL	EXPENSE_ROOT	ANTICIPATION	Gastos - Anticipaciones
EXPENSE_OPERATIONAL_LEGAL	EXPENSE_OPERATIONAL	EXPENSE_ROOT	LEGAL	Gastos - Judicial
EXPENSE_OPERATIONAL_SUBSCRIPTION	EXPENSE_OPERATIONAL	EXPENSE_ROOT	SUBSCRIPTION	Gastos - Mensualidad
EXPENSE_OPERATIONAL_OTHER	EXPENSE_OPERATIONAL	EXPENSE_ROOT	OTHER	Gastos - Otros
EXPENSE_COMPENSATION_COMMISSION	EXPENSE_COMPENSATION	EXPENSE_ROOT	COMMISSION	Compensación - Comisión
EXPENSE_COMPENSATION_SHIPPING	EXPENSE_COMPENSATION	EXPENSE_ROOT	SHIPPING	Compensación - Flete y Logística
EXPENSE_COMPENSATION_CAMPAIGN	EXPENSE_COMPENSATION	EXPENSE_ROOT	CAMPAIGN	Compensación - Publicidad y Campañas
EXPENSE_COMPENSATION_TAX	EXPENSE_COMPENSATION	EXPENSE_ROOT	TAX	Compensación - Impuestos
EXPENSE_COMPENSATION_PENALTY	EXPENSE_COMPENSATION	EXPENSE_ROOT	PENALTY	Compensación - Multas
EXPENSE_COMPENSATION_PURCHASE	EXPENSE_COMPENSATION	EXPENSE_ROOT	PURCHASE	Compensación - Compras
EXPENSE_COMPENSATION_ANTICIPATION	EXPENSE_COMPENSATION	EXPENSE_ROOT	ANTICIPATION	Compensación - Anticipaciones
EXPENSE_COMPENSATION_LEGAL	EXPENSE_COMPENSATION	EXPENSE_ROOT	LEGAL	Compensación - Judicial
EXPENSE_COMPENSATION_SUBSCRIPTION	EXPENSE_COMPENSATION	EXPENSE_ROOT	SUBSCRIPTION	Compensación - Mensualidad
EXPENSE_COMPENSATION_OTHER	EXPENSE_COMPENSATION	EXPENSE_ROOT	OTHER	Compensación - Otros
OTHER_INCOMING_TRANSFER	OTHER_INCOMING	OTHER_ROOT	TRANSACTION	Transferencias - Entradas
OTHER_INCOMING_INFORMATION	OTHER_INCOMING	OTHER_ROOT	NOTICE	Informativos - Entradas
OTHER_INCOMING_UNBLOCKING	OTHER_INCOMING	OTHER_ROOT	WITHHOLDING_AND_RELEASE	Liberaciones - Desbloqueos
OTHER_INCOMING_OTHER	OTHER_INCOMING	OTHER_ROOT	OTHER	Otras Entradas
OTHER_OUTGOING_TRANSFER	OTHER_OUTGOING	OTHER_ROOT	TRANSACTION	Transferencias - Salidas
OTHER_OUTGOING_INFORMATION	OTHER_OUTGOING	OTHER_ROOT	NOTICE	Informativos - Salidas
OTHER_OUTGOING_BLOCKING	OTHER_OUTGOING	OTHER_ROOT	WITHHOLDING_AND_RELEASE	Retenciones - Bloqueos
OTHER_OUTGOING_OTHER	OTHER_OUTGOING	OTHER_ROOT	OTHER	Otras Salidas
OTHER_NEUTRAL_OTHER	OTHER_NEUTRAL	OTHER_ROOT	OTHER	Otros
LEGACY_V1	LEGACY	LEGACY_ROOT	LEGACY	Otros - Legado

Nuevos valores

Pueden crearse nuevas agrupaciones a medida que se mapean nuevos tipos de liquidación. Trata los valores desconocidos de forma tolerante, como se indica al inicio de esta página.

Tipos de notificación

Valor ENUM	Descripción	Endpoints relacionados
TEST_NOTIFICATION	Prueba de la URL registrada	POST en la URL del integrador
ACCOUNT_CREATED	Cuenta creada	POST en la URL del integrador
RECONCILIATION_COMPLETED	Conciliación finalizada	POST en la URL del integrador
BLOCKED_TEMPORARY	Bloqueo temporal	POST en la URL del integrador
BLOCKED_PERMANENT	Bloqueo permanente	POST en la URL del integrador
UNLOCKED	Desbloqueo	POST en la URL del integrador