Dimensa Core Banking

Árvore de páginas

Versões comparadas

Versão antiga 15

changes.mady.by.user Vitor Yuta Takatsuki

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Vitor Yuta Takatsuki

Gravado em

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: 2608 

Fluxo de utilização de API

draw.io DiagrambordertruediagramNamefluxo_api_informesimpleViewerfalsewidthlinksautotbstyle

toplboxtruediagramWidth760revision1

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ão
José Lima da Silva",
  "NumeroDocumentoCliente": "
123.456.789-00
12345678900",
  "TipoPessoa": "F",
  "Email": "
joao
joselima[email protected]",
  "LogradouroCliente": "Av.
Cliente
Principal,
Bairro
123,
Cliente
Centro, 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.",
  "
CEPCliente
NotaRendimentoTributacaoExclusiva": "
87654321
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": "
BancoXYZ
Banco XPTO S.A.",
      "DocumentoFontePagadora": "12.
ABC
345.
12B
678/0001-
01
99",
      "ListaAgenciaConta": [
        {
          "Agencia": "
0101
3322-1",
          "NumeroConta": "
12345678901234567890
98765-
02
X",

          "TipoBeneficiario": "Titular",

          "ListaRendimentosIsentos": [
            {
              "TipoRendimento": "12",
              "Produto": "
Rendimento
Caderneta de
Exemplo
Poupança",

              "Valor": "
10000
2580,
00
40"
,
"Observacao":
"Texto
livre
exemplo" 
}
          ],
          "ListaRendimentosTributacaoExclusiva": [
            {
              "TipoRendimento": "06",

              "Produto": "
RDB/CDB
Fundo de Investimento Renda Fixa",

              "RendimentoBruto": "
1000
1250,00",
              "ImpostoRetido": "
150
187,
00
50",

              "Valor": "
10000
8500,00"
,
"Observacao":
"Texto
livre
exemplo" 
    
}
          ],
          "ListaBensEDireitos": [
            {
              "Grupo": "
01
04",
              "Codigo": "
0011
01",
              "CNPJFundo": "
98
11.
765
222.
432
333/0001-
09
44",
              "Produto": "
Bem Exemplo
Fundo de Ações XP Dividendos FIA",
              "SaldoEmCotasCompetenciaAnterior": "
1234567890
1250,
12345678
1234",
              "SaldoEmCotasCompetenciaAtual": "
1234567890
1300,
12345678
56781234",

              "SituacaoCompetênciaAnterior": "
9000
15000,00",

              "SituacaoAtual": "
12000
17500,00
", "Observacao": "Texto livre exemplo
"
            }
          ],
          "ListaDividasEOnusReais": [
            {
              "Codigo": "
67890
11",
              "Produto": "
Produto Exemplo
Financiamento Imobiliário - Banco Nacional S.A.",
              "Contrato": "
1234567890123456789012
FIN-IMOB-2023-554433",
              "DataContratacao": "
2025
2023-
03
05-
28
20",
              "SituacaoAnterior": "
5000
180000,00",
              "SituacaoAtual": "
3000
168000,00",
              "PrestacoesPagasPeriodo": "
2000
12000,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": "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
  }
]
[ { "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" } ] } ] } ] } 
 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 
 Status 
erros Importação
Endpoint
Caminho: /api/v1/informe/relatorio/
importacao
erro
Método: GET
Content Type: JSON
QueryString:
  • nomeArq: nome do arquivo
expand
  • 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
[
    {
    "
NomeArquivo
NomeDeclarante": "
arquivo202512_cf.json
Nome Sobrenome", 
    "
Status
DocumentoDeclarante": 
"ERRO",
1, 
   
// ENUM (SUCESSO, ERRO, INICIADO, A PROCESSAR)
 "Mensagem": "Erro ao processar fonte pagadora",
    "
DescErro
TipoEscopoErro": "
Erro generico
FONTE_PAGADORA",
    "
QtdSucesso
CampoErro": 
90,
"id_fte_pag", // Campo de objeto que retornou erro
    "
QtdErro
ChaveErro": 
10,
1, // Chave de objeto que retornou erro
    "
QtdTotal
ChaveProcesso": 
100
1
    }
]
 Painel
Retornos
202 - Aceito: Processamento assíncrono Iniciado
Content Type: text/plain
A DEFINIR
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"
}