Crear o editar un cliente

Crea un nuevo cliente o edita uno existente para el negocio actual.

Autenticación requerida: Este endpoint requiere autenticación Bearer Token. Usar el campo tokenCurrent obtenido del servicio de login (/login) en el header: Authorization: Bearer {tokenCurrent}

Permiso requerido: CL_POST (Crear/Editar)

Comportamiento:

  • Si se envía _id, se busca el cliente existente y se actualiza con los datos del body.
  • Si no se envía _id (o no existe), se crea un nuevo cliente con points: 0.
  • Respeta la configuración de compartir clientes con negocio padre.
  • Registra el historial de cambios (creación o actualización).
  • Notifica via WebSocket a todos los usuarios del negocio.

Ejemplos de Uso

1. Crear nuevo cliente

POST /clients
Authorization: Bearer tu_token_aqui
Content-Type: application/json

{
  "name": "Juan",
  "lastName": "Pérez",
  "document": "12345678",
  "idDocumentType": "CC",
  "phone": "+57 300 123 4567",
  "email": "[email protected]",
  "address": "Calle 123 #45-67"
}

2. Editar cliente existente

POST /clients
Authorization: Bearer tu_token_aqui
Content-Type: application/json

{
  "_id": "507f1f77bcf86cd799439021",
  "name": "Juan",
  "lastName": "García",
  "phone": "+57 300 999 8888"
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

ID del cliente. Si se envía y existe, el cliente se actualiza; si no, se crea uno nuevo.

string

Nombre del cliente

string

Apellido del cliente

string

Número de documento de identidad

integer
enum

Código numérico del tipo de documento. Valores válidos:

  • 11 = Registro civil (RC) - Persona
  • 12 = Tarjeta de identidad (TI) - Persona
  • 13 = Cédula de ciudadanía (CC) - Persona
  • 21 = Tarjeta de extranjería (TE) - Persona
  • 22 = Cédula de extranjería (CE) - Persona
  • 31 = NIT - Empresa
  • 41 = Pasaporte (PS) - Persona
  • 42 = Documento de identificación extranjero (DE) - Persona
  • 43 = Sin identificación del exterior o uso exclusivo de la DIAN (SIDIAN) - Empresa
  • 47 = Permiso Especial de Permanencia (PEP) - Persona
  • 48 = Permiso Protección Temporal (PPT) - Persona
string

Nombre del tipo de documento (texto descriptivo)

integer

Dígito de verificación numérico (para NIT)

string

Teléfono de contacto

string

Correo electrónico

string

Dirección

string

Ciudad

cityDetail
object

Detalle de ciudad (objeto completo)

string

Notas adicionales del cliente

date

Fecha de nacimiento

boolean

Si el cliente es una razón social (empresa)

boolean

Si el cliente es contribuyente de IVA

string

Responsabilidades fiscales del cliente (texto libre)

string

Nombre de la responsabilidad fiscal

contact
object

Persona de contacto del cliente (para empresas)

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json