Advise Plataforma - Open API

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 Ramal: 6222
Email: hemerson.ravaneda@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.|
Webhook
GET /core/v1/webwooks
POST /core/v1/webwooks
PUT /core/v1/webwooks/inativar
Consulta uma lista de webhooks
GET /core/v1/webwooks

Exemplo:

GET /webwooks/?campos=IdWebhook,IdCliente,Ativo, IdUsuarioInclusao, IdUsuarioUltAlteracao, DataHoraInclusao, DataHoraUltAlteracao

Request parameters

IdsWebhook
array of integer optional
Collection format: multi
RotaApiCliente
string optional
Ativo
boolean optional
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Ordem
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Cria uma lista de webhooks
POST /core/v1/webwooks

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

201 201

Retorna a lista de objetos inseridos.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Altera uma lista de webhooks
PUT /core/v1/webwooks/inativar

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

objeto

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Turma Recursal
POST /core/v1/turmas-recursais
PUT /core/v1/turmas-recursais/ativar
PUT /core/v1/turmas-recursais/inativar
Consulta uma lista de turmas recursais do sistema
GET /core/v1/turmas-recursais

Request parameters

Nome
string optional
Ativo
boolean optional
IdForo
integer int64 optional
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Ordenacao
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Cria uma lista de turmas recursais do sistema
POST /core/v1/turmas-recursais

Caso não seja informado valor do campo “Ativo”, será criada Turma Recursal com valor True para “Ativo”

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

201 201

Retorna a lista de objetos inseridos.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Altera uma lista de turmas recursais do sistema
PUT /core/v1/turmas-recursais

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Altera uma lista de turmas recursais do sistema
PUT /core/v1/turmas-recursais/ativar

Recebe apenas um id de TurmaRecursal para ativação

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Altera uma lista de turmas recursais do sistema
PUT /core/v1/turmas-recursais/inativar

Recebe apenas um id de Turma Recursal para inativação

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

RegraTRCNJ
Consulta uma lista de regras trcnj do sistema
GET /core/v1/Regras-TR-CNJ

Request parameters

IDs
string optional
IdsRegraJCNJ
string optional
IdsTipoRegraTRCNJ
string optional
NomeTipoRegraTRCNJ
string optional
CodigoJCNJ
string optional
CodigoTRCNJ
string optional
IdsOrgaoJudiciario
string optional
SiglaOrgaoJudiciario
string optional
IdsForo
string optional
NomeForo
string optional
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Ordenacao
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Cria uma lista de regras trcnj do sistema
POST /core/v1/Regras-TR-CNJ

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

201 201

Retorna a lista de objetos inseridos.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Altera uma lista de regras trcnj do sistema
PUT /core/v1/Regras-TR-CNJ

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

RegraJCNJ
Consulta uma lista de regras jcnj do sistema
GET /core/v1/Regras-J-CNJ

Request parameters

IDs
string optional
CodigoJCNJ
string optional
IdsTipoRegraJCNJ
string optional
NomeTipoRegraJCNJ
string optional
IdsSegmentoJudiciario
string optional
NomeSegmentoJudiciario
string optional
IdsEspecSegmentoJudiciario
string optional
NomeEspecSegmentoJudiciario
string optional
IdsOrgaoJudiciario
string optional
SiglaOrgaoJudiciario
string optional
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Ordenacao
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Cria uma lista de regras jcnj do sistema
POST /core/v1/Regras-J-CNJ

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

201 201

Retorna a lista de objetos inseridos.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Altera uma lista de regras jcnj do sistema
PUT /core/v1/Regras-J-CNJ

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

QtdItensPagina
Consulta uma lista de quantidade de itens por página
GET /core/v1/qtd-itens-pagina

Request parameters

IdProdutoAdvise
integer int64 optional
IdUsuarioCliente
integer int64 optional
QtdRegistroMovPorPagina
integer int64 optional
IdUsuarioInclusao
integer int64 optional
IdUsuarioLogado
integer int64 optional
Coluna
string optional
Ordem
string optional
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Limitado
boolean optional
IDs
string optional
Campos
string optional
Expansao
string optional
Q
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Cria uma lista de quantidade de itens por página
POST /core/v1/qtd-itens-pagina

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

201 201

Retorna a lista de objetos inseridos.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Altera uma lista de quantidade de itens por página
PUT /core/v1/qtd-itens-pagina

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Parceiros
GET /core/v1/parceiros
POST /core/v1/parceiros
PUT /core/v1/parceiros
PUT /core/v1/parceiros/ativar
PUT /core/v1/parceiros/inativar
Consulta uma lista de parceiros
GET /core/v1/parceiros

