Sign in
latestOpenAPI 3.0.12026-08-1914141.6 MB

c656412a58bc

Contratos

Listar contratos

Lista os contratos que existem na sua organização.

Os valores dos campos rider_tax, rider_value e total_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)"><!--?lit$8458964218$-->Visualizar valores dos tickets</span>. Caso o usuário não possua esta permissão, esses campos retornarão "--" na resposta.

get/contracts

Query parameters

offsetinteger

Número da página a ser retornada

limitinteger

Número de itens retornados na página

client_idsinteger[]

Filtrar por clientes.

Os IDs devem ser informados na sequência e separados por vírgula

contract_type_idsinteger[]

Filtrar por tipos de contratos.

Os IDs devem ser informados na sequência e separados por vírgula

statusstring[]

Filtrar por status do contrato.

Por padrão, se o status não for especificado, apenas contratos ativos serão listados.

Para filtrar por múltiplos status, informe-os em sequência, separados por vírgula.

Response

idnumber required

Identificador do contrato

cancelledboolean required

Indica se o contrato está cancelado ou com cancelamento agendado

durationnumber nullable required

Duração do contrato em meses. Presente apenas se determinado um prazo de expiração do contrato

expiration_datestring nullable required

Data de expiração do contrato

modality'Free' | 'Credit' | 'Shared' | 'Hours' | 'Saas/Product' | 'Per ticket' | 'Cumulative Hours' required

Modalidade

namestring required

Nome do contrato

readjust_durationnumber nullable required

Intervalo (em meses) para reajuste do contrato. Presente apenas se o contrato tiver reajuste de valores

readjustment_datestring nullable required

Data de reajuste do contrato, se aplicável

rider_taxstring required

Utilizado em contratos de crédito. Esse é o valor fixo mensal à ser pago pelo contrato. Este valor informado não é usado como crédito mensal para abater das horas trabalhadas.

rider_valuestring required

Valor do último adendo

status'actives' | 'readjust' | 'expired' required

Status ou situação em que o contrato se encontra:

  • actives: Ativo

  • readjust: Pendente de reajuste

  • expired: Inativo

total_valuestring required

Valor total do contrato: valor do último adendo (rider_value) + valor fixo mensal (rider_tax)