LOloggro
Clientes

Obtener un cliente por ID

Devuelve el detalle completo de un cliente específico del 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:

  • El cliente debe pertenecer al negocio autenticado.
  • Si el negocio tiene configurado compartir clientes con el negocio padre, también se busca en el negocio padre.
  • Retorna null si el cliente no existe (sin error 404).

Ejemplo de Uso

GET /clients/507f1f77bcf86cd799439021
Authorization: Bearer tu_token_aqui
get/clients/{id}

Request

  • Base URL
    https://api.pirpos.com
  • URL
    https://api.pirpos.com/clients/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

ID único del cliente (MongoDB ObjectId)

Response

Cliente encontrado exitosamente

_idstring

ID único del cliente

businessstring

ID del negocio al que pertenece el cliente

isSocialReasonboolean

Indica si es una razón social (empresa)

responsibilitiesstring

Responsabilidades tributarias

responsibilityNamestring

Nombre de la responsabilidad tributaria

namestring

Nombre del cliente

lastNamestring

Apellido del cliente

idDocumentTypenumber

Tipo de documento de identidad

documentNamestring

Nombre del tipo de documento

documentstring

Número de documento

checkDigitnumber

Dígito verificador del documento

isVATCompanyTypeboolean

Indica si es una empresa con IVA

emailstring email

Correo electrónico del cliente

phonestring

Número de teléfono del cliente

addressstring

Dirección del cliente

citystring

Ciudad del cliente (deprecado)

postalCodestring

Código postal

notesstring

Notas adicionales sobre el cliente

deletedboolean

Indica si el cliente está eliminado

modifiedOnstring date-time

Fecha de última modificación

createdOnstring date-time

Fecha de creación

birthdatestring date

Fecha de nacimiento del cliente

pointsnumber

Puntos de fidelidad del cliente

Example response

{
  "_id": "507f1f77bcf86cd799439021",
  "business": "507f1f77bcf86cd799439012",
  "responsibilities": "R-99-PN",
  "responsibilityName": "Régimen Simplificado",
  "name": "Juan",
  "lastName": "Pérez",
  "idDocumentType": 1,
  "documentName": "Cédula de Ciudadanía",
  "document": "12345678",
  "checkDigit": 9,
  "email": "juan@email.com",
  "phone": "+57 300 123 4567",
  "address": "Calle 123 #45-67",
  "cityDetail": {
    "countryCode": "CO",
    "stateCode": "11",
    "stateName": "Bogotá D.C.",
    "cityCode": "11001",
    "cityName": "Bogotá"
  },
  "city": "Bogotá",
  "postalCode": "110111",
  "notes": "Cliente preferencial con descuentos especiales",
  "deletedInfo": {
    "deletedBy": "507f1f77bcf86cd799439020",
    "date": "2025-08-05T10:30:00.000Z"
  },
  "modifiedOn": "2025-08-05T10:30:00.000Z",
  "createdOn": "2025-08-05T10:00:00.000Z",
  "birthdate": "1990-05-15",
  "points": 150,
  "creditMovement": [
    {
      "paymentMethod": {
        "internalId": "507f1f77bcf86cd799439030",
        "name": "Efectivo"
      },
      "date": "2025-08-05T10:30:00.000Z",
      "total": 50000,
      "notes": "Abono a cuenta"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.