7. Clientes

Este modulo es el encargado de gestionar los clientes del sistema.

Método	Endpoint	Descripción
GET	/api/clients	Lista de cliente registrados
POST	/api/clients	Crear un cliente
GET	/api/clients/{clientId}	Detalles de cliente
PATCH	/api/clients/{clientId}	Modificación de datos de un cliente
DELETE	/api/clients/{clientId}	Eliminación de un cliente

Ejemplo de cuerpo json POST

{
    "code": "CL001",
    "name": "Vito Sanchez",
    "document_type_code": "dni",
    "document_number": "1215482",
    "contact_data": {
        "email": "vitos@gmail.com",
        "web": "https://www.google.com",
        "phone_1": "45154658",
        "phone_2": "455648",
        "address": "Cercado de Lima"
    },
    "custom_properties" : {}
}

7.1 Parámetros

Nombre	Modo	Tipo	Descripción
code	Optional	String	Admite letras, números, guiones y guiones bajos pero no espacios
name	Required	String	Nombre de cliente
document_type_code	Required	String	Tipo de documento registrado en el modulo de taxonomías del sistema
document_number	Required	String	Número de Documento y admite letras, números, guiones y guiones bajos pero no espacios
contact_data.email	Optional	String - Email	Email de contacto
contact_data.web	Optional	String - Url	Dirección Web
contact_data.phone_1	Optional	String	Teléfono 1
contact_data.phone_2	Optional	String	Teléfono 2
contact_data.address	Optional	String	Dirección
custom_properties	Optional	Array	Parámetros custom adicionales