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

Fluxo de utilização de API

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)
  • periodo: A (anual), T (trimestral), M (mensal)

Retornos

200 - Ok

Content Type: application/json

Corpo

{
  "NomeCliente": "João Silva",
  "NumeroDocumentoCliente": "123.456.789-00",
  "TipoPessoa": "F",
  "Email": "[email protected]",
  "LogradouroCliente": "Av. Cliente, Bairro Cliente, Cidade Cliente - RJ",
  "CEPCliente": "87654321",
  "ListaFontePagadora": [
    {
      "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" 
            }
          ],
          "ListaRendimentosTributacaoExclusiva": [
            {
              "TipoRendimento": "06", 
              "Produto": "RDB/CDB", 
              "RendimentoBruto": "1000,00",
              "ImpostoRetido": "150,00", 
              "Valor": "10000,00", 
              "Observacao": "Texto livre exemplo"
            }
          ],
          "ListaBensEDireitos": [
            {
              "Grupo": "01",
              "Codigo": "0011",
              "CNPJFundo": "98.765.432/0001-09",
              "Produto": "Bem Exemplo",
              "SaldoEmCotasCompetenciaAnterior": "1234567890,12345678",
              "SaldoEmCotasCompetenciaAtual": "1234567890,12345678", 
              "SituacaoCompetênciaAnterior": "9000,00", 
              "SituacaoAtual": "12000,00",
              "Observacao": "Texto livre exemplo"
            }
          ],
          "ListaDividasEOnusReais": [
            {
              "Codigo": "67890",
              "Produto": "Produto Exemplo",
              "Contrato": "1234567890123456789012",
              "DataContratacao": "2025-03-28",
              "SituacaoAnterior": "5000,00",
              "SituacaoAtual": "3000,00",
              "PrestacoesPagasPeriodo": "2000,00",
              "Observacao": "Texto livre exemplo"
            }
          ]
        }
      ]
    },
    {
      "NomeFontePagadora": "BancoXYZ Investimentos",
      "DocumentoFontePagadora": "12.123.12A/0001-01",
      "ListaAgenciaConta": [
        {
          "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" 
            }
          ]
        }
      ]
    }
  ]
}

500 - Erro Interno

Content Type: application/json

Corpo:

{
  "status": 0,
  "error": "string",
  "message": "string"
}

40X - Erro Requisição

Content Type: application/json

Corpo:

{
  "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


200 - Ok

Corpo

{
    "NomeArquivo": "arquivo202512_cf.json", 
    "Status": "ERRO",  // ENUM (SUCESSO, ERRO, INICIADO, A PROCESSAR)
    "DescErro": "Erro generico",
    "QtdSucesso": 90,
    "QtdErro": 10,
    "QtdTotal": 100
}

40X - Erro Requisição

Content Type: application/json

Corpo:

{
  "status": 0,
  "error": "string",
  "message": "string"
}

500 - Erro Interno

Content Type: application/json

Corpo:

{
  "status": 0,
  "error": "string",
  "message": "string"
}