Obter Parcelas originais
Autorização
apikey Chave única da IES para consumir a API/endpoint.
Local: header
Parâmetros de Query
Token para obter próxima página (caso exista).
CPF (ou CNPJ, no caso de empresas) do responsável financeiro. Será informado apenas com números, sem conter ponto “.”, traço “-” ou barra "/".
CPF do aluno. Será informado apenas com números, sem conter ponto “.”, traço “-” ou barra "/".
RA (registro) do aluno.
Id (código único) da parcela original no sistema utilizado pela instituição de ensino. Essa informação deve ser enviada no momento da criação da parcela a fim de que algo seja retornado neste campo.
Número da parcela original.
Situação atual da parcela original. Os possíveis valores são: ABERTO, PARCIALMENTE_PAGO, PAGO, CANCELADO_IES.
Tipo de parcela. Os possíveis valores são: Matricula, Rematricula, Mensalidade, Negociacao, Taxa_outros.
Produto associado à parcela. Os possíveis valores são: Receita Garantida, Gestão.
Dias de atraso da parcela.
Campo que identifica se a parcela original está associada a um acordo. Os possíveis valores são: true, false.
Campo que retorna a situação (status) do acordo, caso a parcela esteja associada a um acordo.
Tipo de pagamento associado às parcelas pagas. Os possíveis valores são: Pago na Principia, Pago na IES, Cancelado na IES.
Data de vencimento inicial para filtros de busca.
date-timeData de vencimento final para filtros de busca.
date-timeData de vencimento inicial para filtros de busca.
date-timeData de vencimento final para filtros de busca.
date-timeCorpo da Resposta
application/json
application/json
application/json
curl -X GET "https://example.com/v1/parcela/originais"{ "data": [ { "id": "1363494196228456447", "id_externo": "ufbra", "ies_id": "66", "ies_nome": "UFBRA", "responsavel_financeiro": { "id": "1502329843623432811", "documento": "12382718743", "nome": "Maria Pereira da Silva" }, "aluno": { "ra": "534241", "cpf": "45382418322", "nome": "José da Silva" }, "contrato_id": "1479231091090379755", "data_vencimento": "2019-09-12", "numero": "4", "valor_principal": 397.5, "valor_adimplencia": 357.5, "situacao": "PAGO", "tipo": "MENSALIDADE", "produto": "Receita Garantida", "curso": "Ciência da Computação", "polo_campus": "Campus São Paulo", "dias_atraso": 0, "em_acordo": true, "acordo_situacao": "ATIVO", "acordo_efetivado_numero": "578321", "acordo_efetivado_id": "1363562196228456275", "saldo_atual": 0, "data_pagamento": "2024-09-09", "tipo_pagamento": "Pago na IES", "valor_liquidado": { "multa": "7.95", "juros": "1.84", "desconto": "0.00", "recebido": "407.29" } } ], "metadata": { "totalItems": "string", "itemsPerPage": 0, "continuable": "string" }}