Entidades y configuración BETA

Endpoints en beta

Pueden cambiar de contrato, comportamiento o ser retirados antes de su release definitivo.

Listado paginado de clientes

Devuelve el listado de clientes/entidades con paginación del lado del servidor. Útil para sincronizaciones donde necesitás recorrer la base de clientes por páginas.

GETBETA/integraciones/terceros/entidades

Query parameters

Parámetro	Tipo	Default	Descripción
page	number	0	Página a obtener (base 0)
pageSize	number	10	Registros por página (máximo 100)
column	string	—	Campo por el que ordenar
asc	boolean	—	Orden ascendente si es true

Respuesta

export interface EntidadPage {
  total: number;
  page: number;
  pageSize: number;
  data: Entidad[];
}

El detalle de Entidad está en Esquema de datos.

Ejemplo

curl --request GET \
  --url 'https://api.test-ninox.com.ar/integraciones/terceros/entidades?page=0&pageSize=50' \
  --header 'X-NX-TOKEN: {TU_TOKEN}' \
  --header 'Content-Type: application/json'

Diferencia con exportar/clientes

Este endpoint es para recorrido paginado de a pocos registros. Para una exportación masiva de la base completa usá GET /exportar/clientes, que retorna en un único request pero tiene límites por plan.

Configuración de la integración

Endpoints que exponen la configuración vigente de la integración para que el sistema externo se autoconfigure sin conocer la estructura interna del ERP. No devuelven datos sensibles (token, endpoints internos).

Configuración general

Devuelve la configuración actual: depósitos asociados, sucursales habilitadas, punto de venta, lista de precios, facturación y medios de pago configurados.

GETBETA/integraciones/terceros/config

export interface TercerosConfig {
  appId: number;
  nombre: string;

  // Depósitos
  multiDeposito: boolean;
  depositos: Deposito[];          // solo los depósitos asociados a la integración

  // Sucursales habilitadas para exportar datos y mover stock.
  // Lista vacía = la integración no puede exportar nada (403).
  sucursalesExportacion: SucursalHabilitada[];

  // Venta
  puntoVentaId: number;
  listaPrecioId: number;
  listaPrecioRebajaId?: number;

  // Facturación
  facturacion?: FacturacionConfig;

  // Medios de pago
  mediosPago: MedioPagoConfig[];
}

export interface FacturacionConfig {
  facturacionAutomatica: boolean;
  puntoVentaFacturacionId: number;
  puntoVentaElectronicoId?: number;
}

export interface MedioPagoConfig {
  tipoMedioPago: TipoMedio;
  tipoMedioPagoIntegracion?: string;
  cuentaBancariaId?: number;
  electronica: boolean;
}

export interface Deposito {
  depositoId: number;
  nombre: string;
  direccion: string;
  eliminado: boolean;
  sucursalId?: number;
  sucursalNombre?: string;
  default: boolean;               // true en el depósito principal
}

export interface SucursalHabilitada {
  sucursalId: number;
  nombre: string;
}

Empezá por acá

sucursalesExportacion es la lista autorizada de sucursalId para las exportaciones, los saldos y los movimientos de stock. Leela al arrancar la integración en vez de tantear valores contra 403.

Rate limiting

Comparte el rate limit de los endpoints de parámetros de terceros: 60 segundos en producción (10 segundos en test).

Ejemplo

curl --request GET \
  --url 'https://api.test-ninox.com.ar/integraciones/terceros/config' \
  --header 'X-NX-TOKEN: {TU_TOKEN}'

Depósitos de la integración

Devuelve únicamente los depósitos asociados a la integración (depósito principal, multi-depósito y los mapeados en ubicaciones), a diferencia de GET /integraciones/terceros/depositos que devuelve todos los depósitos de las sucursales habilitadas.

GETBETA/integraciones/terceros/config/depositos

Respuesta: Deposito[]. El depósito principal viene marcado con default: true. Si la integración no tiene depósitos configurados, devuelve una lista vacía.

Cuándo usar cada endpoint

Endpoint	Devuelve
/integraciones/terceros/depositos	Todos los depósitos de las sucursales habilitadas. Útil para exportar stock de varias sucursales. Sin sucursales habilitadas cae a los depósitos del canal
/integraciones/terceros/config/depositos	Solo los depósitos configurados para esta integración (no se filtra por sucursal habilitada: es la config del propio canal, usada por el flujo de pedidos)

Ejemplo

curl --request GET \
  --url 'https://api.test-ninox.com.ar/integraciones/terceros/config/depositos' \
  --header 'X-NX-TOKEN: {TU_TOKEN}'

Empleados de la sucursal

Devuelve los empleados asignados a una sucursal habilitada. Usalo para obtener los empleadoId válidos antes de mandarlos en el campo empleadoId de un pedido, una venta o una nota de crédito.

GETBETA/integraciones/terceros/empleados

Query parameters

Parámetro	Tipo	Default	Descripción
sucursalId	number	—	Sucursal habilitada. Ver sucursales habilitadas: con una sola habilitada podés omitirlo, con varias hay que indicarlo

Respuesta: Empleado[]. El detalle está en Esquema de datos. Devuelve solo empleados activos.

empleadoId es el id de la entidad

En NinoxNet los empleados no son una tabla aparte: son entidades marcadas como empleado. Por eso empleadoId es el id de esa entidad, y es exactamente el valor que después mandás en el campo empleadoId del body. No lo confundas con el id de usuario del ERP.

Ejemplo

curl --request GET \
  --url 'https://api.test-ninox.com.ar/integraciones/terceros/empleados?sucursalId=1' \
  --header 'X-NX-TOKEN: {TU_TOKEN}'

Puntos de venta de la sucursal

Devuelve los puntos de venta de tipo integración de una sucursal habilitada. Son los únicos con los que una integración puede emitir comprobantes: los puntos de venta que se usan desde el ERP no se exponen acá y el ERP los rechaza si intentás usarlos por API.

GETBETA/integraciones/terceros/puntos-venta

Query parameters

Parámetro	Tipo	Default	Descripción
sucursalId	number	—	Igual que en empleados: opcional si tenés una sola sucursal habilitada

Respuesta: PuntoVenta[]. El punto de venta configurado en tu integración viene marcado con default: true — es el que se usa cuando no mandás puntoVentaId, mismo criterio que el depósito principal de /config/depositos.

Es el que necesitás para facturar

POST /facturar exige puntoVentaId y no tiene valor por defecto. venta y notacredito también lo aceptan para pisar el de la configuración. Este endpoint es la forma de descubrir cuáles podés usar sin tantear contra 403.

Ejemplo

curl --request GET \
  --url 'https://api.test-ninox.com.ar/integraciones/terceros/puntos-venta?sucursalId=1' \
  --header 'X-NX-TOKEN: {TU_TOKEN}'