https://api.movidesk.com/public/v1

Consumo del contrato de horas

  URL:    /timeAgreementConsumption
  Métodos: GET 

Layout

timeAgreementConsumption

Puntos importantes

• Obligatoriedad del parámetro name: Para búsquedas utilizando startPeriod y endPeriod, es obligatorio especificar el nombre del contrato de horas en la propiedad name.
• Error de falta de $select: Si name no está especificado, la solicitud devolverá un error indicando que el parámetro $select es necesario.
• Prioridad del parámetro $select: Si $select se usa en la solicitud, las propiedades startPeriod, endPeriod y period se ignorarán, y el sistema devolverá un estado 200 - ok.

Por lo tanto, para una solicitud correcta que busca el consumo de horas, es necesario:
1. Especificar la propiedad name con el nombre del contrato de horas.
2. No incluir $select en la solicitud.
3. Utilizar el $filter para definir el intervalo de period en formato Datetime.

Consumo de contrato de horas > Clientes

timeAgreementConsumption.client[n]

Consumo de contrato de horas » Registros de horas
timeAgreementConsumption.timeAppointments[n]

Consumo de contrato de horas » Gastos

timeAgreementConsumption.expenses[n]

Persona

timeAgreementConsumption.timeAppointments[n].createdBy

timeAgreementConsumption.expenses[n].createdBy

timeAgreementConsumption.clients[n].organization


Equipo

timeAgreementConsumption.timeAppointments[n].createdByTeam
timeAgreementConsumption.expenses[n].createdByTeam


Todo el flujo de datos (Visualización) debe tener el formato JSON como se muestra en el ejemplo a continuación:

{
 "id": 1,
 "name": "contrato",
 "baseAmount": 0,
 "exceededHourAmount": 0,
 "renewalDay": 5,
 "contractedHours": 30,
 "differentiateHoursFranchise": false,
 "differentiateHoursConsumption": false,
 "period": "2018-12-01T00:00:00",
 "consumedHours": 1,
 "discount": null,
 "discountType": null,
 "timeAppointments": [
    {
       "id": 222,
       "activity": "Actividad",
       "date": "2018-12-19T00:00:00",
       "periodStart": "10:41:00",
       "periodEnd": "11:41:00",
       "workTime": "01:00:00",
       "workTypeName": "Extra",
       "createdBy": {
             "id": "571AE126-101B-43C7",
             "personType": 1,
             "profileType": 3,
             "businessName": "Luiz",
             "email": "email@movidesk.com",
             "phone": "47983232821",
             "address": null,
             "complement": null,
             "cep": null,
             "city": null,
             "bairro": null,
             "number": null,
             "reference": null
       },
       "createdByTeam": {
             "id": 1755,
             "name": "Nombre"
       },
       "ticketNumber": "98868",
       "actionNumber": 83
    }
 ],
    "expenses": [
       {
          "id": 74,
          "type": "tipo",
          "serviceReport": "0",
          "createdBy": {
              "id": "571AE126-101B-43C7",
              "personType": 1,
              "profileType": 3,
              "businessName": "Tatiana ",
              "email": "andre.vargas@movidesk.com",
              "phone": "47-84211821",
              "address": null,
              "complement": null,
              "cep": null,
              "city": null,
              "bairro": null,
              "number": null,
              "reference": null
        },
        "createdByTeam": null,
        "date": "2018-12-18T00:00:00",
        "quantity": 14,
        "value": 70
     }
 ],
 "clients": [
     {
          "id": "123",
          "personType": 2,
          "profileType": 2,
          "businessName": "Maria",
          "email": maria@gmail.com,
          "phone": 48996888222,
          "isDeleted": false,
          "organization": null,
          "address": null,
          "complement": null,
          "cep": null,
          "city": null,
          "bairro": null,
          "number": null,
          "reference": null
     },
     {
          "id": "312",
          "personType": 2,
          "profileType": 2,
          "businessName": "João",
          "email": joao@gmail.com,
          "phone": 48996338222,
          "isDeleted": false,
          "organization": null,
          "address": null,
          "complement": null,
          "cep": null,
          "city": null,
          "bairro": null,
          "number": null,
          "reference": null
       }
    ]
 }

Obteniendo un único contrato de horas

GET: /timeAgreementConsumption
Parámetros: name, token


Ejemplo:

Obteniendo el contrato con el id 1

GET: https://api.movidesk.com/public/v1/timeAgreementConsumption?token=448f8647-50cb-47e2-995c-b2bbe474486a&name&startPeriod=periodoinicial&endPeriod=periodofinal

Respuesta:

  { 
    "id": 1,
    "name": "contrato",
    "baseAmount": 0,
    "exceededHourAmount": 0,
    "renewalDay": 5,
    "contractedHours": 30,
  ... Otras columnas en el formato del diseño anterior
  }