Histórico da Página

...

Expandir

title	Consultar Contratos Aluno

HTML
<div class="get">GET</div> <div class="endereco">/rm/api/TOTVSCustomizacao/ContratosTitulos/ConsultarContratosAluno</div>

Consulta os contratos A pesquisa retornará as informações dos contratos e títulos em aberto através do CPF ou Id. Corporativo de um aluno.

Tabela Afetada: Nenhuma

Interface RM:

Authorization - Basic Auth

Username <username>

Password <password>

Parameters

codColigada: Código da Coligada no SGE (Obrigatório)
cpf: CPF do Aluno no SGE
idCorporativo:

Retorno

Bloco de código

language	c#
title	Console

[
    {
        "codColigada": 2,
        "codFilial": 294,
        "codTipoCurso": 1,
        "NomeNivelEnsino": "Educação Básica",
        "codContrato": "145856",
        "idCorporativo": "5073869",
        "idContratante": "4437657",
        "nomeAluno": "Aquiles Gomes Moreira Gigante",
        "nomeContratante": "Douglas Gigante",
        "cpfAluno": "19486970769",
        "cpfContratante": "12489857703",
        "idServicoCorporativo": "49079",
        "nomeServicoCorporativo": "Ensino Fundamental - Anos Iniciais - 1º ano",
        "dataInicioVigencia": "2023-02-09T00:00:00",
        "dataFimVigencia": "2023-12-08T00:00:00",
        "estadoAdimplencia": "IN",
        "dataInicioCompetencia": "2023-02-01T00:00:00",
        "dataFimCompetencia": "2023-12-01T00:00:00",
        "dataFinalTurma": "2023-12-08T00:00:00",
        "dataFinalPletivo": "2023-12-08T00:00:00",
        "Titulos": [
            {
                "$id": "1",
                "codColigada": 2,
                "codFilial": 294,
                "codTipoCurso": 1,
                "NomeNivelEnsino": "Educação Básica",
                "codContrato": "145856",
                "idCorporativo": "5073869",
                "idContratante": "4437657",
                "nomeAluno": "Aquiles Gomes Moreira Gigante",
                "nomeContratante": "Douglas Gigante",
                "cpfAluno": "19486970769",
                "cpfContratante": "12489857703",
                "dataVencimento": "2023-03-10T00:00:00",
                "dataRealVencimento": "2023-03-10T00:00:00",
                "nossoNumero": "000004711311",
                "valorTitulo": 736.57,
                "valorMulta": 14.2900,
                "valorJurosMes": 8.0100,
                "numbParcela": 2,
                "statusLan": 0,
                "idBoleto": 471131,
                "idLan": 465195,
                "estadoTitulo": "IN",
                "InternalId": null
            },
            {
                "$id": "2",
                "codColigada": 2,
                "codFilial": 294,
                "codTipoCurso": 1,
                "NomeNivelEnsino": "Educação Básica",
                "codContrato": "145856",
                "idCorporativo": "5073869",
                "idContratante": "4437657",
                "nomeAluno": "Aquiles Gomes Moreira Gigante",
                "nomeContratante": "Douglas Gigante",
                "cpfAluno": "19486970769",
                "cpfContratante": "12489857703",
                "dataVencimento": "2023-04-10T00:00:00",
                "dataRealVencimento": "2023-04-10T00:00:00",
                "nossoNumero": "00000471132P",
                "valorTitulo": 729.27,
                "valorMulta": 14.2900,
                "valorJurosMes": 0.7100,
                "numbParcela": 3,
                "statusLan": 0,
                "idBoleto": 471132,
                "idLan": 465196,
                "estadoTitulo": "IN",
                "InternalId": null
            },
            {
                "$id": "3",
                "codColigada": 2,
                "codFilial": 294,
                "codTipoCurso": 1,
                "NomeNivelEnsino": "Educação Básica",
                "codContrato": "145856",
                "idCorporativo": "5073869",
                "idContratante": "4437657",
                "nomeAluno": "Aquiles Gomes Moreira Gigante",
                "nomeContratante": "Douglas Gigante",
                "cpfAluno": "19486970769",
                "cpfContratante": "12489857703",
                "dataVencimento": "2023-05-10T00:00:00",
                "dataRealVencimento": "2023-05-10T00:00:00",
                "nossoNumero": "000004711338",
                "valorTitulo": 714.27,
                "valorMulta": 0.0,
                "valorJurosMes": 0.0,
                "numbParcela": 4,
                "statusLan": 0,
                "idBoleto": 471133,
                "idLan": 465197,
                "estadoTitulo": "N",
                "InternalId": null
            }
        ],
        "InternalId": null
    }
]

