TItiflux
Contratos

Listar histórico do grupo de contrato

Changed on

Lista as alterações registradas no grupo de contrato (modalidade Compartilhado), da mais recente para a mais antiga. Como no painel, o histórico é o do grupo: os contratos que compõem o grupo não têm histórico próprio na API, e GET /contracts/{id}/histories responde 404 para eles.

Os campos value e discount_value serão exibidos apenas para usuários com a permissão <span style="white-space: nowrap; margin:1px; padding:1px 8px; font-weight:bold; border-radius:12px; background-color: var(--light-red, var(--input-bg)); color:var(--red); border:1px solid var(--red)">Visualizar valores dos tickets</span>. Caso o usuário não possua esta permissão, esses campos retornarão "--" na resposta.

get/contract-groups/{id}/histories

Request

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

Query parameters

offsetinteger

Número da página a ser retornada

limitinteger

Número de itens retornados na página

Response

idnumber required

Identificador do registro de histórico

rider_numbernumber

Número do adendo vigente quando a alteração foi registrada

releasenumber

Número da revisão do adendo

discount_typenumber nullable

Tipo do desconto

start_datestring date nullable

Data de início do adendo

descriptionstring nullable required

Descrição da alteração. Alterações feitas por esta API têm o prefixo "[API] ". Nulo no registro de adendo removido (status 2)

statusnumber nullable

Tipo do registro: 0 = adendo ou revisão criado, 1 = alteração no contrato ou no adendo, 2 = adendo removido, 3 = contrato criado, 4 = adendo editado ou aviso de consumo enviado por e-mail

created_atstring date-time required

Data e hora da alteração

Changes