Persona

Consulta

Obtener listado de Personas

GET https://api.contifico.com/sistema/api/v1/persona/

Devuelve un listado con todas las personas creadas en el sistema

Respuesta al consultar todas las personas

[
    {
        "adicional1_cliente": "",
        "personaasociada_id": "GOjZdy9jgMcydJ4m",
        "direccion": "",
        "id": "pKBe1Eqk8f6zeXyO",
        "es_vendedor": false,
        "tipo": "N",
        "razon_social": "huesped prueba",
        "nombre_comercial": "nombre comercial prueba",
        "es_corporativo": null,
        "porcentaje_descuento": null,
        "origen": null,
        "ruc": "",
        "banco_codigo_id": null,
        "email": "info@info.com",
        "adicional3_cliente": "",
        "es_cliente": true,
        "adicional1_proveedor": "",
        "numero_tarjeta": "",
        "adicional3_proveedor": "",
        "es_extranjero": false,
        "adicional2_cliente": "",
        "es_empleado": false,
        "aplicar_cupo": false,
        "es_proveedor": false,
        "telefonos": "",
        "adicional4_proveedor": "",
        "tipo_cuenta": null,
        "adicional4_cliente": "",
        "placa": null,
        "adicional2_proveedor": "",
        "cedula": "1802895555",
        "id_categoria": "ZOjZdy0jgMcydJ4n",
        "categoria_nombre": "categoria_persona1"
    },
    {
        "adicional1_cliente": null,
        "personaasociada_id": "IOjZdy0jgMcydJ4m",
        "direccion": "quito",
        "id": "lwKe5yn07gFMje31",
        "es_vendedor": false,
        "tipo": "N",
        "razon_social": "DORIS ESPINOSA",
        "nombre_comercial": "DORIS ESPINOSA",
        "es_corporativo": false,
        "porcentaje_descuento": null,
        "origen": null,
        "ruc": "",
        "banco_codigo_id": null,
        "email": "dorisjespinosa@hotmail.com",
        "adicional3_cliente": null,
        "es_cliente": true,
        "adicional1_proveedor": null,
        "numero_tarjeta": null,
        "adicional3_proveedor": null,
        "es_extranjero": false,
        "adicional2_cliente": null,
        "es_empleado": false,
        "aplicar_cupo": false,
        "es_proveedor": false,
        "telefonos": "222222",
        "adicional4_proveedor": null,
        "tipo_cuenta": null,
        "adicional4_cliente": null,
        "placa": null,
        "adicional2_proveedor": null,
        "cedula": "1712518024",
        "id_categoria": "ZOjZdy0jgMcydJ4n",
        "categoria_nombre": "categoria_persona2"
    },
    ...
]

Parámetro	Tipo	Longitud	Descripción
id	varchar	16	Identificador de la cuenta en el sistema.
adicionales_cliente	varchar	300	Informacion adicional del cliente.
personaasociada_id	varchar	16	Identificador de la persona asociada a la persona actual.
direccion	varchar	300	Direccion de la persona.
es_vendedor	boolean	1	Rol vendedor de la persona.
tipo	varchar	1	Tipo de persona (N:Natural J:Juridica I:SinId P:Placa).
razon_social	varchar	300	Razon social de la persona.
nombre_comercial	varchar	300	Nombre comercial de la persona.
es_corporativo	boolean	1	Rol corporativo de la persona.
porcentaje_descuento	decimal	2	Descuento de tipo cliente (2 decimales Max).
origen	varchar	3	Tipo de POS desde el cual se registro.
ruc	varchar	13	Ruc de la persona.
banco_codigo_id	varchar	16	Codigo de banco asociado a la persona.
email	varchar	50	Correo de la persona.
es_cliente	boolean	1	Rol vendedor de la persona.
adicionales_proveedor	varchar	300	Informacion adicional del proveedor.
numero_tarjeta	varchar	200	Numero de tarjeta de la persona.
es_extranjero	boolean	1	Verificador de personas extranjeras.
es_empleado	boolean	1	Rol empleado de la persona.
es_proveedor	boolean	1	Rol proveedor de la persona.
aplicar_cupo	boolean	1	Verificador si la persona tiene un cupo maximo como cliente.
telefonos	varchar	50	Telefono de la persona.
tipo_cuenta	varchar	2	tipo de la cuenta contable asociada.
placa	varchar	13	Placa de la persona si es de tipo placa.
cedula	varchar	10	Cedula de la persona.
id_categoria	varchar	16	Identificador de la categoria persona en el sistema.
categoria_nombre	varchar	40	Nombre de la categoria asociada a la persona.

Query Parameters

Parámetro	Tipo	Longitud	Descripción
identificacion	varchar	13	Cédula o Ruc de la persona.
fecha_inicial	date		Filtro de fecha inicial de la fecha de ultimo cambio.
fecha_final	date		Filtro de fecha final de la fecha de ultimo cambio.
filtro	varchar	200	Filtro que puede contener la razon social o nombre comercial.
adicional_1	varchar	50	Filtro para campo adicional 1 de cliente.
adicional_2	varchar	50	Filtro para campo adicional 2 de cliente.
adicional_3	varchar	50	Filtro para campo adicional 3 de cliente.
adicional_4	varchar	50	Filtro para campo adicional 4 de cliente.
categoria_id	varchar	16	Identificador de la categoria persona en el sistema.

