Contrato

Gravação de Contratos

Grava uma lista de contratos com base no json informado no body da requisição.

post/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

Request body

codigoIntegradorstring nullable
codigostring nullable
numerostring required
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 required
idCliente2string nullable
descricaostring required
valornumber double required
tipoFaturamento'Nenhum' | 'Diario' | 'Semanal' | 'Decendial' | 'Quinzenal' | 'Mensal' | 'Bimestral' | 'Trimestral' | 'Quadrimestral' | 'Semestral' | 'Anual' required
faturamentoAutomaticoboolean
tipoIndexador'Nenhum' | 'Indice' | 'Valor' | 'Percentual' required
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' required
dataContratoInicialstring date required
dataContratoFinalstring date required
renovacaoAutomaticaboolean
tipoSituacao'Nenhum' | 'Vigente' | 'Inativo' | 'Concluido' | 'Cancelado' | 'Negociacao' | 'Previsao' required
dataConcluidostring date

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

dataCanceladostring date

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

dataInativostring date

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

faturarAteboolean
dataFaturarAtestring date

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

Response

Created

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.