Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Nota

Api em construção e sujeita a alterações
Ultima alteração em:

...

...

 

Fluxo de utilização de API

...

Endpoint: Consulta de Informe

Caminho: /api/v1/

...

Consulta de informe

...

informe

Método: GET
Content Type:
JSON (application/json) ou PDF (application/pdf)

  • Será alterado dependendo do header Accept

QueryString:

  • numeroDocumento: CPF ou CNPJ cliente
  • competencia: competência (MMAAAA) - Para anual, enviar mês "13"
  • periodo: A (anual), T (trimestral

...

  • )

...

  • empresa: código de empresa

Retornos

Painel
borderColorgray
titleSucesso

200 - Ok

Content Type: application/json

Corpo

Expandir
titleMostrar JSON...
Bloco de código
languagejs
{
  "NomeCliente": "

...

José Lima da Silva",
  "NumeroDocumentoCliente": "

...

12345678900",
  "TipoPessoa": "F",
  "Email": "

...

joselima[email protected]",
  "LogradouroCliente": "Av. 

...

Principal, 

...

123, 

...

Centro, Cidade

...

-UF",
  "CEPCliente": "12345678",
  "NotaBemEDireito": "Os saldos apresentados para fundos de investimento referem-se à cotação de fechamento de 31/12/2025. Para outros ativos, consultar o extrato detalhado.",
  "NotaDividaOnusReal": "O saldo devedor do financiamento imobiliário refere-se ao valor principal remanescente em 31/12/2025, não incluindo juros futuros.",
  "NotaRendimentoIsento": "Rendimentos de caderneta de poupança são isentos de Imposto de Renda conforme a Lei nº 8.981/95.",
  "

...

NotaRendimentoTributacaoExclusiva": "

...

O Imposto de Renda sobre aplicações de Renda Fixa (CDB, RDB) é retido pela instituição no momento do resgate ou vencimento, conforme a tabela regressiva.",
  "ListaFontePagadora": [
    {
      "NomeFontePagadora": "

...

Banco XPTO S.A.",
      "DocumentoFontePagadora": "12.

...

345.

...

678/0001-

...

99",
      "ListaAgenciaConta": [
        {
          "Agencia": "

...

3322-1",
          "NumeroConta": "

...

98765-

...

X",

...


          "TipoBeneficiario": "Titular",

...


          "ListaRendimentosIsentos": [
            {
              "TipoRendimento": "12",
              "Produto": "

...

Caderneta de 

...

Poupança",

...


              "Valor": "

...

2580,

...

40"

...


           

...

 

...

}
          ],
          "ListaRendimentosTributacaoExclusiva": [
            {
              "TipoRendimento": "06",

...


              "Produto": "

...

Fundo de Investimento Renda Fixa",

...


              "RendimentoBruto": "

...

1250,00",
              "ImpostoRetido": "

...

187,

...

50",

...


              "Valor": "

...

8500,00"

...


...

       

...

 

...

 

...

 

...

  

...

}
          ],
          "ListaBensEDireitos": [
            {
              "Grupo": "

...

04",
              "Codigo": "

...

01",
              "CNPJFundo": "

...

11.

...

222.

...

333/0001-

...

44",
              "Produto": "

...

Fundo de Ações XP Dividendos FIA",
              "SaldoEmCotasCompetenciaAnterior": "

...

1250,

...

1234",
              "SaldoEmCotasCompetenciaAtual": "

...

1300,

...

56781234",

...


              "SituacaoCompetênciaAnterior": "

...

15000,00",

...


              "SituacaoAtual": "

...

17500,00"

...


            

...

}
          ],
          "ListaDividasEOnusReais": [
            {
              "Codigo": "

...

11",
              "Produto": "

...

Financiamento Imobiliário - Banco Nacional S.A.",
              "Contrato": "

...

FIN-IMOB-2023-554433",
              "DataContratacao": "

...

2023-

...

05-

...

20",
              "SituacaoAnterior": "

...

180000,00",
              "SituacaoAtual": "

...

168000,00",
              "PrestacoesPagasPeriodo": "

...

12000,00

...

"

...


            }
          ]
        }
      ]
    }

...


  

...

]
}  
Painel
borderColorgray
titleErro Interno

500 - Erro Interno

Content Type: application/json

Corpo:

Bloco de código
languagejs
{
  "status": 0,
  "error": "string",
  

...

"

...

message": 

...

"string"
}
Painel
borderColorgray
titleErro Requisição

40X - Erro Requisição

Content Type: application/json

Corpo:

Bloco de código
languagejs
{
  

...

"status": 

...

0,

...


...

  

...

"

...

error": "

...

string",

...


  

...

"message": "

...

string"

...


}




Endpoint: Consulta Status Importação

Caminho: /api/v1/informe/importacao

Método: GET
Content Type:
JSON

QueryString:

  • nomeArq: nome do arquivo


Painel
borderColorgray
titleErro Interno

200 - Ok

Content Type: application/json

Corpo

Bloco de código
languagejs
[
  {
    "NomeArquivo": "202512_CF_00001.json",
    "Status": "ERRO",  // ENUM (INICIADO, SUCESSO, AVISO, ERRO_IMPEDITIVO)
    "QtdSucesso": 90,
    "QtdErro": 10,
    "QtdTotal": 100
  }
]
Painel
borderColorgray
titleErro Requisição

40X - Erro

Requisição

Content Type: application/json

Corpo:

Bloco de código
languagejs
{
  "status": 0,
  "error": "string",
  "message": "string"
}
Painel
borderColorgray
titleErro Interno

500 - Erro Interno

Content Type: application/json

Corpo:

Bloco de código
languagejs
{
  "status": 0,
  "error": "string",
  "message": "string"
}

Endpoint: Consulta

...

erros Importação

...

Caminho: /api/v1/informe/relatorio/

...

erro

Método: GET
Content Type:
JSON

QueryString:

  • nomeArq: nome do arquivo

...

  • tipoProcesso: Informar "I" para importação
  • page: página da paginação
  • size: tamanho de página
Painel
borderColorgray
titleErro Interno

200 - Ok

Content Type: application/json

Corpo

Bloco de código
languagejs
[
    {
    "

...

NomeDeclarante": "

...

Nome Sobrenome", 
    "

...

DocumentoDeclarante": 

...

1, 
 

...

   "Mensagem": "Erro ao processar fonte pagadora",
    "

...

TipoEscopoErro": "

...

FONTE_PAGADORA",
    "

...

CampoErro": 

...

"id_fte_pag", // Campo de objeto que retornou erro
    "

...

ChaveErro": 

...

1, // Chave de objeto que retornou erro
    "

...

ChaveProcesso": 

...

1
    }
]
Painel

Retornos

202 - Aceito: Processamento assíncrono Iniciado

Content Type: text/plain

...

borderColorgray
titleErro Requisição

40X - Erro

...

Requisição

Content Type: application/json

Corpo:

Bloco de código
languagejs
{
  "status": 0,
  "error": "string",
  "message": "string"
}
Painel
borderColorgray
titleErro Interno

500 - Erro Interno

Content Type: application/json

Corpo:

Bloco de código
languagejs
{
  "status": 0,
  "error": "string",
  "message": "string"
}