Obtener una Persona

GET https://api.contifico.com/sistema/api/v1/persona/<ID>/

Devuelve una persona con el <ID> solicitado.

Respuesta al consultar una persona

[
    {
        "adicional1_cliente": "123456",
        "personaasociada_id": null,
        "direccion": "Edificio las camaras",
        "id": "4Lmav7AK4TENb3Nr",
        "es_vendedor": false,
        "tipo": "N",
        "razon_social": "Fernando Apupalo",
        "nombre_comercial": "Fernando Apupalo",
        "es_corporativo": false,
        "porcentaje_descuento": "0.0",
        "origen": null,
        "ruc": null,
        "banco_codigo_id": null,
        "email": "lala@gmail.com",
        "adicional3_cliente": "",
        "es_cliente": true,
        "adicional1_proveedor": "",
        "numero_tarjeta": null,
        "adicional3_proveedor": "",
        "es_extranjero": false,
        "adicional2_cliente": "",
        "es_empleado": false,
        "aplicar_cupo": false,
        "es_proveedor": false,
        "telefonos": "23232",
        "adicional4_proveedor": "",
        "tipo_cuenta": null,
        "adicional4_cliente": "",
        "placa": null,
        "adicional2_proveedor": "",
        "cedula": "0939877993",
        "id_categoria": "ZOjZdy0jgMcydJ4n",
        "categoria_nombre": "categoria_persona2"
    }
]

Parámetro	Tipo	Longitud	Descripción
id	varchar	16	Identificador de la cuenta en el sistema.
adicionales_cliente	varchar	300	Informacion adicional del cliente.
personaasociada_id	varchar	16	Identificador de la persona asociada a la persona actual.
direccion	varchar	300	Direccion de la persona.
es_vendedor	bool		Rol vendedor de la persona.
tipo	varchar	1	Tipo de persona (N:Natural J:Juridica I:SinId P:Placa).
razon_social	varchar	300	Razon social de la persona.
nombre_comercial	varchar	300	Nombre comercial de la persona.
es_corporativo	bool		Rol corporativo de la persona.
porcentaje_descuento	decimal	2	Descuento de tipo cliente (2 decimales Max).
origen	varchar	3	Tipo de POS desde el cual se registro.
ruc	varchar	13	Ruc de la persona.
banco_codigo_id	varchar	16	Codigo de banco asociado a la persona.
email	varchar	50	Correo de la persona.
es_cliente	bool		Rol vendedor de la persona.
adicionales_proveedor	varchar	300	Informacion adicional del proveedor.
numero_tarjeta	varchar	200	Numero de tarjeta de la persona.
es_extranjero	bool		Verificador de personas extranjeras.
es_empleado	bool		Rol empleado de la persona.
es_proveedor	bool		Rol proveedor de la persona.
aplicar_cupo	bool		Verificador si la persona tiene un cupo maximo como cliente.
telefonos	varchar	50	Telefono de la persona.
tipo_cuenta	varchar	2	tipo de la cuenta contable asociada.
placa	varchar	13	Placa de la persona si es de tipo placa.
cedula	varchar	10	Cedula de la persona.
id_categoria	varchar	16	Identificador de la categoria persona en el sistema.
categoria_nombre	varchar	40	Nombre de la categoria asociada a la persona.

Crear una Persona

Para crear una persona se debe de hacer uso de la url:

POST https://api.contifico.com/sistema/api/v1/persona/?pos=<TOKEN>

Por medio del método POST enviando en el cuerpo del requerimiento los datos de la persona:

Estructura del JSON:

    {
        "tipo": "J",
        "personaasociada_id": "AUOjQdy9jgMcydJ4m",
        "nombre_comercial": null,
        "telefonos": "2745486",
        "ruc": "0990004776201",
        "razon_social": "Andres",
        "direccion": "AV. 9 DE OCTUBRE 729 Y BOYACA - GARCIA AVILES",
        "es_extranjero": false,
        "porcentaje_descuento": "10",
        "es_cliente": false,
        "id": null,
        "es_empleado": false,
        "email": "agomez@nomail.com",
        "cedula": "",
        "placa": "24567",
        "es_vendedor": false,
        "es_proveedor": true,
        "adicional1_cliente": null,
        "adicional2_cliente": null,
        "adicional3_cliente": null,
        "adicional4_cliente": null,
        "adicional1_proveedor": null,
        "adicional2_proveedor": null,
        "adicional3_proveedor": null,
        "adicional4_proveedor": null
    }

