Crear cliente

Crea un nuevo cliente en Pymes.

Campos del body

CampoTipoObligatorioDescripción
uuidstringNoUUID del cliente (32 chars hex). Si se envía, se realiza un upsert con ese identificador.
idstring (si no hay uuid)Número de identificación del cliente. Máx. 30 caracteres.
tipoIdstringNoTipo de identificación: CC, NIT, PS, DE, etc. Por defecto CC.
dvstringNoDígito de verificación. Se valida automáticamente para CC y NIT. Máx. 2 caracteres.
nombresstring (si tipoId ≠ NIT)Nombres del cliente. Máx. 150 caracteres.
apellidosstring (si tipoId ≠ NIT)Apellidos del cliente. Máx. 100 caracteres.
nombresCompletosstring (si tipoId = NIT)Razón social o nombre completo. Máx. 510 caracteres.
direccionstringNoDirección del cliente. Máx. 60 caracteres.
telefonostringNoTeléfono (solo dígitos). Máx. 12 caracteres.
emailstringNoCorreo electrónico. Máx. 60 caracteres.
ciudad_codigostringNoCódigo DANE de la ciudad. Máx. 5 caracteres.

Reglas de negocio

  • Para personas naturales (tipoId distinto de NIT): son obligatorios nombres y apellidos.
  • Para personas jurídicas (tipoId = NIT): es obligatorio nombresCompletos.
  • El dv se valida automáticamente para CC y NIT. Si no coincide con el calculado, retorna 400.
  • Para tipoId = PS o DE el campo id admite caracteres alfanuméricos ([A-Z0-9], entre 3 y 32 chars).
  • Si el cliente ya existe pero está inactivo o suspendido, el servicio lo reactiva con los datos enviados y retorna 201.
  • Si el cliente ya existe y está activo, retorna 400 con código cliente.crear.ya-existe.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
length between 32 and 32

UUID del cliente existente en Pymes. Si se envía, no se requieren los demás campos.

string
length ≤ 30

Número de identificación del cliente

string
length between 2 and 32
Defaults to CC

Tipo de identificación (CC, NIT, PS, DE, etc.)

string
length ≤ 2

Dígito de verificación. Se valida automáticamente para CC y NIT.

string
length ≤ 150

Nombres del cliente. Requerido si tipoId no es NIT.

string
length ≤ 100

Apellidos del cliente. Requerido si tipoId no es NIT.

string
length ≤ 510

Nombre completo o razón social. Requerido si tipoId es NIT.

string
length ≤ 60

Dirección del cliente

string
length ≤ 12

Teléfono del cliente (solo dígitos)

string
length ≤ 60

Correo electrónico del cliente

string
length ≤ 5

Código DANE de la ciudad del cliente

Responses

500

Error interno del servidor

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