Histórico da Página

...

Expandir

title	Responsável Financeiro

HTML
<div class="post">POST</div> <div class="endereco">/rm/api/TOTVSCustomizacao/IntegracaoSALESFORCE/GravarResponsavelFinanceiro</div>

Realiza a gravação do responsavel responsável financeiro no SGE, conforme dados enviados pela API.

Authorization - Basic Auth

Username <username>

Password <password>

Body

Bloco de código

language	c#
title	Raw

{
 "CodCFO": "760428860-0004",
 "Nome": "responsaveltesteapi",
 "Cpf": "42302908023",
 "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
}

Content

Nome: Nome do responsável financeiro no SGE (Campo Obrigatório);
Cpf: CPF do responsável financeiro no SGE (Campo Obrigatório);
Email: E-mail do responsável financeiro no SGE (Campo Obrigatório);
Cep: CEP do endereço do aluno no SGE (Campo Obrigatório);
Logradouro: Nome da rua (Campo Obrigatório);
Numero: Numero da residencia (Enviar apenas números)(Campo Obrigatório);
Complemento: Complemento se houver (Campo Obrigatório);
Bairro: Nome do bairro (Campo Obrigatório);
Estado: Enviar Sigla do Estado (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);
Tel_Comercial: Numero telefone comercial(Enviar apenas números com DDD);
Fax: Número fax(Enviar apenas números com DDD);
CodColigada: Código da Coligada no SGE. Enviar 2 para SESI e 3 para SENAI (Campo obrigatório).

Retorno

Bloco de código

language	c#
title	Console

