Upnify API Docs
CRM · /sistema/metas

Sistema

Metas - Creación

POST/sistema/metas

Permite crear una meta y asignarla a un usuario o a un grupo de usuarios.

Parámetros

NombreTipoValidaciónDescripción
tituloStringRequeridoContiene el nombre de la meta, este parámetro es necesario para el ScoreCard.
ponderacionFloatRequeridoContiene un valor que representa un valor de porcentaje para una meta, el valor se encuentra base 1, donde 1 es el 100%, este parámetro es necesario para el ScoreCard.
tkTipoMetaUUIDRequeridoCódigo token que corresponde a un tipo de meta.
tkTabUUIDRequeridoCódigo token que corresponde a una tab de metas.
tipoMetaIntegerRequeridoCódigo que indica si la meta será Individual, Grupal , Empresarial o Distribuidor.
tipoPeriodoIntegerRequeridoCódigo que permite definir el tipo de periodo para una meta.
formatoIntegerRequeridoCódigo que define el formato de la cantidad de la meta a alcanzar, puede ser un monto monetario, o una contabilización.
usuariosAutorizadosStringRequeridoContiene un arreglo con los token de los usuarios autorizados a cambiar el valor de una meta, este parámetro se envía cuando el token de tipo de meta corresponde a manual.
metasObjectRequeridoEste objeto contiene el valor de la meta a lograr y a quién o quienes se les asigna la meta.
tkGrupoUUIDRequeridoCódigo token de que corresponde a un grupo de usuarios en el sitema.
tkUsuarioUUIDRequeridoCódigo token que corresponde a un usuario específico en el sistema.
tkDistribuidorUUIDRequeridoCódigo token que hace referencia a un distribuidor en el sitema.
periodoObjectRequeridoEste objeto permite guardar la información del valor de la meta, así como la fecha de inicio y de fin de la meta, si la meta a cumplir se divide en más de un periodo, es necesario colocar todos los periodos.
metaIntegerRequeridoIndica el valor de la meta a alcanzar, el valor depende del tipo de meta escogido previamente, puede representar un monto monetario, o un conteo de ventas, etc.
fechaInicioDateRequeridoMarca el inicio de la meta, la fecha desde la cual la meta empieza a ser válida.
fechaFinDateRequeridoMarca el final de la meta, la fecha a la cual vence el plazo válido de una meta.
criteriosObjectRequeridoEste objeto contiene información de configuración específica para cada meta. Es necesario enviar los criterios correspondientes para cada meta.
tkCriterioIntegerRequeridoCódigo token que corresponde a un tipo de criterio para el filtro.
criterioUUIDRequeridoCódigo que identifica al tipo de criterio que corresponde al token de criterio.
operadorIntegerRequeridoCódigo que indica el tipo de operador lógico utilizado para los filtros, o criterios.

Solicitud

Ejemplo de parámetros Metas

{
    "tkTipoMeta": "EE2391F2-0CAD-4462-A631-1CF28F5B7DF7",
    "tkTab":"",
    "tipoMeta": "3",
    "tipoPeriodo": "6",
    "formato": "2",
    "usuariosAutorizados":"U-6106C482-381F-4587-9CEB-80A7822D041B,U-AF45248E-DB1B-444D-9ED8-D2776E43A071",
    "metas":[
        {
            "tkGrupo":"2D86F432-3ED0-4CF4-B5F5-504140D2E352",
            "tkUsuario":"",
            "periodo":[
                {
                    "meta":5000,
                    "fechaInicio":"2018/10/01",
                    "fechaFin":"2018/10/10"
                },
                {
                    "meta":6000,
                    "fechaInicio":"2018/10/11",
                    "fechaFin":"2018/10/20"
                }
            ]
        },
        {
            "tkGrupo":"",
            "tkUsuario":"U-6DD17E5B-9E13-42EF-9C6A-299C8431C286",
            "periodo":[
                {
                    "meta":7000,
                    "fechaInicio":"2018/10/21",
                    "fechaFin":"2018/10/30"
                },
                {
                    "meta":8000,
                    "fechaInicio":"2018/11/01",
                    "fechaFin":"2018/11/10"
                }
            ]
        }
    ],
    "criterios": [
        {
            "tkCriterio":"A8FF0705-AA8F-4C1A-9876-193864D483F0",
            "criterio":2,
            "operador":1
        },
        {
            "tkCriterio":"E8FF0705-AU8F-4C8Y-9396-193864D483Z9",
            "criterio":4,
            "operador":1
        }
    ]
}

Ejemplo de parámetros ScoreCard

{
    "tkTab":"",
    "tipoPeriodo": "6",
    "metas":[
        {
            "tkGrupo":"2D86F432-3ED0-4CF4-B5F5-504140D2E352",
            "tkUsuario":"",
            "periodo":[
                {
                    "meta":5000,
                    "ponderacion":1,
                    "fechaInicio":"2018/10/01",
                    "fechaFin":"2018/10/10"
                },
                {
                    "meta":6000,
                    "ponderacion":1,
                    "fechaInicio":"2018/10/11",
                    "fechaFin":"2018/10/20"
                }
            ]
        },
        {
            "tkGrupo":"",
            "tkUsuario":"U-6DD17E5B-9E13-42EF-9C6A-299C8431C286",
            "periodo":[
                {
                    "meta":7000,
                    "ponderacion":1,
                    "fechaInicio":"2018/10/21",
                    "fechaFin":"2018/10/30"
                },
                {
                    "meta":8000,
                    "ponderacion":0.5,
                    "fechaInicio":"2018/11/01",
                    "fechaFin":"2018/11/10"
                }
            ]
        }
    ]
}