Mostrar un cliente

Busca un cliente activo por tipo y número de documento.

La guía correspondiente está en Clientes.

Solicitud

La ruta POST /clienteMostrar se agrega a la URL base del ambiente.

Enviá los headers x-api-key y x-api-secret. Cómo obtenerlos está en Credenciales.

El cuerpo es JSON (Content-Type: application/json).

Campos

Si falta un campo obligatorio, la API rechaza la solicitud.

Campo	Tipo	Obligatorio	Descripción	Ejemplo
tipoDocumento	number	Sí	Tipo de documento del cliente: 2=RUT, 3=CI, 4=Otros, 5=Pasaporte, 6=DNI, 7=NIFE (los mismos valores que en POST /ventaCrear).	3
documento	string	Sí	Número de documento, sin puntos ni guiones. La búsqueda es exacta: tiene que coincidir con el documento guardado en Fixed.	12345678

Respuesta 200

Cliente encontrado o null si no existe

Si la operación sale bien, codigoError es "0".

Si no hay un cliente activo con ese tipo y número de documento, la respuesta igual es HTTP 200: codigoError es "0", cliente es null y descripcion dice que no existe.

Campo	Tipo	Obligatorio	Descripción	Ejemplo
descripcion	string	Sí	—	—
codigoError	string	Sí	—	—
cliente	objeto | null	Sí	Ver cliente.	—

Respuesta cliente

Mismos campos que se envían en cliente de POST /ventaCrear. null si no existe.

Campo	Tipo	Obligatorio	Descripción	Ejemplo
tipoDocumento	number	Sí	Tipo de documento: 2=RUT, 3=CI, 4=Otros, 5=Pasaporte, 6=DNI, 7=NIFE.	2
documento	string	Sí	Número de documento (RUT, CI, etc.). Obligatorio para tipoDocumento 2 (RUT); opcional para el resto. Ver sección “Identificación del cliente” en la descripción de POST /ventaCrear.	219314970014
pais	string	No	Código ISO de país (2 letras). Obligatorio para tipoDocumento 4 (Otros), 5 (Pasaporte), 6 (DNI) y 7 (NIFE). Para tipoDocumento 6 (DNI) solo se admite AR, BR, CL o PY.	AR
razonSocial	string	Sí	Razón social del cliente.	Panadería El Buen Pan S.A.
nombreComercial	string	Sí	Nombre comercial.	El Buen Pan
domicilio	string	Sí	Domicilio fiscal.	Av. Italia 1234
localidad	string	Sí	Localidad.	Montevideo
departamento	string	Sí	Departamento.	Montevideo
domicilioEntrega	string	Sí	Domicilio de entrega.	Av. Italia 1234
mailEnvioFactura	string	Sí	Email para envío de factura. Si no se envía documento, se usa para identificar al cliente (ver sección “Identificación del cliente” en la descripción de POST /ventaCrear).	facturacion@ejemplo.com
telefono	string	Sí	Teléfono de contacto.	099123456
observaciones	string	Sí	Observaciones del cliente.	""

Errores

Una respuesta de error trae codigoError y descripcion. El mismo código puede significar cosas distintas según el endpoint. El índice completo está en Códigos de error.

Si fallan las credenciales o el formato del body, aplican los códigos comunes: A01 a A06, V01 y V02.

Código	Significado
E02	Empresa no encontrada

HTTP 500

Error al buscar cliente

{
  "descripcion": "No existe cliente con documento y/o tipo documento indicado",
  "codigoError": "0",
  "cliente": null
}

Ejemplos

Buscar cliente por RUT

{
  "tipoDocumento": 2,
  "documento": "219314970014"
}

Buscar cliente por cédula

{
  "tipoDocumento": 3,
  "documento": "12345678"
}