Documentação API - FIRJAN

Este documento tem por objetivo a documentar as API's disponíveis nos projetos da FIRJAN.

Orientações gerais, autenticação e exemplos de consumo das API's.

Consultar Contratos Aluno

GET

/rm/api/TOTVSCustomizacao/ContratosTitulos/ConsultarContratosAluno

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

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: Nome do Nível de Ensino
codContrato: Código do contrato no SGE
idCorporativo: Id Corporativo
idContratante: Id do Contratante
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
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: Data de início de Vigência do contrato
dataFimVigencia: Data de Fim de Vigência do contrato
estadoAdimplencia: Será enviado os seguintes códigos dos estados
- Normal(N): Se todas as parcelas vencidas Estão Pagas
- Sem obrigação(SO): Se não existir lançamentos gerados para as parcelas do contrato
- Sem cobrança(SC): Se não existir parcelas criadas para o contrato
- Inadimplente(IN): Quando existir uma ou mais parcelas vencidas
dataInicioCompetencia: Data de competência Inicial
dataFimCompetencia: Data de competência Final
dataFinalTurma: Data Final da Turma
dataFinalPletivo: Data Final do Período Letivo
- Titulos:
  - id: Id 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: Nome do Nível de Ensino
  - codContrato: Código do contrato no SGE
  - idCorporativo: Id Corporativo
  - idContratante: Id do Contratante
  - 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: Data real do vencimento
  - nossoNumero: Nosso Numero do Lançamento
  - valorTitulo: Valor total do Título(Sem Juros e Multa)
  - valorMulta: Valor de multa por atraso
  - valorJurosMes: Valor de juros ao mês
  - numbParcela: Número de parcelas
  - statusLan: Status do Lançamento
  - idBoleto: Chave única do boleto
  - idLan: Chave única do lançamento
  - estadoTitulo: Estado do Título

Consultar Contratos Responsável Financeiro

GET

/rm/api/TOTVSCustomizacao/ContratosTitulos/ConsultarContratosResFinanceiro

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

Retorno

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: Nome do Nível de Ensino
codContrato: Código do contrato no SGE
idCorporativo: Id Corporativo
idContratante: Id do Contratante
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
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: Data de início de Vigência do contrato
dataFimVigencia: Data de Fim de Vigência do contrato
estadoAdimplencia: Será enviado os seguintes códigos dos estados
- Normal(N): Se todas as parcelas vencidas Estão Pagas
- Sem obrigação(SO): Se não existir lançamentos gerados para as parcelas do contrato
- Sem cobrança(SC): Se não existir parcelas criadas para o contrato
- Inadimplente(IN): Quando existir uma ou mais parcelas vencidas
dataInicioCompetencia: Data de competência Inicial
dataFimCompetencia: Data de competência Final
dataFinalTurma: Data Final da Turma
dataFinalPletivo: Data Final do Período Letivo
- Titulos:
  - id: Id 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: Nome do Nível de Ensino
  - codContrato: Código do contrato no SGE
  - idCorporativo: Id Corporativo
  - idContratante: Id do Contratante
  - 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: Data real do vencimento
  - nossoNumero: Nosso Numero do Lançamento
  - valorTitulo: Valor total do Título(Sem Juros e Multa)
  - valorMulta: Valor de multa por atraso
  - valorJurosMes: Valor de juros ao mês
  - numbParcela: Número de parcelas
  - statusLan: Status do Lançamento
  - idBoleto: Chave única do boleto
  - idLan: Chave única do lançamento
  - estadoTitulo: Estado do Título
    - Normal(N): Se todas as parcelas vencidas Estão Pagas
    - Sem obrigação(SO): Se não existir lançamentos gerados para as parcelas do contrato
    - Sem cobrança(SC): Se não existir parcelas criadas para o contrato
    - Inadimplente(IN): Quando existir uma ou mais parcelas vencidas

Consultar Contratos

GET

/rm/api/TOTVSCustomizacao/ContratosTitulos/ConsultarContratos