Exemplo:

GET /parceiros/?campos=id,ativo,advise,URLAcessoCliente, idcliente

Request parameters

UrlAcessoCliente
string optional
Advise
boolean optional
Ativo
boolean optional
IdCliente
integer int64 optional
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Coluna
string optional
Ordem
string optional
Limitado
boolean optional
IDs
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Cria uma lista de parceiros
POST /core/v1/parceiros

Descrição:

POST /parceiros/

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

objeto

Responses

201 201

Retorna a lista de objetos inseridos.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Altera uma lista de parceiros
PUT /core/v1/parceiros

Descrição:

PUT /parceiros/

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

objeto

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Altera uma lista de parceiros
PUT /core/v1/parceiros/ativar

PUT /parceiros/ativar

body: { “ids”: [1, 2, 3, 4] }

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Altera uma lista de parceiros
PUT /core/v1/parceiros/inativar

PUT /parceiros/inativar

body: { “ids”: [1, 2, 3, 4] }

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Parametros Gerais
Consulta uma lista de parametros gerais do sistema
GET /core/v1/parametros-gerais

Request parameters

IdParametroGeral
integer int64 optional
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Ordenacao
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Altera uma lista de parametros gerais do sistema
PUT /core/v1/parametros-gerais

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Juizos
POST /core/v1/juizos
PUT /core/v1/juizos
PUT /core/v1/juizos/ativar
PUT /core/v1/juizos/inativar
Cria uma lista de juizos
POST /core/v1/juizos

Caso não seja informado valor do campo “Ativo”, será criado forum com valor True para “Ativo”

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

201 201

Retorna a lista de objetos inseridos.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Altera uma lista de juizos
PUT /core/v1/juizos

Caso não sejam passados valores para idForo e idForum, serão alterados para nulo

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Altera uma lista de juizos
PUT /core/v1/juizos/ativar

Recebe apenas um id de Juizo para ativação

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Altera uma lista de juizos
PUT /core/v1/juizos/inativar

Recebe apenas um id de Juizo para inativação

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Foruns
Consulta uma lista de foruns do sistema
GET /core/v1/foruns

Request parameters

Id
integer int64 optional
Nome
string optional
Ativo
boolean optional
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Ordenacao
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Cria uma lista de foruns do sistema
POST /core/v1/foruns

Caso não seja informado valor do campo “Ativo”, será criado forum com valor True para “Ativo”

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

201 201

Retorna a lista de objetos inseridos.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Altera uma lista de foruns do sistema
PUT /core/v1/foruns

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Altera uma lista de foruns do sistema
PUT /core/v1/foruns/ativar

Recebe apenas um id de Forum para ativação

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Altera uma lista de foruns do sistema
PUT /core/v1/foruns/inativar

Recebe apenas um id de Forum para inativação

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Foros
Consulta uma lista de foros do sistema
GET /core/v1/foros

Request parameters

Nome
string optional
Ativo
boolean optional
Id
integer int64 optional
IdOrgaoJudiciario
integer int64 optional
IdMunicipioSede
integer int64 optional
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Ordenacao
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Cria uma lista de foros do sistema
POST /core/v1/foros

Caso não seja informado valor do campo “Ativo”, será criado foro com valor True para “Ativo”

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

201 201

Retorna a lista de objetos inseridos.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Altera uma lista de foros do sistema
PUT /core/v1/foros

Caso não seja passado valor para o idMunicipioSede, será alterado para nulo

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Altera uma lista de foros do sistema
PUT /core/v1/foros/ativar

Recebe apenas um id de Foro para ativação

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Altera uma lista de foros do sistema
PUT /core/v1/foros/inativar

Recebe apenas um id de Foro para inativação

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Erros
GET /core/ErroV1/disparar-erro
GET /core/ErroV1/disparar-exception
ApiErroV1DispararerroGet
GET /core/ErroV1/disparar-erro

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

ApiErroV1DispararexceptionGet
GET /core/ErroV1/disparar-exception

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

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).
EventoAgendaV1
PUT /core/v1/eventos-agenda/vincular-movimento
PUT /core/v1/eventos-agenda/desvincular-movimento
Altera uma lista de eventos da agenda
PUT /core/v1/eventos-agenda/vincular-movimento

Descrição:

(Explicação da API)

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Altera uma lista de eventos da agenda
PUT /core/v1/eventos-agenda/desvincular-movimento

Descrição:

