API de Integração
Importação

Listar parcelas enviadas

GET
/importacao/enviados/parcelas
apikey<token>

Chave única da IES para consumir a API/endpoint.

Local: header

Parâmetros de Query

continuable?string

Token para obter próxima página. Se não informado, será retornado a primeira página.

lote?string

Id (código único) do lote em que o registro foi enviado para a API.

aluno_cpf?string

CPF do aluno.

responsavel_financeiro_documento?string

Documento do responsável financeiro.

data_inicial_envio?string

Data inicial de envio no formato: aaaa-mm-dd.

Formatodate-time
data_final_envio?string

Data final de envio no formato: aaaa-mm-dd.

Formatodate-time
id_parcela?string

Id da parcela.

tipo_parcela?string

Tipo da parcela.

situacao_baixa?string

Situação de baixa da parcela.

data_vencimento?string

Data de vencimento no formato: aaaa-mm-dd.

Formatodate-time
codigo_curso?string

Código do curso.

nome_curso?string

Nome do curso.

grau_curso?string

Grau do curso.

modalidade_curso?string

Modalidade do curso.

nome_organizacao?string

Nome da organização.

nome_polo?string

Nome do polo.

id_polo?string

Id do polo.

Corpo da Resposta

application/json

curl -X GET "https://example.com/importacao/enviados/parcelas"
{  "loteId": "BB774789-39A3-41D8-88C9-0581C6F5A6BC",  "dataEnvio": "2023-11-21T14:51:03.486Z",  "dadosEnviados": {    "alunoCpf": "81111724008",    "alunoRa": "RA11724008",    "responsavelFinanceiroTipoDocumento": "CPF",    "responsavelFinanceiroDocumento": "81111724008",    "periodoLetivo": "2023-07-01T00:00:00",    "numeroMatricula": "b1234343",    "codigoTurma": "TEC1234",    "nomeTurma": "Turma A",    "codigoCurso": "Curso123",    "nomeCurso": "Ciencia da Computação",    "grauCurso": "Pós Graduação",    "modalidadeCurso": "EAD",    "idOrganizacao": "2",    "nomeOrganizacao": "Faculdade ABC",    "idPolo": "2",    "nomePolo": "Campus de São Paulo",    "numeroParcela": "123",    "totalParcelas": "6",    "numeroContrato": "12344",    "tipoParcela": "MENSALIDADE",    "valorBoleto": "200.00",    "descontosAdimplencia": [      {        "percentual": 15.25,        "dias_desconto": 15      },      {        "percentual": 10.5,        "dias_desconto": 10      }    ],    "dataVencimento": "2023-05-01T00:00:00",    "situacaoBaixa": "LIQUIDADA",    "descricaoLiquidacao": "Liquidada na Instituição",    "descricao": "Parcela 1",    "descricaoParcela": "Material didático",    "idParcela": "PARC1",    "itensFatura": [      {        "idExterno": "111001",        "alunoCpf": "81111724008",        "alunoRa": "RA11724008",        "alunoNome": "João Carvalho",        "nomeCurso": "Ciência da Computação",        "grauCurso": "Pós Graduação",        "modalidadeCurso": "EAD",        "nomeOrganizacao": "Faculdade ABC",        "nomePolo": "Polo São Paulo",        "numeroParcela": "3",        "tipo": "MENSALIDADE",        "descricao": "Mensalidade 9º ano",        "valor": "350.00",        "descontosAdimplencia": [          {            "percentual": 10,            "valor": "35.00",            "dias_desconto": 15,            "data_limite": "2026-06-05"          }        ]      }    ],    "pagamento": {      "valorRecebido": "223.91",      "valorDesconto": "29.20",      "valorEncargos": "13.98",      "data": "2023-05-01T00:00:00"    }  }}