Content

Expandir

title	Consultar Contratos Responsável Financeiro

codColigada: Código da Coligada no SGE
codFilial:
codTipoCurso:
NomeNivelEnsino:
codContrato:
idCorporativo:
idContratante:
nomeAluno:
nomeContratante:
cpfAluno:
cpfContratante:
idServicoCorporativo:
nomeServicoCorporativo:
dataInicioVigencia:
dataFimVigencia:
estadoAdimplencia:
dataInicioCompetencia:
dataFimCompetencia:
dataFinalTurma:
dataFinalPletivo:
- Titulos:
  - id:
  - codColigada:

HTML
<div class="get">GET</div> <div class="endereco">/rm/api/TOTVSCustomizacao/ContratosTitulos/ConsultarContratosResFinanceiro</div>

Consulta os contratos através do CPF ou Id. Corporativo de um responsável financeiro

Tabela Afetada: Nenhuma

Interface RM:

Authorization - Basic Auth

Username <username>

Password <password>

Parameters

codColigada:
- - Código da Coligada no SGE
cpfResFinanceiro: CPF do Responsável Financeiro no SGE
- - codFilial:
  - codTipoCurso:
  - NomeNivelEnsino:
  - codContrato:
  - idCorporativo:
  - idContratante:
  - nomeAluno:
  - nomeContratante:
  - cpfAluno:
  - cpfContratante:
  - dataVencimento:
  - dataRealVencimento:
  - nossoNumero:
  - valorTitulo:
  - valorMulta:
  - valorJurosMes:
  - numbParcela:
  - statusLan:
  - idBoleto:
  - idLan:
  - estadoTitulo:

Expandir

title	Consultar Contratos Responsável Financeiro

HTML
<div class="get">GET</div> <div class="endereco">/rm/api/TOTVSCustomizacao/ContratosTitulos/ConsultarContratosResFinanceiro</div>

A pesquisa retornará as informações dos contratos e títulos em aberto através do CPF ou Id. Corporativo de um responsável financeiro

Tabela Afetada: Nenhuma

Interface RM:

Authorization - Basic Auth

Username <username>

Password <password>

Parameters

codColigada: Código da Coligada no SGE
cpfResFinanceiro: CPF do Responsável Financeiro no SGE
idCorporativo:

Retorno

Bloco de código

language	c#
title	Console

