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

Método para consultar informações financeiras.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
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

Body Parameters

None.

Response Information

Resource Description

Collection of FinanceiroModel
NameDescriptionTypeAdditional information
CodigoAluno

Codigo do aluno.

 integer

None.
Informacoes

Informações dos documentos.

 string

None.
InformacoesAVencer

Informações dos documentos a vencer.

 string

None.
Informacoes12Meses

Informações dos últimos 12 meses.

 string

None.
Documento

CPF / CNPJ do cliente.

 string

None.
TotalDiasAtraso

Total de dias em atraso.

 integer

None.
ValorTitulosAberto

Valor de títulos em aberto.

 decimal number

None.
QuantidadeTitulosAberto

Quantidade de títulos em aberto.

 integer

None.
ValorSaldo

Valor de saldo.

 decimal number

None.
TotalTituloVencido

Valor total de titulos vencidos.

 integer

None.
ValorTotalTituloAVencer

Valor total de titulos a vencer

 decimal number

None.
QuantidadeTotalTituloAVencer

Quantidade total de títulos a vencer.

 integer

None.
CodigoRetorno

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

 integer

None.
MensagemRetorno

Mensagem de retorno da API

 string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "CodigoAluno": 1,
    "Informacoes": "sample string 2",
    "InformacoesAVencer": "sample string 3",
    "Informacoes12Meses": "sample string 4",
    "Documento": "sample string 5",
    "TotalDiasAtraso": 6,
    "ValorTitulosAberto": 7.0,
    "QuantidadeTitulosAberto": 8,
    "ValorSaldo": 9.0,
    "TotalTituloVencido": 10,
    "ValorTotalTituloAVencer": 11.0,
    "QuantidadeTotalTituloAVencer": 12,
    "CodigoRetorno": 13,
    "MensagemRetorno": "sample string 14"
  },
  {
    "CodigoAluno": 1,
    "Informacoes": "sample string 2",
    "InformacoesAVencer": "sample string 3",
    "Informacoes12Meses": "sample string 4",
    "Documento": "sample string 5",
    "TotalDiasAtraso": 6,
    "ValorTitulosAberto": 7.0,
    "QuantidadeTitulosAberto": 8,
    "ValorSaldo": 9.0,
    "TotalTituloVencido": 10,
    "ValorTotalTituloAVencer": 11.0,
    "QuantidadeTotalTituloAVencer": 12,
    "CodigoRetorno": 13,
    "MensagemRetorno": "sample string 14"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfFinanceiroModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebApi.Models">
  <FinanceiroModel>
    <CodigoAluno>1</CodigoAluno>
    <CodigoRetorno>13</CodigoRetorno>
    <Documento>sample string 5</Documento>
    <Informacoes>sample string 2</Informacoes>
    <Informacoes12Meses>sample string 4</Informacoes12Meses>
    <InformacoesAVencer>sample string 3</InformacoesAVencer>
    <MensagemRetorno>sample string 14</MensagemRetorno>
    <QuantidadeTitulosAberto>8</QuantidadeTitulosAberto>
    <QuantidadeTotalTituloAVencer>12</QuantidadeTotalTituloAVencer>
    <TotalDiasAtraso>6</TotalDiasAtraso>
    <TotalTituloVencido>10</TotalTituloVencido>
    <ValorSaldo>9</ValorSaldo>
    <ValorTitulosAberto>7</ValorTitulosAberto>
    <ValorTotalTituloAVencer>11</ValorTotalTituloAVencer>
  </FinanceiroModel>
  <FinanceiroModel>
    <CodigoAluno>1</CodigoAluno>
    <CodigoRetorno>13</CodigoRetorno>
    <Documento>sample string 5</Documento>
    <Informacoes>sample string 2</Informacoes>
    <Informacoes12Meses>sample string 4</Informacoes12Meses>
    <InformacoesAVencer>sample string 3</InformacoesAVencer>
    <MensagemRetorno>sample string 14</MensagemRetorno>
    <QuantidadeTitulosAberto>8</QuantidadeTitulosAberto>
    <QuantidadeTotalTituloAVencer>12</QuantidadeTotalTituloAVencer>
    <TotalDiasAtraso>6</TotalDiasAtraso>
    <TotalTituloVencido>10</TotalTituloVencido>
    <ValorSaldo>9</ValorSaldo>
    <ValorTitulosAberto>7</ValorTitulosAberto>
    <ValorTotalTituloAVencer>11</ValorTotalTituloAVencer>
  </FinanceiroModel>
</ArrayOfFinanceiroModel>