Contratos

Consultar consumo do contrato

Changed on

Retorna o consumo do contrato por ciclo de apuração: contratado, usado, saldo, excedente e percentual, com a quebra entre atendimento e plantão.

O ciclo vem do cronograma de faturamento do contrato, e não de um intervalo livre de datas: são retornados os até 3 ciclos mais recentes iniciados até a base_date, incluindo o ciclo que contém a data, que pode ainda estar aberto (closed: false).

Em Horas acumuladas, os ciclos param no primeiro ciclo ainda não faturado, porque o crédito acumulado dos ciclos seguintes ainda não foi apurado: uma base_date posterior a esse ciclo devolve os mesmos ciclos que a data atual.

contracted, used, balance e percent_used saem arredondados em 2 casas decimais.

Contratos das modalidades Livre e SaaS/Produto não têm ciclo de apuração e retornam cycles vazio.

get/contracts/{id}/usage

Request

  • Base URL
    https://api.tiflux.com/api/v2
  • Auth
    HTTP bearer

Query parameters

base_datestring date

Data de referência para apurar os ciclos. Quando omitida, usa a data atual.

Response

contract_idnumber required

Identificador do contrato

namestring required

Nome do contrato

modality'free' | 'credit' | 'shared' | 'hours' | 'recurrent' | 'per_ticket' | 'cumulative_hours' required

Modalidade do contrato

last_consume_notificationstring nullable required

Data do ciclo da última notificação de consumo enviada ao cliente

Changes