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>

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: O ID corporativo do cliente/fornecedor

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

codColigada: Código da Coligada no SGE
codFilial: Código da Filial do Lançamento no SGE
codTipoCurso: Nivel de Ensino no SGE
NomeNivelEnsino:
codContrato:
idCorporativo:
idContratante:
nomeAluno:
nomeContratante:
cpfAluno:
cpfContratante:
idServicoCorporativo: ID do serviço, localizado no anexo “Dados do Curso” do cadastro de matriz curricular
nomeServicoCorporativo: Descrição da matriz curricular, localizado no anexo “Dados do Curso” do cadastro de matriz curricular
dataInicioVigencia:
dataFimVigencia:
estadoAdimplencia: Será enviado os seguintes códigos dos estados
- Normal(N)
- Sem obrigação(SO):
- Sem cobrança(SC):
- Inadimplente(IN):
dataInicioCompetencia:
dataFimCompetencia:
dataFinalTurma:
dataFinalPletivo:
- Titulos:
  - id: Chave única do lançamentoId sequencial da lista de títulos
  - codColigada: Código da Coligada no SGE
  - codFilial: Código da Filial do Lançamento no SGE
  - codTipoCurso: Nivel de Ensino no SGE
  - NomeNivelEnsino:
  - codContrato: Código do contrato no SGE
  - idCorporativo:
  - idContratante:
  - nomeAluno: Nome do Aluno no SGE
  - nomeContratante: Nome do Responsável do contrato no SGE
  - cpfAluno: CPF do Aluno no SGE
  - cpfContratante: CPF do Responsável do contrato no SGE
  - dataVencimento: Data de Vencimento do Lançamento
  - dataRealVencimento:
  - nossoNumero: Nosso Numero do Lançamento
  - valorTitulo:
  - valorMulta: Valor da Multa do Lançamento
  - valorJurosMes:
  - numbParcela:
  - statusLan:
  - idBoleto: Chave única do boleto
  - idLan: Chave única do lançamento
  - 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,
        "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

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:

...

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 26

Nova versão 27

Chave

Authorization - Basic Auth

Parameters

Retorno

Authorization - Basic Auth

Parameters

Retorno