Enums y códigos

La API manda y recibe estos valores como números. Esta página lista solo los que la integración de terceros devuelve o acepta, y en qué endpoints aparecen. El ERP tiene más valores internos en algunas de estas listas: no los vas a recibir por esta API.

Tolerá valores nuevos

Si te llega un número que no está en esta página, no lo trates como error: guardalo tal cual y tratalo como "otro". La lista puede crecer cuando la API exponga más tipos de comprobante.

Comprobantes

ComprobanteTipo

Qué es el comprobante. Lo trae el campo comprobanteTipo de las exportaciones y de GET /comprobante/{id}, y es lo que acepta el parámetro comprobanteTipo de las exportaciones paginadas.

export enum ComprobanteTipo {
  FACTURA_COMPRA = 1,
  FACTURA_VENTA = 2,
  NOTA_CREDITO_COMPRA = 3,
  NOTA_CREDITO_VENTA = 4,
  FACTURA_GASTO = 7,
  PREVENTA = 33,
}

Valor	Qué es	Dónde aparece
1	Factura de compra	Exportar compra
2	Factura de venta	Exportar venta, POST /venta, GET /comprobante/{id}
3	Nota de crédito de compra	Exportar compra
4	Nota de crédito de venta	Exportar venta, POST /notacredito, GET /comprobante/{id}
7	Gasto (módulo Gastos)	Exportar gastos
33	Preventa: un pedido todavía sin facturar	POST /pedido, GET /comprobante/{id} y Exportar venta con comprobanteTipo=33

Una preventa facturada pasa a ser una venta

Cuando se factura una preventa, el mismo comprobante (mismo facturaId) pasa de 33 a 2. Ver Preventas y estado.

ComprobanteEstado

En qué estado está el comprobante. Lo trae el campo estado de las exportaciones y de GET /comprobante/{id}.

export enum ComprobanteEstado {
  NUEVO = 0,
  PENDIENTE = 1,
  FACTURADO = 2,
  ANULADO = 3,
  PROCESANDO = 100,
  PAGADO = 101,
}

Valor	Qué significa
0	Sin estado. Es el valor de los gastos del módulo Gastos, que no tienen ciclo de estados
1	Pendiente. Una venta o compra con saldo pendiente (cuenta corriente), o una preventa que espera facturarse
2	Facturado. La venta o compra está saldada
3	Anulado. La venta fue anulada o la preventa fue cancelada. Sigue saliendo en las exportaciones
100	Procesando. Preventa con un pago en curso (canales de e-commerce)
101	Pagado. Preventa con el pago confirmado

Un comprobante eliminado se borra del ERP: no tiene estado, simplemente deja de aparecer.

TipoDocumento

La letra del comprobante. Lo trae el campo tipoDocumento.

export enum TipoDocumento {
  A = 1,
  B = 2,
  C = 3,
  E = 4,
  R = 5,
  X = 6,  // comprobante interno, no fiscal
  M = 7,
}

Las ventas y notas de crédito creadas con POST /venta y POST /notacredito son tipo X (6), igual que los gastos del módulo Gastos.

Pagos

TipoMedio

Con qué se pagó. Lo traen formasPago[].tipo en las exportaciones (con incluirMediosPago=true) y el campo tipo del medio de pago en las altas.

export enum TipoMedio {
  EFECTIVO = 1,
  CHEQUE = 2,
  CHEQUE_PROPIO = 3,
  CHEQUE_CARTERA = 4,
  TARJETA = 5,
  CUENTA_CORRIENTE = 6,
  ADELANTO = 7,
  TRANSFERENCIA_BANCO = 8,
  DEPOSITO_BANCO = 9,
  COMPROBANTE = 10,
  VIRTUAL = 11,
}

En las exportaciones puede aparecer cualquiera de estos valores, porque reflejan cómo se cargó el comprobante en el ERP. En las altas (POST /venta, POST /notacredito, POST /pedido) hoy se aplican solo EFECTIVO (1), DEPOSITO_BANCO (9) y VIRTUAL (11); POST /facturar acepta además TARJETA (5) y CUENTA_CORRIENTE (6). Ver Ventas (BETA).

TipoFormaPago

La forma de pago habitual de un cliente o proveedor. Lo trae el campo formaPago de las entidades en GET /entidades y GET /exportar/clientes.

export enum TipoFormaPago {
  OTRO = -1,
  SIN_ESPECIFICAR = 0,
  CONTADO = 1,
  TARJETA = 2,
  CHEQUE = 3,
  CUENTA_CORRIENTE = 4,
  BANCO_TRANSFERENCIA = 5,
  DOCUMENTOS = 6,
  MIXTO = 7,        // varios medios
  DEPOSITO = 8,
  VIRTUAL = 9,
  QR = 10,
}

No confundir con TipoMedio: TipoFormaPago es una preferencia de la ficha del cliente, TipoMedio es el medio con que se pagó un comprobante.

Clientes

CondicionIva

Condición frente al IVA del cliente. Lo usan usuario.condicion en POST /pedido y las altas de venta, y cliente.condicionIva en GET /comprobante/{id}.

export enum CondicionIva {
  SIN_CATEGORIA = 0,
  CONSUMIDOR_FINAL = 1,
  RESPONSABLE_INSCRIPTO = 2,
  MONOTRIBUTO = 3,
  EXENTO = 4,
  RESPONSABLE_NO_INSCRIPTO = 5,
}

Artículos y stock

TipoArticulo

Tipo de artículo. Es el parámetro opcional tipoArticulo de GET /exportar/stock.

export enum TipoArticulo {
  ARTICULO = 0,
  PRODUCTO = 1,
  SERVICIO = 3,
  CORTE = 4,
  CONTABLE = 5,
  MATERIA_PRIMA = 10,
  KIT = 20,
  TELA = 101,
  AVIOS = 102,
  DROPSHIPPING = 200,
}

TipoTalleColor

Si el artículo tiene curva de talles, de colores o de las dos. Lo trae el campo talleColor de los artículos del catálogo.

export enum TipoTalleColor {
  NINGUNO = 0,
  TALLES = 1,
  COLORES = 2,
  TALLES_COLORES = 3,
}

TipoTag

Qué clase de etiqueta es un tag del artículo. Lo trae el campo tipo de ArticuloTag.

export enum TipoTag {
  TODAS = -1,      // solo como filtro
  TAG = 0,
  CATEGORIA = 1,
  MARCA = 2,
  TEMPORADA = 3,
  SEGMENTO = 4,
}

TipoStockTransaccion

Tipo de movimiento en POST /stock/movimiento.

export enum TipoStockTransaccion {
  INGRESO_MANUAL = 4,
  EGRESO_MANUAL = 5,
  TRANSFERENCIA = 10,
  PRODUCCION = 19,
}

Respuestas

NxTipoResultado

Resultado de las operaciones que responden NxResultado (por ejemplo POST /stock/movimiento y POST /pedido/cancelar).

export enum NxTipoResultado {
  ERROR = 0,
  OK = 1,
  VALIDACION = 2,
}

Ver también

• Esquema de datos — las interfaces que usan estos enums.
• Exportar venta — preventas y estado de los comprobantes.
• Errores — códigos HTTP y mensajes.