Parámetro	Tipo	Longitud	Descripción	Obligatorio
adicionales_cliente	varchar	300	Informacion adicional del cliente (acepta null)	No
personaasociada_id	varchar	16	Identificador de la persona asociada a la persona actual (acepta null)	No
direccion	varchar	300	Direccion de la persona	No
es_vendedor	boolean	1	Rol vendedor de la persona	No
tipo	varchar	1	Tipo de persona (N:Natural J:Juridica I:SinId P:Placa)	Si
razon_social	varchar	300	Razon social de la persona	Si
nombre_comercial	varchar	300	Nombre comercial de la persona	Opcional
es_corporativo	boolean	1	Rol corporativo de la persona	No
porcentaje_descuento	decimal	2	Descuento de tipo cliente	No
origen	varchar	3	Tipo de POS desde el cual se registro (acepta null)	No
ruc	varchar	13	Ruc de la persona	Opcional
banco_codigo_id	varchar	16	Codigo de banco asociado a la persona (acepta null)	No
email	varchar	50	Correo de la persona	No
es_cliente	boolean	1	Rol vendedor de la persona	Si
adicionales_proveedor	varchar	300	Informacion adicional del proveedor	No
numero_tarjeta	varchar	200	Numero de tarjeta de la persona	No
es_extranjero	boolean	1	Verificador de personas extranjeras	No
es_empleado	boolean	1	Rol empleado de la persona	No
es_proveedor	boolean	1	Rol proveedor de la persona	Si
aplicar_cupo	boolean	1	Verificador si la persona tiene un cupo maximo como cliente	No
telefonos	varchar	50	Telefono de la persona	No
tipo_cuenta	varchar	2	tipo de la cuenta contable asociada	No
placa	varchar	13	Placa de la persona si es de tipo placa	Opcional
cedula	varchar	10	Cedula de la persona	Si

Parámetro	Tipo	Longitud	Descripción
token	varchar	16	Token enviado por Contifico.

NOTA: Para el correcto funcionamiento de la persona en la pagina web de contifico, campos de asignacion de rol en la empresa como es_vendedor, es_cliente, es_empleado, es_proveedor aunque no son obligatorios para la creacion de la persona se debe enviar rol para el cual sera usada la persona. Los campos opcionales son obligatorios dependiendo del tipo de persona que se cree, personas Juridicas requieren el envio del campo ruc.

Modificar una Persona

Para modificar una persona se debe de hacer uso de la url:

PUT https://api.contifico.com/sistema/api/v1/persona/?pos=<TOKEN>

Por medio del método PUT enviando en el cuerpo del requerimiento los datos de la persona:

Estructura del JSON:

    {
        "id": "AUOjQdy9jgMcydJ4m",
        "tipo": "J",
        "personaasociada_id": null,
        "nombre_comercial": null,
        "telefonos": "2745486",
        "ruc": "0990004776201",
        "razon_social": "Andres",
        "direccion": "AV. 9 DE OCTUBRE 729 Y BOYACA - GARCIA AVILES",
        "es_extranjero": false,
        "porcentaje_descuento": "10",
        "es_cliente": false,
        "id": null,
        "es_empleado": false,
        "email": "agomez@nomail.com",
        "cedula": "",
        "placa": "24567",
        "es_vendedor": false,
        "es_proveedor": true,
        "adicional1_cliente": null,
        "adicional2_cliente": null,
        "adicional3_cliente": null,
        "adicional4_cliente": null,
        "adicional1_proveedor": null,
        "adicional2_proveedor": null,
        "adicional3_proveedor": null,
        "adicional4_proveedor": null
    }

Parámetro	Tipo	Longitud	Descripción	Obligatorio
id	varchar	16	Identificador de la cuenta en el sistema	Si
adicionales_cliente	varchar	50	Informacion adicional del cliente (acepta null)	No
personaasociada_id	varchar	16	Identificador de la persona asociada a la persona actual (acepta null)	No
direccion	varchar	300	Direccion de la persona	No
es_vendedor	bool		Rol vendedor de la persona	No
tipo	varchar	1	Tipo de persona (N:Natural J:Juridica I:SinId P:Placa)	Si
razon_social	varchar	50	Razon social de la persona	Si
nombre_comercial	varchar	50	Nombre comercial de la persona	Opcional
es_corporativo	bool		Rol corporativo de la persona	No
porcentaje_descuento	decimal	2	Descuento de tipo cliente	No
origen	varchar	3	Tipo de POS desde el cual se registro (acepta null)	No
ruc	varchar	13	Ruc de la persona	Opcional
banco_codigo_id	varchar	16	Codigo de banco asociado a la persona (acepta null)	No
email	varchar	50	Correo de la persona	No
es_cliente	bool		Rol vendedor de la persona	No
adicionales_proveedor	varchar	50	Informacion adicional del proveedor	No
numero_tarjeta	varchar	200	Numero de tarjeta de la persona	No
es_extranjero	bool		Verificador de personas extranjeras	No
es_empleado	bool		Rol empleado de la persona	No
es_proveedor	bool		Rol proveedor de la persona	No
aplicar_cupo	bool		Verificador si la persona tiene un cupo maximo como cliente	No
telefonos	varchar	50	Telefono de la persona	No
tipo_cuenta	varchar	2	tipo de la cuenta contable asociada	No
placa	varchar	13	Placa de la persona si es de tipo placa	Opcional
cedula	varchar	10	Cedula de la persona	Si

Parámetro	Tipo	Longitud	Descripción
token	varchar	16	Token enviado por Contifico.