TItiflux
Contratos

Consultar grupo de contrato

Changed on

Retorna os dados de um grupo de contrato (modalidade Compartilhado).

Grupos de contrato e contratos individuais vêm de tabelas distintas, com identificadores independentes: o mesmo ID pode existir nos dois. Use o campo kind da listagem GET /contracts para saber qual rota consultar.

Os campos monetários do adendo 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}

Request

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

Response

idnumber required

Identificador do grupo de contrato

kind'contract_group' required

Origem do registro

namestring required

Nome do grupo de contrato

activeboolean required

Indica se o grupo de contrato está ativo

expiration_datestring nullable required

Data de expiração do grupo de contrato

durationnumber nullable required

Duração do grupo de contrato em meses

automatic_renewalboolean required

Renovação automática

billing_in_batchboolean required

Faturamento em lote

automatic_billingboolean required

Faturamento automático

billing_days_beforenumber nullable required

Faturar em quantos dias antes. Nulo quando o faturamento automático está desabilitado

technical_observationsstring nullable

Observações técnicas

Changes

  • 04c2680f0936Revision changes
    • info

      added the optional property // to the response with the status

  • 98fe904b6118Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status