(Explicação da API)

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Agendas
POST /core/v1/envio-email-prazos
GET /core/v1/agendas
Compartilhamento de prazos da agenda por email
POST /core/v1/envio-email-prazos

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

201 201

Retorna a lista de objetos inseridos.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Consulta uma lista de agendas
GET /core/v1/agendas

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

IdUsuarioCliente
integer int64 optional
Ativo
boolean optional
IDs
string optional
CodigosIDs
array of integer optional
Collection format: multi
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Ordenacao
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Eventos de Agenda

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

GET /core/v1/eventos-agenda
POST /core/v1/eventos-agenda
PUT /core/v1/eventos-agenda
PUT /core/v1/eventos-agenda/ativar
PUT /core/v1/eventos-agenda/inativar
Consulta uma lista de eventos da agenda
GET /core/v1/eventos-agenda

Descrição:

filtro.IDs = "IdEventoAgendaA, IdEventoAgendaB, IdEventoAgendaC" (Utilize o Id do EventoAgenda),
filtro.IdUsuarioCliente = 30877 (Utilize o Id do UsuárioClienteDono),

Request parameters

IdUsuarioCliente
integer int64 optional
IdTipoEventoAgenda
integer int64 optional
DataInicial
string date-time optional
DataFinal
string date-time optional
Importante
boolean optional
Ativo
boolean optional
Concluido
boolean optional
DiaInteiro
boolean optional
Titulo
string optional
IdAgenda
integer int64 optional
IdRepetEventoAgenda
integer int64 optional
IdOpcaoLembreteAgenda
integer int64 optional
DataFimRepeticao
string date-time optional
Sincronizar
boolean optional
EventoGoogleId
string optional
IDs
string optional
CodigosIDs
array of integer optional
Collection format: multi
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Ordenacao
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Cria uma lista de eventos da agenda
POST /core/v1/eventos-agenda

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

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

201 201

Retorna a lista de objetos inseridos.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Altera uma lista de eventos da agenda
PUT /core/v1/eventos-agenda

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

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

objeto

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Ativa eventos da agenda
PUT /core/v1/eventos-agenda/ativar

Descrição:

(Explicação da API)

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Inativa Eventos da agenda
PUT /core/v1/eventos-agenda/inativar

Descrição:

(Explicação da API)

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Tipos de Eventos de Agendas

Controla os Tipos de Eventos Agendas por Cliente

GET /core/v1/tipos-eventos
PUT /core/v1/tipos-eventos/inativar
Consulta uma lista de tipos de eventos
GET /core/v1/tipos-eventos

Exemplo:

GET /tipo-eventos/

Request parameters

IdCliente
integer int64 optional
Ativo
boolean optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Inativa tipos de eventos de agenda
PUT /core/v1/tipos-eventos/inativar

Exemplo:

GET /tipo-eventos/inativar

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

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.

GET /core/v1/tipos-eventos-padroes
Consulta uma lista de tipos de eventos padrões
GET /core/v1/tipos-eventos-padroes

Exemplo:

GET /tipos-eventos-padroes/

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

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.

Consulta uma lista de tipos de repetição de eventos da agenda
GET /core/v1/tipos-repeticao-eventos

Exemplo:

GET /tipos-repeticao-eventos/

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

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.

Consulta uma lista de tipos de lembretes de eventos da agenda
GET /core/v1/tipos-lembretes-eventos

Exemplo:

GET /tipos-lembretes-eventos/

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Integração com Google Calendar
POST /core/v1/integracao-google-calendar
PUT /core/v1/agenda-google-calendar
PUT /core/v1/integracao-google-calendar
POST /core/v1/agenda-google-calendar
GET /core/v1/integracao-google-calendar
Consultar lista de Agendas do Google Calendar integradas
GET /core/v1/agenda-google-calendar

Exemplo:

GET /agenda-google-calendar/

   
Lista de possiveis campos:
    ''

Request parameters

PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
IdsAgendaGoogleCalendar
string optional
AgendaGoogleId
string optional
Sincronizado
boolean optional
Ativo
boolean optional
Limitado
boolean optional
Coluna
string optional
Ordem
string optional
IDs
string optional
Campos
string optional
Expansao
string optional
Q
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Cria uma lista de integracao google calendar
POST /core/v1/integracao-google-calendar

Descrição:

POST /integracao-google-calendar/

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

objeto

Responses

201 201

Retorna a lista de objetos inseridos.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Atualizar agenda integrada com Google Calendar
PUT /core/v1/agenda-google-calendar

Descrição:

PUT /agenda-google-calendar/

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