A 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

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: Nome do Nível de Ensino
codContrato: Código do contrato no SGE
idCorporativo: Id Corporativo
idContratante: Id do Contratante
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
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: Data de início de Vigência do contrato
dataFimVigencia: Data de Fim de Vigência do contrato
estadoAdimplencia: Será enviado os seguintes códigos dos estados
- Normal(N): Se todas as parcelas vencidas Estão Pagas
- Sem obrigação(SO): Se não existir lançamentos gerados para as parcelas do contrato
- Sem cobrança(SC): Se não existir parcelas criadas para o contrato
- Inadimplente(IN): Quando existir uma ou mais parcelas vencidas
dataInicioCompetencia: Data de competência Inicial
dataFimCompetencia: Data de competência Final
dataFinalTurma: Data Final da Turma
dataFinalPletivo: Data Final do Período Letivo
- Titulos:
  - id: Id 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: Nome do Nível de Ensino
  - codContrato: Código do contrato no SGE
  - idCorporativo: Id Corporativo
  - idContratante: Id do Contratante
  - 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: Data real do vencimento
  - nossoNumero: Nosso Numero do Lançamento
  - valorTitulo: Valor total do Título(Sem Juros e Multa)
  - valorMulta: Valor de multa por atraso
  - valorJurosMes: Valor de juros ao mês
  - numbParcela: Número de parcelas
  - statusLan: Status do Lançamento
  - idBoleto: Chave única do boleto
  - idLan: Chave única do lançamento
  - estadoTitulo: Estado do Título
    - Normal(N): Se todas as parcelas vencidas Estão Pagas
    - Sem obrigação(SO): Se não existir lançamentos gerados para as parcelas do contrato
    - Sem cobrança(SC): Se não existir parcelas criadas para o contrato
    - Inadimplente(IN): Quando existir uma ou mais parcelas vencidas

Consultar Contratos Nosso Numb

GET

/rm/api/TOTVSCustomizacao/ContratosTitulos/ConsultarContratosNossoNumb

Consulta os contratos através do seu número

Tabela Afetada: Nenhuma

Interface RM:

Authorization - Basic Auth

Username <username>

Password <password>

Parameters

codColigada: Código da Coligada no SGE
nossoNumero: Nosso Numero do lançamento

Retorno

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
            }
        ],
        "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: Nome do Nível de Ensino
codContrato: Código do contrato no SGE
idCorporativo: Id Corporativo
idContratante: Id do Contratante
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
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: Data de início de Vigência do contrato
dataFimVigencia: Data de Fim de Vigência do contrato
estadoAdimplencia: Será enviado os seguintes códigos dos estados
- Normal(N): Se todas as parcelas vencidas Estão Pagas
- Sem obrigação(SO): Se não existir lançamentos gerados para as parcelas do contrato
- Sem cobrança(SC): Se não existir parcelas criadas para o contrato
- Inadimplente(IN): Quando existir uma ou mais parcelas vencidas
dataInicioCompetencia: Data de competência Inicial
dataFimCompetencia: Data de competência Final
dataFinalTurma: Data Final da Turma
dataFinalPletivo: Data Final do Período Letivo
- Titulos:
  - id: Id 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: Nome do Nível de Ensino
  - codContrato: Código do contrato no SGE
  - idCorporativo: Id Corporativo
  - idContratante: Id do Contratante
  - 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: Data real do vencimento
  - nossoNumero: Nosso Numero do Lançamento
  - valorTitulo: Valor total do Título(Sem Juros e Multa)
  - valorMulta: Valor de multa por atraso
  - valorJurosMes: Valor de juros ao mês
  - numbParcela: Número de parcelas
  - statusLan: Status do Lançamento
  - idBoleto: Chave única do boleto
  - idLan: Chave única do lançamento
  - estadoTitulo: Estado do Título
    - Normal(N): Se todas as parcelas vencidas Estão Pagas
    - Sem obrigação(SO): Se não existir lançamentos gerados para as parcelas do contrato
    - Sem cobrança(SC): Se não existir parcelas criadas para o contrato
    - Inadimplente(IN): Quando existir uma ou mais parcelas vencidas

Baixa Titulos Contratos

POST

/rm/api/TOTVSCustomizacao/ContratosTitulos/BaixaTitulosContratos

Realiza a baixa de titulos do SGE e realiza a integração com o Tecnotime.

Ao executar a chamada do webservice, se for inclusão de um serviço novo, o método irá:

Realizar a baixa do titulo no SGE:
- Buscar os dados da Conta Caixa no SGE, seja a passada na requisição ou caso não seja passada no parametro de Conta Caixa PDV (Anexo do Cadastro de Filial);
- Valida os dados da Conta Caixa;
- Valida se foi informado os dados de Motivo da Baixa;
- Valida se o lançamento existe no SGE;
- Preenche os dados da forma de pagamento da Baixa;
Realizar a integração da baixa do titulo com o Tecnotime.
- Com base nos dados do lançamento realiza a integração com o Tecnotime pela base de dados informada na tela Parametros Tecnotime (Educacional | Customização) no SGE;