{
   "Message": "Responsavel: 00000005, criado com 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

title	Item Contábil

HTML
<div class="post">POST</div> <div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/ItemContabil</div>

Insere e/ou atualiza itens contábeis no RM, para uso no projeto Integração Protheus FIEC.

Authorization - Basic Auth

Username <username>

Password <password>

Body

Bloco de código

language	c#
title	Raw

[
    {
		"codColigada": "3",
		"idItemContabil": "1253",
		"itemContabil": "0001253",
        "codFilial": null,
		"descricao": "teste Exemplo 0",
		"status": "T"
	}
]

Content

codColigada: Código da Coligada (primary keyobrigatório);
idItemContabil: Id do item Contábil (primary key);
.
itemContabil: Código do Item Contábil Protheus ;(obrigatório). Para alterações, o SGE irá localizar o registro através deste código e do número da coligada.
codFilial: Código da Filial;.
descricao: Descrição do item contábil;.
status: Status do item contábil;.
- T = Ativo
- F = Inativo

Retorno

Bloco de código

language	c#
title	Console

{
"Message": "Sucesso ao criar o item 123\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

title	Inclusão do lançamento

HTML
<div class="post">POST</div> <div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/InclusaoLancamento</div>

Realiza a inclusão dos lançamentos no RM, para uso no projeto Integração Protheus FIEC.

Authorization - Basic Auth

Username <username>

Password <password>

Body

Bloco de código

language	c#
title	Raw

[
    {
        "codColigada": "3",
        "xnumpro": "TESTE1",
        "contaCaixaBanco": "001",
        "contaCaixaAgencia": "01",
        "contaCaixaContaCorrente": "111111",
        "parcela": 
            {   "pedidoVendaGerencial": "TESTE2",
                "nossoNumero": "TESTE2",
                "dataEmissao": "01/01/2000",
                "dataVencimento": "05/01/2000"
            }       
    }
]

Content

codColigada: Código da Coligada (obrigatório);.
xnumpro: Utilizado para identificar o contrato/parcela referente ao lançamento (obrigatório);.
contaCaixaBanco: Código do Banco da Conta Caixa/Convênio;.
contaCaixaAgencia: Agência da Conta Caixa/Convênio;.
contaCaixaContaCorrente: Conta Conta Corrente da Conta Caixa/Convênio, com o dígito;.
parcela: Dados da Parcela do SGE
- pedidoVendaGerencial: Número do Pedido de Venda Gerencial gerado no Protheus referente à parcela (obrigatório);.
- nossoNumero: Nosso número do boleto;.
- dataEmissao: Data de Emissão do lançamento (obrigatório);.
- dataVencimento: Data de vencimento do lançamento (obrigatório).

Retorno

Bloco de código

language	c#
title	Console

{
"Message": "Sucesso ao incluir o Id. Lançamento 142.\r\n",
"Status": "Sucesso",
"StatusCode": 200,
"IdLan": 142
}

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;
IdLan: Identificador do lançamento gerado pelo SGE.

...

Expandir

title	Cancelamento de baixas do lançamento

HTML
<div class="post">POST</div> <div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/CancelamentoBaixa</div>

Cancela as baixas dd dos lançamento no RM, para uso no projeto Integração Protheus FIEC.

Authorization - Basic Auth

Username <username>

Password <password>

Body

Bloco de código

language	c#
title	Raw

[
    {
		"codColigada": "3",
  		"idLan": "142",
  		"DataCancelamento": "01/01/2000"
	}
]

Content

codColigada: Código da Coligada (primary key);
idLan: Id do Lançamento (primary key);
DataCancelamento: Data do Cancelamento do Lançamento (primary key);

Retorno

Bloco de código

language	c#
title	Console

{
"Message": "Sucesso ao cancelar baixa do Id. Lançamento 142\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

title	Baixa do Título

HTML
<div class="post">POST</div> <div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/BaixaTitulo</div>

Insere e/ou atualiza itens contábeis no RM, para uso no projeto Integração Protheus FIECEfetua a baixa do lançamento financeiro do SGE.

Authorization - Basic Auth

Username <username>

Password <password>

Body

Bloco de código

language	c#
title	Raw

[{
    "codColigada": "3",
    "idLan": "143",
    "ValorBaixa": 311.26,
    "DataBaixa": "16/12/2021",
    "ContaCaixa_Banco": "002",
    "ContaCaixa_AG": "9598",
    "ContaCaixa_CC": "1234",
    em análise pela FIEC: "ContaCaixa_SEMMOVIMENTACAO": "00001", 
    "Juros": 30.76,
    "Multa": 5.50,
    "Desconto": 0.0
}]

Content

codColigada: Código da Coligada (primary key);
idLan: Id do Lançamento (primary key);
ValorBaixa: Valor da Baixa do Título (primary key);
DataBaixa: Data da Baixa do Título (primary key);
Baixas com movimentação bancária:
- ContaCaixa_Banco: Código do banco da Conta para realização da Baixa;
- ContaCaixa_AG: Código da agencia do banco da Conta para realização da Baixa;
- ContaCaixa_CC: Codigo da Conta corrente para rea\lização da Baixa;Baixas com movimentação bancária:
Baixas sem movimentação bancária:
- ContaCaixa_SemMovimentação: Código da Conta caixa do SGE utilizada para baixas de cartão e NCC que não efetuam movimentação bancária.
Juros: Taxa de Juros da Baixa;
Multa: Valor da Multa da Baixa;
Desconto: Valor de Desconto da Baixa;

Retorno

Bloco de código

language	c#
title	Console

{
    "Message": "Sucesso ao baixar o titulo do Id. Lançamento 143\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

title	Alteração NossoNumero

HTML
<div class="post">POST</div> <div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/AlteracaoNossoNumero</div>

Insere e/ou atualiza itens contábeis no RM, para uso no projeto Integração Protheus FIECo NossoNumero do lançamento financeiro do SGE.

Authorization - Basic Auth

Username <username>

Password <password>

Body

Bloco de código

language	c#
title	Raw

{
  "codColigada" : "1",
  "NossoNumero" : "123", 
  "IDLan" : 123,
  "NumeroPedido" : "123"null,
  "CodFilial" : 1null
}

Content

codColigada: Código da Coligada ;(obrigatório).
NossoNumero: Numero do NossoNumero ;(obrigatório).
IDLan: Id do Lançamento (Opcionalopcional) (Caso não seja possível passal preencher o campo IDLanIdLan, deverá deverão ser passado como parâmetros Numero Pedido e Codigo Filial); enviados os parâmetros NumeroPedido e CodFilial).
NumeroPedido: Numero do Pedido Gerencial (Opcionalopcional);.
CodFilial: Código da Filial (Opcionalopcional);.

Retorno

Bloco de código

language	c#
title	Console

{
    "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

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>
-->

Expandir

title	Recebimento de Acordo

HTML
<div class="post">POST</div> <div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/InclusaoAcordo</div>

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.

Authorization - Basic Auth

Username <username>

Password <password>

Body

Bloco de código

language	c#
title	Raw

[
  {
    "IdNegociacao": 100,
    "Codcoligada": 2,
    "NumParcelas": 10,
    "CodCCusto": null,
    "TipoJuros": 0,
    "TaxaJuros": 0,
    "ValorJurosDia": 0.0,
    "DataAcordo": "29/01/2022",
    "ValorLiquido": 1500.00,
    "ValorAcordo": 1500.00,
    "ValorDesconto": 0.0,
    "ValorAcrescimo": 0.0,
    "RA": null,
    "LancamentosOriginais": 
     [{
        "idlan": 22
      }],
    "LancamentosAcordo": 
     [{
        "xnumpro": null,
        "idlan": 0,
        "nossoNumero": null,
        "dataVencimento": "0001-01-01T00:00:00",
        "valor": 0.0
      }]
}

Content

codColigada: Código da Coligada (obrigatório)
idLan: Id do Lançamento (primary key);
DataCancelamento: Data do Cancelamento do Lançamento (primary key);

Retorno

Bloco de código

language	c#
title	Console

{
"Message": "Sucesso ao incluir o Acordo: 22\r\n",
"Status": "Sucesso",
"StatusCode": 200, 
"idAcordo": 22
}

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

title	Cancelamento de Acordo

HTML
<div class="post">POST</div> <div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/CancelamentoAcordo</div>

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.

Authorization - Basic Auth

Username <username>

Password <password>

Body

Bloco de código

language	c#
title	Raw

[
    {
		"codColigada": "3",
  		"idAcordo": "22",
  		"DataCancelamento": "01/01/2000"
	}
]

Content

codColigada: Código da Coligada (obrigatório).
idAcordo: Id do acordo do SGE (obrigatório). Tal informação é devolvida para o Protheus pela API de inclusão de acordo.
DataCancelamento: Data do Cancelamento do acordo (obrigatório).

Retorno

Bloco de código

language	c#
title	Console

{
"Message": "Sucesso ao cancelar o acordo identificador: 22\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;

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 40

Nova versão 41

Chave

Authorization - Basic Auth

Body

Retorno

Authorization - Basic Auth

Body

Retorno

Authorization - Basic Auth

Body

Retorno

Authorization - Basic Auth

Body

Retorno

Authorization - Basic Auth

Body

Retorno

Authorization - Basic Auth

Body

Retorno

Authorization - Basic Auth

Body

Retorno

Authorization - Basic Auth

Body

Retorno