Á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: 0309 

Fluxo de utilização de API

draw.io Diagrambordertrue

diagramNamefluxo_api_informesimpleViewerfalsewidthlinksautotbstyletoplboxtruediagramWidth760revision1

Endpoint: Consulta de Informe

Caminho: /api/v1/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), M (mensal)
  • 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 - RJ-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.",
  "CEPClienteNotaRendimentoTributacaoExclusiva": "87654321O 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": "BancoXYZBanco XPTO S.A.",
      "DocumentoFontePagadora": "12.ABC345.12B678/0001-0199",
      "ListaAgenciaConta": [
        {
          "Agencia": "01013322-1",
          "NumeroConta": "1234567890123456789098765-02X", 
          "TipoBeneficiario": "Titular", 
          "ListaRendimentosIsentos": [
            {
              "TipoRendimento": "12",
              "Produto": "RendimentoCaderneta de ExemploPoupança", 
              "Valor": "100002580,0040",
              "Observacao": "Texto livre exemplo" 
            }
          ],
          "ListaRendimentosTributacaoExclusiva": [
            {
              "TipoRendimento": "06", 
              "Produto": "RDB/CDBFundo de Investimento Renda Fixa", 
              "RendimentoBruto": "10001250,00",
              "ImpostoRetido": "150187,0050", 
              "Valor": "100008500,00", 
              "Observacao": "Texto livre exemplo"
            }
          ],
          "ListaBensEDireitos": [
            {
              "Grupo": "0104",
              "Codigo": "001101",
              "CNPJFundo": "9811.765222.432333/0001-0944",
              "Produto": "Bem ExemploFundo de Ações XP Dividendos FIA",
              "SaldoEmCotasCompetenciaAnterior": "12345678901250,123456781234",
              "SaldoEmCotasCompetenciaAtual": "12345678901300,1234567856781234", 
              "SituacaoCompetênciaAnterior": "900015000,00", 
              "SituacaoAtual": "1200017500,00",
              "Observacao": "Texto livre exemplo"
            }
          ],
          "ListaDividasEOnusReais": [
            {
              "Codigo": "6789011",
              "Produto": "Produto ExemploFinanciamento Imobiliário - Banco Nacional S.A.",
              "Contrato": "1234567890123456789012FIN-IMOB-2023-554433",
              "DataContratacao": "20252023-0305-2820",
              "SituacaoAnterior": "5000180000,00",
              "SituacaoAtual": "3000168000,00",
              "PrestacoesPagasPeriodo": "200012000,00",
              "Observacao": "Texto livre exemplo"
            }
          ]
        }
      ]
    },
    ]
}  
Painel
borderColorgray
titleErro Interno

500 - Erro Interno

Content Type: application/json

Corpo:

Bloco de código
languagejs
{
  
"
NomeFontePagadora
status": 
"BancoXYZ Investimentos"
0,
  "
DocumentoFontePagadora
error": "
12.123.12A/0001-01
string",
  
"
ListaAgenciaConta
message": 
[ { "Agencia": "0103", "NumeroConta": "127890-02", "TipoBeneficiario": "Titular", "ListaBensEDireitos": [ { "Grupo": "02", "Codigo": "0012", "CNPJFundo": "98.222.432/0001-09", "Produto": "Bem Exemplo", "SaldoEmCotasCompetenciaAnterior": "1234567890,12345678", "SaldoEmCotasAtual": "1234567890,12345678", "SituacaoCompetênciaAnterior": "9000,00", "SituacaoAtual": "12000,00" } ] } ] } ] }
"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
Interno
Requisição
500

40X - Erro

Interno

Requisição

Content Type: application/json

Corpo:

Bloco de código
languagejs
{
  "status": 0,
  "error": "string",
  "message": "string"
}
Painel
borderColorgray
titleErro
Requisição
Interno
40X

500 - Erro

Requisição

Interno

Content Type: application/json

Corpo:

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

Endpoint: Consulta

Status

erros Importação

Caminho:/api/v1/informe/relatorio/importacaoerro

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
[
    {
    "NomeArquivoNomeDeclarante": "202512_CF_00001.jsonNome Sobrenome", 
    "StatusDocumentoDeclarante": 1, 
    "ERROMensagem",: "Erro //ao ENUMprocessar (INICIADO, SUCESSO, ERRO, ERRO_IMPEDITIVO)fonte pagadora",
    "DescErroTipoEscopoErro": "Erro genericoFONTE_PAGADORA",
    "QtdSucessoCampoErro": 90,"id_fte_pag", // Campo de objeto que retornou erro
    "QtdErroChaveErro": 10,1, // Chave de objeto que retornou erro
    "QtdTotalChaveProcesso": 1001
    }
]
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"
}