[
    {
        "codColigada": 2

Retorno

Bloco de código

language	c#
title	Console

[
    {
        "codColigada": 2,
        "codFilial": 294,
        "codTipoCurso": 1,
        "NomeNivelEnsino": "Educação Básica",
        "codContrato": "145856",
        "idCorporativo": "5073869",
        "idContratante": "4437657",
        "nomeAluno": "Aquiles Gomes Moreira Gigante",
        "nomeContratantecodFilial": "Douglas Gigante"294,
        "cpfAlunocodTipoCurso": "19486970769"1,
        "cpfContratanteNomeNivelEnsino": "12489857703Educação Básica",
        "idServicoCorporativocodContrato": "49079145856",
        "nomeServicoCorporativoidCorporativo": "Ensino Fundamental - Anos Iniciais - 1º ano5073869",
        "dataInicioVigenciaidContratante": "2023-02-09T00:00:004437657",
        "dataFimVigencianomeAluno": "2023-12-08T00:00:00Aquiles Gomes Moreira Gigante",
        "estadoAdimplencianomeContratante": "INDouglas Gigante",
        "dataInicioCompetenciacpfAluno": "2023-02-01T00:00:0019486970769",
        "dataFimCompetenciacpfContratante": "2023-12-01T00:00:0012489857703",
        "dataFinalTurmaidServicoCorporativo": "2023-12-08T00:00:0049079",
        "dataFinalPletivonomeServicoCorporativo": "2023-12-08T00:00:00Ensino Fundamental - Anos Iniciais - 1º ano",
        "TitulosdataInicioVigencia": ["2023-02-09T00:00:00",
        "dataFimVigencia": "2023-12-08T00:00:00",
   {
        "estadoAdimplencia": "IN",
        "$iddataInicioCompetencia": "12023-02-01T00:00:00",
        "dataFimCompetencia": "2023-12-01T00:00:00",
        "codColigadadataFinalTurma": 2"2023-12-08T00:00:00",
        "dataFinalPletivo": "2023-12-08T00:00:00",
        "Titulos": [
            {
                "$id": "1",
                "codColigada": 2,
                "codFilial": 294,
                "codTipoCurso": 1,
                "NomeNivelEnsino": "Educação Básica",
                "codContrato": "145856",
                "idCorporativo": "5073869",
                "idContratante": "4437657",
                "nomeAluno": "Aquiles Gomes Moreira Gigante",
                "nomeContratante": "Douglas Gigante",
                "cpfAluno": "19486970769",
                "cpfContratante": "12489857703",
                "dataVencimento": "2023-03-10T00:00:00",
                "dataRealVencimento": "2023-03-10T00:00:00",
                "nossoNumero": "000004711311",
                "valorTitulo": 736.57,
                "valorMulta": 14.2900,
                "valorJurosMes": 8.0100,
                "numbParcela": 2,
                "statusLan": 0,
                "idBoleto": 471131,
                "idLan": 465195,
                "estadoTitulo": "IN",
                "InternalId": null
            },
            {
                "$id": "2",
                "codColigada": 2,
                "codFilial": 294,
                "codTipoCurso": 1,
                "NomeNivelEnsino": "Educação Básica",
                "codContrato": "145856",
                "idCorporativo": "5073869",
                "idContratante": "4437657",
                "nomeAluno": "Aquiles Gomes Moreira Gigante",
                "nomeContratante": "Douglas Gigante",
                "cpfAluno": "19486970769",
                "cpfContratante": "12489857703",
                "dataVencimento": "2023-04-10T00:00:00",
                "dataRealVencimento": "2023-04-10T00:00:00",
                "nossoNumero": "00000471132P",
                "valorTitulo": 729.27,
                "valorMulta": 14.2900,
                "valorJurosMes": 0.7100,
                "numbParcela": 3,
                "statusLan": 0,
                "idBoleto": 471132,
                "idLan": 465196,
                "estadoTitulo": "IN",
                "InternalId": null
            },
            {
                "$id": "3",
                "codColigada": 2,
                "codFilial": 294,
                "codTipoCurso": 1,
                "NomeNivelEnsino": "Educação Básica",
                "codContrato": "145856",
                "idCorporativo": "5073869",
                "idContratante": "4437657",
                "nomeAluno": "Aquiles Gomes Moreira Gigante",
                "nomeContratante": "Douglas Gigante",
                "cpfAluno": "19486970769",
                "cpfContratante": "12489857703",
                "dataVencimento": "2023-05-10T00:00:00",
                "dataRealVencimento": "2023-05-10T00:00:00",
                "nossoNumero": "000004711338",
                "valorTitulo": 714.27,
                "valorMulta": 0.0,
                "valorJurosMes": 0.0,
                "numbParcela": 4,
                "statusLan": 0,
                "idBoleto": 471133,
                "idLan": 465197,
                "estadoTitulo": "N",
                        "InternalId": null
            }
        ],
        "InternalId": null
    }
]

Content

"InternalId": null
            }
        ],
        "InternalId": null
    }
]

Content

codColigada: Código da Coligada no SGE
codFilial:
codTipoCurso:
NomeNivelEnsino:
codContrato:
idCorporativo:
idContratante:
nomeAluno:
nomeContratante:
cpfAluno:
cpfContratante:
idServicoCorporativo:
nomeServicoCorporativo:
dataInicioVigencia:
dataFimVigencia:
estadoAdimplencia:
dataInicioCompetencia:
dataFimCompetencia:
dataFinalTurma:
dataFinalPletivo:
- Titulos:
  - id:
  - codColigada: Código da Coligada no SGE
  - codFilial:
  - codTipoCurso:
  - NomeNivelEnsino:
  - codContrato:
  - idCorporativo:
  - idContratante:
  - nomeAluno:
  - nomeContratante:
  - cpfAluno:
  - cpfContratante:
  - dataVencimento:
  - dataRealVencimento:
  - nossoNumero:
  - valorTitulo:
  - valorMulta:
  - valorJurosMes:
  - numbParcela:
  - statusLan:
  - idBoleto:
  - idLan:
  - estadoTitulo:

Expandir

title	Consultar Contratos

HTML
<div class="get">GET</div> <div class="endereco">/rm/api/TOTVSCustomizacao/ContratosTitulos/ConsultarContratos</div>

Consulta os contratos através do seu númeroA pesquisa retornará as informações do contrato e de todos os títulos em aberto do contrato retornado. Caso não exista títulos em aberto as informações do contrato deverão ser retornadas.

Tabela Afetada: Nenhuma

Interface RM:

Authorization - Basic Auth

Username <username>

Password <password>

Parameters

