...
Orientações gerais, autenticação e exemplos de consumo das API's.
Expandir |
---|
title | Consultar Contratos Aluno |
---|
|
HTML |
---|
<div class="get">GET</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/ContratosTitulos/ConsultarContratosAluno</div> |
Consulta Contrato de um Aluno
Tabela Afetada: Interface RM: Authorization - Basic AuthUsername <username> Password <password> Parameters- codColigada: Código da Coligada no SGE
- cpf:
- idCorporativo:
Retorno
Content |
Expandir |
---|
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 AuthUsername <username> Password <password> Parameters- codColigada: Código da Coligada no SGE
- cpf:
- idCorporativo:
Retorno
Content |
Expandir |
---|
title | Consultar Contratos Aluno |
---|
|
HTML |
---|
<div class="get">GET</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/MatrizCurriculares/ConsultarStatus</div> |
Consulta Contrato de um Aluno
Tabela Afetada: Interface RM: Authorization - Basic AuthUsername <username> Password <password> Parameters- codColigada: Código da Coligada no SGE
- cpf:
- idCorporativo:
Retorno
Content |
Expandir |
---|
title | Baixa Titulos Contratos |
---|
|
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 AuthUsername <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;
|
...