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

Consumo de contrato de horas

  URL:    /timeAgreementConsumption
  Métodos: GET 

Layout

timeAgreementConsumption

Consumo de contrato de horas > Clientes

timeAgreementConsumption.client[n]

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

Consumo de contrato de horas » Despesas

timeAgreementConsumption.expenses[n]

Person

timeAgreementConsumption.timeAppointments[n].createdBy

timeAgreementConsumption.expenses[n].createdBy

timeAgreementConsumption.clients[n].organization


Team

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


Todo o fluxo de dados (Visualização) devem possuir o formato JSON conforme exemplo abaixo:

{
 "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": "Atividade",
 "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": "Nome"
 },
 "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
 }
 ]
 }

Obtendo um único contrato de horas

GET: /timeAgreementConsumption
Parâmetros: name, token


Exemplo:

Obtendo o contrato com o id 1

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

Retorno:

  { 
    "id": 1,
    "name": "contrato",
    "baseAmount": 0,
    "exceededHourAmount": 0,
    "renewalDay": 5,
    "contractedHours": 30,
  ... Demais colunas no formato do layout acima
  }

Obtendo uma lista de contratos de horas

GET: /timeAgreementConsumption
Parametros: token, $select


Exemplo:

Obtendo uma lista de contratos de horas(é obrigatório o uso da cláusula $select)

GET: https://api.movidesk.com/public/v1/timeAgreementConsumption?token=52ee6ca5-8639-422b-bafe-470013c11176&$select=name,renewalDay

Retorno:

[
 { 
 "name": "contrato",
 "renewalDay": "5"  
 },
 {
 "name": "contrato2",
 "renewalDay": "10" 
 }
 ... Demais itens da lista 
 ]

Obtendo os contratos de horas com filtros

GET: /timeAgreementConsumption
Parâmetros: token, $select

Para permitir e simplificar consultas com filtros, a API utiliza o protocolo aberto OData. Os filtros possíveis são:
• $filter: a expressão especificada com esse filtro é avaliada para cada item do retorno da consulta e somente os itens em que o resultado da expressão for verdadeiro serão incluídos no retorno final;
• $orderby: permite que os itens do retorno da consulta sejam ordenados de forma ascendente (asc) ou descendente (desc). Se não for especificado asc ou desc, o padrão será asc;
• $top: permite especificar o número de itens que devem ser incluídos no retorno da consulta;
• $skip: permite especificar a quantidade de itens que devem ser ignorados e não incluídos no retorno da consulta;
• $select: permite especificar propriedades especificas dos itens que devem ser preenchidas no retorno da consulta;
• $expand: permite expandir as coleções filhas dos itens consultados.

Exemplos:

Obtendo o nome e o dia de renovação dos contratos de horas que possuam o número de horas contratadas maior do que 30:

GET: https://api.movidesk.com/public/v1/timeAgreementConsumption?token=52ee6ca5-8639-422b-bafe-470013c11176&$select=name,renewalDay&$filter=contractedHours gt 30

Retorno:

[
 { 
 "name": "contrato3",
 "renewalDay": "9" 
 },
 {
 "name": "contrato5",
 "renewalDay": "11" 
 }
 ]

Obtendo o id, nome e dia de renovação dos contratos de horas que possuam o número de horas contratadas maior do que 30 e ordenados de forma descendente em relação ao nome:

GET: https://api.movidesk.com/public/v1/timeAgreementConsumption?token=52ee6ca5-8639-422b-bafe-470013c11176&$select=id,name,renewalDay&$filter=contractedHours gt 30&$orderby=id desc

Retorno:

[ 
  {
   "id": "29",
   "name": "contrato3",
   "renewalDay": "9"
 },
 {
   "id": "20",
   "name": "contrato5",
   "renewalDay": "11"
 },
    ... Demais itens da lista que possuam as horas contratadas maior do que 30 e ordenados de forma descendente em relação ao id
]