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.
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>
[ { "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
{ "Message": "Serviço incluído com sucesso!\r\n", "Status": "Sucesso", "StatusCode": 200 }
Content
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
Username <username>
Password <password>
{ "CodCFO": "172104210001", "Nome": "Template Json API ", "CPFCNPJ": "17210421000140", "Email": "[email protected]", "Cep": "31810365", "Logradouro": "Logradouro", "Numero": 20, "Complemento": "101", "Bairro": "Bairro", "Estado": "MG", "Cidade": "Belo Horizonte", "Pais": "Brasil", "Telefone": "03189898989", "Celular": "77777777777", "Tel_Comercial": "0314545454545", "Fax": "0314545454545", "CodColigada": 3, "Global": true }
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
Nome: Nome do responsável financeiro no SGE (Campo Obrigatório);
Logradouro: Nome da rua (Campo Obrigatório);
Numero: Numero da residencia (Enviar apenas números)(Campo Obrigatório);
Cidade: Enviar Nome da Cidade (Campo Obrigatório);
Pais: Enviar Nome do país (Campo Obrigatório);
Telefone: Número telefone fixo (Enviar apenas números com DDD)(Campo Obrigatório);
Celular: Número telefone celular (Enviar apenas números com DDD) (Campo Obrigatório);
Fax: Número fax (Enviar apenas números com DDD);
{ "Message": "Responsavel: 0172104210001, criado com Sucesso!", "Status": "Sucesso", "StatusCode": 200 }
Content
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
Username <username>
Password <password>
{ "Nome": "Teste Api 2 ", "EstadoNatal": "MG", "Naturalidade": "Belo Horizonte", "DataNascimento": "05/07/1978", "Cpf": "85763425022", "Cep": "38700412", "Rua": "Pascoal Soares", "Numero": 10, "Complemento": "102", "Bairro": "Savassi", "Estado": "SP", "Cidade": "São Paulo", "Pais": "Brasil", "Tel_Residencial": "3333333333333", "Tel_Celular": "2312321312", "Tel_3": "13123132313", "Fax": "312321313131", "SitOcupacional": 1, "TipoEscola": 3, "CodColigada": 3, "IdMatrizAplicada": 4, "Email": "[email protected]", "NomeMae": "Nome da mãe do Aluno" }
Content
Nome: Nome do Aluno no SGE (Campo Obrigatório);
EstadoNatal: Estado Natal do Aluno no SGE (Campo Obrigatório);
Valores possíveis:
1 = Empregado
2 = Desempregado
3 = Empregador
4 = Autônomo/Conta Própria
5 = Profissional Liberal
6 = 1º Emprego
7 = Aposentado
8 = Microempreendedor Individual - MEI
9 = Aprendiz com contrato
Valores possíveis:
1 = Particular
2 = Pública - Municipal
3 = Pública - Estadual
4 = Pública - Federal
9 = Não Declarado
{ "Message": "Aluno: 205, existente em base, atualizado com Sucesso!\r\n", "Status": "Sucesso", "StatusCode": 200 }
Content
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
Username <username>
Password <password>
{ "CodColigada": 3, "IdMatrizAplicada": "3|22", "RA": "0000000382", "Turma": "11|TEC.001.017", "DataMatricula": "30/05/2022", "DataPrevSaida": "30/05/2023", "CondicaoAluno": 0, "CodFinSCAE": 1, "Articulacao": 2, "Contrato": { "NomeRespFin": "NOME DO CLIENTE FORNECEDOR", "CodColCfo": 0, "CodCFO": "0564404200001", "ValorTotal": 240.0, "QuantidadeParc": 1, "ParcelasCartaoParcelaUm": 0, "DataVencimento": "20/06/2022", "DiaVencimento": 20, "DescontoInstitucional": 0, "DescontoAdicional": 0, "Motivo": "Teste matricula aluno", "DataVenda": "26/04/2022", "IdOportunidade": 1, "FormaPagtoPrimeiraParc": "CAC", "FormaPagtoDemaisParc": "CAC", "ReceberBoletoEmail": "Sim", "Ecommerce": "SIM", "DadosCartao": { "Cod_Loja": 0001, "Agencia": "1369", "Cod_Banco": "001", "Conta": "2002", "Motivo": "CAC", "AdquirenteCartao": "999999999", "BandeiraCartao": "MASTERCARD", "NSU": "9999999999", "MeioPagamento": "Crédito", "ValorTotalCartao": 240.0, "ParcelasCartao": 5 } }, "Disciplinas": [] }
Content
Valores possíveis:
0 = Não Gratuita.
1 = Gratuidade regimental
2 = Bolsa de estudos
3 = Convênio
0 = Não Gratuita
2 = Gratuidade Regulamentar
3 = Gratuidade Não Regulamentar
Valores possíveis:;
BOLETO: BOL (Mensalidade Boleto)
Cartão crédito: CAC (Mensalidade Cartão de crédito)
Cartão débito: CAR (Mensalidade Cartão de débito)
Dinheiro: ESP (Mensalidade dinheiro)
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
{ "Matricula": { "Matricula": "0000000001", "XNumPro": "SGE3F20C100", "CodFilial": "UN20", "FilialProtheus": "03CE0001", "CodColigada": 3, "CodContrato": "100", "StatusContrato": "Vigente", "DataInicio": "2022-07-08T00:00:00", "DuracaoEmMeses": 4, "SituacaoMatricula": "Pré-Matriculado" }, "Message": "Matrícula realizada com sucesso!", "Status": "Sucesso", "StatusCode": 200 }
Content
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
Username <username>
Password <password>
[ { "codColigada": "3", "itemContabil": "0001253", "codFilial": null, "descricao": "teste Exemplo 0", "status": "T" } ]
Content
{ "Message": "Sucesso ao criar o item 123\r\n", "Status": "Sucesso" "StatusCode": 200 }
Content
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
Username <username>
Password <password>
[ { "codColigada": "3", "xnumpro": "TESTE1", "contaCaixaBanco": "001", "contaCaixaAgencia": "01", "contaCaixaContaCorrente": "111111", "parcela": { "pedidoVendaGerencial": "TESTE2", "nossoNumero": "", "dataEmissao": "01/01/2000", "dataVencimento": "13/06/2022", "dataPrevisaoBaixa": "12/06/2022", "Filial": "03CE0001", "Prefixo": "001", "Num": "000804", "Parcela": "1", "Tipo": "P" } } ]
Content
{ "Message": "Sucesso ao incluir o Id. Lançamento 142.\r\n", "Status": "Sucesso", "StatusCode": 200, "IdLan": 142 }
Content
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
Username <username>
Password <password>
[ { "codColigada": "3", "idLan": "142", "Filial": "03CE0001", "Prefixo": "001", "Num": "000804", "Parcela": "1", "Tipo": "P", "DataCancelamento": "01/01/2000" } ]
Content
Importante: Quando o idLan estiver vazio, serão considerados os seguintes campos como chave: Filial, Prefixo, Num, Parcela e Tipo.
{ "Message": "Sucesso ao excluir o Id. Lançamento 142\r\n", "Status": "Sucesso", "StatusCode": 200 }
Content
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")
Username <username>
Password <password>
[ { "IdLan": "334", "Filial": "03CE0001", "Prefixo": "001", "Num": "000804", "Parcela": "1", "Tipo": "P", "DataCancelamento": "06/07/2022", "DataBaixa": "06/07/2022", "ContaCaixaBanco": "002", "ContaCaixaAgencia": "9598", "ContaCaixaContaCorrente": "1234", "ValorBaixa": 2000, "codColigada": "3", "ContaCaixa_SEMMOVIMENTACAO": "" } ]
Content
Importante: Quando o idLan estiver vazio, serão considerados os seguintes campos como chave: Filial, Prefixo, Num, Parcela e Tipo.
{ "Message": "Sucesso ao cancelar baixa do Id. Lançamento 142\r\n", "Status": "Sucesso", "StatusCode": 200 }
Content
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")
Username <username>
Password <password>
[{ "codColigada": "3", "idLan": "143", "Filial": "03CE0001", "Prefixo": "001", "Num": "000804", "Parcela": "1", "Tipo": "P", "ValorBaixa": 311.26, "DataBaixa": "16/12/2021", "ContaCaixa_Banco": "002", "ContaCaixa_AG": "9598", "ContaCaixa_CC": "1234", "ContaCaixa_SEMMOVIMENTACAO": "00001", "Juros": 30.76, "Multa": 5.50, "Desconto": 0.0 }]
Content
Exemplo:
Observação: Quando for informado um valor de desconto (campo "Desconto") este deverá representar o valor total do desconto (Bolsa permanente + outros descontos). Caso este valor seja maior que o valor da bolsa a diferença será gravada na baixa, no campo "Desconto". O valor informado no campo "ValorBaixa" deve contemplar este desconto.
Exemplo:
Importante: Quando o idLan estiver vazio, serão considerados os seguintes campos como chave: Filial, Prefixo, Num, Parcela e Tipo.
{ "Message": "Sucesso ao baixar o titulo do Id. Lançamento 143\r\n", "Status": "Sucesso", "StatusCode": 200 }
Content
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
Username <username>
Password <password>
{ "codColigada" : "1", "NossoNumero" : "123", "Idlan": 232, "Filial": "03CE0001", "Prefixo": "001", "Num": "000805", "Parcela": "1", "Tipo": "P", "NumeroPedido" : null, "CodFilial" : null }
Content
Importante: Quando o idLan estiver vazio, serão considerados os seguintes campos como chave: Filial, Prefixo, Num, Parcela e Tipo.
{ "Message": "Sucesso ao fazer a Alteração do Nosso Numero (IDLan/Numero Pedido : 172, NossoNumero: 123).\r\n\r\n", "Status": "Sucesso", "StatusCode": 200 }
Content
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")
Username <username>
Password <password>
{ "IdLiquidacao": "3|CSI|TESTE|CNI418Parc1&5", "codColigada": "3", "NumParcelas": 3, "CodCCusto": "3.03.01.03.01", "TipoJuros": 0, "TaxaJuros": 0, "ValorJurosDia": 0, "DataAcordo": "2022-06-14", "ValorAcordo": 2499.0, "ValorDesconto": 1, "ValorAcrescimo": 100, "LancamentosOriginais": [ { "Idlan": 232, "Filial": "03CE0001", "Prefixo": "001", "Num": "000805", "Parcela": "1", "Tipo": "P" }, { "Idlan": 233, "Filial": "03CE0001", "Prefixo": "001", "Num": "000805", "Parcela": "1", "Tipo": "P" } ], "LancamentosAcordo": [ { "Identificador": "001", "Filial": "03CE0001", "Prefixo": "001", "Num": "000804", "Parcela": "1", "Tipo": "P", "DataVencimento": "2022-07-10", "DataPrevisaoBaixa": "2022-07-10", "Valor": 1050.11 }, { "Identificador": "002", "Filial": "03CE0001", "Prefixo": "001", "Num": "000804", "Parcela": "1", "Tipo": "P", "DataVencimento": "2022-08-10", "DataPrevisaoBaixa": "2022-08-11", "Valor": 1248.89 }, { "Identificador": "003", "Filial": "03CE0001", "Prefixo": "001", "Num": "000804", "Parcela": "1", "Tipo": "P", "DataVencimento": "2022-09-10", "DataPrevisaoBaixa": "2022-09-12", "Valor": 200.00 } ] }
Content
Importante: Quando o idLan estiver vazio, serão considerados os seguintes campos como chave: Filial, Prefixo, Num, Parcela e Tipo.
{ "Message": "Acordo 33 gerado com sucesso\r\n", "Status": "Sucesso", "StatusCode": 200, "Data": "{ "IdAcordo":33, "LancamentosAcordo":[ { "Identificador":"001", "Idlan":300, "DataVencimento":"2022-07-10T00:00:00" }, { "Identificador":"002", "Idlan":301, "DataVencimento":"2022-08-10T00:00:00" }, { "Identificador":"003", "Idlan":302, "DataVencimento":"2022-09-10T00:00:00" } ] }" }
Content
Importante: Quando o idLan estiver vazio, serão considerados os seguintes campos como chave: Filial, Prefixo, Num, Parcela e Tipo.
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")
Username <username>
Password <password>
{ "codColigada": "3", "idLiquidacao": "22", "DataCancelamento": "01/01/2000" }
Content
{ "Message": "Acordo 21 (Liquidação Protheus: 3|CSI|TESTE|CNO418Parc4&5), cancelado com sucesso.\r\n", "Status": "Sucesso", "StatusCode": 200, }
Content
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
Username <username>
Password <password>
{ "CodColigada": 3, "Filial": "03CE0001", "NumeroContrato": "123456", "NumProposta": "123", "CNPJ": "58069568000149", "NomeEmpresa": "Entrega Contrato PJ", "ValorContrato": 1000, "CodTurma": "APB.001.001", "IdPerlet": 4, "VagasOfertadas": 10, "VagasUtilizadas": 2 }
Content
{ "Message": "Registro integrado com sucesso", "Status": Sucesso, "StatusCode": 200 }
Content
Consulta um Contrato Pessoa Jurídica no SGE
Tabela Afetada: Nenhuma
Interface RM: TOTVS Educacional | Educacional | Customizações | Contrato PJ | Contratos
Username <username>
Password <password>
[ { "NumeroContrato": "123456", "NumProposta": "123", "DataInicioTurma": "2022-09-27T00:00:00", "DataFimTurma": "2022-11-29T00:00:00", "TotalVagas": 10, "VagasDisponiveis": 8, "VagasUtilizadas": 2, "AlunosVinculados": 4, "StatusContrato": "Não iniciado", "Clientefornecedor": "005959790001" } ]
Content