Upnify API Docs
CRM · /sistema/metas

Sistema

Metas - Lista

GET/sistema/metas

Permite obtener la lista de metas registradas en el sistema.

Parámetros

NombreTipoValidaciónDescripción
filtrosObjectRequeridoArreglo de datos, en el que se definen los filtros para la obtención de los resultados.
periodoStringRequeridoEsta variable se envía, para definir un periodo de tiempo, en el que se realizará la búsqueda de las metas.
tkTipoMetaUUIDRequeridoContiene el código token de un tipo de meta, este parámetro se envía cuando se selecciona el filtro "Por meta"
tipoMetaIntegerRequeridoContiene el código para un tipo de meta, este parámetro se envía cuando se selecciona el filtro "Mostrar".
statusIntegerRequeridoCódigo que indica el estado de las metas a consultar.
tkTabUUIDRequeridoCódigo token de la tab en donde se encuentran las metas.
tkUsuarioUUIDRequeridoCódigo token de un usuario, se envía cuando se selecciona el valor de "individuales" del filtro "Mostrar".
tkGrupoUUIDRequeridoCódigo token de un grupo de usuarios, se envía cunado en el filtro "Mostrar", "Grupales" o "Empresariales" se encuentra seleccionado.
fechaInicioDateRequeridoEste parámetro se envía cuando en el filtro "Periodo", se encuentra seleccionado "Periodo", y permite establecer una fecha de inicio para un rango de búsqueda de una meta.
fechaFinDateRequeridoEste parámetro se envía cuando en el filtro "Periodo", se encuentra seleccionado "Periodo", y permite establecer una fecha de fin para un rango de búsqueda de una meta.

Respuesta

NombreTipoDescripción
tkTabUUIDCódigo token que corresponde al tab o pestaña en donde se encuentra listada la meta.
tabStringContiene el nombre de la tab o pestaña en donde se encuentra listada la meta.
tkTipoMetaUUIDCódigo token que corresponde al tipo de meta utilizado.
componenteStringContiene una descripción del tipo de meta utilizado.
tkMetaUUIDCódigo token que identifica de forma única a la meta.
inicialesCreadorUtringContiene las iniciales del nombre del ejecutivo que creó la meta.
tkGrupoCreadorUUIDCódigo token del grupo de usuarios al que pertenece el usuario que creó la meta.
grupoCreadorStringNombre del grupo de usuarios al que pertenece el usuario que creó la meta.
tkUsuarioResponsableUUIDCódigo token de un usuario, el cual, es el responsable de cumplir la meta.
ejecutivoResponsableStringNombre de un usuario, el cual, es el responsable de cumplir la meta.
inicialesResponsableStringInciales del nombre de un usuario, el cual, es el responsable de cumplir la meta.
tkGrupoResponsableUUIDCódigo token de un grupo de usuarios, los cuales, son los responsables de cumplir la meta.
grupoResponsableStringNombre de un grupo de usuarios, los cuales, son los responsables de cumplir la meta.
descripcionStringProporciona una descripción a la meta creada.
metaFloatContiene una cantidad, la cual es, la meta a alcanzar.
avanceFloatIndica la cantidad actual de avance con respecto a la cantidad fijada en la meta.
porcentajeAvanceFloatContiene un número base 1, que indica un porcentaje, el cual es el avance de la meta.
ponderacionFloatIndica el porcentaje de valor de la meta, el porcentaje se encuentra en base 1, donde 1 es el 100%.
ordenIntegerDefine la posición del registro con respecto a los demas registros, en la vista de sistema.
inicioDatetimeContiene un formato compuesto de fecha y hora, el cual marca el inicio de la contabilización de la meta.
finDatetimeContiene un formato compuesto de fecha y hora, el cual marca el fin de la contabilización de la meta.
diasIntegerDefine el número de días disponiples para cumplir la meta, el número de días es marcado por la fecha de inicio y fin de una meta.
diasTranscurridosIntegerContiene la contabilización de los días transcurridos desde que inició la contabilización de la meta.

Solicitud

Ejemplo de parámetros

{
    "filtros":"[{\"periodo\":\"0\",\"tkTipoMeta\":\"\",\"tipoMeta\":\"0\",
            \"status\":\"0\",\"tkTab\":\"\",\"tkUsuario\":\"\",
            \"tkGrupo\":\"\",\"fechaInicio\":\"\",\"fechaFin\":\"\"}]"
}