Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Expandir
titleBaixa 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 Auth

Username <username>

Password <password>

Body


Bloco de código
languagec#
titleRaw
[
    {   
		"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,
		"historicoBaixa": "BAIXA REALIZADA VIA API"
	}
]

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.
  • historicoBaixa: Campo de texto livre para que seja informado o valor que será preenchido no campo FXCX.HISTORICO da tela de Extrato de Baixa.

Retorno


Bloco de código
languagec#
titleConsole
{
   	"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;
Expandir
titleCancelar Baixa de Titulos
HTML
<div class="post">POST</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/ContratosTitulos/CancelarBaixaTitulos</div>


Realiza o cancelamento da baixa de títulos do SGE.

Ao executar a chamada do webservice, o método irá:

  • Realizar o cancelamento da baixa do titulo no SGE.
  • Realizar a integração do cancelamento da baixa no Protheus.


Tabela Afetada: FLAN, FLANBAIXA

Interface RM: TOTVS BackOffice | Gestão Financeira | Lançamentos | Processos | Cancelar Baixa

Authorization - Basic Auth

Username <username>

Password <password>

Body


Bloco de código
languagec#
titleRaw
[
    {   
		"codColigada": 3,
        "idLan": 1904,
        "dataCancelamento": "2023-01-18",
		"historico": "Cancelamento via API"
	}
]

Content

  • codColigada: Código da Coligada no SGE.
  • idLan: Identificador do Lançamento no SGE;
  • dataCancelamento: Data em que o cancelamento da baixa será realizado;
  • historico: Campo de texto livre para que seja informado o valor que será preenchido no campo FXCX.HISTORICO da tela de Extrato de Baixa.

Retorno


Bloco de código
languagec#
titleConsole
{
   	"codColigada": 3,
   	"idLan": 12,
	"statusErro": 0,
	"Erros": [{ "mensagemErro": null, "codigoErro": null }],
}

Content

  • codColigada: Codigo da Coligada do lançamento;
  • idLan: IdLan do lançamento baixado;
  • 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;
Expandir
titleAlterar 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>

Body


Bloco de código
languagec#
titleConsole
{
  "CodColigada": 2,
  "CodCurso": "",
  "CodHabilitacao": "",
  "CodGrade": "",
  "ItemContabil": "",
  "DtInicioItemContabil": "2023-04-13T18:36:06.583Z",
  "DtFimItemContabil": "2023-04-13T18:36:06.583Z",
  "ContaContabil": "",
  "DtInicioContaContabil": "2023-04-13T18:36:06.583Z",
  "DtFimContaContabil": "2023-04-13T18:36:06.583Z",
  "IdServico": 0,
  "DescServico": ""
} 

Content

  • CodColigada: Código da Coligada no SGE
  • CodCurso: Identificador da Matriz Aplicada (Curso/Habilitação e Período Letivo)
  • CodHabilitacao: Identificador da Matriz Aplicada (Curso/Habilitação e Período Letivo)
  • CodGrade: Identificador da Matriz Aplicada (Curso/Habilitação e Período Letivo)
  • ItemContabil: Código Item Contábil
  • DtInicioItemContabil: Data Inicio do Item Contábil
  • DtFimItemContabil: Data Final do Item Contábil
  • ContaContabil: Código Conta Contábil
  • DtInicioContaContabil: Data Inicio da Conta Contábil
  • DtFimContaContabil: Data Final da Conta Contábil
  • IdServico: Código do Serviço
  • DescServico: Descrição do Serviço

Retorno


Bloco de código
languagec#
titleConsole
{
"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;
Expandir
titleConsultar Status
HTML
<div class="get">GET</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/MatrizCurriculares/ConsultarStatus</div>


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 Auth

Username <username>

Password <password>

Parameters

  • codColigada: Código da Coligada no SGE
  • codCurso: Identificador da Matriz Aplicada (Curso/Habilitação e Período Letivo)
  • codHabilitacao: Identificador da Matriz Aplicada (Curso/Habilitação e Período Letivo)
  • codGrade: Identificador da Matriz Aplicada (Curso/Habilitação e Período Letivo)

Retorno

Bloco de código
languagec#
titleConsole
"2"

Content

Status: 

0 = Ativa
1 = Inativa
2 = Atual

Expandir
titleAtualizar Pessoa
HTML
<div class="put">PUT</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/Pessoas/AtualizarPessoa</div>


Consulta Contrato de um Aluno


Tabela Afetada

Interface RM

Authorization - Basic Auth

Username <username>

Password <password>

Body


Bloco de código
languagec#
titleRaw
[     
	{
  		"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",
  		"Matricula": "string",
  		"PaisNacionalidade": "string",
  		"EstadoNatal": "string",
  		"MunicipioNatal": "string",
  		"CodigoCliente": "string",
  		"FilialCliente": "string",
  		"TipoCliente": "string"
	} 
]

Retorno


Bloco de código
languagec#
titleConsole
{
"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;
Expandir
titleAtualizar 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>

Body


Bloco de código
languagec#
titleRaw
[     
	{
  		"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",
  		"Matricula": "string",
  		"PaisNacionalidade": "string",
  		"EstadoNatal": "string",
  		"MunicipioNatal": "string",
  		"CodigoCliente": "string",
  		"FilialCliente": "string",
  		"TipoCliente": "string"
	} 
]

Retorno


Bloco de código
languagec#
titleConsole
{
"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;


...