Á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

draw.io Diagram
bordertrue
diagramNamefluxo_api_informe
simpleViewerfalse
width
linksauto
tbstyletop
lboxtrue
diagramWidth786
revision3


Endpoint: Consulta de Informe

Caminho: /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": "JoãoJosé Lima da Silva",
  "NumeroDocumentoCliente": "123.456.789-0012345678900",
  "TipoPessoa": "F",
  "Email": "joaojoselima[email protected]",
  "LogradouroCliente": "Av. ClientePrincipal, Bairro123, ClienteCentro, Cidade Cliente - RJUF",
  "CEPCliente": "8765432112345678",
  "ListaFontePagadoraNotaBemEDireito": "Os [
saldos apresentados para fundos {
de investimento referem-se à cotação de fechamento "NomeFontePagadora": "BancoXYZ",
      "DocumentoFontePagadora": "12.ABC.12B/0001-01",
      "ListaAgenciaConta": [
        {
          "Agencia": "0101",
          "NumeroConta": "12345678901234567890-02", 
          "TipoBeneficiario": "Titular", 
          "ListaRendimentosIsentos": [
            {
              "TipoRendimento": "12",
              "Produto": "Rendimento Exemplo", 
              "Valor": "10000,00",
              "Observacao": "Texto livre exemplo" 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",
          "ListaRendimentosTributacaoExclusivaNumeroConta": ["98765-X",
            {
              "TipoRendimento"TipoBeneficiario": "06Titular", 
              "ProdutoListaRendimentosIsentos": "RDB/CDB", [
              "RendimentoBruto": "1000,00",{
              "ImpostoRetidoTipoRendimento": "150,0012", 
              "ValorProduto": "10000,00Caderneta de Poupança", 
              "ObservacaoValor": "Texto livre exemplo2580,40"
            }
          ],
          "ListaBensEDireitosListaRendimentosTributacaoExclusiva": [
            {
              "GrupoTipoRendimento": "01",
              "Codigo": "0011"06",
              "CNPJFundo": "98.765.432/0001-09",
              "Produto": "Bem Exemplo",
              "SaldoEmCotasCompetenciaAnterior": "1234567890,12345678Fundo de Investimento Renda Fixa",
              "SaldoEmCotasCompetenciaAtualRendimentoBruto": "12345678901250,1234567800", 
              "SituacaoCompetênciaAnteriorImpostoRetido": "9000187,0050", 
              "SituacaoAtualValor": "120008500,00",
              "Observacao": "Texto livre exemplo"
            }
          ],
          "ListaDividasEOnusReaisListaBensEDireitos": [
            {
              "CodigoGrupo": "6789004",
              "ProdutoCodigo": "Produto Exemplo01",
              "ContratoCNPJFundo": "123456789012345678901211.222.333/0001-44",
              "DataContratacaoProduto": "2025-03-28",
              "SituacaoAnterior": "5000,00",Fundo de Ações XP Dividendos FIA",
              "SituacaoAtualSaldoEmCotasCompetenciaAnterior": "30001250,001234",
              "PrestacoesPagasPeriodoSaldoEmCotasCompetenciaAtual": "20001300,0056781234",
              "ObservacaoSituacaoCompetênciaAnterior": "Texto livre exemplo"
            }
          ]
        }
      ]
    },
    {
15000,00",
       "NomeFontePagadora": "BancoXYZ Investimentos",
      "DocumentoFontePagadoraSituacaoAtual": "12.123.12A/0001-01",
      "ListaAgenciaConta": [17500,00"
        {
          "Agencia": "0103", }
          "NumeroConta": "127890-02", ],
          "TipoBeneficiario": "Titular", 
          "ListaBensEDireitosListaDividasEOnusReais": [
            {
              "GrupoCodigo": "0211", 
              "CodigoProduto": "0012",Financiamento 
Imobiliário - Banco            "CNPJFundo": "98.222.432/0001-09", Nacional S.A.",
              "ProdutoContrato": "Bem ExemploFIN-IMOB-2023-554433", 
              "SaldoEmCotasCompetenciaAnteriorDataContratacao": "1234567890,123456782023-05-20", 
              "SaldoEmCotasAtualSituacaoAnterior": "1234567890180000,1234567800", 
              "SituacaoCompetênciaAnteriorSituacaoAtual": "9000168000,00",
              "SituacaoAtualPrestacoesPagasPeriodo": "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: /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, ERROAVISO, ERRO_IMPEDITIVO)
    "DescErro": "Erro generico",
    "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"
}