objeto

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Altera uma lista de integracao google calendar
PUT /core/v1/integracao-google-calendar

Descrição:

PUT /integracao-google-calendar/

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

objeto

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Cadastrar integração com o Google Calendar
POST /core/v1/agenda-google-calendar

Descrição:

POST /agenda-google-calendar/

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

objeto

Responses

201 201

Retorna a lista de objetos inseridos.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Consulta uma lista de integracao google calendar
GET /core/v1/integracao-google-calendar

Exemplo:

GET /integracao-google-calendar/

   
Lista de possiveis campos:
    ''

Request parameters

PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
IdsIntegracaoGoogleCalendar
string optional
Email
string optional
RefreshToken
string optional
Ativo
boolean optional
Coluna
string optional
Ordem
string optional
Limitado
boolean optional
IDs
string optional
Campos
string optional
Expansao
string optional
Q
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Contatos
POST /core/v1/envio-email-contatos
PessoaClienteFotoV1
POST /core/v1/contatos-fotos
DELETE /core/v1/contatos-fotos
GET /core/v1/contatos-fotos/{pessoaClienteId}
Cria uma lista de foto contato
POST /core/v1/contatos-fotos

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

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

objeto

Responses

201 201

Retorna a lista de objetos inseridos.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Remove uma lista de foto contato
DELETE /core/v1/contatos-fotos

Descrição:

DELETE /contatos-fotos?fotoId=sd33asfsfasd

Request parameters

fotoId
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos excluidos.

201 201

objeto incluído

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Consulta uma lista de foto contato
GET /core/v1/contatos-fotos/{pessoaClienteId}

Descrição:

GET /contatos-fotos?fotoId=sd33asfsfasd

Path variables

pessoaClienteId
integer int64 required

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

201 201

objeto incluído

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

MarcadorContatoV1
PUT /core/v1/marcadores-contato
Altera uma lista de marcador contatos
PUT /core/v1/marcadores-contato

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Envia contatos por email
POST /core/v1/envio-email-contatos

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

201 201

Retorna a lista de objetos inseridos.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

PadraoMarcadorContatoV1
GET /core/v1/padroes-marcadores-contato
Consulta uma lista de padrao marcador contatos
GET /core/v1/padroes-marcadores-contato

Exemplo:

GET /padroes-marcadores-contato?campos=nome

IdPadraoMarcadorContato,NomeMarcadorContato,Ativo,IdUsuarioInclusao,DataHoraInclusao,IdUsuarioUltAlteracao,DataHoraUltAlteracao,NomeUsuarioInclusao,NomeUsuarioUltAlteracao

Request parameters

IdsPadraoMarcadorContato
string optional
NomePadraoMarcadorContato
string optional
Ativo
boolean optional
IDs
string optional
CodigosIDs
array of integer optional
Collection format: multi
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Ordenacao
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

MarcadorContatoV1
GET /core/v1/marcadores-contato
POST /core/v1/marcadores-contato
PUT /core/v1/marcadores-contato/inativar
Consulta uma lista de marcador contatos
GET /core/v1/marcadores-contato

Campos:

IdMarcadorContato, IdCliente, NomeMarcadorContato, Ativo, IdUsuarioInclusao, DataHoraInclusao, IdUsuarioUltAlteracao, DataHoraUltAlteracao, NomeUsuarioInclusao, NomeUsuarioUltAlteracao
PadraoMarcadorContato.IdPadraoMarcadorContato, PadraoMarcadorContato.NomePadraoMarcadorContato,

Request parameters

IdsMarcadoresContado
string optional
NomeMarcadorContato
string optional
IdPadraoMarcadorContato
integer int64 optional
Ativo
boolean optional
IDs
string optional
CodigosIDs
array of integer optional
Collection format: multi
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Ordenacao
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Cria uma lista de marcador contatos
POST /core/v1/marcadores-contato

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

201 201

Retorna a lista de objetos inseridos.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Altera uma lista de marcador contatos
PUT /core/v1/marcadores-contato/inativar

Descrição:

(Explicação da API)

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

ListaContatosV1
GET /core/v1/listas-contato
POST /core/v1/listas-contato
PUT /core/v1/listas-contato
PUT /core/v1/listas-contato/inativar
Consulta uma lista de lista contatos
GET /core/v1/listas-contato

Campos:

