Este documento tem por objetivo a documentar as API's disponíveis no projeto Integração Protheus FIEC.
Orientações gerais, autenticação e exemplos de consumo das API's
...
title | Informação Importante |
---|
...
Expandir | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Expandir | ||
---|---|---|
| ||
Este projeto foi migrado para página principal dos projetos DN. Para acessar diretamente a página do projeto clique aqui. |
Expandir | ||
---|---|---|
| ||
Este projeto foi migrado para página principal dos projetos DN. Para acessar diretamente a página do projeto clique aqui. |
Expandir | ||
---|---|---|
| ||
Este projeto foi migrado para página principal dos projetos DN. Para acessar diretamente a página do projeto clique aqui. |
Expandir | ||
---|---|---|
| ||
Este projeto foi migrado para página principal dos projetos DN. Para acessar diretamente a página do projeto clique aqui. |
Expandir | ||
---|---|---|
| ||
Este projeto foi migrado para página principal dos projetos DN. Para acessar diretamente a página do projeto clique aqui. |
Expandir | ||
---|---|---|
| ||
Este projeto foi migrado para página principal dos projetos DN. Para acessar diretamente a página do projeto clique aqui. |
Expandir | ||
---|---|---|
| ||
Este projeto foi migrado para página principal dos projetos DN. Para acessar diretamente a página do projeto clique aqui. |
Expandir | ||
---|---|---|
| ||
Este projeto foi migrado para página principal dos projetos DN. Para acessar diretamente a página do projeto clique aqui. |
title | SENAI |
---|
title | Integração Google |
---|
Link para download:
Estado subtle true colour Red title LIB DN 12.1.32.003 Estado subtle true colour Red title Validação Google & LMS
Ações:
Conversão para versão 12.1.32
label | Versões |
---|
icon | false |
---|
Arquivos Contidos no Pacote de Instalação:
id | Arquivos |
---|
label | Instaladores |
---|
A execução dos arquivos abaixo devem ser após a execução dos scripts.
label | Scripts |
---|
Os scripts devem ser executados antes dos instaladores e a ordem de execução deve ser respeitada. É necessário executar os scripts em alguma das situações descritas na coluna "Quando Executar?".
1 - Script_Template_Funcionalidade_Log__IntGoogle_Oracle.sql
1 - Script_Template_Funcionalidade_Log_IntGoogle.sql
Estado subtle true colour Blue title Primeira Instalação Estado subtle true colour Blue title Conversão 12.1.32
2 - FS007919-Extração_de_dados_para_o_Google_ORACLE.sql
2 - FS007919-Extração_de_dados_para_o_Google_MSSQL.sql
Estado subtle true colour Blue title Primeira Instalação Estado subtle true colour Blue title Conversão 12.1.32
Estado subtle true colour Blue title Primeira Instalação Estado subtle true colour Blue title Conversão 12.1.32
Estado subtle true colour Blue title Primeira Instalação Estado subtle true colour Blue title Conversão 12.1.32
Estado subtle true colour Blue title Primeira Instalação Estado subtle true colour Blue title Conversão 12.1.32
Estado subtle true colour Blue title Primeira Instalação Estado subtle true colour Blue title Conversão 12.1.32
Estado subtle true colour Blue title Primeira Instalação Estado subtle true colour Blue title Conversão 12.1.32
title | Fase Empresa |
---|
Link para download:
Estado subtle true colour Red title LIB DN 12.1.32.003
Ações:
Conversão para versão 12.1.32;
label | Versões |
---|
icon | false |
---|
Arquivos Contidos no Pacote de Instalação:
id | Arquivos |
---|
label | Instaladores |
---|
A execução dos arquivos abaixo devem ser após a execução dos scripts.
label | Scripts |
---|
Os scripts devem ser executados antes dos instaladores e a ordem de execução deve ser respeitada. É necessário executar os scripts em alguma das situações descritas na coluna "Quando Executar?".
1 - TOTVS_Custom_Register_Action_Oracle.sql
1 - TOTVS_Custom_Register_Actions_All.sql
Estado subtle true colour Blue title Primeira Instalação Estado subtle true colour Blue title Conversão 12.1.32
Estado subtle true colour Blue title Primeira Instalação Estado subtle true colour Blue title Conversão 12.1.32
Estado subtle true colour Blue title Primeira Instalação Estado subtle true colour Blue title Conversão 12.1.32
Estado subtle true colour Blue title Primeira Instalação Estado subtle true colour Blue title Conversão 12.1.32
Estado subtle true colour Blue title Primeira Instalação Estado subtle true colour Blue title Conversão 12.1.32
Expandir | ||
---|---|---|
| ||
Este projeto foi migrado para página principal dos projetos DN. Para acessar diretamente a página do projeto clique aqui. |
Expandir | ||
---|---|---|
| ||
Este projeto foi migrado para página principal dos projetos DN. Para acessar diretamente a página do projeto clique aqui. |
Expandir | ||
---|---|---|
| ||
Este projeto foi migrado para página principal dos projetos DN. Para acessar diretamente a página do projeto clique aqui. |
Expandir | ||
---|---|---|
| ||
Este projeto foi migrado para página principal dos projetos DN. Para acessar diretamente a página do projeto clique aqui. |
title | Fórmulas Visuais - SENAI |
---|
Link para download:
Serviço CRM |
HTML |
---|
<div class="get">GET</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/IntegracaoSALESFORCE/AtualizarServicoCRM</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á:
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
Username <username>
Password <password>
Bloco de código | ||||
---|---|---|---|---|
| ||||
[
{
"CodColigada: 3,
"Codigo: "10",
"Descricao: "Mensalidade - Curso Técnico Mecânica",
"ProdutoProtheus": "121551",
"Natureza": "1100103",
"ItemContabil": "123",
"ContaContabil": "090090009",
"Ativo": true,
"CodCursos": [ "APT.00011", "TEC.00011" ]
}
] |
Content
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"Message": "Serviço incluído com sucesso!\r\n",
"Status": "Sucesso",
"StatusCode": 200
}
|
Content
Expandir | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
Realiza a gravação do Responsável Financeiro (Cliente/Fornecedor) no SGE, conforme dados enviados pela API. Importante: Caso o CPF/CNPJ enviado já exista no SGE, o registro é localizado e o cadastro é atualizado com os dados enviados. Tabela Afetada: FCFO Interface RM: TOTVS BackOffice | Gestão Financeira | Cadastros | Cliente/Fornecedor Authorization - Basic AuthUsername <username> Password <password> Body
Content
Deve ser enviado no seguinte formato: 9 primeiros dígitos do CPF ou 8 primeiros primeiros dígitos do CNPJ + código da loja. Exemplo: 0101251250001
Retorno
Content
|
Expandir | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
Realiza a gravação do aluno no SGE, conforme dados enviados pela API. Importante: Caso o CPF enviado já exista no SGE, a API identifica a pessoa e o RA, e atualiza o cadastro com os dados enviados. Tabelas Afetadas: SALUNO, PPESSOA, SALUNOCOMPL Interface RM: TOTVS Educacional | Educacional | Currículo e Oferta | Alunos Authorization - Basic AuthUsername <username> Password <password> Body
Content
Valores possíveis:
Valores possíveis:
Retorno
Content
|
Expandir | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
Realiza a Matrícula do aluno no SGE, geração do Contrato Educacional e suas parcelas e preenche o anexo de dados complementares do contrato, conforme dados enviados pela API. Tabelas Afetadas: SMATRICPL, SMATRICULA, SHABILITACAOALUNO, SCONTRATO, SPARCELA, ZINTSFDADOSCONTRATO e ZINTSFDADOSCONTRATOPARCELA Interfaces RM: TOTVS Educacional | Educacional | Currículo e Oferta | Alunos | Anexo | Matricula no Período Letivo | Anexo | Matriculas em disciplinas TOTVS Educacional | Educacional | Matricula e Avaliação | Matricula no Período Letivo | Aluno | Anexo | Matriculas em disciplinas TOTVS Educacional | Educacional | Financeiro Contábil | Contratos | Alunos | Dados complementares do Contrato TOTVS Educacional | Educacional | Financeiro Contábil | Contratos | Anexo | Dados complementares do Contrato Authorization - Basic AuthUsername <username> Password <password> Body
Content
Valores possíveis:; BOLETO: BOL (Mensalidade Boleto)
Valores possíveis: Sim ou Não
Informação sobre o envio de pagamento via e-commerce: Quando for enviado pagamento via e-commerce o campo QuantidadeParc do contrato deve ser igual a 1 (um), pois será considerada apenas uma parcela no SGE. A quantidade de vezes que o pagamento foi parcelado no cartão deve ser enviado no campo ParcelasCartao dos dados do pagamento com cartão.
Retorno
Content
|
Expandir | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
Insere e/ou atualiza itens contábeis no RM, para uso no projeto Integração Protheus FIEC. Tabela Afetada: ZINTPROTHEUSITEMCONTABILPROTHEUS Interface RM: TOTVS Educacional | Educacional | Customização | Integração Protheus | Cadastros | Item contábil Authorization - Basic AuthUsername <username> Password <password> Body
Content
Retorno
Content
|
Expandir | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
Realiza a inclusão dos lançamentos no Contrato Educacional do SGE para uso no projeto Integração Protheus FIEC. A API efetua a execução do processo de "Geração de Lançamentos". Tabela Afetada: FLAN, SLAN, FBOLETO Interfaces RM: TOTVS Educacional | Educacional | Financeiro/Contábil | Contratos | Parcelas | Lançamentos Financeiros TOTVS Educacional | Educacional | Financeiro/Contábil | Contratos | Parcelas | Lançamentos Financeiros | Boletos Authorization - Basic AuthUsername <username> Password <password> Body
Content
Retorno
Content
|
Expandir | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
Cancela os lançamentos no RM, para uso no projeto Integração Protheus FIEC. O status do lançamento (FLAN.STATUS) é alterado para 2-Cancelado. Tabela Afetada: FLAN Interface RM: TOTVS Educacional | Educacional | Financeiro/Contábil | Contratos | Parcelas | Lançamentos Financeiros Authorization - Basic AuthUsername <username> Password <password> Body
Content
Importante: Quando o idLan estiver vazio, serão considerados os seguintes campos como chave: Filial, Prefixo, Num, Parcela e Tipo. Retorno
Content
|
Expandir | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
Cancela as baixas dos lançamento no RM, para uso no projeto Integração Protheus FIEC. O status do lançamento (FLAN.STATUS) é alterado de 1-Baixado para 0-Em aberto. Tabela Afetada: FLAN, FLANBAIXA Interface RM: TOTVS Educacional | Educacional | Financeiro/Contábil | Contratos | Parcelas | Lançamentos Financeiros (editar o lançamento e acessar o anexo "Baixas do Lançamento") Authorization - Basic AuthUsername <username> Password <password> Body
Content
Importante: Quando o idLan estiver vazio, serão considerados os seguintes campos como chave: Filial, Prefixo, Num, Parcela e Tipo. Retorno
Content
|
Expandir | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
Efetua a baixa do lançamento financeiro do SGE. O status do lançamento (FLAN.STATUS) é alterado para 1-Baixado. Tabelas Afetadas: FLAN, FLANBAIXA Interface RM: TOTVS Educacional | Educacional | Financeiro/Contábil | Contratos | Parcelas | Lançamentos Financeiros (editar o lançamento e acessar o anexo "Baixas do Lançamento") Authorization - Basic AuthUsername <username> Password <password> Body
Content
Importante: Quando o idLan estiver vazio, serão considerados os seguintes campos como chave: Filial, Prefixo, Num, Parcela e Tipo.
Retorno
Content
|
Expandir | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
Insere e/ou atualiza o NossoNumero do Lançamento Financeiro e Boleto do SGE. Tabela Afetada: FLAN, FBOLETO Interfaces RM: TOTVS Educacional | Educacional | Financeiro/Contábil | Contratos | Parcelas | Lançamentos Financeiros TOTVS Educacional | Educacional | Financeiro/Contábil | Contratos | Parcelas | Lançamentos Financeiros | Boleto Authorization - Basic AuthUsername <username> Password <password> Body
Content
Importante: Quando o idLan estiver vazio, serão considerados os seguintes campos como chave: Filial, Prefixo, Num, Parcela e Tipo. Retorno
Content
|
Expandir | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
Efetiva no SGE os acordos efetuados no Protheus. A API efetua a criação do acordo, a baixa dos lançamentos originais e a criação dos novos lançamentos gerados pelo acordo, conforme negociação gerada no Protheus. Tabela Afetada: FLAN, FLANBAIXA, FACORDO, FACORDOREL Interface RM: TOTVS Educacional | Educacional | Financeiro/Contábil | Contratos | Parcelas | Lançamentos Financeiros (editar o lançamento e acessar o anexo "Acordo") Authorization - Basic AuthUsername <username> Password <password> Body
Content
Importante: Quando o idLan estiver vazio, serão considerados os seguintes campos como chave: Filial, Prefixo, Num, Parcela e Tipo. Retorno
Content
Importante: Quando o idLan estiver vazio, serão considerados os seguintes campos como chave: Filial, Prefixo, Num, Parcela e Tipo. |
Expandir | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
Cancela o acordo financeiro gerado pelo Protheus importado para o SGE. Necessário enviar o identificador do acordo do SGE. O cancelamento do acordo implica na reabertura dos títulos originais do acordo. Permitido apenas para acordos sem nenhuma parcela paga. Se necessário, deverá chamar antes a API de cancelamento de baixa para os títulos do acordo. Tabela Afetada: FLAN, FLANBAIXA, FACORDO, FACORDOREL Interface RM: TOTVS Educacional | Educacional | Financeiro/Contábil | Contratos | Parcelas | Lançamentos Financeiros (editar o lançamento e acessar o anexo "Acordo") Authorization - Basic AuthUsername <username> Password <password> Body
Content
Retorno
Content
|
Expandir | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
Inclui ou altera um Contrato Pessoa Jurídica no SGE, para permitir que matrículas geradas no SGE sejam vinculadas aos contratos. Tabela Afetada: ZPJFIECCONTRATO Interface RM: TOTVS Educacional | Educacional | Customizações | Contrato PJ | Contratos Authorization - Basic AuthUsername <username> Password <password> Body
Content
Retorno
Content
|
Expandir | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
Consulta um Contrato Pessoa Jurídica no SGE Tabela Afetada: Nenhuma Interface RM: TOTVS Educacional | Educacional | Customizações | Contrato PJ | Contratos Authorization - Basic AuthUsername <username> Password <password> Parameters
Retorno
Content
|
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>
--> |
Nota | ||
---|---|---|
| ||
Ao converter a base já tendo as fórmulas importadas, não é necessário nenhuma ação. Somente é necessário importar as fórmulas visuais para primeira utilização. |
Após baixar, efetue o processo de importação descrito na documentação do projeto "CNI Formulas Visuais - Manual Customização - SENAI v5.pdf".
Para outras dúvidas, clique aqui.
Importante!
As consultas SQL utilizadas pelas fórmulas visuais não podem ser utilizadas por outros processos no RM, como relatórios por exemplo. Elas são identificadas pelo código, que sempre iniciam com a sigla FSW. Exemplo: FSW.001.
Expandir | ||
---|---|---|
| ||
Este projeto foi migrado para página principal dos projetos DN. Para acessar diretamente a página do projeto clique aqui. |
title | SESI |
---|
title | Melhorias Template SESI |
---|
Link para download:
Estado subtle true colour Red title LIB DN 12.1.32.003
Ações:
Conversão para versão 12.1.32
label | Versões |
---|
icon | false |
---|
Arquivos Contidos no Pacote de Instalação:
id | Arquivos |
---|
label | Instaladores |
---|
A execução dos arquivos abaixo devem ser após a execução dos scripts.
label | Scripts |
---|
Os scripts devem ser executados antes dos instaladores e a ordem de execução deve ser respeitada. É necessário executar os scripts em alguma das situações descritas na coluna "Quando Executar?".
Estado subtle true colour Blue title Primeira Instalação Estado subtle true colour Blue title Conversão 12.1.32
Estado subtle true colour Blue title Primeira Instalação Estado subtle true colour Blue title Conversão 12.1.32
title | Integração Office 365 |
---|
Link para download:
Estado subtle true colour Red title LIB DN 12.1.32.003
Ações:
Conversão para versão 12.1.32
label | Versões |
---|
icon | false |
---|
Arquivos Contidos no Pacote de Instalação:
id | Arquivos |
---|
label | Instaladores |
---|
A execução dos arquivos abaixo devem ser após a execução dos scripts.
label | Scripts |
---|
Os scripts devem ser executados antes dos instaladores e a ordem de execução deve ser respeitada. É necessário executar os scripts em alguma das situações descritas na coluna "Quando Executar?".
1- TOTVS_Custom_Consolidated_All_Oracle.sql
1- TOTVS_Custom_Consolidated_All_SQL.sql
Estado subtle true colour Blue title Primeira Instalação Estado subtle true colour Blue title Conversão 12.1.32
Estado subtle true colour Blue title Primeira Instalação Estado subtle true colour Blue title Conversão 12.1.32
title | Portal SESI Educação |
---|
Link para download:
Estado subtle true colour Red title LIB DN 12.1.32.003
Ações:
Conversão para versão 12.1.32
label | Versões |
---|
icon | false |
---|
Arquivos Contidos no Pacote de Instalação:
id | Arquivos |
---|
label | Instaladores |
---|
A execução dos arquivos abaixo devem ser após a execução dos scripts.
label | Scripts |
---|
Os scripts devem ser executados antes dos instaladores e a ordem de execução deve ser respeitada. É necessário executar os scripts em alguma das situações descritas na coluna "Quando Executar?".
1 - TOTVS_Custom_Register_Action_DN_Ora.sql
1 - TOTVS_Custom_Register_Action_All.sql
Estado subtle true colour Blue title Primeira Instalação Estado subtle true colour Blue title Conversão 12.1.32
Estado subtle true colour Blue title Primeira Instalação Estado subtle true colour Blue title Conversão 12.1.32
Estado subtle true colour Blue title Primeira Instalação Estado subtle true colour Blue title Conversão 12.1.32
title | Fórmulas Visuais - SESI |
---|
Link para download:
Nota | ||
---|---|---|
| ||
Ao converter a base já tendo as fórmulas importadas, não é necessário nenhuma ação. Somente é necessário importar as fórmulas visuais para primeira utilização. |
Ações:
Para acessar a documentação deste projeto, clique aqui.
Dica |
---|
|
title | Importante! |
---|
As consultas SQL utilizadas pelas fórmulas visuais não podem ser utilizadas por outros processos no RM, como relatórios por exemplo. Elas são identificadas pelo código, que sempre iniciam com a sigla FSW. Exemplo: FSW.001.
Mudança de Nomes
Foi realizada uma alteração na Fórmula Visual “SESI - Colocar campos complementares da Matricula no Período Letivo como obrigatórios”. Ela foi reformulada e renomeada para "SESI - Campos complementares obrigatórios da Matrícula no Período Letivo".
Caso exista, a fórmula visual "SESI - Colocar campos complementares da Matrícula no Período Letivo como obrigatórios" deve ser removida