Histórico da Página

...

Expandir

title	Serviço CRM

HTML
<div class="postget">POST<>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á:

Incluir o Serviço CRM no SGE (cadastro customizado).
Preencher todos os dados do serviço:

Código do Serviço/Produto
Descrição do Serviço/Produto
Código do produto do Protheus (obrigatório),
Código da Natureza Financeira do Protheus
Item Contábil
Conta Contábil
Status

Vincular o Serviço CRM no anexo customizado dos Cursos informados

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

Authorization - Basic Auth

Username <username>

Password <password>

Body

Bloco de código

language	c#
title	Raw

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

CodColigada: Código da Coligada no SGE. Enviar 2 para SESI e 3 para SENAI (primary key).
Codigo: Código do Serviço CRM (primary key);
Descricao: Nome do Serviço CRM;
Produto Protheus: Código do Produto no Protheus, associado ao serviço/curso. Utilizado no envio do Pedido de Venda do SGE para o Protheus (obrigatório);
Natureza: Código da Natureza Financeira, associado ao serviço/curso. Utilizado no envio do Pedido de Venda do SGE para o Protheus;
Item Contabil: (Id do protheus);
Conta Contabil: (Conta Contabil)
Ativo: true ou false, indica se o serviço está ativo ou não;
CodCurso: 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

language	c#
title	Console