IdListaContato, IdUsuarioClienteDono, NomeListaContato, ListaPadrao, Ativo
UsuarioClienteCompartilhado.IdUsuarioClienteCompartilhado, UsuarioClienteCompartilhado.NomeUsuarioCliente, UsuarioClienteCompartilhado.IncluiContato, 
UsuarioClienteCompartilhado.AlteraContato, UsuarioClienteCompartilhado.InativaContato, UsuarioClienteCompartilhado.IncluiAtividadeContato,
UsuarioClienteCompartilhado.VerAtividadeContato, UsuarioClienteCompartilhado.Ativo

Request parameters

IdsListaContato
string optional
NomeListaContato
string optional
ListaPadrao
boolean optional
Ativo
boolean optional
IdUsuarioClienteCompartilhado
integer int64 optional
IDs
string optional
CodigosIDs
array of integer optional
Collection format: multi
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Ordenacao
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Cria uma lista de lista contatos
POST /core/v1/listas-contato

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

201 201

Retorna a lista de objetos inseridos.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Altera uma lista de lista contatos
PUT /core/v1/listas-contato

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Altera uma lista de lista contatos
PUT /core/v1/listas-contato/inativar

Descrição:

(Explicação da API)

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

ContatoV1
GET /core/v1/contatos
POST /core/v1/contatos
PUT /core/v1/contatos
PUT /core/v1/contatos/ativar
PUT /core/v1/contatos/inativar
Consulta uma lista de contatos
GET /core/v1/contatos

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.NomeMarcadorContato

Request parameters

IdsContato
string optional
IdPessoaCliente
integer int64 optional
NomePessoaCliente
string optional
CpfCnpj
string optional
IdListaContato
integer int64 optional
NomeListaContato
string optional
ListaPadrao
boolean optional
Ativo
boolean optional
IdMarcadorContato
integer int64 optional
NomeMarcadorContato
string optional
MarcadorAtivo
boolean optional
IDs
string optional
CodigosIDs
array of integer optional
Collection format: multi
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Ordenacao
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Cria uma lista de contatos
POST /core/v1/contatos

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

201 201

Retorna a lista de objetos inseridos.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Altera uma lista de contatos
PUT /core/v1/contatos

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Altera uma lista de contatos
PUT /core/v1/contatos/ativar

Descrição:

(Explicação da API)

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Altera uma lista de contatos
PUT /core/v1/contatos/inativar

Descrição:

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

CompartilhaListaContatosV1
GET /core/v1/compartilha-listas-contato
POST /core/v1/compartilha-listas-contato
PUT /core/v1/compartilha-listas-contato
PUT /core/v1/compartilha-listas-contato/inativar
Consulta uma lista de compartilha lista contatos
GET /core/v1/compartilha-listas-contato

Campos:

IdCompartilhaContato, IdUsuarioClienteCompartilhado, IncluiContato, AlteraContato, InativaContato, IncluiAtividadeContato, VerAtividadeContato, Ativo,
ListaContato.IdListaContato, ListaContato.IdUsuarioClienteDono

Request parameters

IdsCompartilhaListaContato
string optional
IdsUsuarioClienteCompartilhado
string optional
IdListaContato
integer int64 optional
IncluiContato
boolean optional
AlteraContato
boolean optional
InativaContato
boolean optional
IncluiAtividadeContato
boolean optional
VerAtividadeContato
boolean optional
Ativo
boolean optional
IDs
string optional
CodigosIDs
array of integer optional
Collection format: multi
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Ordenacao
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Cria uma lista de compartilha lista contatos
POST /core/v1/compartilha-listas-contato

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

201 201

Retorna a lista de objetos inseridos.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Altera uma lista de compartilha lista contatos
PUT /core/v1/compartilha-listas-contato

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Altera uma lista de compartilha lista contatos
PUT /core/v1/compartilha-listas-contato/inativar

Descrição:

(Explicação da API)

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Financeiro
Envio Email
POST /core/v1/envio-email-parcelas
Envia as parcelas por email
POST /core/v1/envio-email-parcelas

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

201 201

Retorna a lista de objetos inseridos.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

BaixaFinanceiroV1
PUT /core/v1/baixas-financeiro
GET /core/v1/baixas-financeiro
POST /core/v1/baixas-financeiro
PUT /core/v1/baixas-financeiro/inativar
Altera uma lista de baixa financeiro
PUT /core/v1/baixas-financeiro

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Consulta uma lista de baixa financeiro
GET /core/v1/baixas-financeiro

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.Baixado

Request parameters

IdsBaixaFinanceiro
string optional
IdParcelaFinanceiro
integer int64 optional
DataBaixa
string date-time optional
Ativo
boolean optional
IDs
string optional
CodigosIDs
array of integer optional
Collection format: multi
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Ordenacao
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.