Este documento tem por objetivo a documentar as API's disponíveis nos projetos da FIRJAN.
Orientações gerais, autenticação e exemplos de consumo das API's.
A pesquisa retornará as informações dos contratos e títulos em aberto através do CPF ou Id. Corporativo de um aluno. Tabela Afetada: Nenhuma Interface RM: Authorization - Basic AuthUsername <username> Password <password> Parameters
Retorno
Content
|
A pesquisa retornará as informações dos contratos e títulos em aberto através do CPF ou Id. Corporativo de um responsável financeiro Tabela Afetada: Nenhuma Interface RM: Authorization - Basic AuthUsername <username> Password <password> Parameters
Retorno
Content
|
A pesquisa retornará as informações do contrato e de todos os títulos em aberto do contrato retornado. Caso não exista títulos em aberto as informações do contrato deverão ser retornadas. Tabela Afetada: Nenhuma Interface RM: Authorization - Basic AuthUsername <username> Password <password> Parameters
Retorno
Content
|
Consulta os contratos através do seu número Tabela Afetada: Nenhuma Interface RM: Authorization - Basic AuthUsername <username> Password <password> Parameters
Retorno
Content
|
Realiza a baixa de titulos do SGE e realiza a integração com o Tecnotime. Ao executar a chamada do webservice, se for inclusão de um serviço novo, o método irá:
Novo! A baixa de títulos agora é realizada apenas no SGE, sem envio para a TECNOTIME. A API foi ajustada para não incluir mais os campos numbRPS e serieRPS, antes recebidos da TECNOTIME. Além disso, a API de baixa de títulos foi atualizada para incluir campos de juros, multa e desconto: Juros : Somado ao valor principal do título. Exemplos de Regras para aplicação dos campos: Cenário 01: Se o valor total do título por R$ 100,00, com R$ 50,00 de juros e R$ 2,00 de multa, totalizando R$ 152,00, e o valor pago foi R$ 150,00: Pagamento com Diferença A Maior: Importante: Para ambos os casos, o título deverá ser baixado. Vale lembrar que a API reflete o processo nativo de baixa que ocorre no RM e também na importação de arquivos de retorno bancário do produto. Tabela Afetada: FLAN, FLANBAIXA Interface RM: TOTVS BackOffice | Gestaçao Financeira | Lançamentos | Processos | Baixa Authorization - Basic AuthUsername <username> Password <password> Body
Content
Retorno
Content
|
Realiza o cancelamento da baixa de títulos do SGE. Ao executar a chamada do webservice, o método irá:
Tabela Afetada: FLAN, FLANBAIXA Interface RM: TOTVS BackOffice | Gestão Financeira | Lançamentos | Processos | Cancelar Baixa Authorization - Basic AuthUsername <username> Password <password> Body
Content
Retorno
Content
|
Consulta Contrato de um Aluno Tabela Afetada: Interface RM: Authorization - Basic AuthUsername <username> Password <password> Body
Content
Retorno
Content
|
O Gestor de Serviços poderá acionar um Web Service TOTVS capaz de retornar ao Gestor o Status da Matriz Curricular solicitada. Tabela Afetada: Nenhuma Interface RM: Authorization - Basic AuthUsername <username> Password <password> Parameters
Retorno
Content Status: 0 = Ativa |
Consulta Contrato de um Aluno Tabela Afetada: Interface RM: Authorization - Basic AuthUsername <username> Password <password> Body
Retorno
Content
|
Consulta Contrato de um Aluno Tabela Afetada: Interface RM: Authorization - Basic AuthUsername <username> Password <password> Body
Retorno
Content
|
<style>
.expand-control {
cursor: pointer;
text-decoration: none;
margin-bottom: 10px;
background-color: #ededed;
height: 30px;
font-size: 20px;
padding: 5px;
}
.expand-control-text {
vertical-align: top;
font-weight: bold;
color: #242424;
}
.post {
background-color: #378000;
color: #ffffff;
display: inline-block;
padding: 5px;
border-radius: 5px;
font-weight: bold;
}
.get {
background-color: #004fd6;
color: #ffffff;
display: inline-block;
padding: 5px;
border-radius: 5px;
font-weight: bold;
}
.put {
background-color: #ffa200;
color: #ffffff;
display: inline-block;
padding: 5px;
border-radius: 5px;
font-weight: bold;
}
.delete {
background-color: #cf0000;
color: #ffffff;
display: inline-block;
padding: 5px;
border-radius: 5px;
font-weight: bold;
}
.endereco{
display: inline-block;
padding: 5px;
font-weight: bold;
}
</style>
<!--
EXEMPLO DE MARCAÇÃO PARA TIPO DE REQUEST:
<div class="post">POST</div>
<div class="get">GET</div>
<div class="put">PUT</div>
<div class="delete">DELETE</div>
O ENDEREÇO DEVE SER INSERIDO COM A SEGUINTE MARCAÇÃO:
<div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/ItemContabil</div>
--> |