{
   "Message": "Serviço incluído 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	Baixa do Título

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

Efetua a baixa do lançamento financeiro do SGE. O status do lançamento (FLAN.STATUS) é alterado para 1-Baixado.

Tabelas Afetadas: FLAN, FLANBAIXA

Authorization - Basic Auth

Username <username>

Password <password>

Body

Bloco de código

language	c#
title	Raw

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

codColigada: Código da Coligada. Enviar 2 para SESI e 3 para SENAI (primary key).
idLan: Id do Lançamento (primary key);
Filial: Filial do Título (primary key) ;
Prefixo: Prefixo do Título (primary key);
Num: Número do Título (primary key);
Parcela: Parcela do Título (primary key);
Tipo: Tipo do Título (primary key);
ValorBaixa: Valor Total da Baixa do Título (primary key). Ver observação 2 ao final;, somando juros e multa e descontando o valor de desconto, se existir.
- Exemplo:
  - Valor original: R$ 300,00
  - Valor do Juros: R$ 30,00
  - Valor da Multa: R$ 6,00
  - Valor a ser informado no campo "ValorBaixa": R$ 336,00
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: Código da Conta corrente para realização da Baixa;
- Será utilizada a Filial do lançamento financeiro enviado para localizar a Conta Caixa correta no SGE, já que podem existir vários cadastros de conta caixa com o mesmo número do banco, agência e conta.
Baixas sem movimentação bancária (só deve ser enviada se os dados de baixa com movimentação não for informado):
- 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 Valor dos Juros da Baixa;
Multa: Valor da Multa da Baixa;
Desconto: Valor de Desconto da Baixa;
- 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:
  - Valor original: R$ 458,33
  - Valor da bolsa permanente: R$ 45,83
  - Valor do desconto: R$ 10,00
  - Valor a ser informado no campo "ValorBaixa": R$ 402,50
  - Valor a ser informado no campo "Desconto": R$ 55,83 (Soma do valor da bolsa + algum outro desconto adicional)

Importante: Quando o idLan estiver vazio, serão considerados os seguintes campos como chave: Filial, Prefixo, Num, Parcela e Tipo.

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 o NossoNumero do Lançamento Financeiro e Boleto do SGE.

Tabela Afetada: FLAN, FBOLETO

Interfaces RM:

Authorization - Basic Auth

Username <username>

Password <password>

Body

Bloco de código

language	c#
title	Raw

{
  "codColigada" : "1",
  "NossoNumero" : "123",
  "Idlan": 232,
  "Filial": "03CE0001",
  "Prefixo": "001",
  "Num": "000805",
  "Parcela": "1",
  "Tipo": "P",   
  "NumeroPedido" : null,
  "CodFilial" : null
}

Content

codColigada: Código da Coligada. Enviar 2 para SESI e 3 para SENAI (primary key).
NossoNumero: Numero do NossoNumero (obrigatório).
IDLan: Id do Lançamento (opcional) (Caso não seja possível preencher o campo IdLan, deverão ser enviados os parâmetros NumeroPedido e CodFilial).
Filial: Filial do Título (primary key) ;
Prefixo: Prefixo do Título (primary key);
Num: Número do Título (primary key);
Parcela: Parcela do Título (primary key);
Tipo: Tipo do Título (primary key);
NumeroPedido: Numero do Pedido Gerencial (opcional).
CodFilial: Código da Filial (opcional).

Importante: Quando o idLan estiver vazio, serão considerados os seguintes campos como chave: Filial, Prefixo, Num, Parcela e Tipo.

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;

Expandir

title	Recebimento de Acordo

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

<div class="post">POST</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheusAcordo/Inclusao</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 gerada no Protheus.

Tabela Afetada: FLAN, FLANBAIXA, FACORDO, FACORDOREL

Authorization - Basic Auth

Username <username>

Password <password>

Body

Bloco de código

language	c#
title	Raw

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

Expandir

title	Recebimento de Acordo

HTML
<div class="post">POST</div> <div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheusAcordo/Inclusao</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 gerada no Protheus.

Tabela Afetada: FLAN, FLANBAIXA, FACORDO, FACORDOREL

Authorization - Basic Auth

Username <username>

Password <password>

Body

Bloco de código

language	c#
title	Raw

{
  "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": [
    {
      "IdlanIdentificador": 232"003",
      "Filial": "03CE0001",
      "Prefixo": "001",
      "Num": "000805000804",
      "Parcela": "1",
      "Tipo": "P"
,     },
    {    
      "IdlanDataVencimento": 233"2022-09-10",
      "FilialDataPrevisaoBaixa": "03CE0001",
      "Prefixo": "001"2022-09-12",
      "NumValor": "000805",200.00
      "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

CodColigada: Código da Coligada. Enviar 2 para SESI e 3 para SENAI (primary key).
IdLiquidacao: Chave da liquidação do Protheus utilizada para identificar o registro no Log do Processo (pode concatenar vários valores neste campo). O valor enviado será gravado no campo "Observação" do Acordo gerado no SGE.
NumParcelas: Número de Parcelas que devem ser geradas pelo Acordo no SGE.
CodCCusto: Código do Centro de Custo do Acordo
TipoJuros: Juros Futuros - indica se será informado o percentual ou o valor dos juros. Enviar 0 para informar Taxa e 1 para informar Valor. De acordo com o preenchimento, apenas um campo abaixo deve ser informado:
- TaxaJuros: Percentual de taxa de juros ao dia do Acordo
- ValorJurosDia: Valor da taxa de juros ao dia do Acordo
DataAcordo: Data em que o acordo foi gerado no Protheus.
ValorAcordo: Valor Final do Acordo gerado: Soma do valor dos lançamentos financeiros gerados pelo acordo, considerando valor de desconto e acréscimo.
ValorDesconto: Valor do desconto do Acordo. Esse valor é informativo e fica gravado na capa do acordo. Não interfere no cálculo do acordo no SGE.
ValorAcrescimo: Valor do acréscimo do Acordo. Esse valor é informativo e fica gravado na capa do acordo. Não interfere no cálculo do acordo no SGE.

LancamentosOriginais: lista de lançamentos que darão origem ao acordo. Os lançamentos enviados aqui serão baixados no SGE (tipo de baixa = Por Acordo).
- Idlan: Identificador do lançamento original do acordo
- Filial: Filial do Título (primary key) ;
- Prefixo: Prefixo do Título (primary key);
- Num: Número do Título (primary key);
- Parcela: Parcela do Título (primary key);
- Tipo: Tipo do Título (primary key);
LancamentosAcordo: lista de lançamentos que serão gerados pelo Acordo. O número de itens desta lista deve ser igual ao campo NumParcelas. Os lançamentos enviados aqui serão gerados no SGE com status Em Aberto (tabela FLAN).
- Identificador: Número identificador do título do Protheus (chave única, composta por E1_FILIAL + E1_PREFIXO + E1_NUM + E1_PARCELA + E1_TIPO).
- Filial: Filial do Título (primary key) ;
- Prefixo: Prefixo do Título (primary key);
- Num: Número do Título (primary key);
- Parcela: Parcela do Título (primary key);
- Tipo: Tipo do Título (primary key);
- DataVencimento: Data de vencimento real (dia útil) do lançamento/boleto (FLAN.DTVENCIMENTO).
- DataPrevisaoBaixa: Data de previsão de vencimento do lançamento/boleto calculada pelo Protheus. Informação gravada em FLAN.DATAPREVBAIXA.
- Valor: Valor total do boleto/lançamento que será gerado.

Importante: Quando o idLan estiver vazio, serão considerados os seguintes campos como chave: Filial, Prefixo, Num, Parcela e Tipo.

Retorno

Content

CodColigada: Código da Coligada. Enviar 2 para SESI e 3 para SENAI (primary key).
IdLiquidacao: Chave da liquidação do Protheus utilizada para identificar o registro no Log do Processo (pode concatenar vários valores neste campo). O valor enviado será gravado no campo "Observação" do Acordo gerado no SGE.
NumParcelas: Número de Parcelas que devem ser geradas pelo Acordo no SGE.
CodCCusto: Código do Centro de Custo do Acordo
TipoJuros: Juros Futuros - indica se será informado o percentual ou o valor dos juros. Enviar 0 para informar Taxa e 1 para informar Valor. De acordo com o preenchimento, apenas um campo abaixo deve ser informado:
- TaxaJuros: Percentual de taxa de juros ao dia do Acordo
- ValorJurosDia: Valor da taxa de juros ao dia do Acordo
DataAcordo: Data em que o acordo foi gerado no Protheus.
ValorAcordo: Valor Final do Acordo gerado: Soma do valor dos lançamentos financeiros gerados pelo acordo, considerando valor de desconto e acréscimo.
ValorDesconto: Valor do desconto do Acordo. Esse valor é informativo e fica gravado na capa do acordo. Não interfere no cálculo do acordo no SGE.
ValorAcrescimo: Valor do acréscimo do Acordo. Esse valor é informativo e fica gravado na capa do acordo. Não interfere no cálculo do acordo no SGE.

LancamentosOriginais: lista de lançamentos que darão origem ao acordo. Os lançamentos enviados aqui serão baixados no SGE (tipo de baixa = Por Acordo).
- Idlan: Identificador do lançamento original do acordo
- Filial: Filial do Título (primary key) ;
- Prefixo: Prefixo do Título (primary key);
- Num: Número do Título (primary key);
- Parcela: Parcela do Título (primary key);
- Tipo: Tipo do Título (primary key);
LancamentosAcordo: lista de lançamentos que serão gerados pelo Acordo. O número de itens desta lista deve ser igual ao campo NumParcelas. Os lançamentos enviados aqui serão gerados no SGE com status Em Aberto (tabela FLAN).
- Identificador: Número identificador do título do Protheus (chave única, composta por E1_FILIAL + E1_PREFIXO + E1_NUM + E1_PARCELA + E1_TIPO).
- Filial: Filial do Título (primary key) ;
- Prefixo: Prefixo do Título (primary key);
- Num: Número do Título (primary key);
- Parcela: Parcela do Título (primary key);
- Tipo: Tipo do Título (primary key);
- DataVencimento: Data de vencimento real (dia útil) do lançamento/boleto (FLAN.DTVENCIMENTO).
- DataPrevisaoBaixa: Data de previsão de vencimento do lançamento/boleto calculada pelo Protheus. Informação gravada em FLAN.DATAPREVBAIXA.
- Valor: Valor total do boleto/lançamento que será gerado.

Importante: Quando o idLan estiver vazio, serão considerados os seguintes campos como chave: Filial, Prefixo, Num, Parcela e Tipo.

Retorno

Bloco de código

language	c#
title	Console

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

Bloco de código

language	c#
title	Console

{
  "Message": "Acordo 33 gerado com sucesso\r\n",
  "Status": "Sucesso",
  "StatusCode": 200,
  "Data": "{
                "IdAcordo":33,
                "LancamentosAcordo":[},
                    {
                        "Identificador":"001003",
                        "Idlan":300302,
                        "DataVencimento":"2022-0709-10T00:00:00"
                    },
                    {]
                        "Identificador":"002",
                        "Idlan":301,
                        "DataVencimento":"2022-08-10T00:00:00"
                    },
                    {
                        "Identificador":"003",
                        "Idlan":302,
                        "DataVencimento":"2022-09-10T00:00:00"
                    }
                ]
            }"
}

Content

}"
}

