GET api/Financeiro?codigoAluno={codigoAluno}&nossoNumero={nossoNumero}&CNPJ={CNPJ}&token={token}&codigoEmpresa={codigoEmpresa}&RegistroAluno={RegistroAluno}&CodigoPedido={CodigoPedido}

Método para consultar NF-e do aluno.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
codigoAluno

Código do aluno.

integer

Required

nossoNumero

Nosso numero (indentificador do boleto).

string

Required

CNPJ

Numero do CNPJ da empresa (polo) que receberá as informações.

string

Required

token

Código de acesso à API

string

Required

codigoEmpresa

Código identificador da empresa (polo)

integer

Required

RegistroAluno

Registro do Aluno, para utilização na busca do aluno

string

Default value is

CodigoPedido

Codigo do Pedido no e-Gestão para consulta

integer

Default value is -2147483648

Body Parameters

None.

Response Information

Resource Description

ClasseRetorno
NameDescriptionTypeAdditional information
CodigoRetorno

Código do retorno da API: 0 - erro || 1 - sucesso

integer

None.

MensagemRetorno

Mensagem de retorno da API

string

None.

ValorRetorno

Valor de retorno da API, quando houver

string

None.

ValorRetornoComplementar

Valor de retorno complementar da API, quando houver

string

None.

ValorRetornoComplementar2

Valor de retorno complementar da API, quando houver

string

None.

Response Formats

application/json, text/json

Sample:
{
  "CodigoRetorno": 1,
  "MensagemRetorno": "sample string 2",
  "ValorRetorno": "sample string 3",
  "ValorRetornoComplementar": "sample string 4",
  "ValorRetornoComplementar2": "sample string 5"
}

application/xml, text/xml

Sample:
<ClasseRetorno xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebApi.Models">
  <CodigoRetorno>1</CodigoRetorno>
  <MensagemRetorno>sample string 2</MensagemRetorno>
  <ValorRetorno>sample string 3</ValorRetorno>
  <ValorRetornoComplementar>sample string 4</ValorRetornoComplementar>
  <ValorRetornoComplementar2>sample string 5</ValorRetornoComplementar2>
</ClasseRetorno>