Advise Plataforma V1

Documentação
Advise Plataforma

APIs REST para a plataforma Advise.

Cada API da Advise fornece, de forma fácil e objetiva, seus métodos suportados, campos retornados, obrigatoriedade de informações, tal como suas situações e resultados.

Todas as APIs encontram-se divididas de acordo com a sua funcionalidade e métodos.

Contato
Telefone: (43) 3339-1000
Email: gislene.koyama@advise.com.br
Manual de Utilização da Documentação

Navegação

A organização das pastas foi feita com a intenção de agrupar os assuntos em Documentação, Operações e Models.

Na pasta Documentação, irá constar as informações sobre a Empresa, manuais de utilização e informações mais genéricas.

Na pasta Models, irá constar os DTOs.

A pasta Operações está organizada em Assuntos\APIs\Rotas Sempre que clicar em um Assunto, vai mostrar as regras e informações

  • Ás páginas funcionam de forma sequencial, então conforme vai descendo a página irá mostrando os próximos assuntos e rotas.

Try It Out (Testar Rota)

Toda rota irá ter esse botão.

Na tela que abrir, selecionar os parâmetros em ‘Request Params’, conforme for marcando irá mostrando no lado esquerdo em Query Parameters.

Informar os parâmetros e clicar em SUBMIT.

Operações

Métodos HTTPs permitidos:

GET
  • Método para consultar recursos do servidor.
POST
  • Método para inserir novos recursos.
PUT
  • Método para alterar recursos existentes.|
DELETE
  • Método para remover recursos do servidor.|
Parametros Gerais
Juizos
Foruns
Foros
Agendas

Módulo para controle de compromissos, por exemplo: prazos, reuniões, tarefas, audiências e outros.

Separação de compromissos por Vencendo, Vencidos, Importante e Concluídos.

Integração com os movimentos de processo que podem ser facilmente vinculados a um compromisso na agenda.

Integração com o Google Calendar.

Regras e Informações:
1 - Ao contratar um serviço de agenda, cria-se uma agenda para cada usuário cliente do cliente (que não tiverem).
2 - Ao criar um usuário-cliente, é criada uma agenda para ele, com o seu nome (caso o cliente tiver o serviço de agenda contratado(core.Servico.Id = -6)).
3 - Ao contratar um serviço de agenda(core.Servico.Id = -6), são criados os tipos de evento de agenda definidos no padrão tipo evento agenda.
4 - Ao criar um evento, pode haver um movimento vinculado a ele.
5 - Um evento de agenda tem informações referentes ao cabeçalho e ao corpo do evento.   
    5.a - Campos DataHoraInicio e DataHoraFim referem-se ao cabeçalho do evento. por exemplo: O evento acontece 01/01/2019 as 08:00hrs e se repete por mais 2 dias, assim cria-se apenas um registro para esse evento.
    5.b - Campos DataEvento e HoraInicioEventoAgenda referem-se ao corpo do evento. por exemplo: O evento acontece dia 01/01/2019 as 08:00hrs e se repete por mais 2 dias, assim cria-se 3 registros, um para cada dia que ocorrer o evento.
6 - Os campos que devem receber valores de ordenação: 
        Tabela EventoAgenda:
        - DataHoraInicio
        - DataHoraFim
        - Titulo
        - FlConcluido
        - FlAtivo
        - FlDiaInteiro
        - FlImportante
        Tabela UsuarioClienteXEventoAgenda
        - DataEventoAgenda
        - HoraInicioEventoAgenda
        - FlDiaInteiro
        - FlImportante
        - FlConcluido
        - FlAtivo
7 - Front - ao selecionar um tipo de repetição diferente de ‘não repetir’ necessário abrir uma opção de data para incluir o final da repetição; (item inserido 18-2-2019)
    7.a.    Melhoria - implementar o controle de repetições por quantidade de ocorrências,  assim será necessário alterar criar campo no banco, alterar api, e alterar as procedures de criação dos registros da tabela agenda.UsuarioClienteXEventoAgenda.
    7.b.    Melhoria - Quando o usuário selecionar repetições do tipo -2. Todos os dias e -4. Todos os dias da semana mostrar a opção de Data Fim Repetição. Se o usuário selecionar a opção -3.Semanal ou -5.Mensal ou -6.Anual mostrar a opção de quantidade de ocorrências.
    7.c.    Melhoria - Se selecionar a repetição em meses, abrir um campo com as opçãos dos meses, para selecionar até qual mês vai repetir, se for anos, até qual ano e se for semana até qual semana(Verificar o melhor formato para semanas).
Agendas
Eventos de Agenda

Refere-se as manutenções dos Eventos de Agenda(os compromissos)

Tipos de Eventos de Agendas

Controla os Tipos de Eventos Agendas por Cliente

Padrões de Tipos de Eventos de Agendas

Esses padrões serão definidos pela Advise, e terão id negativo, não podendo ser alterado pelo usuário.

Repetição de Eventos de Agendas

Refere-se a forma com qual o evento pode ser repetido. Exemplo: o evento pode acontecer diariamente, semanalmente, e etc.

Opções de Lembretes de Agenda

Refere-se ao tempo em que o lembrete será mostrado antes do evento acontecer. Por exemplo: 5 minutos. irá enviar email para lembrar que o evento irá acontecer em 5 minutos. Obs: Como terá integração com o google calendar, será enviado a informação para que o proprio google calendar mostre a notificação.

Integração com Google Calendar
Contatos
Contatos Fotos
Contatos
Lista de Contatos
Compartilhamento de Lista de Contatos
Marcadores de Contatos
Padrão de Marcados de Contatos
Financeiro
Baixas Financeiras
Financeiros
Lançamentos Financeiros

Manutenção dos lançamentos financeiros, podendo ser criados receitas, despesas, despesas reembolsáveis e transferências.

