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.


<div class="post">POST</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/ContratosTitulos/BaixaTitulosContratos</div>


Inclui ou altera um Serviço originado do CRM no cadastro customizado de Serviços do SGE, vinculando o serviço aos cursos informados.

Ao executar a chamada do webservice, se for inclusão de um serviço novo, o método irá:

  • Incluir o Serviço CRM no SGE (cadastro customizado).
  • Preencher todos os dados do serviço: 
    • Código do Serviço/Produto
    • Descrição do Serviço/Produto
    • Código do produto do Protheus (obrigatório), 
    • Código da Natureza Financeira do Protheus
    • Item Contábil
    • Conta Contábil
    • Status
  • Vincular o Serviço CRM no anexo customizado dos Cursos informados

Ao executar a chamada do webservice, se for atualização de um serviço existente será permitido alterar o status e o processo deverá identificar o serviço CRM no SGE através do código e atualizar seu status no cadastro customizado.


Tabela Afetada: ZINTSFSERVICOCRM

Interface RM: TOTVS Educacional | Educacional | Currículo e Oferta | Cursos | Anexos | Serviço CRM

Authorization - Basic Auth

Username <username>

Password <password>

Body


[
    {   
		"codColigada": 3,
        "codFilial": 471,
        "codTipoCurso": 1,
        "idLan": 1904,
        "nossoNumero": "012121",
        "motivoBaixa": 
        [
            { 
            "motivoBaixa":"DIS", 
            "valorBaixa": 200.0
            }
        ],
        "dataBaixa": "2023-01-18",
        "dataVencimento": "2022-12-20",
        "valorTotal": 200.0,
        "valorMulta": 0.0,
        "coligadaContaCaixa": 3,
        "contaCaixa": "58",
        "valorJuros": 0.0   
	}
]

Content

  • codColigada: Código da Coligada no SGE. Enviar 2 para SESI e 3 para SENAI (primary key).
  • codFilial: Código do Serviço CRM (primary key);
  • codTipoCurso: Nome do Serviço CRM;
  • idLan: Código do Produto no Protheus, associado ao serviço/curso. Utilizado no envio do Pedido de Venda do SGE para o Protheus (obrigatório);
  • nossoNumero: Código da Natureza Financeira, associado ao serviço/curso. Utilizado no envio do Pedido de Venda do SGE para o Protheus;
  • motivoBaixo: (Id do protheus);
  • dataBaixa: (Conta Contabil)
  • dataVencimento: true ou false, indica se o serviço está ativo ou não;
  • valorTotal: Lista de códigos de curso no SGE que serão vinculados, através do anexo customizado do Curso SGE,  ao serviço que está sendo criado.
  • valorMulta: Lista de códigos de curso no SGE que serão vinculados, através do anexo customizado do Curso SGE,  ao serviço que está sendo criado.
  • coligadaContaCaixa: Lista de códigos de curso no SGE que serão vinculados, através do anexo customizado do Curso SGE,  ao serviço que está sendo criado.
  • contaCaixa: Lista de códigos de curso no SGE que serão vinculados, através do anexo customizado do Curso SGE,  ao serviço que está sendo criado.
  • valorJuros: Lista de códigos de curso no SGE que serão vinculados, através do anexo customizado do Curso SGE,  ao serviço que está sendo criado.


Retorno


{
   	"codColigada": "Serviço incluído com sucesso!\r\n",
   	"idLan": "Sucesso",
   	"nossoNumero": 200,
	"statusErro": 1,
	"Erros": 1,
	"numbRPS": 10,
	"serieRPS": 1,
	"filialRPS": 10
}

Content

  • Message: Mensagem de retorno do consumo da requisição;
  • Status: Situação do processamento da requisição;
  • StatusCode: Código de status do processamento da requisição;
<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>
-->