Histórico da Página
...
| Expandir | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
Consulta os contratos 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 | |||||||||
| Expandir | |||||||||
| |||||||||
Consulta os contratos através do CPF ou Id. Corporativo de um responsável financeiro Tabela Afetada: Nenhuma Interface RM: Authorization - Basic AuthUsername <username> Password <password> Parameters
|
| Expandir | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
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
Retorno
Content | ||||||||||||||||
| Expandir | ||||||||||||||||
| ||||||||||||||||
Consulta os contratos através do seu número Tabela Afetada: Nenhuma Interface RM: Authorization - Basic AuthUsername <username> Password <password> Parameters
Retorno
Content
|
| Expandir | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
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 | |||||||||
| Expandir | |||||||||
| |||||||||
Consulta os contratos através do seu número Tabela Afetada: Nenhuma Interface RM: Authorization - Basic AuthUsername <username> Password <password> Parameters
Retorno
Content | |||||||||
| Expandir | |||||||||
Content
|
| Expandir | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
Consulta os contratos através do seu número Tabela Afetada: Nenhuma Interface RM: Authorization - Basic AuthUsername <username> Password <password> Parameters
Retorno
Content
|
| Expandir | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
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
|
| Expandir | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
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
|
| Expandir | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
Consulta Contrato de um Aluno Tabela Afetada: Interface RM: Authorization - Basic AuthUsername <username> Password <password> Body
Content
Retorno
Content
|
| Expandir | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
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 |
| Expandir | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Consulta Contrato de um Aluno Tabela Afetada: Interface RM: Authorization - Basic AuthUsername <username> Password <password> Body
| ||||||||||
|
| HTML |
|---|
<div class="post">POST</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/ContratosTitulos/BaixaTitulosContratos</div> |
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á:
- Realizar a baixa do titulo no SGE:
- Buscar os dados da Conta Caixa no SGE, seja a passada na requisição ou caso não seja passada no parametro de Conta Caixa PDV (Anexo do Cadastro de Filial);
- Valida os dados da Conta Caixa;
- Valida se foi informado os dados de Motivo da Baixa;
- Valida se o lançamento existe no SGE;
- Preenche os dados da forma de pagamento da Baixa;
- Realizar a integração da baixa do titulo com o Tecnotime.
- Com base nos dados do lançamento realiza a integração com o Tecnotime pela base de dados informada na tela Parametros Tecnotime (Educacional | Customização) no SGE;
Tabela Afetada: FLAN, FLANBAIXA
Interface RM: TOTVS BackOffice | Gestaçao Financeira | Lançamentos | Processos | Baixa
Authorization - Basic Auth
Username <username>
Password <password>
Body
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
[
{
"codColigada": 3,
"codFilial": 471,
"codTipoCurso": 1,
"idLan": 1904,
"nossoNumero": "012121",
"motivoBaixa":
[
{
"motivoBaixa":"DIS",
"valorBaixa": 100.0,
"coligadaContaCaixa": 3,
"contaCaixa": "58"
},
{
"motivoBaixa":"PIX",
"valorBaixa": 100.0,
"coligadaContaCaixa": 3,
"contaCaixa": "60"
}
],
"dataBaixa": "2023-01-18",
"dataVencimento": "2022-12-20",
"valorTotal": 200.0,
"valorMulta": 0.0,
"valorJuros": 0.0
}
] |
Content
- codColigada: Código da Coligada no SGE.
- codFilial: Código da Filial do Lançamento no SGE;
- codTipoCurso: Nivel de Ensino no SGE;
- idLan: Identificador do Lançamento no SGE;
- nossoNumero: Nosso Numero do Lançamento;
- motivoBaixa: Lista com os dados de MotivoBaixa: Codigo da tabela dinamica (BXPROTHEUS) que indica a forma de pagamento do protheus, ValorBaixa, coligadaContaCaixa e contaCaixa, para informar a conta caixa separadamente em cada forma de pagamento do lançamento, caso a mesma não seja informada será utilizado a conta caixa do parametro;
- dataBaixa: Data da Baixa do Lançamento;
- dataVencimento: Data de Vencimento do Lançamento;
- valorTotal: Valor Total do Lançamento.
- valorMulta: Valor da Multa do Lançamento.
- 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
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
"codColigada": 3,
"idLan": 12,
"nossoNumero": "200121",
"statusErro": 0,
"Erros": [{ "mensagemErro": null, "codigoErro": null }],
"numbRPS": 10,
"serieRPS": "1",
"filialRPS": 10
}
|
Content
- codColigada: Codigo da Coligada do lançamento;
- idLan: IdLan do lançamento baixado;
- nossoNumero: Nosso Numero do lançamento;
- statusErro: 0 - Sucesso, 1 - Erro;
- Erros: Lista de erros ocorridos na baixa do lançamento, composto por mensagemErro: Descrição do erro ocorrido e codigoErro: 1 - Motivo Baixa não informado, 2 - Conta Caixa SGE ou PDV não informada, 3 - Total liguido do lançamento diferente do valor total pago, 4 - Numero de RPS não gerado, 5 - Baixa não realizada, 6 - Forma de pagamento inválida, 7 - Lançamento não encontrado no SGE, 8 - Motivo Baixa não cadastrado, 9 - Erro na integração Tecnotime;
- numbRPS: Numero do RPS da integração Tecnotime;
- serieRPS: Serie do RPS da integração Tecnotime;
- filialRPS: Filial do RPS da integração Tecnotime;
| title | Alterar Informações Contábeis |
|---|
| HTML |
|---|
<div class="put">PUT</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/MatrizCurriculares/AlterarInformacoesContabies</div> |
Consulta Contrato de um Aluno
Tabela Afetada:
Interface RM:
Authorization - Basic Auth
Username <username>
Password <password>
Parameters
Retorno
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
"Message":
}
|
Content
| title | Consultar Status |
|---|
| HTML |
|---|
<div class="get">GET</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/MatrizCurriculares/ConsultarStatus</div> |
Consulta Contrato de um Aluno
Tabela Afetada: Nenhuma
Interface RM:
Authorization - Basic Auth
Username <username>
Password <password>
Parameters
- codColigada: Código da Coligada no SGE
- cpf:
- idCorporativo:
"Sucesso \r\n",
"Status": "Sucesso",
"StatusCode": 200
} |
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;
| Expandir | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
}
|
Content
| title | Atualizar Pessoa |
|---|
| HTML |
|---|
<div class="put">PUT</div> <div class="endereco">/rm/api/TOTVSCustomizacao/Pessoas/AtualizarPessoa<AtualizarResponsavelFinanceiro</div> |
Consulta Contrato de um Aluno
Tabela Afetada:
Interface RM:
Authorization - Basic Auth
Username <username>
Password <password>
Parameters
- codColigada: Código da Coligada no SGE
- cpf:
- idCorporativo:
Body
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
[
{
"ID": 0,
"CodPessoa": 0,
"Nome": "string",
"DataNascimento": "2023-04-11T17:46:24.482Z",
"EstadoCivil": "string",
"Sexo": "string",
"Cor": 0,
"NomeMae": "string",
"NomePai": "string",
"CPF": "string",
"Identidade": "string",
"OrgaoEmissor": "string",
"DataEmissao": "2023-04-11T17:46:24.482Z",
"TituloEleitor": "string",
"Passaporte": "string",
"Nacionalidade": "string",
"CidadeEnder": "string",
"BairroEnder": "string",
"UFEnder": "string",
"Estrangeiro": "string",
"Email": "string",
"DDD": "string",
"Telefone": "string",
"DDDCelular": "string",
"Celular": "string",
"Logradouro": "string",
"Complemento": "string",
"Numero": "string",
"CEP": "string",
"Municipio_IBGE": "string",
"TipoBeneficiario": "string",
"CodFilial": 0,
"CodUsuario": "string",
"IdCorporativo": 0,
"GrauInstrucao": "string"0,
"MatriculaCodUsuario": "string",
"PaisNacionalidadeIdCorporativo": "string"0,
"EstadoNatalGrauInstrucao": "string",
"MunicipioNatalMatricula": "string",
"CodigoClientePaisNacionalidade": "string",
"FilialClienteEstadoNatal": "string",
"TipoClienteMunicipioNatal": "string",
}
] |
Retorno
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{ } |
Content
| title | Atualizar Responsável Financeiro |
|---|
| HTML |
|---|
<div class="put">PUT</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/Pessoas/AtualizarResponsavelFinanceiro</div> |
Consulta Contrato de um Aluno
Tabela Afetada:
Interface RM:
Authorization - Basic Auth
Username <username>
Password <password>
Parameters
"CodigoCliente": "string",
"FilialCliente": "string",
"TipoCliente": "string"
}
] |
Retorno
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
"Message": "Sucesso
}
|
\r\n",
"Status": "Sucesso",
"StatusCode": 200
} |
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;
| HTML |
|---|
<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>
--> |
Import HTML Content
Visão Geral
Conteúdo das Ferramentas