Contrato

Busca de Contratos

Lê uma lista de Contratos com base no filtro informado na URL da requisição.

get/api/gerenciador/v1/contrato

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
  • Auth: HTTP bearer

Query parameters

Codigostring
Numerostring
TipoContrato'Nenhum' | 'Simples' | 'Faixa' | 'Medicao' | 'FaixaEMedicao' | 'Parcelamento'
SituacaoContrato'Nenhum' | 'Vigente' | 'Inativo' | 'Concluido' | 'Cancelado' | 'Negociacao' | 'Previsao'
TipoRenovacao'Todos' | 'Renovacao' | 'SemRenovacao'
DataContratoInicialstring date
DataContratoFinalstring date
DataAssinaturaInicialstring date
DataAssinaturaFinalstring date
DataSituacaoInicialstring date
DataSituacaoFinalstring date
DataFaturamentoInicialstring date
DataFaturamentoFinalstring date
DataHoraUltimaAlteracaoInicialstring date-time
DataHoraUltimaAlteracaoFinalstring date-time
Descricaostring
ContratoOriginalstring
IdFilialstring
IdIndicestring
IdClientestring
IdCliente2string
IdClassificacaostring
IdGerencialstring
IdServicostring
Idsstring[]

IDs dos registros a serem filtrados. Caso seja passado um ID inválido ou inexistente o dado será retornado como null.

CodigosIntegradorstring[]

Códigos de integrador dos registros a serem filtrados.

Fieldsstring[]

Campos retornados na busca.

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.