Advise Plataforma - Open API
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 Ramal: 6222 | |
| Email: hemerson.ravaneda@advise.com.br |
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.
Exemplo:
GET /webwooks/?campos=IdWebhook,IdCliente,Ativo, IdUsuarioInclusao, IdUsuarioUltAlteracao, DataHoraInclusao, DataHoraUltAlteracaoRequest parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request headers
Request body
Responses
Retorna a lista de objetos inseridos.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request headers
Request body
objeto
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Caso não seja informado valor do campo “Ativo”, será criada Turma Recursal com valor True para “Ativo”
Request headers
Request body
Responses
Retorna a lista de objetos inseridos.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Recebe apenas um id de TurmaRecursal para ativação
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Recebe apenas um id de Turma Recursal para inativação
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request headers
Request body
Responses
Retorna a lista de objetos inseridos.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request headers
Request body
Responses
Retorna a lista de objetos inseridos.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Request headers
Request body
Responses
Retorna a lista de objetos inseridos.
Retorna uma lista de erros padronizados com características da API solicitada.
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Exemplo:
GET /parceiros/?campos=id,ativo,advise,URLAcessoCliente, idclienteRequest parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Descrição:
POST /parceiros/Request headers
Request body
objeto
Responses
Retorna a lista de objetos inseridos.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Descrição:
PUT /parceiros/Request headers
Request body
objeto
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
PUT /parceiros/ativar
body: { “ids”: [1, 2, 3, 4] }
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
PUT /parceiros/inativar
body: { “ids”: [1, 2, 3, 4] }
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Caso não seja informado valor do campo “Ativo”, será criado forum com valor True para “Ativo”
Request headers
Request body
Responses
Retorna a lista de objetos inseridos.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Caso não sejam passados valores para idForo e idForum, serão alterados para nulo
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Recebe apenas um id de Juizo para ativação
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Recebe apenas um id de Juizo para inativação
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Caso não seja informado valor do campo “Ativo”, será criado forum com valor True para “Ativo”
Request headers
Request body
Responses
Retorna a lista de objetos inseridos.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Recebe apenas um id de Forum para ativação
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Recebe apenas um id de Forum para inativação
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Caso não seja informado valor do campo “Ativo”, será criado foro com valor True para “Ativo”
Request headers
Request body
Responses
Retorna a lista de objetos inseridos.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Caso não seja passado valor para o idMunicipioSede, será alterado para nulo
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Recebe apenas um id de Foro para ativação
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Recebe apenas um id de Foro para inativação
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
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).
Descrição:
(Explicação da API)Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Descrição:
(Explicação da API)Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Request headers
Request body
Responses
Retorna a lista de objetos inseridos.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Regras:
1 - Ao contratar um serviço de agenda, uma agenda é criada os usuários-cliente do cliente (que não tiverem).
2 - Ao criar um usuário-cliente, é criada também uma agenda para ele, com o seu nome, se 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 para o cliente.Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Refere-se as manutenções dos Eventos de Agenda(os compromissos)
Descrição:
filtro.IDs = "IdEventoAgendaA, IdEventoAgendaB, IdEventoAgendaC" (Utilize o Id do EventoAgenda),
filtro.IdUsuarioCliente = 30877 (Utilize o Id do UsuárioClienteDono),Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Regras:
1 - Todo evento vinculado ao tipo padrão prazo (IdTipoEventoAgenda = -1), deve ter IdMovProcessoCliente vinculado.
2 - Quando o usuário inserir em duracao maior que 1 dia EventoAgenda o sistema não permitirá a inclusão do campo IdRepetEventoAgenda com valor igual a -2. Todos os dias, e -4. Todos os dias da semana.
3 - O cliente não poderá inserir repetições(agenda.EventoAgenda.DataFimRepeticao) além da quantidade de anos parametrizadas em "Param.AnosRepetEventoAgenda".
4 - A agenda tem um dono, que é o usuário-cliente que a criou.O dono pode compartilhar a agenda com outros usuários do mesmo cliente => não tem compartilhamento nesse momento (porque só tem um usuário-cliente por cliente);
5 - Se for menor que um dia, pode qualquer tipo de repeticao.
6 - Se for maior que um dia, pode somente repeticao semanal ou maior.
7 - Se for maior que uma semana, pode somente repeticao mensal ou maior.
8 - Se for maior que um mes, permite somente repetição anual.
9 - Se for maior que um ano não permite nenhuma forma de repetição, espera-se o tipo "null" ou (-1)ERepetEventoAgenda.NaoRepete.Caso null API seta(-1) automaticamente.Request headers
Request body
Responses
Retorna a lista de objetos inseridos.
Retorna uma lista de erros padronizados com características da API solicitada.
Exemplo:
PUT /eventos-agenda/
"itens":
{
"Id": 0,
"IdAgenda": 0,
"Titulo": "título",
"DataHoraFim": "2018-09-17T00:00:00",
"DataHoraInicio": "2018-09-17T00:00:00",
"DiaInteiro": false,
"Concluido": false,
"Importante": true,
"Observacao": "observação",
"Localizacao": "localização",
"IdOpcaoLembreteAgenda": 0,
"IdTipoEventoAgenda": 0,
"IdRepetEventoAgenda": 0,
"DataFimRepeticao": "2018-09-17T00:00:00"
}Request headers
Request body
objeto
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Descrição:
(Explicação da API)Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Descrição:
(Explicação da API)Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Controla os Tipos de Eventos Agendas por Cliente
Exemplo:
GET /tipo-eventos/Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Exemplo:
GET /tipo-eventos/inativarRequest headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Esses padrões serão definidos pela Advise, e terão id negativo, não podendo ser alterado pelo usuário.
Exemplo:
GET /tipos-eventos-padroes/Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Refere-se a forma com qual o evento pode ser repetido. Exemplo: o evento pode acontecer diariamente, semanalmente, e etc.
Exemplo:
GET /tipos-repeticao-eventos/Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
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.
Exemplo:
GET /tipos-lembretes-eventos/Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Exemplo:
GET /agenda-google-calendar/
Lista de possiveis campos:
''Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Descrição:
POST /integracao-google-calendar/Request headers
Request body
objeto
Responses
Retorna a lista de objetos inseridos.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Descrição:
PUT /agenda-google-calendar/Request headers
Request body
objeto
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Descrição:
PUT /integracao-google-calendar/Request headers
Request body
objeto
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Descrição:
POST /agenda-google-calendar/Request headers
Request body
objeto
Responses
Retorna a lista de objetos inseridos.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Exemplo:
GET /integracao-google-calendar/
Lista de possiveis campos:
''Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
{pessoaClienteId}Descrição:
id = idPessoaCliente a ser inserido a foto
extensao = extensão do arquivo .jpg ou .png
foto = string contendo os bytes da imagem
POST /contatos-fotos/Request headers
Request body
objeto
Responses
Retorna a lista de objetos inseridos.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Descrição:
DELETE /contatos-fotos?fotoId=sd33asfsfasdRequest parameters
Request headers
Request body
Responses
Retorna a lista de objetos excluidos.
objeto incluído
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
{pessoaClienteId}Descrição:
GET /contatos-fotos?fotoId=sd33asfsfasdPath variables
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
objeto incluído
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request headers
Request body
Responses
Retorna a lista de objetos inseridos.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Exemplo:
GET /padroes-marcadores-contato?campos=nome
IdPadraoMarcadorContato,NomeMarcadorContato,Ativo,IdUsuarioInclusao,DataHoraInclusao,IdUsuarioUltAlteracao,DataHoraUltAlteracao,NomeUsuarioInclusao,NomeUsuarioUltAlteracaoRequest parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Campos:
IdMarcadorContato, IdCliente, NomeMarcadorContato, Ativo, IdUsuarioInclusao, DataHoraInclusao, IdUsuarioUltAlteracao, DataHoraUltAlteracao, NomeUsuarioInclusao, NomeUsuarioUltAlteracao
PadraoMarcadorContato.IdPadraoMarcadorContato, PadraoMarcadorContato.NomePadraoMarcadorContato,Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request headers
Request body
Responses
Retorna a lista de objetos inseridos.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Descrição:
(Explicação da API)Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Campos:
IdListaContato, IdUsuarioClienteDono, NomeListaContato, ListaPadrao, Ativo
UsuarioClienteCompartilhado.IdUsuarioClienteCompartilhado, UsuarioClienteCompartilhado.NomeUsuarioCliente, UsuarioClienteCompartilhado.IncluiContato,
UsuarioClienteCompartilhado.AlteraContato, UsuarioClienteCompartilhado.InativaContato, UsuarioClienteCompartilhado.IncluiAtividadeContato,
UsuarioClienteCompartilhado.VerAtividadeContato, UsuarioClienteCompartilhado.AtivoRequest parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request headers
Request body
Responses
Retorna a lista de objetos inseridos.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Descrição:
(Explicação da API)Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Campos:
IdPessoaCliente, CpfCnpj, NomePessoaCliente, IdSexo, IdTipoPessoa, Logradouro
NumeroEndereco, cep, ComplementoEndereco, IdMunicipio, DataNascimentoAbertura
Email, Fone1, Fone2, Celular1, Celular2, Observacao
Contato.IdContato, Contato.Ativo
Contato.ListaContato.IdListaContato, Contato.ListaContato.IdUsuarioClienteDono, Contato.ListaContato.NomeListaContato, Contato.ListaContato.ListaPadrao, Contato.ListaContato.Ativo
Contato.ContatoXMarcadorContato.idContatoXMarcadorContato, Contato.ContatoXMarcadorContato.Ativo
Contato.ContatoXMarcadorContato.MarcadorContato.IdMarcadorContato, Contato.ContatoXMarcadorContato.MarcadorContato.NomeMarcadorContatoRequest parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request headers
Request body
Responses
Retorna a lista de objetos inseridos.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Descrição:
(Explicação da API)Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Descrição:
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Campos:
IdCompartilhaContato, IdUsuarioClienteCompartilhado, IncluiContato, AlteraContato, InativaContato, IncluiAtividadeContato, VerAtividadeContato, Ativo,
ListaContato.IdListaContato, ListaContato.IdUsuarioClienteDonoRequest parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request headers
Request body
Responses
Retorna a lista de objetos inseridos.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Descrição:
(Explicação da API)Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request headers
Request body
Responses
Retorna a lista de objetos inseridos.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Campos:
IdBaixaFinanceiro, DataBaixa, ValorBaixa, Ativo
ParcelaFinanceiro.IdParcelaFinanceiro, ParcelaFinanceiro.NumeroParcela, ParcelaFinanceiro.ValorOriginal, ParcelaFinanceiro.ValorAberto, ParcelaFinanceiro.Baixado
ParcelaFinanceiro.LancamentoFinanceiro.IdLancamentoFinanceiro, ParcelaFinanceiro.LancamentoFinanceiro.IdLancamentoFinanceiro, ParcelaFinanceiro.LancamentoFinanceiro.IdPessoaCliente,
ParcelaFinanceiro.LancamentoFinanceiro.IdContaFinanceiro, ParcelaFinanceiro.LancamentoFinanceiro.DebitoCredito, ParcelaFinanceiro.LancamentoFinanceiro.DataEmissao
ParcelaFinanceiro.LancamentoFinanceiro.BaixadoRequest parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.