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, 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

  // 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
}

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 del ERP.

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 del ERP. Útil para exportar stock de todas las sucursales
/integraciones/terceros/config/depositos	Solo los depósitos configurados para esta integración

Ejemplo

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