Parcelas
Contas Financeiras
Categorias Financeiras
Baixas Financeiro
Tipos de Categorias Financeiras
Tipos de Lancamentos Relacionados
Tipos de Parcelamentos
Saldos de Contas Financeiras
Partner
Painel Parceiro
Jurisprudência
Aplicações
Aplicações
Perfis de Aplicações
Clientes
Clientes
Perfis de Clientes
Funcionalidades de Clientes
Empresas
Tipos de OAB
Colaboradores
Colaboradores
Perfis de Colaboradores
Departamentos
Central de Pagamentos
Cobranças
Assinaturas
Formas de Pagamentos
Perfis de Pagamentos
Tipos de Contagens de Cobranças
Produtos Advise
Produtos Advise
Tipos de Regras de Funcionalidades
Serviços
Periodicidades
Planos
Tipos de Planos
Contratos
Aditivos
Contratos
RegraDiarioContratoV1
Adesões de Contratos
AdesaoContratoV1
Importação
Gerenciamento de Eventos
Regras de Ações de Eventos de Emails
Estrutura Poder Judiciário
Grau Jurisdição
Fontes de Parâmetros de CNJ
Juízos
Tipos de Justiças
Órgãos Judiciários
Tipos de Órgãos Judiciários
Fontes Parâmetros de Órgãos Judiciários
Especializações de Segmentos Judiciários
Diários
Diários
Diários de Usuário Cliente
Tipos de Diários
Cadernos Diários
Edições dos Cadernos dos Diários
Cadernos Diários Edições Publicações
Processos
Importação de Processos
Processos Clientes
Processos
Cabeçalho Processos
Processos de Clientes
Movimentações de Clientes
Movimentações de Processos de Clientes - Lido
Movimentações de Pastas de Usuário Clientes
Busca Automática de Processos por Usuário Cliente
Pesquisas de Processos de Usuários Clientes
Processos Encontrados
Processos Solicitados
Situações de Pesquisas de Processos de Usuários Clientes
Pastas de Usuários Clientes
Fontes de Processos
Fontes de Pesquisas de Processos
Tipos de Pastas
Tipos de Sujeitos de Processos
Tipos de Sujeitos de Processos - Spider
Tipos Números de Processos
Tipos Movimentações de Processos
ComplFonteXTipoPesquisaV1
FontePesquisaV1
FonteTipoPesquisaV1
Publicações
MovProcUCXUsuarioLeituraV1
Publicações Clientes
Publicações de Clientes
Movimentações de Clientes
Municípios Publicações
Juízos de Publicações
MovProcUsuarioClienteV1
MovimentoUsuarioClienteV1
PesqPublicacaoUsuarioClienteV1
Palavras Chaves
Pesquisa de Publicações de Usuários Clientes
Palavra Chave Cliente
UsuarioClienteXPalChaveV1
Palavras Chaves
Tipos de Palavras Chaves
Situações de Palavras Chaves
Palavras Chaves de Usuários Clientes
RegraOOOOCNJV1
Pessoas
Tipos de Pessoas
Pessoas Fotos
Sexos
Municipios\Ufs
Municípios
Unidades Federativas - Ufs
Unidades Federativas - UFs - Municípios IBGE
Dias da Semana
Usuários
Usuários
Usuários Clientes
Permissões de Usuários Clientes
Tipos de Usuários
Valores de Tipos de Regras de Funcionalidades
Emails
Configuração de Envio de Emails
Padrão Regra Ação Evento Email
Campos de Email
Envio de Emails
Emails Usuarios Clientes
Quantidade de Itens por Página
Ações
Acões
Tipos de Ações
Permissões de Ações
Downloads
Spiders
ErroV1
ClassifRetornoSpiderV1
FonteXTipoPesquisaV1
ImportacaoProcessoV1
Monitoramento Retorno
RetornoSpiderV1
CNJ
RegraTRCNJ
Turma Recursal
RegraJCNJ
WebHook
Webhook - Envio de Publicações\Andamentos
Models
EntradaImportacaoProcessoDTO
Object
idUsuarioCliente
integer int64
idGrupoUsuarios
integer int64
idTipoLote
integer int64
idSituacaoProcesso
integer int64
flOrigemDBAdvise
boolean
processos
PostContatoDTO
Object
idsMarcadorContato
string
cpf
string
cnpj
string
nomePessoaCliente
string
idSexo
integer int64
idTipoPessoa
integer int64
logradouro
string
numeroEndereco
string
cep
string
complementoEndereco
string
idMunicipio
integer int64
dataNascimento
string date-time
dataAbertura
string date-time
departamento
string
email
string
fone1
string
fone2
string
celular1
string
celular2
string
observacao
string
empresa
string
cargoEmpresa
string
bairro
string
idCliente
integer int64
idUsuarioLogado
integer int64
PostCompartilhaListaContatoDTO
Object
idUsuarioClienteCompartilhado
integer int64
idListaContato
integer int64
incluirContato
boolean
alterarContato
boolean
inativarContato
boolean
incluirAtividadeContato
boolean
verAtividadeContato
boolean
ativo
boolean
idUsuarioClienteDono
integer int64
PostListaContatosDTO
Object
nomeListaContato
string
listaPadrao
boolean
idUsuarioCliente
integer int64
ProcessoImportacaoDTO
Object
numeroProcesso
string
nomePasta
string
fonte
integer int64
parametro
integer int64
nomeSpider
string
valorParametro
string
PutCompartilhaListaContatoDTO
Object
idCompartilhaContato
integer int64
idUsuarioClienteCompartilhado
integer int64
idListaContato
integer int64
incluirContato
boolean
alterarContato
boolean
inativarContato
boolean
incluirAtividadeContato
boolean
verAtividadeContato
boolean
ativo
boolean
idUsuarioUltAlteracao
integer int64
PutContatoDTO
Object
idContato
integer int64
idsMarcadorContato
string
cpf
string
cnpj
string
nomePessoaCliente
string
idSexo
integer int64
idTipoPessoa
integer int64
logradouro
string
numeroEndereco
string
cep
string
complementoEndereco
string
idMunicipio
integer int64
dataNascimento
string date-time
departamento
string
dataAbertura
string date-time
email
string
fone1
string
fone2
string
celular1
string
celular2
string
observacao
string
empresa
string
cargoEmpresa
string
bairro
string
idCliente
integer int64
idUsuarioLogado
integer int64
PutListaContatoDTO
Object
idListaContato
integer int64
nomeListaContato
string
listaPadrao
boolean
idUsuarioCliente
integer int64
RetornoSpiderDTO
Object
id
integer int64 required
mensagemSpider
string
mensagemAmigavel
string
flGeraNovaPesquisa
boolean required
flPesquisaComSucesso
boolean required
idUsuarioUltAlteracao
integer int64
dataHoraUltAlteracao
string date-time
mensagemSpiderTratada
string
idFonteXTipoPesquisa
integer int64 required
nomeFonte
string
idValorParamFontePesq
integer int64
nomeFonteParametro
string required
Min length: 1
idClassifRetornoSpider
integer int64 required
mensagem
string
totalRegistros
integer int32
VincularMovimentoEventoDTO
Object
idMovProcessoCliente
integer int64
idEventoAgenda
integer int64
idUsuarioInclusao
integer int64
dataHoraInclusao
string date-time
PostBaixaFinanceiroDTO
Object
idParcelaFinanceiro
integer int64
dataBaixa
string date-time
valorBaixa
number double
idCliente
integer int64
idUsuarioInclusao
integer int64
PostMarcadorContatoDTO
Object
idPadraoMarcadorContato
integer int64
nomeMarcadorContato
string
idCliente
integer int64
idUsuarioInclusao
integer int64
PutContaFinanceiroDTO
Object
idContaFinanceiro
integer int64
idFinanceiro
integer int64
nomeContaFinanceiro
string
idTipoContaFinanceiro
integer int64
idPadraoContaFinanceiro
integer int64
idCliente
integer int64
idUsuarioUltAlteracao
integer int64
PutCategoriaFinanceiroDTO
Object
idCategoriaFinanceiro
integer int64 required
idTipoCategoriaFinanceiro
integer int64 required
nomeCategoriaFinanceiro
string required
Min length: 1
corCategoria
string
idCliente
integer int64
idUsuarioUltAlteracao
integer int64
PostFinanceirosDTO
Object
nomeFinanceiro
string required
Min length: 1
idCliente
integer int64
idUsuarioInclusao
integer int64
PostContaFinanceiroDTO
Object
idFinanceiro
integer int64 required
nomeContaFinanceiro
string required
Min length: 1
idTipoContaFinanceiro
integer int64 required
idPadraoContaFinanceiro
integer int64
idCliente
integer int64
idUsuarioInclusao
integer int64
PostCategoriaFinanceiroDTO
Object
idTipoCategoriaFinanceiro
integer int64 required
nomeCategoriaFinanceiro
string required
Min length: 1
corCategoria
string
idCliente
integer int64
idUsuarioInclusao
integer int64
EnvioNotificacaoAgendaFiltro
Object
destinatarios
Array of string required
idEventoAgenda
integer int64 required
idAndamento
integer int64
idPublicacao
integer int64
idUsuarioCliente
integer int64
idCliente
integer int64
AgendaGoogleCalendarDTO
Object
idAgendaGoogleCalendar
integer int64
idIntegracaoGoogleCalendar
integer int64
idAgenda
integer int64
agendaGoogleId
string
sincronizado
boolean
ativo
boolean
DesbloqueioContratoDTO
Object
idContrato
integer int64
idUsuarioAlteracao
integer int64
motivoDesbloqueio
string
dataProximoBloqueio
string date-time
PutLancamentoDTO
Object
idLancamentoFinanceiro
integer int64 required
idFinanceiro
integer int64 required
idLancamentoFinanceiroPai
integer int64
idPessoaCliente
integer int64
idContaFinanceiro
integer int64 required
debitoCredito
string required
Min length: 1
descricao
string
dataEmissao
string date-time required
valor
number double
repeticaoFixo
boolean
idProcesso
integer int64
idTipoParcelamentoFinanceiro
integer int64 required
quantidadeParcelas
integer int64 required
idCategoriaFinanceiro
integer int64 required
idLancamentoRelacionado
integer int64
observacao
string
previsao
boolean
ativo
boolean
idParcelaFinanceiro
integer int64 required
dataVencimento
string date-time
valorOriginal
number double
alterarEsteEProximosLancamentos
boolean
baixado
boolean
idUsuarioUltAlteracao
integer int64
idCliente
integer int64
BloqueioContratoDTO
Object
idContrato
integer int64
idUsuarioAlteracao
integer int64
motivoBloqueio
string
idSituacaoContrato
integer int64
PostLancamentoFinancDTO
Object
idFinanceiro
integer int64 required
idLancamentoFinanceiroPai
integer int64
idPessoaCliente
integer int64
idContaFinanceiro
integer int64 required
debitoCredito
string required
Min length: 1
descricao
string
dataEmissao
string date-time required
dataVencimento
string date-time required
valor
number double required
repeticaoFixo
boolean
idProcesso
integer int64
idTipoParcelamentoFinanceiro
integer int64
quantidadeParcelas
integer int64 required
idCategoriaFinanceiro
integer int64 required
observacao
string
previsao
boolean
idUsuarioInclusao
integer int64
idCliente
integer int64
ContratoUsuarioClienteDTO
Object
id
integer int64
numero
string
idSituacaoContrato
integer int64
planos
AgendamentoProcessosDTO
Object
idAgendPesqAndProcesso
integer int64
descricao
string
quantidadeOcorrencias
integer int32
idPeriodPesqAndProcesso
integer int64
idRegraPesqAndProc
integer int64
dataAgendamentos
AcaoEventoUsuarioDTO
Object
id
integer int64
idUsuarioCliente
integer int64
nomeUsuarioCliente
string
idRegraAcaoEvento
integer int64 required
descricaoRegraAcaoEvento
string
idProdutoAdviseXAcaoEvento
integer int64
nomeProdutoAdviseXAcaoEvento
string
ativo
boolean
idUsuarioInclusao
integer int64
nomeUsuarioInclusao
string
dataHoraInclusao
string date-time
idUsuarioUltimaAlteracao
integer int64
nomeUsuarioUltimaAlteracao
string
dataHoraUltimaAlteracao
string date-time
EmailUsuarioClienteDTO
Object
id
integer int64 required
idUsuarioCliente
integer int64
email
string required
Min length: 1
flAtivo
boolean
idUsuarioInclusao
integer int64
idUsuarioUltAlteracao
integer int64
nomeUsuarioCliente
string
dataHoraInclusao
string date-time
dataHoraUltAlteracao
string date-time
nomeUsuarioInclusao
string
nomeUsuarioUltAlteracao
string
idGrupoUsuarios
integer int64
idParceiro
integer int64
idTipoUsuario
integer int64
MovProcessoClienteLidoPastaDTO
Object
idPastaUsuarioCliente
integer int64
ClienteXFontePesqProcDTO
Object
idCliente
integer int64 required
idFontePesqProcesso
integer int64 required
idLoteProcSpiderUltSuces
integer int64
idLoteProcSpiderUltAgend
integer int64
ativo
boolean
flSolicErroSpider
boolean
pesqProcUsuarioCliente
PesqProcUsuarioClienteDTO
Object
id
integer int64 required
idClienteXFontePesProc
integer int64 required
flPesqAndamentoAuto
boolean required
flPesqPublicacaoAuto
boolean required
idUsuarioClienteXFuncionalidade
integer int64 required
idSitPesqProcUsuarioCliente
integer int64 required
idUsuarioInclusao
integer int64
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
dataHoraUltAlteracao
string date-time
dataHoraUltSolic
string date-time
EnvioEmailMovimentosDTO
Object
idsMovimentos
string
destinatarios
Array of string
idUsuarioMovimento
integer int64
idGrupoMovimento
integer int64
EnvioEmailAndamentosDTO
Object
idsAndamentos
string
destinatarios
Array of string
EnvioEmailPublicacoesDTO
Object
idsPublicacoes
string
destinatarios
Array of string
MovProcClienteXEventoAgendaDTO
Object
id
integer int64
idMovProcessoCliente
integer int64
idTipoMovProcesso
integer int64
idEventoAgenda
integer int64
idUsuarioInclusao
integer int64
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
dataHoraUltAlteracao
string date-time
PalavraChavePostDTO
Object
palavraChave
string required
Min length: 1
idTipoPalavraChave
integer int64 required
idPalavraChavePrincipal
integer int64
palavraChaveExata
boolean
ativo
boolean
idContrato
integer int64
idPlano
integer int64
usuariosCliente
idSituacaoPalavraChave
integer int64
idUsuarioAcao
integer int64
migracao
boolean
UsuarioClienteXPalChaveDiarioDTO
Object
idDiario
integer int64 required
ativo
boolean
PalavraChavePutDTO
Object
palavraChave
string required
Min length: 1
idTipoPalavraChave
integer int64
palavraChaveExata
boolean
idContrato
integer int64
idPlano
integer int64
usuariosCliente
idUsuarioAcao
integer int64
idPalavraChavePrincipal
integer int64
UsuarioClienteXPalChavePutDTO
Object
idCliente
integer int64
id
integer int64
vincularTodosDiarios
boolean
diarios
idUsuarioClienteXFuncionalidade
integer int64
ativo
boolean
UsuarioClienteXPalChavePostDTO
Object
idCliente
integer int64
id
integer int64
vincularTodosDiarios
boolean
diarios
idUsuarioClienteXFuncionalidade
integer int64
ativo
boolean
ColunaConsultaBanco
Object
campo
string
expansao
string
parametro
string
coluna
string
nivel
integer int32
lista
boolean
chave
boolean
tipoEntidade
unknown
colunaConsulta
string
colunaConsultaAlias
string
AdesaoContratoDTO
Object
id
integer int64 required
idUsuarioCliente
integer int64
idCliente
integer int64
nomeCliente
string
planos
idUsuarioOperacao
integer int64
PlanoContratoDTO
Object
idContratoXPlano
integer int64
id
integer int64
nome
string
descricao
string
idTipoPlano
integer int64
nomeTipoPlano
string
ativo
boolean
idSituacaoContratoXPlano
integer int64
aderido
boolean
precoContratado
number double
servicos
ServicoPlanoContratoDTO
Object
id
integer int64
nome
string
funcionalidades
FuncionalidadePlanoContratoDTO
Object
id
integer int64
nomeFuncionalidade
string
selecionado
boolean
permiteAdicional
boolean
adicional
boolean
opcional
boolean
quantidadeContratada
integer int32
quantidadeUtilizada
integer int32
precoFuncionalidade
number double
quantidadePermitida
integer int32
idPlanoXFuncionalidade
integer int64
idClienteXPlano
integer int64
idContratoXPlano
integer int64
idContratoXFuncionalidade
integer int64
valorTotal
number double
aggregationKey
string
AplicacaoDTO
Object
id
integer int64 required
nome
string required
Min length: 1
nomeInterno
string required
Min length: 1
descricao
string
idUsuarioInclusao
integer int64
nomeUsuarioInclusao
string
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
nomeUsuarioUltAlteracao
string
dataHoraUltAlteracao
string date-time
dataHoraUltExecucao
string date-time
selecionado
boolean
acoes
Array of AcaoDTO
AcaoDTO
Object
id
integer int64 required
idAplicacao
integer int64 required
nome
string required
Min length: 1
nomeInterno
string required
Min length: 1
idTipoAcao
integer int64
tipoAcao
string
selecionado
boolean
Types: AplicacaoDTO
AssinaturaDTO
Object
id
integer int64
idContrato
integer int64
idCliente
integer int64
qtdParcelas
integer int32
diaCobranca
integer int32
ativo
boolean
contatoCobranca
perfilPagamento
idUsuarioInclusao
integer int64
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
dataHoraUltAlteracao
string date-time
cancelarFaturas
boolean
PessoaDTO
Object
id
integer int64 required
cpfcnpj
string
nome
string required
Min length: 1
idSexo
integer int64 required
idTipoPessoa
integer int64 required
logradouro
string
numeroEndereco
string
cep
string
complementoEndereco
string
idMunicipio
integer int64
idParceiro
integer int64
dataNascimentoAbertura
string date-time
email
string required
Min length: 1
fone1
string
fone2
string
celular1
string
celular2
string
observacao
string
idUsuarioInclusao
integer int64
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
dataHoraUltAlteracao
string date-time
bairro
string
nomeSexo
string
nomeTipoPessoa
string
nomeMunicipio
string
nomeUsuarioInclusao
string
nomeUsuarioUltAlteracao
string
idUFMunicipio
integer int64
nomeUF
string
siglaUF
string
fotoID
string uuid
foto
string byte
PerfilPagamentoDTO
Object
id
integer int64
dadosPagamento
idUsuarioInclusao
integer int64
dataHoraInclusao
string date-time
DadosPagamentoDTO
Object
nomeProprietario
string
numeroCartaoCred
string
validCartaoCred
string
codigoSeguranca
string
nomeBandeira
string
SolicitacaoBuscaAutomaticaDTO
Object
idUsuarioCliente
integer int64
idGrupoUsuarios
integer int64
idSituacaoPesquisaProcesso
integer int64
pesquisaAndamentoAutomatica
boolean
pesquisaPublicacaoAutomatica
boolean
idsFontesProcesso
Array
integer int64
idsFontesPesquisaProcesso
Array
integer int64
idUsuarioClienteLogado
integer int64
idClienteLogado
integer int64
CadDiarioEdicaoPublDTO
Object
id
integer int64
codDiario
integer int32 required
codCaderno
integer int32 required
edicaoDiario
integer int32 required
idCadernoDiarioEdicao
integer int64
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
dataHoraUltAlteracao
string date-time
anoPublicacao
integer int32 required
nomeUsuarioUltAlteracao
string
nomeCaderno
string
nomeDiario
string
edicaoCorrigida
integer int32
codDiarioCorrigido
integer int32
codCadernoCorrigido
integer int32
nomeCadernoCorrigido
string
nomeDiarioCorrigido
string
CadernoDiarioEdicaoDTO
Object
id
integer int64
idDiarioEdicao
integer int64 required
idCadernoDiario
integer int64 required
edicao
integer int32
qtdadeTotalPartes
integer int32
qtdadePartesProc
integer int32
idSituacaoDiarioEdicao
integer int64
situacaoDiarioEdicao
string
nomeCaderno
string
CadernoDiarioDTO
Object
id
integer int64
idDiario
integer int64
nome
string required
Min length: 1
descricao
string required
Min length: 1
idUsuarioInclusao
integer int64
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
dataHoraUltAlteracao
string date-time
codCaderno
integer int32
ativo
boolean
nomeDiario
string
nomeUsuarioInclusao
string
nomeUsuarioUltAlteracao
string
totalRegistros
integer int32
ClienteDTO
Object
id
integer int64 required
idPessoa
integer int64 required
orgaoPublico
boolean required
ativo
boolean required
utilizaPerfil
boolean required
idProdutoAdviseContratado
integer int64
nomeProdutoAdviseContratado
string
idParceiro
integer int64
possuiGrupo
boolean
idOrigemCliente
integer int64
nomeOrigemCliente
string
idCarteiraCliente
integer int64
flka
boolean
pessoaCliente
contratos
planosVinculados
carteira
Object
idCarteiraCliente
integer int64
nomeCarteira
string
nomeColaborador
string
idUsuarioInclusao
integer int64
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
dataHoraUltAlteracao
string date-time
nomePlanoBase
string
nomeUsuarioInclusao
string
nomeUsuarioUltAlteracao
string
totalRegistros
integer int32
ContratoClienteDTO
Object
id
integer int64
idCliente
integer int64
numero
string
consorcio
boolean
convenioOAB
boolean
parceria
boolean
dataContratacao
string date-time
dataInicioVigencia
string date-time
dataFimVigencia
string date-time
cortesia
boolean
situacaoContrato
integer int32
servicos
planos
Array of PlanoClienteDTO
Types: ClienteDTO
UsuarioClienteSimplificadoDTO
Object
id
integer int64
idPessoa
integer int64
usuarioAdministrador
boolean
pessoa
idCliente
integer int64
ativoUsuario
boolean
nomeCliente
string
nomeUsuario
string
dataHoraUltAcesso
string date-time
emailUsuario
string
idUsuarioAlteracao
integer int64
Types: ClienteDTO
PlanoClienteDTO
Object
id
integer int64
idPlano
integer int64
nome
string
idTipoPlano
integer int64
nomeTipoPlano
string
ativo
boolean
servicos
EntradaDadosInativacaoDTO
Object
iDs
Array
integer int64
RetentativaCobrancaDTO
Object
idContrato
integer int64
id
integer int64
dadosPagamento
idUsuarioInclusao
integer int64
dataHoraInclusao
string date-time
VindiCobrancaDTO
Object
id
integer int64
amount
number double
status
string
dueAt
string date-time
paidAt
string date-time
installments
integer int32
attemptCount
integer int32
nextAttempt
string date-time
printUrl
string
createdAt
string date-time
updatedAt
string date-time
lastTransaction
customer
VindiTransacaoDTO
Object
id
integer int32
transactionType
string
status
string
amount
number double
installments
integer int32
gatewayMessage
string
gatewayResponseCode
string
gatewayAuthorization
string
gatewayTransactionId
string
gatewayResponseFields
fraudDetectorScore
number double
fraudDetectorStatus
string
fraudDetectorId
string
createdAt
string date-time
updatedAt
string date-time
paymentProfile
customer
VindiMetodoPagamentoDTO
Object
id
integer int32
publicName
string
name
string
code
string
type
string
status
string
Enumeration:
active
inactive
deleted
setSubscriptionOnSuccess
string
allowAsAlternative
boolean
paymentCompanies
maximumAttempts
integer int32
createdAt
string date-time
updatedAt
string date-time
VindiFaturaDTO
Object
id
integer int64
code
string
amount
string
installments
integer int32
status
string
seenAt
string
billingAt
string
dueAt
string
url
string
createdAt
string
updatedAt
string
billItems
charges
customer
subscription
paymentProfile
paymentCondition
metadata
unknown
VindiClienteDTO
Object
id
integer int64
name
string
email
string
registryCode
string
code
string
notes
string
status
string
Enumeration:
active
inactive
archived
created_at
string date-time
updatedAt
string date-time
metadata
unknown
phones
Array of VindiFoneDTO
VindiGatewayResponseFieldsDTO
Object
tid
string
pan
string
nsu
string
stoneIdRcptTxId
string
VindiGatewayDTO
Object
id
integer int32
connector
string
VindiPerfilPagamentoDTO
Object
id
integer int64
status
string
holderName
string
registryCode
string
bankBranch
string
bankAccount
string
cardExpiration
string
cardNumberFirstSix
string
cardNumberLastFour
string
cardNumber
string
cardCVV
string
token
string
gatewayToken
string
type
string
createdAt
string date-time
updatedAt
string date-time
paymentMethodCode
string
paymentCompanyCode
string
customerId
integer int64
paymentCompany
customer
VindiMetodoPagamentoSettingsDTO
Object
automaticBillCharge
boolean
dueDays
integer int32
VindiEmpresaPagamentoDTO
Object
id
integer int32
name
string
code
string
VindiItemFaturaDTO
Object
id
integer int32
amount
string
quantity
integer int32
pricingRangeId
integer int32
description
string
pricingSchema
productItem
usages
VindiPeriodoDTO
Object
id
integer int32
billingAt
string date-time
cycle
integer int32
startAt
string date-time
endAt
string date-time
duration
integer int32
subscription
createdAt
string date-time
updatedAt
string date-time
VindiAssinaturaDTO
Object
id
integer int64
code
string
status
string
Enumeration:
active
canceled
future
expired
planId
integer int64
customerId
integer int64
startAt
string date-time
endAt
string date-time
nextBillingAt
string date-time
overdueSince
string date-time
cancelAt
string date-time
interval
string
intervalCount
integer int32
billingTriggerType
string
Enumeration:
beginning_of_period
end_of_period
day_of_month
billingTriggerDay
integer int32
billingCycles
integer int32
installments
integer int32
createdAt
string date-time
updatedAt
string date-time
paymentMethodCode
string
Enumeration:
credit_card
cash
invoiceSplit
boolean
customer
productItems
currentPeriod
paymentProfile
VindiCondicaoPagamentoDTO
Object
penaltyFeeValue
integer int32
penaltyFeeType
string
dailyFeeValue
number double
dailyFeeType
string
afterDueDays
integer int32
paymentConditionDiscounts
VindiEnderecoDTO
Object
street
string
number
string
additional_details
string
zipcode
string
neighborhood
string
city
string
state
string
country
string
VindiFoneDTO
Object
id
integer int64
phoneType
string
Enumeration:
mobile
landline
number
string
extension
string
destroy
integer int32
VindiEsquemaPrecoDTO
Object
id
string
shortFormat
string
price
number double
minimumPrice
number double
schemaType
string
Enumeration:
flat
per_unit
step_usage
volume_usage
tier_usage
pricingRanges
createdAt
string date-time
VindiProdutoDTO
Object
id
integer int32
name
string
code
string
unit
string
status
string
description
string
invoice
string
createdAt
string date-time
updatedAt
string date-time
pricingSchema
metadata
unknown
VindiItemProdutoDTO
Object
id
integer int64
productId
integer int64
subscriptionId
integer int64
status
string
Enumeration:
active
inactive
deleted
cycles
integer int64
quantity
integer int64
created_at
string date-time
updated_at
string date-time
pricingSchema
discounts
VindiDescontoDTO
Object
id
integer int64
productItemId
integer int64
discountType
string
Enumeration:
percentage
amount
quantity
percentage
number double
amount
number double
quantity
integer int32
cycles
integer int32
status
string
created_at
string date-time
updated_at
string date-time
productItem
VindiUtilizacaoDTO
Object
id
integer int32
quantity
integer int32
description
string
createdAt
string date-time
VindiPlanoDTO
Object
id
integer int32
name
string
interval
string
Enumeration:
days
months
intervalCount
integer int32
billingTriggerType
string
Enumeration:
beginning_of_period
end_of_period
day_of_month
billingTriggerDay
integer int32
billingCycles
integer int32
code
string
description
string
status
string
Enumeration:
active
inactive
deleted
installments
integer int32
invoiceSplit
boolean
intervalName
string
createdAt
string date-time
updatedAt
string date-time
planItems
metadata
unknown
VindiCondicaoPagamentoDescontoDTO
Object
value
number double
valueType
string
daysBeforeDue
integer int32
VindiFaixaPrecoDTO
Object
id
string
startQuantity
integer int32
endQuantity
integer int32
price
number double
overagePrice
number double
VindiItemPlanoDTO
Object
id
integer int64
productId
integer int64
cycles
integer int32
createdAt
string date-time
updatedAt
string date-time
destroy
integer int32
ColaboradorDTO
Object
id
integer int64 required
idDepartamento
integer int64 required
idPessoa
integer int64 required
pessoa
perfilColaborador
nomeDepartamento
string
ativoUsuario
boolean
idUsuarioAlteracao
integer int64
ColaboradorXPerfilDTO
Object
id
integer int64
nome
string
ativo
boolean
ContratoDTO
Object
id
integer int64
numero
string required
Min length: 1
idClienteContratante
integer int64 required
idColaborador
integer int64
nomeClienteContratante
string
consorcio
boolean
convenioOAB
boolean
cortesia
boolean
geraNF
boolean
renovacaoAutomatica
boolean
sujeitoARegraInadimplencia
boolean
preCadastroClientes
boolean
parceria
boolean
motivoSituacaoContrato
string
transicao
boolean
dataContratacao
string date-time
dataInicioVigencia
string date-time required
dataFimVigencia
string date-time required
idUsuarioUltAlteracao
integer int64
nomeUsuarioUltAlteracao
string
dataHoraUltAlteracao
string date-time
idUsuarioInclusao
integer int64
nomeUsuarioInclusao
string
dataHoraInclusao
string date-time
pagamentoContrato
valorTotal
number double
idEmpresa
integer int64 required
razaoSocialEmpresa
string
idColaboradorConsultor
integer int64
nomeColaboradorConsultor
string
planos
Array of PlanoContratoDTO required
clientes
idContratoPai
integer int64
numeroContratoPai
string
planosContratoPai
idSituacaoContrato
integer int64
situacaoContrato
string
cancelado
boolean
nomePlanoBase
string
diasAlertaPagamentos
integer int64
observacao
string
valorOriginal
number double
flPermiteGrupo
boolean
dataDesbloqueio
string date-time
idParceiro
integer int64
PagamentoContratoDTO
Object
id
integer int64
idFormaPagamento
integer int64 required
nomeFormaPagamento
string
idPeriodicidadeCobranca
integer int64 required
idSituacaoPagContrato
integer int64
idPessoaPagador
integer int64
nomePessoaPagador
string
codSacado
integer int64
nomePeriodicidadePagamento
string
quantidadeParcelas
integer int32 required
idTipoContagemCobranca
integer int64
nomeTipoContagemCobranca
string
quantidadeDiasCobranca
integer int32
diaDoMesCobranca
integer int32
prePago
boolean
recorrente
boolean
diaMesPrimeiroVencimento
string
proximoVencimento
string date-time
dataProximoBloqueioInadimplencia
string date-time
temAssinatura
boolean
diasAlertaPagamentos
integer int64
dataInicioPeriodoCobranca
string date-time
situacaoPagContrato
diasGeraBoleto
integer int32
Types: ContratoDTO
ClienteContratoDTO
Object
id
integer int64
nome
string
nomeSituacao
string
ativo
boolean
motivoAlteracao
string
planosVinculados
Types: ContratoDTO
PlanoAdicionalDTO
Object
id
integer int64
nome
string
idContrato
integer int64
idTipoPlano
integer int64
nomeTipoPlano
string
dataInicioVigencia
string date-time
dataFimVigencia
string date-time
servicos
selecionado
boolean
Types: ContratoDTO
SituacaoPagContratoDTO
Object
id
integer int64
nome
string
codigoSituacaoVindi
string
descricaoSituacaoVindi
string
PlanoContratadoClienteDTO
Object
id
integer int64
nome
string
descricao
string
idTipoPlano
integer int64
nomeTipoPlano
string
ativo
boolean
aderido
boolean
ServicoAdicionalContratoDTO
Object
id
integer int64
nome
string
funcionalidades
selecionado
boolean
FuncionalidadeAdicionalContratoDTO
Object
id
integer int64
nome
string
selecionado
boolean
quantidadeContratada
integer int32
quantidadeUtilizada
integer int32
precoFuncionalidade
number double
quantidadePermitida
integer int32
idPlanoXFuncionalidade
integer int64
valorTotal
number double
PagadorContratoDTO
Object
idContrato
integer int64
idPessoa
integer int64
idUsuarioAlteracao
integer int64
CancelamentoDTO
Object
id
integer int64
motivo
string
idUsuarioCancelamento
integer int64
DepartamentoDTO
Object
id
integer int64 required
nome
string required
Min length: 1
ativo
boolean required
idUsuarioInclusao
integer int64
nomeUsuarioInclusao
string
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
nomeUsuarioUltAlteracao
string
dataHoraUltAlteracao
string date-time
DiariosUsuarioClienteDTO
Object
idCliente
integer int64 required
id
integer int64 required
idContrato
integer int64 required
idPlano
integer int64 required
nomeUsuarioCliente
string
diarios
Array of ViewDiarioDTO
ViewDiarioDTO
Object
id
integer int64
idDiario
integer int64 required
nome
string
descricao
string
nomeUsuarioInclusao
string
nomeUsuarioUltAlteracao
string
flDonoDiario
boolean
ativo
boolean
dataHoraUltAlteracao
string date-time
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
idUsuarioInclusao
integer int64
numeroContrato
string
nomePlano
string
DiarioDTO
Object
id
integer int64
nome
string required
Min length: 1
descricao
string required
Min length: 1
idTipoDiario
integer int64 required
ativo
boolean
idUsuarioInclusao
integer int64
codDiario
integer int32
nomeUsuarioInclusao
string
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
nomeUsuarioUltAlteracao
string
dataHoraUltAlteracao
string date-time
EventoAgendaDTO
Object
id
integer int64
idEventoAgenda
integer int64
idUsuarioCliente
integer int64
idPadraoTipoEventoAgenda
integer int64
idAgenda
integer int64 required
idTipoEventoAgenda
integer int64 required
tipoEventoAgenda
string
titulo
string required
Min length: 1
dataHoraInicio
string date-time
dataHoraFim
string date-time
diaInteiro
boolean
importante
boolean
idRepetEventoAgenda
integer int64
tipoRepeticao
string
dataFimRepeticao
string date-time
idOpcaoLembreteAgenda
integer int64
opcaoLembreteAgenda
string
localizacao
string
observacao
string
eventoGoogleId
string
sincronizado
boolean
concluido
boolean
ativo
boolean
horaInicioEventoAgenda
Object
ticks
integer int64
days
integer int32
hours
integer int32
milliseconds
integer int32
minutes
integer int32
seconds
integer int32
totalDays
number double
totalHours
number double
totalMilliseconds
number double
totalMinutes
number double
totalSeconds
number double
dataEventoAgenda
string date-time
idsMovProcessosVinculados
totalRegistros
integer int64
idUsuarioInclusao
integer int64
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
dataHoraUltAlteracao
string date-time
CadastroFontePesquisaProcessoDTO
Object
idProcesso
integer int64 required
idFonteXTipoPesquisa
integer int64 required
idValorParamFonteProc
integer int64
numeroProcesso
string required
Min length: 1
flSolicPorPublic
boolean required
flAtivo
boolean
idUsuarioInclusao
integer int64
dataHoraInclusao
string date-time
JuizoPublicacaoDTO
Object
id
integer int64 required
codDiario
integer int32
varaDescricao
string
idJuizo
integer int64
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
dataHoraUltAlteracao
string date-time
nomeUsuarioUltAlteracao
string
nomeJuizoCorrigido
string
corrigido
boolean
Object
id
integer int64 required
nome
string required
Min length: 1
idAplicacao
integer int64
idMenuPai
integer int64
sequencia
integer int32 required
idUsuarioInclusao
integer int64
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
dataHoraUltAlteracao
string date-time
nomeAplicacao
string
nomeMenuPai
string
nomeUsuarioInclusao
string
nomeUsuarioUltAlteracao
string
MovProcClienteLidoDTO
Object
idUsuarioAuditoria
integer int64
id
integer int64
idUsuarioCliente
integer int64 required
idGrupoUsuarios
integer int64
idMovProcessoCliente
integer int64 required
idClienteLogado
integer int64
idUsuarioMovimento
integer int64
pastasRelacionadas
MunicipioPublicacaoDTO
Object
id
integer int64 required
cidadeComarcaDescricao
string
idMunicipio
integer int64 required
idUF
integer int64 required
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
dataHoraUltAlteracao
string date-time
municipioCorrigido
string
ufCorrigido
string
nomeUsuarioUltAlteracao
string
MunicipioDTO
Object
id
integer int64 required
nome
string required
Min length: 1
idUF
integer int64 required
codigoIBGE
integer int64 required
ativo
boolean
idUsuarioInclusao
integer int64
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
dataHoraUltAlteracao
string date-time
capitalUF
boolean
nomeUF
string
nomeUsuarioInclusao
string
nomeUsuarioUltAlteracao
string
OrgaoJudiciarioDTO
Object
id
integer int64
nome
string
sigla
string
idTipoOrgaoJudiciario
integer int64
nomeTipoOrgaoJudiciario
string
idTipoJustica
integer int64 required
nomeTipoJustica
string
idEspecSegmentoJudiciario
integer int64 required
nomeEspecSegmentoJudiciario
string
idGrauJurisdicao
integer int64 required
nomeGrauJurisdicao
string
supremoTribunalFederal
boolean
localizacao
ativo
boolean
idUsuarioInclusao
integer int64
nomeUsuarioInclusao
string
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
nomeUsuarioUltAlteracao
string
dataHoraUltAlteracao
string date-time
OrgaoJudicLocalizacaoDTO
Object
id
integer int64
idUF
integer int64 required
uf
string
GeracaoPastaUsuarioClienteDTO
Object
idUsuarioCliente
integer int64
idGrupoUsuarios
integer int64
idTipoPasta
integer int64
idsFontesPesquisaProcesso
Array
integer int64
idPalavraChave
integer int64
idUsuarioAlteracao
integer int64
idParceiro
integer int64
PastaUsuarioClienteDTO
Object
id
integer int64
idUsuarioCliente
integer int64
idGrupoUsuarios
integer int64
nomeUsuarioCliente
string
nomeGrupoUsuarios
string
idTipoPasta
integer int64
nomeTipoPasta
string
permiteAlterarNomeTipoPasta
boolean
nome
string
idProcesso
integer int64
numeroProcesso
string
idPalavraChave
integer int64
palavraChave
string
idSituacaoPalavraChave
integer int64
nomeSituacaoPalavraChave
string
ativo
boolean
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
nomeUsuarioUltAlteracao
string
dataHoraUltAlteracao
string date-time
totalNaoLidas
integer int64
totalLidas
integer int64
quantidadeTotal
integer int64
idUsuarioInclusao
integer int64
totalPasta
integer int64
RemocaoMovimentoPastaDTO
Object
idUsuarioCliente
integer int64
idGrupoUsuarios
integer int64
idPastaUsuarioCliente
integer int64
idMovimentoProcessoCliente
integer int64
PerfilClienteDTO
Object
id
integer int64
idCliente
integer int64 required
nomeCliente
string
nome
string
ativo
boolean
planos
idUsuarioInclusao
integer int64
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
dataHoraUltAlteracao
string date-time
nomeUsuarioInclusao
string
nomeUsuarioUltAlteracao
string
PlanoPerfilClienteDTO
Object
id
integer int64
idProdutoAdvise
integer int64
nome
string
idTipoPlano
integer int64
nomeTipoPlano
string
nomeProdutoAdvise
string
servicos
ServicoPerfilClienteDTO
Object
id
integer int64
nome
string
funcionalidades
selecionado
boolean
FuncionalidadePerfilClienteDTO
Object
id
integer int64
nome
string
quantidade
integer int32
quantidadePermitida
integer int32
idContratoXFuncionalidade
integer int64
selecionado
boolean
PerfilColaboradorDTO
Object
id
integer int64
idDepartamento
integer int64 required
nome
string required
Min length: 1
ativo
boolean
consultor
boolean
idUsuarioInclusao
integer int64
nomeUsuarioInclusao
string
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
nomeUsuarioUltAlteracao
string
dataHoraUltAlteracao
string date-time
nomeDepartamento
string
idColaborador
integer int64
perfilColabXAplicacao
aplicacoes
Array of AplicacaoDTO
PerfilColabXAplicacaoDTO
Object
id
integer int64
idAplicacao
integer int64 required
selecionado
boolean
nomeAplicacao
string
perfilColabAplicXAcao
PerfilColabAplicXAcaoDTO
Object
id
integer int64
idPerfilColabXAplicacao
integer int64 required
idAcao
integer int64 required
nomeAcao
string
selecionado
boolean
CadastroPesqProcUsuarioClienteDTO
Object
Default:
{
    "ativo": true,
    "flPesqAndamentoAuto": true,
    "flPesqPublicacaoAuto": true,
    "idUsuarioClienteXFuncionalidade": 1,
    "flDonoProcesso": true,
    "idSitPesqProcUsuarioCliente": 1,
    "idUsuarioInclusao": 1,
    "dataHoraInclusao": "",
    "idUsuarioUltAlteracao": 1,
    "dataHoraUltAlteracao": "",
    "processos": [
        {
            "id": 1,
            "numeroProcesso": "",
            "idTipoNumeroProcesso": 1,
            "flNumUnicaCNJ": true,
            "solicPrimVezCliente": true,
            "fontesPesquisa": [
                {
                    "id": 1,
                    "idProcesso": 1,
                    "idFonteXTipoPesquisa": 1,
                    "idValorParamFonteProc": 1,
                    "flSolicPorPublic": true,
                    "ativo": true,
                    "clienteXFontePesqProcDTO": [
                        {
                            "idCliente": 1,
                            "idFontePesqProcesso": 1,
                            "idLoteProcSpiderUltSuces": 1,
                            "idLoteProcSpiderUltAgend": 1,
                            "ativo": true,
                            "flSolicErroSpider": true,
                            "pesqProcUsuarioCliente": [
                                {
                                    "id": 1,
                                    "idClienteXFontePesProc": 1,
                                    "flPesqAndamentoAuto": true,
                                    "flPesqPublicacaoAuto": true,
                                    "idUsuarioClienteXFuncionalidade": 1,
                                    "idSitPesqProcUsuarioCliente": 1,
                                    "idUsuarioInclusao": 1,
                                    "dataHoraInclusao": "",
                                    "idUsuarioUltAlteracao": 1,
                                    "dataHoraUltAlteracao": ""
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}
idCliente
integer int64
idUsuarioCliente
integer int64
idGrupoUsuarios
integer int64
ativo
boolean
flPesqAndamentoAuto
boolean required
flPesqPublicacaoAuto
boolean required
idUsuarioClienteXFuncionalidade
integer int64 required
flDonoProcesso
boolean
idSitPesqProcUsuarioCliente
integer int64 required
idUsuarioInclusao
integer int64
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
idClienteLogado
integer int64
idUsuarioClienteLogado
integer int64
dataHoraUltAlteracao
string date-time
processos
Array of ProcessoDTO
idParceiro
integer int64
ProcessoDTO
Object
id
integer int64
numeroProcesso
string required
Min length: 1
idTipoNumeroProcesso
integer int64
flNumUnicaCNJ
boolean required
solicPrimVezCliente
boolean
nomePasta
string
idSitPesqProcUsuarioCliente
integer int64
fontesPesquisa
FontePesqProcessoDTO
Object
id
integer int64 required
idProcesso
integer int64
idFonteXTipoPesquisa
integer int64
idValorParamFonteProc
integer int64
flSolicPorPublic
boolean required
ativo
boolean
clienteXFontePesqProcDTO
Types: ProcessoDTO
SituacaoPesqProcUsuarioClienteDTO
Object
idPesqProcUsuarioCliente
integer int64 required
situacao
integer int64 required
idUsuarioUltAlteracao
integer int64
PessoaFoto
Object
notifications
Array
Object
id
string uuid
key
string
value
string
date
string date-time
id
integer int64
fotoId
string uuid
foto
string byte
extensao
string
PlanoDTO
Object
id
integer int64
idProdutoAdvise
integer int64 required
nome
string
descricao
string
dataInicioVigencia
string date-time required
dataFimVigencia
string date-time
diasCortesia
integer int32
idTipoPlano
integer int64 required
autoContratacao
boolean
permitePlanoAdicional
boolean
quantidadeUsuarios
integer int32
precoTotal
number double
idUsuarioInclusao
integer int64
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
dataHoraUltAlteracao
string date-time
formasPagamento
nomeUsuarioInclusao
string
nomeUsuarioUltAlteracao
string
nomeTipoPlano
string
nomeProdutoAdvise
string
precoSugerido
number double
ServicoPlanoXFuncionalidadeDTO
Object
id
integer int64
nome
string
funcionalidades
selecionado
boolean
idProdutoAdvise
integer int64
Types: PlanoDTO
PagamentoPlanoDTO
Object
id
integer int64
idFormaPagamento
integer int64 required
nomeFormaPagamento
string
idPeriodicidadeCobranca
integer int64 required
nomePeriodicidadePagamento
string
quantidadeParcelas
integer int32 required
idTipoContagemCobranca
integer int64 required
nomeTipoContagemCobranca
string
quantidadeDiasCobranca
integer int32
diaDoMesCobranca
integer int32
prePago
boolean
permiteRecorrencia
boolean
autoContratacao
boolean
precoTotal
number double required
Types: PlanoDTO
PlanoXFuncionalidadeDTO
Object
id
integer int64 required
nome
string
quantidadePermitida
integer int32
quantidade
integer int32
valorFuncionalidade
number double
regrasFuncionalidade
permiteVincularRegra
boolean
permiteVincularDiario
boolean
selecionado
boolean
obrigatorio
boolean
permiteAdicional
boolean
idPlanoXFuncionalidade
integer int64
RegraFuncionalidadeDTO
Object
id
integer int64
idPlanoXFuncionalidade
integer int64
idTipoRegraFuncionalidade
integer int64
idValorTipoRegraFuncionalidade
integer int64
nomeValorTipoRegraFuncionalidade
string
permiteNegociacao
boolean
idDiario
integer int64
nomeDiario
string
agendamentos
ProdutoAdviseDTO
Object
id
integer int64
nome
string
ativo
boolean
servicos
Array of ServicoDTO
idUsuarioInclusao
integer int64
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
dataHoraUltAlteracao
string date-time
nomeUsuarioInclusao
string
nomeUsuarioUltAlteracao
string
utilizaPastaMovimentos
boolean
diasBuscaPublicacoesPalavrasChaves
integer int32
permiteSolicPrimVezCliente
boolean
urlProdutoAdvise
string
ServicoDTO
Object
id
integer int64
nome
string required
Min length: 1
funcionalidades
selecionado
boolean
idUsuarioUltAlteracao
integer int64
nomeUsuarioUltAlteracao
string
FuncionalidadeDTO
Object
id
integer int64 required
idServico
integer int64 required
nome
string required
Min length: 1
selecionado
boolean
valorFuncionalidade
number double
idFuncionalidadePai
integer int64
idUsuarioInclusao
integer int64
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
dataHoraUltAlteracao
string date-time
nomeFuncionalidadePai
string
nomeUsuarioInclusao
string
nomeUsuarioUltAlteracao
string
permiteVincularRegra
boolean
permiteVincularDiario
boolean
Types: ServicoDTO
RegraAcaoEventoEmailDTO
Object
id
integer int64
idProdAdviseXAcaoEvento
integer int64 required
idRegraAcaoEvento
integer int64 required
assunto
string required
Min length: 1
mensagem
string required
Min length: 1
flHTML
boolean
flAtivo
boolean
idParceiro
integer int64
nomeParceiro
string
idAcaoEvento
integer int64
descricao
string
idUsuarioInclusao
integer int64
nomeUsuarioInclusao
string
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
nomeUsuarioUltAlteracao
string
titulo
string
produtoAdvise
string
idProdutoAdvise
integer int64
evento
string
idEvento
integer int64
dataHoraUltAlteracao
string date-time
flGeraPadrao
boolean
TipoSujeitoProcSpiderDTO
Object
id
integer int64 required
nome
string required
Min length: 1
idTipoSujeitoProcesso
integer int64
nomeTipoSujeitoProcesso
string
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
nomeUsuarioUltAlteracao
string
dataHoraUltAlteracao
string date-time
UFDTO
Object
id
integer int64
nome
string required
Min length: 1
sigla
string required
Min length: 1
ativo
boolean
idUsuarioInclusao
integer int64
nomeUsuarioInclusao
string
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
nomeUsuarioUltAlteracao
string
dataHoraUltAlteracao
string date-time
codigoIBGE
integer int64
UsuarioClienteDTO
Object
id
integer int64
idPessoa
integer int64 required
usuarioAdministrador
boolean
aceitaTermosUso
boolean
usuarioApi
boolean
pessoa
PessoaDTO required
idCliente
integer int64 required
emailUsuario
string
ativoUsuario
boolean
nomeCliente
string
nomeUsuario
string
dataHoraUltAcesso
string date-time
idUsuarioInclusao
integer int64
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
dataHoraUltAlteracao
string date-time
nomeUsuarioInclusao
string
nomeUsuarioUltAlteracao
string
codigoIntegracao
string
totalRegistros
integer int32
idParceiro
integer int64
contratos
dadosOAB
PlanoUsuarioClienteDTO
Object
id
integer int64
nome
string
nomeTipoPlano
string
idContratoXPlano
integer int64
servicos
OABUsuarioClienteDTO
Object
id
integer int64
idUF
integer int64 required
nomeUF
string
siglaUF
string
idTipoOAB
integer int64 required
nomeTipoOAB
string
numero
string
ativo
boolean
ServicoPlanoUsuarioClienteDTO
Object
id
integer int64
nome
string
funcionalidades
selecionado
boolean
FuncionalidadePlanoUsuarioClienteDTO
Object
id
integer int64
nome
string
quantidade
integer int32
quantidadeUtilizada
integer int32
quantidadePermitida
integer int32
quantidadeContratada
integer int32
idContratoXFuncionalidade
integer int64
selecionado
boolean
UsuarioClienteXPalChaveDTO
Object
id
integer int64
idUsuarioClienteXDiario
integer int64
palavraChave
flAtivo
boolean
idUsuarioClienteXFuncionalidade
integer int64
flDonoPalavraChave
integer int64
vincularTodosDiarios
boolean
idUsuarioInclusao
integer int64
dataHoraInclusao
string date-time
idUsuarioAlteracao
integer int64
dataHoraUlAlteracao
string date-time
PalavraChaveDTO
Object
id
integer int64
idClienteXDiario
integer int64
palavraChave
string required
Min length: 1
idPalavraChave
integer int64
dataHoraInclusao
string date-time
idTipoPalavraChave
integer int64 required
flPalavraChaveExata
boolean
idPalavraChavePrincipal
integer int64
idSituacaoPalavraChave
integer int64
nomePessoaCliente
string
idCliente
integer int64 required
nomePessoaUsuarioCliente
string
idUsuarioCliente
integer int64
nomePlano
string
idPlano
integer int64
nomeTipoPlano
string
idTipoPlano
integer int64
tipoPalavra
string
situacao
string
dataHoraUltAlteracao
string date-time
idContrato
integer int64
numeroContrato
string
idDiario
integer int64 required
nomeDiario
string
idUsuarioInclusao
integer int64
nomeUsuarioInclusao
string
idUsuarioUltAlteracao
integer int64
nomeUsuarioUltAlteracao
string
diasRetroativa
integer int64
flMigracao
boolean
nomePlanoBase
string
UsuarioClienteDiarioXPalChaveAdicionarDTO
Object
idDiario
integer int64
idUsuarioClienteXPalChave
integer int64 required
vincularTodosDiarios
boolean
idUsuarioInclusao
integer int64
AlteracaoSenhaDTO
Object
idUsuario
integer int64
email
string
senhaDigitadaAtual
string
novaSenhaDigitada
string
confirmacaoNovaSenhaDigitada
string
chaveRecuperacao
integer int64
idUsuarioUltAlteracao
integer int64
UsuarioAlterarEmailDTO
Object
emailAtual
string required
Min length: 1
novoEmail
string required
Min length: 1
confirmacaoNovoEmail
string required
Min length: 1
senha
string required
Min length: 1
idUsuarioCliente
integer int64
VindiWebHookDTO
Object
evento
Evento
Object
type
string
created_at
string date-time
data
Data
Object
Types: Evento
VindiPendenciaDTO
Object
id
integer int32
tipoPendencia
string
status
string
item_type
string
item_id
string
data
string
dataHoraInclusao
string
datahoraUltAlteracao
string
customer
Types: Data
DatasAgendamentosDTO
Object
id
integer int64
idRegraPesqDiaHora
integer int64
idAgendPesqAndProc
integer int64
idPeriodPesqAndProcesso
integer int64
idDiaSemana
integer int64
diaMes
integer int32
hora
integer int32
flUltDiaMes
boolean
EnvioNotificacaoContatoDTO
Object
destinatarios
Array of string required
idPessoaCliente
Array required
integer int64
idParceiro
integer int64
idUsuarioCliente
integer int64
idCliente
integer int64
EnvioNotificacaoParcelaDTO
Object
destinatarios
Array of string required
idParcela
integer int64 required
idUsuarioCliente
integer int64
idCliente
integer int64
PutMarcadorContato
Object
idMarcadorContato
integer int64 required
nomeMarcadorContato
string
idPadraoMarcadorContato
integer int64
idCliente
integer int64
idUsuarioLogado
integer int64
AcaoEventoXCampoEmailDTO
Object
id
integer int64
idAcaoEvento
integer int64
idCampoEmail
integer int64
EntradaDadosInativacaoMarcadores
Object
inativarPessoas
boolean
iDs
Array
integer int64
EnvioEmailDTO
Object
id
integer int64
smtp
string
nomeContato
string
emailContato
string
ssl
boolean
usuarioEmail
string
senha
string
porta
integer int32
ativo
boolean
idUsuarioInclusao
integer int64
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
dataHoraUltAlteracao
string date-time
idParceiro
integer int64
InativacaoWebhookDTO
Object
idsWebhook
Array
integer int64
idUsuarioLogado
integer int64
InativarParcelaDTO
Object
ids
string required
Min length: 1
inativaEsteEProximosLancamentos
boolean
idUsuarioUltAlteracao
integer int64
idCliente
integer int64
LancamentoReembolsavelDTO
Object
idFinanceiro
integer int64 required
idLancamentoFinanceiroPai
integer int64
idContaFinanceiro
integer int64 required
idContaFinanceiroReembolso
integer int64 required
idPessoaCliente
integer int64
idPessoaClienteReembolso
integer int64
idCategoriaFinanc
integer int64
idCategoriaFinancReembolso
integer int64
debitoCredito
string required
Min length: 1
descricao
string
descricaoReembolso
string
idProcesso
integer int64
dataEmissao
string date-time required
dataVencimento
string date-time required
dataVencimentoReembolso
string date-time required
valor
number double required
valorReembolso
number double required
repeticaoFixo
boolean
idTipoParcelamentoFinanceiro
integer int64
idTipoParcelamentoFinanceiroReembolso
integer int64
quantidadeParcelas
integer int32 required
quantidadeParcelasReembolso
integer int32 required
observacao
string
observacaoReembolso
string
previsao
boolean
ativo
boolean
idUsuarioCliente
integer int64
idCliente
integer int64
PalavraChaveAltSituacaoDTO
Object
idPalavraChave
integer int64
idSituacaoPalavraChave
integer int64
motivoSituacaoPalavraChave
string
PalavraChaveAtualizacaoDTO
Object
idPalavraChave
integer int64
palavraChave
string
idTipoPalavraChave
integer int64
flPalavraChaveExata
boolean
idPalavraChavePrincipal
integer int64
PalavraChaveCadastroDTO
Object
listaPalavraChave
idCliente
integer int64
idUsuarioCliente
integer int64
idGrupoUsuarios
integer int64
idSituacaoPalavraChave
integer int64
PalavraChaveInclusaoDTO
Object
palavraChave
string
idTipoPalavraChave
integer int64
flPalavraChaveExata
boolean
idPalavraChavePrincipal
integer int64
palavraChavePrincipal
string
idClassifPalavraChave
integer int64
ParamUsuarioProdAdvDTO
Object
id
integer int64
idProdutoAdvise
integer int64
idUsuarioCliente
integer int64
qtdRegistroMovPorPagina
integer int32
idTipoVisualizacao
string
Enumeration:
Grid
Lista
exibirInfo
boolean
exibirPromoQi
boolean
novaAgenda
boolean
atualizarFone
boolean
idUsuarioInclusao
integer int64
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
dataHoraUltAlteracao
string date-time
PesqPublicUsuarioClienteAtualizacaoDTO
Object
idPalavraChave
integer int64
palavraChave
string
idTipoPalavraChave
integer int64
flPalavraChaveExata
boolean
idPalavraChavePrincipal
integer int64
palavraChavePrincipal
string
idClassifPalavraChave
integer int64
idDiario
integer int64
idUsuarioCliente
integer int64
idGrupoUsuarios
integer int64
flAtualizacao
boolean
idPesqPublicUsuarioCliente
integer int64
flAtivo
boolean
flPesquisaDespacho
boolean
PesqPublicUsuarioClienteAtualizacaoStatusDTO
Object
idPesqPublicUsuarioCliente
integer int64
flAtivo
boolean
PesquisaPublicacaoStatusDTO
Object
idUsuarioCliente
integer int64
idGrupoUsuarios
integer int64
idUsuarioClienteFuncionalidade
integer int64
listaPesqPublicAtualizacaoStatus
PessoaClienteFoto
Object
notifications
Array
Object
id
string uuid
key
string
value
string
date
string date-time
id
integer int64
fotoId
string uuid
foto
string byte
extensao
string
PostEnvioEmailDTO
Object
smtp
string
nomeContato
string
emailContato
string
ssl
boolean
usuarioEmail
string
senha
string
porta
integer int32
ativo
boolean
idUsuarioInclusao
integer int64
dataHoraInclusao
string date-time
idParceiro
integer int64
PostParceiroDTO
Object
urlAcessoCliente
string
advise
boolean required
ativo
boolean required
idCliente
integer int64 required
PostPutCampoEmailDTO
Object
id
integer int64
nomeCampo
string
idTipoCampoEmail
integer int64
acaoEventoXCampoEmail
tipoCampoEmail
PutBaixaFinanceiroDTO
Object
idParcelaFinanceiro
integer int64
dataBaixa
string date-time
idCliente
integer int64
idUsuarioLogado
integer int64
PutEnvioEmailDTO
Object
id
integer int64
smtp
string
nomeContato
string
emailContato
string
ssl
boolean
usuarioEmail
string
senha
string
porta
integer int32
idUsuarioUltAlteracao
integer int64
dataHoraUltAlteracao
string date-time
idCliente
integer int64
idParceiro
integer int64
PutParceiroDTO
Object
idParceiro
integer int64 required
urlAcessoCliente
string required
Min length: 1
advise
boolean required
idCliente
integer int64 required
TipoCampoEmailDTO
Object
id
integer int64
nome
string
VariacaoAltStatusDTO
Object
idPalavraChave
integer int64
flStatus
boolean
motivoSituacaoPalavraChave
string
WebhookPost
Object
rotaApiCliente
string
ativo
boolean
idCliente
integer int64
idUsuarioCliente
integer int64
idUsuarioLogado
integer int64
AcaoEventoUsuarioClienteDTO
Object
idAcaoEventoUsuarioCliente
integer int64
idCliente
integer int64
idUsuarioCliente
integer int64
usuarioAdministrador
boolean
ativo
boolean
idRegraAcaoEvento
integer int64
idProdAdviseXAcaoEvento
integer int64
idGrupoUsuarios
integer int64
idParceiro
integer int64
idUsuarioAlteracao
integer int64
AlterarSituacaoProcessoDTO
Object
idUsuarioClienteLogado
integer int64
idClienteLogado
integer int64
idUsuarioCliente
integer int64
idGrupoUsuarios
integer int64
idCliente
integer int64
flAtivo
boolean
pesqProcAltSituacao
EntradaAtivacaoInativacaoForoDTO
Object
id
integer int64
ativo
boolean
idUsuarioLogado
integer int64
EntradaAtivacaoInativacaoForumDTO
Object
id
integer int64
ativo
boolean
idUsuarioLogado
integer int64
EntradaAtivacaoInativacaoJuizoDTO
Object
id
integer int64
ativo
boolean
idUsuarioLogado
integer int64
EntradaAtivacaoInativacaoTurmaRecursalDTO
Object
id
integer int64
ativo
boolean
idUsuarioLogado
integer int64
EnvioEmailAdesaoFiltro
Object
idCliente
integer int64
idsUsuarioCliente
Array
integer int64
envioGeral
boolean
ExcluirFonteXProcessoDTO
Object
idUsuarioCliente
integer int64
idGrupoUsuarios
integer int64
idCliente
integer int64
fonteParamPesqProcesso
FonteParamPesqProcessoDTO
Object
numeroProcesso
string
idFonteXTipoPesquisa
integer int64
idValorParamFonteProc
integer int64
idPesqProcUsuarioCliente
integer int64
PostForoDTO
Object
nome
string
idOrgaoJudiciario
integer int64
idMunicipioSede
integer int64
ativo
boolean
idUsuarioLogado
integer int64
PostForumDTO
Object
nome
string
idUf
integer int64
ativo
boolean
idUsuarioLogado
integer int64
PostJuizoDTO
Object
idOrgaoJudiciario
integer int64
idForo
integer int64
idForum
integer int64
nome
string
idMunicipioSede
integer int64
ativo
boolean
idUsuarioLogado
integer int64
PostRegraJCNJDTO
Object
codigoJCNJ
integer int32
idTipoRegraJCNJ
integer int64
idOrgaoJudiciario
integer int64
idSegmentoJudiciario
integer int64
idEspecSegmentoJudiciario
integer int64
PostRegraTRCNJDTO
Object
idRegraJCNJ
integer int64
idTipoRegraTRCNJ
integer int64
codigoTRCNJ
integer int32
idOrgaoJudiciario
integer int64
idForo
integer int64
PostTurmaRecursalDTO
Object
nome
string
idForo
integer int64
ativo
boolean
idUsuarioLogado
integer int64
PutForoDTO
Object
id
integer int64
nome
string
idOrgaoJudiciario
integer int64
idMunicipioSede
integer int64
idUsuarioLogado
integer int64
PutForumDTO
Object
id
integer int64
nome
string
idUf
integer int64
idUsuarioLogado
integer int64
PutJuizoDTO
Object
id
integer int64
idOrgaoJudiciario
integer int64
idForo
integer int64
idForum
integer int64
nome
string
idMunicipioSede
integer int64
idUsuarioLogado
integer int64
PutParamGeralDTO
Object
idParametroGeral
integer int64
idEnvioEmailRecupSenha
integer int64
diasPesqAndAPartirPublic
integer int32
diasBuscaPublicPalChave
integer int32
valorTaxaBoleto
number double
valorMinContrato
number double
diasInadBloqueio
integer int32
diasInadInativacao
integer int32
diasProxBloqueioInad
integer int32
tentatCobrManualCliente
integer int32
anosRepetEventoAgenda
integer int32
diasSPagBloqueio
integer int32
diasSPagInativacao
integer int32
diasPesqAndPrimVez
integer int32
diasAlertaPagamentos
integer int32
qtdRepeticaoFixa
integer int32
sequencialContrato
string
diasSPagInatTransicao
integer int32
padraoDiasGeraBoleto
integer int32
agendPesqAndProcesso
integer int64
horaAgendamento
integer int32
diasExcluirMovLixeira
integer int32
PutRegraJCNJDTO
Object
idRegraJCNJ
integer int64
codigoJCNJ
integer int32
idTipoRegraJCNJ
integer int64
idOrgaoJudiciario
integer int64
idSegmentoJudiciario
integer int64
idEspecSegmentoJudiciario
integer int64
PutRegraTRCNJDTO
Object
id
integer int64
idRegraJCNJ
integer int64
idTipoRegraTRCNJ
integer int64
codigoTRCNJ
integer int32
idOrgaoJudiciario
integer int64
idForo
integer int64
PutTurmaRecursalDTO
Object
id
integer int64
idForo
integer int64
nome
string
idUsuarioLogado
integer int64
RegraDiarioContratoAtualizacaoDTO
Object
id
integer int64
idValorTipoRegraFunc
integer int64
idDiario
integer int64
quantidadeContratada
integer int32
flObrigatorio
boolean
RegraDiarioContratoInsercaoDTO
Object
idContrato
integer int64
idContratoXFuncionalidade
integer int64
idValorTipoRegraFunc
integer int64
idDiario
integer int64
quantidadeContratada
integer int32
flObrigatorio
boolean
flAtivo
boolean
RegraDiarioContratoStatusDTO
Object
id
integer int64
flAtivo
boolean
idSituacaoRegraDiarioContrato
integer int64
ReqDadosListaNumeroProcessoDTO
Object
listaNumeroProcesso
Array of string
EntradaAderir
Object
idCliente
integer int64
idsPlanos
Array
integer int64
idsFuncionalidades
Array
integer int64
EntradaAlteracaoLoteDTO
Object
idLoteClienteAdesao
integer int64
idSituacaoLoteCLienteAdesao
integer int64
idUsuarioLogado
integer int64
EntradaAtivacaoInativacaoFonteTipoPesquisaDTO
Object
id
integer int64
ativo
boolean
idUsuarioLogado
integer int64
EntradaDadosInativacaoParceiroDTO
Object
idUsuarioClienteParceiro
integer int64
iDs
Array
integer int64
EntradaMarcarDesmarcarClienteLoteDTO
Object
idClienteLoteAdesao
integer int64
marcado
boolean
idUsuarioLogado
integer int64
FuncionalidadesAdesao
Object
idContratoXFuncionalidade
integer int64
aderir
boolean
Pagamento
Object
idPessoaPagador
integer int64
idFormaPagamento
integer int64
idPeriodicidadeCobranca
integer int64
quantidadeParcelas
integer int32
prePago
boolean
diaDoMesCobranca
integer int32
diasGeraBoleto
integer int32
recorrente
boolean
dataInicioPeriodoCobranca
string date-time
dataProxBloqueioInad
string date-time
PlanoVinculadoClienteDTO
Object
id
integer int64
idContrato
integer int64
idCliente
integer int64
idContratoXPlano
integer int64
dataAdesao
string date-time
idSituacaoClienteXPlano
integer int64
ativo
boolean
Types: ClienteDTO
PlanosAdesao
Object
idContratoXPlano
integer int64
aderir
boolean
PostComplFonteXTipoPesquisaDTO
Object
id
integer int64
flBuscaAnexos
boolean
idTipoFontePesquisa
integer int64
idTipoCaptcha
integer int64
flObrigatorioInformarCaptcha
boolean
flReaproveitaSessao
boolean
flQuebraCaptchaAutomatica
boolean
PostFontePesquisaDTO
Object
nome
string
url
string
nomeExibicao
string
codFonte
integer int32
idUsuarioLogado
integer int64
PostFonteTipoPesquisaDTO
Object
idFontePesquisa
integer int64
idTipoPesquisa
integer int64
idAplicacao
integer int64
ativo
boolean
idUsuarioLogado
integer int64
PutComplFonteXTipoPesquisaDTO
Object
id
integer int64
flBuscaAnexos
boolean
idTipoFontePesquisa
integer int64
idTipoCaptcha
integer int64
flObrigatorioInformarCaptcha
boolean
flReaproveitaSessao
boolean
flQuebraCaptchaAutomatica
boolean
PutFontePesquisaDTO
Object
id
integer int64
nome
string
url
string
nomeExibicao
string
codFonte
integer int32
idUsuarioLogado
integer int64
PutFonteTipoPesquisaDTO
Object
idFonteXTipoPesquisa
integer int64
idFontePesquisa
integer int64
idTipoPesquisa
integer int64
idAplicacao
integer int64
idUsuarioLogado
integer int64
PutMovProcUsuarioClienteDTO
Object
id
integer int64
flConferido
boolean
idUsuarioLogado
integer int64
RegraOOOOCNJDTO
Object
id
integer int64
idRegraTRCNJ
integer int64
idRegraJCNJ
integer int64
codigoOOOOCNJ
integer int32
codigoTRCNJ
integer int32
codigoJCNJ
integer int32
idTipoRegraOOOOCNJ
integer int64
nomeTipoRegraOOOOCNJ
string
idForo
integer int64
nomeForo
string
idJuizo
integer int64
nomeJuizo
string
idTurmaRecursal
integer int64
nomeTurmaRecursal
string
idForum
integer int64
nomeForum
string
RequestAgendPesqAndProcesso
Object
idAgendPesqAndProcesso
integer int64
descricao
string
idPeriodPesqAndProcesso
integer int64
qtdOcorrenciasPeriodo
integer int32
RequestAtivacaoInativacaoAdesao
Object
idContrato
integer int64
idCliente
integer int64
planosAdesao
Array of PlanosAdesao
funcionalidadesAdesao
idParceiro
integer int64
idUsuarioLogado
integer int64
RequestContrato
Object
idContrato
integer int64
idContratoPai
integer int64
idEmpresa
integer int64
idClienteContratante
integer int64
dataContratacao
string date-time
dataInicioVigencia
string date-time
dataFimVigencia
string date-time
valorTotal
number double
consorcio
boolean
convenioOAB
boolean
preCadastroClientes
boolean
cortesia
boolean
parceria
boolean
transicao
boolean
idColaboradorConsultor
integer int64
geraNF
boolean
renovacaoAutomatica
boolean
sujeitoARegraInadimplencia
boolean
quantidadeUsuarios
integer int32
observacao
string
idProdutoAdvise
integer int64
ativo
boolean
idUsuario
integer int64
valorOriginal
number double
dataReajuste
string date-time
idPessoaAutoContratacao
integer int64
pagamento
planos
Array of RequestPlano
funcionalidadeContrato
RequestFuncionalidade
Object
idContratoXFuncionalidade
integer int64
idPlanoXFuncionalidade
integer int64
idFuncionalidade
integer int64
quantidadeContratada
integer int32
precoContratado
number double
precoTotalContratado
number double
RequestPlano
Object
idContratoXPlano
integer int64
idPlano
integer int64
funcionalidades
RequestRegraFuncionalidade
Object
idRegra
integer int64
idRegraFuncContrato
integer int64
idValorTipoRegraFunc
integer int64
regraPesqAndProcContrato
AlterarSituacaoGrupoUsuarioDTO
Object
idGrupo
integer int64
idCliente
integer int64
nomeGrupo
string
idSituacaoGrupo
integer int64
EntradaAlteracaoSituacaoAdesaoDTO
Object
idClienteXPlano
integer int64
idSituacaoClienteXPlano
integer int64
InativarUsuarioGrupoDTO
Object
idUsuarioXGrupo
integer int64
idGrupo
integer int64
idUsuarioCliente
integer int64
administrador
boolean
ativo
boolean
MovProcUCXUsuarioLeituraDTO
Object
idGrupoUsuarios
integer int64
idUsuarioCliente
integer int64
idMovProcUsuarioCliente
Array
integer int64
idUsuarioClienteLogado
integer int64
idClienteLogado
integer int64
idParceiro
integer int64
PostGrupoUsuarioDTO
Object
idGrupo
integer int64
idCliente
integer int64
nomeGrupo
string
idSituacaoGrupo
integer int64
PostUsuarioGrupoDTO
Object
idUsuarioXGrupo
integer int64
idGrupo
integer int64
idUsuarioCliente
integer int64
administrador
boolean
ativo
boolean
ProcessoClienteAnexosFiltro
Object
trazerAnexosAndamento
boolean
pagina
integer int32
registrosPagina
integer int32
idUsuarioCliente
integer int64
idGrupoUsuarios
integer int64
ProcessoClienteAnexosFonteProcessoFiltro
Object
idFonteProcesso
integer int64
idProcesso
integer int64
idFonte
integer int64
idParametro
integer int64
PutGrupoUsuarioDTO
Object
idGrupo
integer int64
idCliente
integer int64
nomeGrupo
string
idSituacaoGrupo
integer int64
PutUsuarioGrupoDTO
Object
idUsuarioXGrupo
integer int64
idGrupo
integer int64
idUsuarioCliente
integer int64
administrador
boolean
ativo
boolean
AdesaoConvenioDTO
Object
nomeCliente
string
cpfCnpj
string
numeroOAB
string
idUFOAB
integer int64
tipoSexo
string
Enumeration:
NaoInformar
Masculino
Feminino
emailCliente
string
dataNascimento
string date-time
fone1
string
fone2
string
celular1
string
celular2
string
cep
string
logradouro
string
numeroEndereco
string
complemento
string
bairro
string
idMunicipio
integer int64
observacao
string
emailsNotificacao
string
idContrato
integer int64
diarios
string
palavraChave
string
variacoesPalavraChave
idUsuarioLogado
integer int64
idParceiro
integer int64
AditivoXAgendaPesqAndDTO
Object
id
integer int64
idRegraPesqAndProceAditivo
integer int64
idDiaHoraPesqAndProc
integer int64
idContratoXAgendPesqAnd
integer int64
idDiaSemana
integer int64
diaMes
integer int32
hora
integer int32
ultDiaMes
boolean
AditivoXFuncionalidadeDTO
Object
id
integer int64
idAditivo
integer int64
idPlanoXFuncionalidade
integer int64
idFuncionalidade
integer int64
precoContratado
number double
quantidadeContratada
integer int32
flAtivo
boolean
idContratoXFuncionalidade
integer int64
idAditivoXPlano
integer int64
precoTotalContratado
number double
regrasFuncAditivo
AditivoXPlanoDTO
Object
id
integer int64
idAditivo
integer int64
idPlano
integer int64
idContratoXPlano
integer int64
funcionalidadesAditivo
EntradaAtivacaoAdesaoDTO
Object
idClienteXPlano
integer int64
EntradaBloqueioAdesaoDTO
Object
idClienteXPlano
integer int64
EntradaCancelamentoAdesaoDTO
Object
idClienteXPlano
integer int64
FuncionalidadeClienteDTO
Object
idContratoXFuncionalidade
integer int64
idFuncionalidade
integer int64
nomeFuncionalidade
string
ImportacaoAgendaVinculoDTO
Object
idTipoUsuario
integer int64
codVinculo
integer int32
idUsuarioCliente
integer int64
MovProcUCXUsuarioLeituraFiltro
Object
campos
string
paginaAtual
integer int32
registrosPorPagina
integer int32
ordenacao
string
idGrupoUsuarios
integer int64
idUsuarioCliente
integer int64
idMovProcUsuarioCliente
Array
integer int64
flLido
boolean
idUsuarioClienteLogado
integer int64
idClienteLogado
integer int64
idParceiro
integer int64
PesqPublicPalavraChaveDiarioDTO
Object
idPalavraChave
integer int64
palavraChave
string
idTipoPalavraChave
integer int64
flPalavraChaveExata
boolean
idPalavraChavePrincipal
integer int64
palavraChavePrincipal
string
idClassifPalavraChave
integer int64
idDiario
integer int64
idUsuarioCliente
integer int64
idGrupoUsuarios
integer int64
flAtualizacao
boolean
idPesqPublicUsuarioCliente
integer int64
flAtivo
boolean
flPesquisaDespacho
boolean
guid
string uuid
PesqPublicUsuarioGrupoDTO
Object
listaPesquisaPublicacao
guid
string uuid
idUsuarioCliente
integer int64
idGrupoUsuarios
integer int64
idUsuarioClienteXFuncionalidade
integer int64
idSituacaoPalavraChave
integer int64
PessoaPagadorDTO
Object
id
integer int64
cpfcnpj
string
nome
string required
Min length: 1
email
string
cep
string
idSexo
integer int64 required
logradouro
string
numeroEndereco
string
complementoEndereco
string
bairro
string
idMunicipio
integer int64
idUFMunicipio
integer int64
fone
string
celular
string
idTipoPessoa
integer int64
idParceiro
integer int64
idUsuarioInclusao
integer int64
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
dataHoraUltAlteracao
string date-time
PostCampoDTO
Object
idTipoInfoSpider
integer int64
nomeCampo
string
idCampoPlataforma
integer int64
idUsuarioLogado
integer int64
PostFonteDTO
Object
nome
string
nomeInterno
string
nomeExibicao
string
tipoFontePesquisa
integer int64
tipoCaptcha
integer int64
flBuscaAnexos
integer int32
flObrigatorioInformarCaptcha
integer int32
flReaproveitaSessao
integer int32
flQuebraCaptchaAutomatica
integer int32
url
string
codFonte
integer int64
idUsuarioLogado
integer int64
PostFonteDicionarioCampoSpiderDTO
Object
idFonteXTipoPesquisa
integer int64
iDsCampos
string
ordens
string
idUsuarioLogado
integer int64
PostOrgaoDTO
Object
nomeOrgao
string
sigla
string
idTipoOrgao
integer int64
idTipoJustica
integer int64
idEspecializacao
integer int64
idGrau
integer int64
idSegmento
integer int64
idUsuarioLogado
integer int64
PostOrgaoJudiciarioDTO
Object
idFonteXTipoPesquisa
integer int64
iDsOrgaoJudiciario
string
idUsuarioLogado
integer int64
PostParametroDTO
Object
idFonteXTipoPesquisa
integer int64
idsTipoParametro
string
nomes
string
nomesExibicao
string
valoresParametro
string
codFonteParametros
string
valorParametrosProcessos
string
urls
string
idUsuarioLogado
integer int64
PostPastaUsuarioClienteAnotacaoDTO
Object
idUsuarioClienteLogado
integer int64
idPastaUsuarioCliente
integer int64
anotacao
string
PostPushNotificacaoDTO
Object
hash
string
dispositivo
string
idUsuarioCliente
integer int64
gruposUsuarios
Array
integer int64
idTipoUsuario
integer int64
idParceiro
integer int64
idUsuarioLogado
integer int64
idClienteLogado
integer int64
PostTermoDTO
Object
termoChave
string
mensagemRetorno
string
mensagemInterna
string
idUsuarioLogado
integer int64
PostTipoNumProcDTO
Object
nomeTipoNumProcesso
string
codTipoNumero
integer int64
cnj
integer int64
idUsuarioLogado
integer int64
PostTipoNumProcessoDTO
Object
idFonteXTipoPesquisa
integer int64
idTipoNumeroProcesso
integer int64
idUsuarioLogado
integer int64
PutDispositivoPushNotificacaoDTO
Object
hash
string
ativo
boolean
idTipoUsuario
integer int64
idParceiro
integer int64
idUsuarioLogado
integer int64
idClienteLogado
integer int64
PutFonteDTO
Object
idAplicacao
integer int64
nome
string
nomeInterno
string
nomeExibicao
string
tipoFontePesquisa
integer int64
tipoCaptcha
integer int64
flBuscaAnexos
integer int32
flObrigatorioInformarCaptcha
integer int32
flReaproveitaSessao
integer int32
flQuebraCaptchaAutomatica
integer int32
url
string
codFonte
integer int64
flAtivo
integer int64
idUsuarioLogado
integer int64
PutFonteDicionarioCampoSpiderDTO
Object
idFonteXTipoPesquisa
integer int64
iDsCampos
string
ordens
string
idUsuarioLogado
integer int64
PutInativaAtivaEnvioEmailDTO
Object
id
integer int64
idUsuarioUltAlteracao
integer int64
dataHoraUltAlteracao
string date-time
idCliente
integer int64
idParceiro
integer int64
PutOrgaoJudiciarioDTO
Object
idFonteXTipoPesquisa
integer int64
iDsOrgaoJudiciario
string
idUsuarioLogado
integer int64
PutParametroDTO
Object
idValorParamFontePesq
integer int64
valorParametro
string
nomeExibicao
string
url
string
codFonteParametro
string
flAtivo
integer int64
idUsuarioLogado
integer int64
PutPastaMarcarDesmarcarLidoDTO
Object
idUsuarioCliente
integer int64
idGrupoUsuarios
integer int64
idProcesso
integer int64
idFontePesquisa
integer int64
idParametro
integer int64
dataInicio
string date-time
dataFim
string date-time
flLido
boolean
idsProcessoFonteParametro
idUsuarioLogado
integer int64
idTipoUsuarioLogado
integer int64
PutPastaUsuarioClienteAnotacaoDTO
Object
idUsuarioClienteLogado
integer int64
idPastaUsuarioCliente
integer int64
idPastaUsuarioClienteAnotacao
integer int64
anotacao
string
PutProcessoFonteParametroDTO
Object
idProcesso
integer int64
idFontePesquisa
integer int64
idParametro
integer int64
PutPushNotificacaoDTO
Object
ids
Array
integer int64
recebeNotificacao
boolean
idTipoUsuario
integer int64
idParceiro
integer int64
idUsuarioLogado
integer int64
idClienteLogado
integer int64
PutTermoDTO
Object
idTermoChave
integer int64
flAtivo
boolean
idUsuarioLogado
integer int64
PutTipoNumProcessoDTO
Object
idFonteXTipoPesquisa
integer int64
idTipoNumeroProcesso
integer int64
idUsuarioLogado
integer int64
RegraFuncAditivoDTO
Object
id
integer int64
idAditivoXFuncionalidade
integer int64
idValorTipoRegraFunc
integer int64
idRegraFuncContrato
integer int64
idSituacaoRegraFuncContrato
integer int64
regraPesqAndProcAditivo
RegraPesqAndProcAditivoDTO
Object
id
integer int64
idAgendPesqAndProcesso
integer int64
idRegraPesqAndProcContrato
integer int64
descricao
string
idPeriodPesqAndProcesso
integer int64
qtdOcorrenciasPeriodo
integer int32
agendamentosAditivo
RelacionarParametrosInativarDTO
Object
idParamFontePesq
integer int64
idUsuarioLogado
integer int64
RequestAditivoDTO
Object
id
integer int64
idContrato
integer int64
valorContratoComAditivo
number double
dataAditivo
string date-time
dataInicioVigencia
string date-time
dataFimVigencia
string date-time
dataReajuste
string date-time
quantidadeUsuarios
integer int32
idPeriodicidadeCobranca
integer int64
quantidadeParcelas
integer int32
diaDoMesCobranca
integer int32
recorrente
boolean
prePago
boolean
observacao
string
idColaboradorConsultorAditivo
integer int64
idEmpresa
integer int64
funcionalidadesAditivo
planosAditivo
idsTipoAditivo
Array
integer int64
idUsuarioLogado
integer int64
idTipoUsuarioLogado
integer int64
RequestBloqueiContrato
Object
motivoBloqueio
string
idSituacaoContrato
integer int64
RequestCancelamentoContrato
Object
motivo
string
RequestContratoUsuarioClienteDTO
Object
idContrato
integer int64
RequestContratoXAgendPesqAnd
Object
idContratoXAgendPesqAnd
integer int64
idRegraPesqAndProcContrato
integer int64
diaHoraPesqAndProc
RequestDesbloqueioContrato
Object
motivoDesbloqueio
string
dataProximoBloqueio
string date-time
RequestDiaHoraPesqAndProc
Object
idDiaHoraPesqProc
integer int64
idDiaSemana
integer int64
diaMes
integer int32
hora
integer int32
flUltDiaMes
boolean
RequestFuncionalidadeUsuarioClienteDTO
Object
idContratoXFuncionalidade
integer int64
selecionado
boolean
quantidade
integer int32
RequestPlanoUsuarioClienteDTO
Object
idContratoxPlano
integer int64
idPlano
integer int64
RequestRegraPesqAndProcContrato
Object
idRegraPesqAndProcContrato
integer int64
agendPesqAndProcesso
contratoXAgendPesqAnd
RequestServicoUsuarioClienteDTO
Object
idServico
integer int64
nomeServico
string
funcionalidades
ServicoClienteDTO
Object
id
integer int64
nome
string
funcionalidades
VariacaoPalavraChave
Object
palavraChave
string
idTipoPalavraChave
integer int64
flPalavraChaveExata
boolean