Tabela Afetada: FLAN, FLANBAIXA

Interface RM: TOTVS BackOffice | Gestaçao Financeira | Lançamentos | Processos | Baixa

Authorization - Basic Auth

Username <username>

Password <password>

Body

Raw

[
    {   
		"codColigada": 3,
        "codFilial": 471,
        "codTipoCurso": 1,
        "idLan": 1904,
        "nossoNumero": "012121",
        "motivoBaixa": 
        [
            { 
            "motivoBaixa":"DIS", 
            "valorBaixa": 100.0,
			"coligadaContaCaixa": 3,
        	"contaCaixa": "58"             
			},
			{ 
            "motivoBaixa":"PIX", 
            "valorBaixa": 100.0,
			"coligadaContaCaixa": 3,
        	"contaCaixa": "60"             
			}         
		],
        "dataBaixa": "2023-01-18",
        "dataVencimento": "2022-12-20",
        "valorTotal": 200.0,
        "valorMulta": 0.0,
        "valorJuros": 0.0   
	}
]

Content

codColigada: Código da Coligada no SGE.
codFilial: Código da Filial do Lançamento no SGE;
codTipoCurso: Nivel de Ensino no SGE;
idLan: Identificador do Lançamento no SGE;
nossoNumero: Nosso Numero do Lançamento;
motivoBaixa: Lista com os dados de MotivoBaixa: Codigo da tabela dinamica (BXPROTHEUS) que indica a forma de pagamento do protheus, ValorBaixa, coligadaContaCaixa e contaCaixa, para informar a conta caixa separadamente em cada forma de pagamento do lançamento, caso a mesma não seja informada será utilizado a conta caixa do parametro;
dataBaixa: Data da Baixa do Lançamento;
dataVencimento: Data de Vencimento do Lançamento;
valorTotal: Valor Total do Lançamento.
valorMulta: Valor da Multa do Lançamento.
valorJuros: 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

Console

{
   	"codColigada": 3,
   	"idLan": 12,
   	"nossoNumero": "200121",
	"statusErro": 0,
	"Erros": [{ "mensagemErro": null, "codigoErro": null }],
	"numbRPS": 10,
	"serieRPS": "1",
	"filialRPS": 10
}

Content

codColigada: Codigo da Coligada do lançamento;
idLan: IdLan do lançamento baixado;
nossoNumero: Nosso Numero do lançamento;
statusErro: 0 - Sucesso, 1 - Erro;
Erros: Lista de erros ocorridos na baixa do lançamento, composto por mensagemErro: Descrição do erro ocorrido e codigoErro: 1 - Motivo Baixa não informado, 2 - Conta Caixa SGE ou PDV não informada, 3 - Total liguido do lançamento diferente do valor total pago, 4 - Numero de RPS não gerado, 5 - Baixa não realizada, 6 - Forma de pagamento inválida, 7 - Lançamento não encontrado no SGE, 8 - Motivo Baixa não cadastrado, 9 - Erro na integração Tecnotime;
numbRPS: Numero do RPS da integração Tecnotime;
serieRPS: Serie do RPS da integração Tecnotime;
filialRPS: Filial do RPS da integração Tecnotime;

Alterar Informações Contábeis

PUT

/rm/api/TOTVSCustomizacao/MatrizCurriculares/AlterarInformacoesContabies

Consulta Contrato de um Aluno

Tabela Afetada:

Interface RM:

Authorization - Basic Auth

Username <username>

Password <password>

Body

Console

{
  "CodColigada": 2,
  "CodCurso": "",
  "CodHabilitacao": "",
  "CodGrade": "",
  "ItemContabil": "",
  "DtInicioItemContabil": "2023-04-13T18:36:06.583Z",
  "DtFimItemContabil": "2023-04-13T18:36:06.583Z",
  "ContaContabil": "",
  "DtInicioContaContabil": "2023-04-13T18:36:06.583Z",
  "DtFimContaContabil": "2023-04-13T18:36:06.583Z",
  "IdServico": 0,
  "DescServico": ""
}

Content

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)
ItemContabil: Código Item Contábil
DtInicioItemContabil: Data Inicio do Item Contábil
DtFimItemContabil: Data Final do Item Contábil
ContaContabil: Código Conta Contábil
DtInicioContaContabil: Data Inicio da Conta Contábil
DtFimContaContabil: Data Final da Conta Contábil
IdServico: Código do Serviço
DescServico: Descrição do Serviço

