Contrato

Atualização de Contrato

Atualiza o contrato com o ID igual ao informado na URL da requisição com base nos dados do body.

patch/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 atualizado.

Request body

codigoIntegradorstring nullable
numerostring nullable
idFilialstring nullable

Define qual a filial do contrato. Se não informado, será considerado a primeira filial cadastrada do cadastro de Filiais do Radar Empresarial.

tipoContrato'Nenhum' | 'Simples' | 'Faixa' | 'Medicao' | 'FaixaEMedicao' | 'Parcelamento'
aditivostring nullable
contratoOriginalstring nullable
idClientestring nullable
idCliente2string nullable
descricaostring nullable
valornumber double nullable
tipoFaturamento'Nenhum' | 'Diario' | 'Semanal' | 'Decendial' | 'Quinzenal' | 'Mensal' | 'Bimestral' | 'Trimestral' | 'Quadrimestral' | 'Semestral' | 'Anual'
faturamentoAutomaticoboolean nullable
imprimirNotaFiscalboolean nullable
tipoIndexador'Nenhum' | 'Indice' | 'Valor' | 'Percentual'
idIndicestring nullable

Define qual indice será considerado para o contrato. Apenas deve ser informado se for do TipoIndexador Indice.

tipoReajuste'Nenhum' | 'Mensal' | 'Bimestral' | 'Trimestral' | 'Quadrimestral' | 'Semestral' | 'Anual' | 'Suspenso' | 'Faturamento' | 'Quinquimestral'
dataContratoInicialstring date nullable
dataContratoFinalstring date nullable
renovacaoAutomaticaboolean nullable
tipoSituacao'Nenhum' | 'Vigente' | 'Inativo' | 'Concluido' | 'Cancelado' | 'Negociacao' | 'Previsao'
dataConcluidostring date nullable

Define qual a data de conclusão do contrato. Apenas deve ser informado se for do TipoSituacao Concluido.

dataCanceladostring date nullable

Define qual a data de cancelamento do contrato. Apenas deve ser informado se for do TipoSituacao Cancelado.

dataInativostring date nullable

Define qual a data de inativo do contrato. Apenas deve ser informado se for do TipoSituacao Inativo.

faturarAteboolean nullable
dataFaturarAtestring date nullable

Define qual a última data de faturamento do contrato. Apenas deve ser informado se for do TipoSituacao Cancelado e FaturarAte true.

idUsuariostring nullable

Define qual o usuário que cadastrou o contrato. Se não informado, será considerado o usuário que realizou a requisição.

dataAssinaturastring date nullable

Response

No Content

Changes

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