Contrato

Leitura de Contrato pelo ID

Lê um Contrato com base no ID informado na URL da requisição.

get/api/gerenciador/v1/contrato/{id}

Request

  • Base URL: https://api-docs.wk.com.br (the document declares no server; this is the origin it was published from)
  • URL: https://api-docs.wk.com.br/api/gerenciador/v1/contrato/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

ID do Contrato a ser lido.

Response

OK

idstring nullable
codigoIntegradorstring nullable
codigostring nullable
numerostring nullable
idFilialstring nullable
tipoContrato'Nenhum' | 'Simples' | 'Faixa' | 'Medicao' | 'FaixaEMedicao' | 'Parcelamento'
aditivostring nullable
contratoOriginalstring nullable
idClientestring nullable
idCliente2string nullable
descricaostring nullable
valornumber double
tipoFaturamento'Nenhum' | 'Diario' | 'Semanal' | 'Decendial' | 'Quinzenal' | 'Mensal' | 'Bimestral' | 'Trimestral' | 'Quadrimestral' | 'Semestral' | 'Anual'
faturamentoAutomaticoboolean
tipoIndexador'Nenhum' | 'Indice' | 'Valor' | 'Percentual'
idIndicestring nullable
tipoReajuste'Nenhum' | 'Mensal' | 'Bimestral' | 'Trimestral' | 'Quadrimestral' | 'Semestral' | 'Anual' | 'Suspenso' | 'Faturamento' | 'Quinquimestral'
dataContratoInicialstring date
dataContratoFinalstring date
renovacaoAutomaticaboolean
tipoSituacao'Nenhum' | 'Vigente' | 'Inativo' | 'Concluido' | 'Cancelado' | 'Negociacao' | 'Previsao'
dataConcluidostring date
dataCanceladostring date
dataInativostring date
faturarAteboolean
dataFaturarAtestring date
idUsuariostring nullable
dataAssinaturastring date
dataHoraUltimaAlteracaostring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.