Retorno

Console

{
"Message": "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;

Consultar Status

GET

/rm/api/TOTVSCustomizacao/MatrizCurriculares/ConsultarStatus

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

Console

"2"

Content

Status:

0 = Ativa
1 = Inativa
2 = Atual

Atualizar Pessoa

PUT

/rm/api/TOTVSCustomizacao/Pessoas/AtualizarPessoa

Consulta Contrato de um Aluno

Tabela Afetada:

Interface RM:

Authorization - Basic Auth

Username <username>

Password <password>

Body

Raw

[     
	{
  		"ID": 0,
  		"CodPessoa": 0,
  		"Nome": "string",
  		"DataNascimento": "2023-04-11T17:46:24.482Z",
  		"EstadoCivil": "string",
 		"Sexo": "string",
  		"Cor": 0,
  		"NomeMae": "string",
  		"NomePai": "string",
  		"CPF": "string",
 		"Identidade": "string",
 		"OrgaoEmissor": "string",
 		"DataEmissao": "2023-04-11T17:46:24.482Z",
		"TituloEleitor": "string",
		"Passaporte": "string",
 		"Nacionalidade": "string",
 		"CidadeEnder": "string",
		"BairroEnder": "string",
		"UFEnder": "string",
  		"Estrangeiro": "string",
  		"Email": "string",
  		"DDD": "string",
  		"Telefone": "string",
  		"DDDCelular": "string",
  		"Celular": "string",
  		"Logradouro": "string",
  		"Complemento": "string",
  		"Numero": "string",
  		"CEP": "string",
  		"Municipio_IBGE": "string",
  		"TipoBeneficiario": "string",
  		"CodFilial": 0,
  		"CodUsuario": "string",
  		"IdCorporativo": 0,
  		"GrauInstrucao": "string",
  		"Matricula": "string",
  		"PaisNacionalidade": "string",
  		"EstadoNatal": "string",
  		"MunicipioNatal": "string",
  		"CodigoCliente": "string",
  		"FilialCliente": "string",
  		"TipoCliente": "string"
	} 
]

Retorno

Console

{
"Message": "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;

Atualizar Responsável Financeiro

PUT

/rm/api/TOTVSCustomizacao/Pessoas/AtualizarResponsavelFinanceiro

Consulta Contrato de um Aluno

Tabela Afetada:

Interface RM:

Authorization - Basic Auth

Username <username>

Password <password>

Body

Raw

[     
	{
  		"ID": 0,
  		"CodPessoa": 0,
  		"Nome": "string",
  		"DataNascimento": "2023-04-11T17:46:24.482Z",
  		"EstadoCivil": "string",
 		"Sexo": "string",
  		"Cor": 0,
  		"NomeMae": "string",
  		"NomePai": "string",
  		"CPF": "string",
 		"Identidade": "string",
 		"OrgaoEmissor": "string",
 		"DataEmissao": "2023-04-11T17:46:24.482Z",
		"TituloEleitor": "string",
		"Passaporte": "string",
 		"Nacionalidade": "string",
 		"CidadeEnder": "string",
		"BairroEnder": "string",
		"UFEnder": "string",
  		"Estrangeiro": "string",
  		"Email": "string",
  		"DDD": "string",
  		"Telefone": "string",
  		"DDDCelular": "string",
  		"Celular": "string",
  		"Logradouro": "string",
  		"Complemento": "string",
  		"Numero": "string",
  		"CEP": "string",
  		"Municipio_IBGE": "string",
  		"TipoBeneficiario": "string",
  		"CodFilial": 0,
  		"CodUsuario": "string",
  		"IdCorporativo": 0,
  		"GrauInstrucao": "string",
  		"Matricula": "string",
  		"PaisNacionalidade": "string",
  		"EstadoNatal": "string",
  		"MunicipioNatal": "string",
  		"CodigoCliente": "string",
  		"FilialCliente": "string",
  		"TipoCliente": "string"
	} 
]

Retorno

Console

{
"Message": "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;

Atalhos

Páginas filhas

Authorization - Basic Auth

Parameters

Retorno

Authorization - Basic Auth

Parameters

Retorno

Authorization - Basic Auth

Parameters

Retorno

Authorization - Basic Auth

Parameters

Retorno

Authorization - Basic Auth

Body

Retorno

Authorization - Basic Auth

Body

Retorno

Authorization - Basic Auth

Parameters

Retorno

Authorization - Basic Auth

Body

Retorno

Authorization - Basic Auth

Body

Retorno