Content

Message: Mensagem de retorno do consumo da requisição, com identificador do Acordo gerado.
Status: Situação do processamento da requisição;
StatusCode: Código de status do processamento da requisição;
Data: lista com informações do acordo gerado no SGE
- Identificador: chave do título do Protheus, enviado na requisição.
- Idlan: identificador do lançamento gerado no SGE.
- Filial: Filial do Título (primary key) ;
- Prefixo: Prefixo do Título (primary
Message: Mensagem de retorno do consumo da requisição, com identificador do Acordo gerado.
Status: Situação do processamento da requisição;
StatusCode: Código de status do processamento da requisição;
Data: lista com informações do acordo gerado no SGE
- Identificador: chave do título do Protheus, enviado na requisição.
- Idlan: identificador do lançamento gerado no SGE.
- Filial: Filial do Título (primary key) ;
- Prefixo: Prefixo do Título (primary key);
- Num: Número do Título (primary key);
- Parcela: Parcela do Título (primary key);
- Tipo: Tipo do Título (primary key);
- DataVencimento: data de vencimento do lançamento gerado.

Importante: Quando o idLan estiver vazio, serão considerados os seguintes campos como chave: Filial, Prefixo, Num, Parcela e Tipo.

...

Expandir

title	Contrato PJ - Recebimento Contrato

HTML
<div class="post">POST</div> <div class="endereco">/rm/api/TOTVSCustomizacao/ContratoPJ/SetContract</div>

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 Auth

Username <username>

Password <password>

Body

Bloco de código

language	c#
title	Raw

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

CodColigada: Código da Coligada no SGE. Enviar 2 para SESI e 3 para SENAI (primary key).
Filial: Código da Filial do Salesforce, formato do SGE (sem sigla 'UN').
NumeroContrato: Número do Contrato PJ no CRM (primary key);
NumProposta Número da Proposta do Contrato PJ no CRM (primary key);
CNPJ: CNPJ da empresa responsável pelo Contrato PJ (obrigatório).
NomeEmpresa: CNPJ da empresa responsável pelo Contrato PJ (obrigatório).
ValorContrato: Valor total do Contrato PJ.
CoTurmaCodTurma: Código da turma referente ao Contrato PJ, no mesmo formato enviado na exportação de Turmas. .
IdPerlet: Código do Período Letivo da Turma.
VagasOfertadas: Número total de vagas ofertadas para o Contrato PJ.
VagasUtilizadas: Número de vagas já utilizadas do Contrato PJ.
- Observação: O número de vagas disponíveis deverá ser calculado a partir do total de vagas ofertadas e as vagas utilizadas de cada Contrato PJ.

Retorno

Bloco de código

language	c#
title	Console

{
  "Message": "Registro integrado com sucesso",
  "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	Contrato PJ - Consulta Contrato

HTML
<div class="get">GET</div> <div class="endereco">/rm/api/TOTVSCustomizacao/ContratoPJ/ConsultContract</div>

Consulta um Contrato Pessoa Jurídica no SGE

Tabela Afetada: Nenhuma

Interface RM: TOTVS Educacional | Educacional | Customizações | Contrato PJ | Contratos

Authorization - Basic Auth

Username <username>

Password <password>

Parameters

numeroContrato: Numero do contrato no CRM a ser consultado.
numProposta: Numero da proposta no CRM a ser consultada.

Retorno

Bloco de código

language	c#
title	Console

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

NumeroContrato: Número do Contrato no CRM;
NumProposta: Número da Proposta no CRM;
DataInicioTurma: Data de início da turma associada ao contrato;
DataFimTurma: Data final da turma associada ao contrato;
TotalVagas: Quantidade Total de Vagas do Contrato;
VagasDisponiveis: Quantidade de Vagas disponíveis no Contrato;
VagasUtilizadas: Quantidade de Vagas utilizadas;
AlunosVinculados: Quantidade de Alunos vinculados ao contrato;
StatusContrato: Situação do Contrato;
Clientefornecedor: Responsavel Financeiro do Contrato.

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

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 107

Nova versão Atual

Chave

Authorization - Basic Auth

Body

Retorno

Authorization - Basic Auth

Body

Retorno

Authorization - Basic Auth

Body

Retorno

Authorization - Basic Auth

Body

Authorization - Basic Auth

Body

Retorno

Retorno

Authorization - Basic Auth

Body

Retorno

Authorization - Basic Auth

Parameters

Retorno