codColigada: Código da Coligada no SGE
numeroContrato: Número contrato

Retorno

Bloco de código

language	c#
title	Console

[
    {
        "codColigada": 2,
        "codFilial": 294,
        "codTipoCurso": 1,
        "NomeNivelEnsino": "Educação Básica",
        "codContrato": "145856",
        "idCorporativo": "5073869",
        "idContratante": "4437657",
        "nomeAluno": "Aquiles Gomes Moreira Gigante",
        "nomeContratante": "Douglas Gigante",
        "cpfAluno": "19486970769",
        "cpfContratante": "12489857703",
        "idServicoCorporativo": "49079",
        "nomeServicoCorporativo": "Ensino Fundamental - Anos Iniciais - 1º ano",
        "dataInicioVigencia": "2023-02-09T00:00:00",
        "dataFimVigencia": "2023-12-08T00:00:00",
        "estadoAdimplencia": "IN",
        "dataInicioCompetencia": "2023-02-01T00:00:00",
        "dataFimCompetencia": "2023-12-01T00:00:00",
        "dataFinalTurma": "2023-12-08T00:00:00",
        "dataFinalPletivo": "2023-12-08T00:00:00",
        "Titulos": [
            {
                "$id": "1",
                "codColigada": 2,
                "codFilial": 294,
                "codTipoCurso": 1,
                "NomeNivelEnsino": "Educação Básica",
                "codContrato": "145856",
                "idCorporativo": "5073869",
                "idContratante": "4437657",
                "nomeAluno": "Aquiles Gomes Moreira Gigante",
                "nomeContratante": "Douglas Gigante",
                "cpfAluno": "19486970769",
                "cpfContratante": "12489857703",
                "dataVencimento": "2023-03-10T00:00:00",
                "dataRealVencimento": "2023-03-10T00:00:00",
                "nossoNumero": "000004711311",
                "valorTitulo": 736.57,
                "valorMulta": 14.2900,
                "valorJurosMes": 8.0100,
                "numbParcela": 2,
                "statusLan": 0,
                "idBoleto": 471131,
                "idLan": 465195,
                "estadoTitulo": "IN",
                "InternalId": null
            },
            {
                "$id": "2",
                "codColigada": 2,
                "codFilial": 294,
                "codTipoCurso": 1,
                "NomeNivelEnsino": "Educação Básica",
                "codContrato": "145856",
                "idCorporativo": "5073869",
                "idContratante": "4437657",
                "nomeAluno": "Aquiles Gomes Moreira Gigante",
                "nomeContratante": "Douglas Gigante",
                "cpfAluno": "19486970769",
                "cpfContratante": "12489857703",
                "dataVencimento": "2023-04-10T00:00:00",
                "dataRealVencimento": "2023-04-10T00:00:00",
                "nossoNumero": "00000471132P",
                "valorTitulo": 729.27,
                "valorMulta": 14.2900,
                "valorJurosMes": 0.7100,
                "numbParcela": 3,
                "statusLan": 0,
                "idBoleto": 471132,
                "idLan": 465196,
                "estadoTitulo": "IN",
                "InternalId": null
            },
            {
                "$id": "3",
                "codColigada": 2,
                "codFilial": 294,
                "codTipoCurso": 1,
                "NomeNivelEnsino": "Educação Básica",
                "codContrato": "145856",
                "idCorporativo": "5073869",
                "idContratante": "4437657",
                "nomeAluno": "Aquiles Gomes Moreira Gigante",
                "nomeContratante": "Douglas Gigante",
                "cpfAluno": "19486970769",
                "cpfContratante": "12489857703",
                "dataVencimento": "2023-05-10T00:00:00",
                "dataRealVencimento": "2023-05-10T00:00:00",
                "nossoNumero": "000004711338",
                "valorTitulo": 714.27,
                "valorMulta": 0.0,
                "valorJurosMes": 0.0,
                "numbParcela": 4,
                "statusLan": 0,
                "idBoleto": 471133,
                "idLan": 465197,
                "estadoTitulo": "N",
                "InternalId": null
            }
        ],
        "InternalId": null
    }
]

Content

...

Expandir

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

language	c#
title	Console

"2"

Content

Status:

0 = Ativa
1 = Inativa
2 = Atual

...

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 21

Nova versão 22

Chave

Authorization - Basic Auth

Parameters

Retorno

Authorization - Basic Auth

Parameters

Authorization - Basic Auth

Parameters

Retorno

Retorno

Authorization - Basic Auth

Parameters

Retorno

Authorization - Basic Auth

Parameters

Retorno