Atualizado em
Descreveremos nesta pagina o detalhamento de todas as APIs que serão utilizadas pelo Rating Service
API Recalculo: Esta API será utilizada para informar os dados que impactam no calculo das provisões de perdas, alteração de classificação, etc. Existem 3 tipos de comandadas:
A API somente poderá ser executada se a situação da interface estive como FINALIZADA
Operação: Utilizada para alteração das operações (instrumentos financeiros)
Parâmetros de chamada:
Empresa
Data Movimento no formato AAAAMM
IPOC da Operação - Deverá existir na base de dados do Rating na competência e interface informada - ou chave do contrato formada por código cliente, numero contrato, modalidade e Adlib.
Comandada = O
Informações a serem alteradas:
Classificação Contábil do Instrumento Financeiro: conforme anexo 40 do 3040, valores possíveis 1,2 ou 3
Estágio do Instrumento Financeiro conforme Anexo 41 do 3040 (Se o estágio informado for diferente do usado na competência anterior do instrumento, é obrigatório informar o motivo da realocação através da API - Motivos Alocação. Se atraso superior a 60 dias, não pode ser classificada como Estágio 1
Carteira de Classificação utilizada para cálculo de provisão mínima requerida - Resolução BCB 309/2023 (Anexo 43) - Carteira utilizada para cálculo de provisão mínima requerida - Resolução BCB 309/2023 (Anexo 43), campo preenchimento obrigatório 'C1', 'C2', 'C3', 'C4' ou 'C5' para as modalidades de 1 a 14 e 18 e operações de naturezas 1,2,3,11,13,14,15 e 32.
Percentual Perda Esperada
Percentual LGD
Indicador Ativo Problemático - Regras de preenchimento:
Declaração Completa
Estágio 1 e 2 não pode haver informação de Ativo Problemático e característica especial 19 é proibida
Se estagio = 3 a marcação de Ativo Problemático obrigatória e característica especial 19 é obrigatória.
Declaração Simplificada
Ativo problemático obrigatório para operações vencidas acima de 90 dias característica especial 19 é obrigatória.
Tratamento de Risco - Informar "S", caso o tratamento do risco de crédito seja realizado de forma isolada, não se aplicando o Art. 42 da Resolução CMN nº 4.966/2021.
Valor Perda Incorrida
Valor Perda esperada
Valor Provisão Adicional
Cliente: Utilizada para alteração de todas as operações deste cliente
Parâmetros de chamada:
Empresa
Data Movimento no formato AAAAMM
Comandada = C
CNPJ ou CPF do cliente a ser considerado para comandada
Informações a serem alteradas:
Classificação Contábil do Instrumento Financeiro: conforme anexo 40 do 3040
Estágio do Instrumento Financeiro conforme Anexo 41 do 3040 (Se o estágio informado for diferente do usado na competência anterior do instrumento, é obrigatório informar o motivo da realocação através da API - Motivos Alocação. Se atraso superior a 60 dias, não pode ser classificada como Estágio 1
Carteira de Classificação utilizada para cálculo de provisão mínima requerida - Resolução BCB 309/2023 (Anexo 43) Carteira utilizada para cálculo de provisão mínima requerida - Resolução BCB 309/2023 (Anexo 43), campo preenchimento obrigatório 'C1', 'C2', 'C3', 'C4' ou 'C5' para as modalidades de 1 a 14 e 18 e operações de naturezas 1,2,3,11,13,14,15 e 32.
Percentual Perda Esperada
Percentual LGD
Indicador Ativo Problemático
Regras de preenchimento:
Declaração Completa
Estágio 1 e 2 não pode haver informação de Ativo Problemático e característica especial 19 é proibida
Se estagio = 3 a marcação de Ativo Problemático obrigatória e característica especial 19 é obrigatória.
Declaração Simplificada
Ativo problemático obrigatório para operações vencidas acima de 90 dias característica especial 19 é obrigatória.
Tratamento de Risco - Informar "S", caso o tratamento do risco de crédito seja realizado de forma isolada, não se aplicando o Art. 42 da Resolução CMN nº 4.966/2021.
Valor Perda Incorrida
Valor perda esperada
Valor Adicional de Provisão
Grupo Cliente: Utilizada para alteração de todas as operações de todos os clientes pertencentes ao Grupo
Parâmetros de chamada:
Empresa
Data Movimento no formato AAAAMM
Comandada = G
Sigla Grupo Econômico que será considerado na comandada
Informações a serem alteradas:
Classificação Contábil do Instrumento Financeiro: conforme anexo 40 do 3040
Estágio do Instrumento Financeiro conforme Anexo 41 do 3040 (Se o estágio informado for diferente do usado na competência anterior do instrumento, é obrigatório informar o motivo da realocação através da API - Motivos Alocação. Se atraso superior a 60 dias, não pode ser classificada como Estágio 1
Carteira de Classificação utilizada para cálculo de provisão mínima requerida - Resolução BCB 309/2023 (Anexo 43) Carteira utilizada para cálculo de provisão mínima requerida - Resolução BCB 309/2023 (Anexo 43), campo preenchimento obrigatório 'C1', 'C2', 'C3', 'C4' ou 'C5' para as modalidades de 1 a 14 e 18 e operações de naturezas 1,2,3,11,13,14,15 e 32.
Percentual Perda Esperada
Percentual LGD
Indicador Ativo Problemático
Regras de preenchimento:
Declaração Completa
Estágio 1 e 2 não pode haver informação de Ativo Problemático e característica especial 19 é proibida
Se estagio = 3 a marcação de Ativo Problemático obrigatória e característica especial 19 é obrigatória.
Declaração Simplificada
Ativo problemático obrigatório para operações vencidas acima de 90 dias característica especial 19 é obrigatória.
Tratamento de Risco - Informar "S", caso o tratamento do risco de crédito seja realizado de forma isolada, não se aplicando o Art. 42 da Resolução CMN nº 4.966/2021.
Valor Perda Incorrida
Valor perda esperada
Valor Adicional de Provisão
Importante: O sistema assumirá sempre a ultima informação recebida.
Exemplo: No arquivo de Operação foram informados Indicador Ativo Problemático N, Classificação da Carteira C4 para determinado instrumento financeiro e posteriormente esta mesma operação tenha sido enviada no registro 22 com Ativo Problemático S, e Classificação da Carteira C5, será considerada a última Informação.
A chamada de cada tipo de comandada (Operação, Cliente ou Grupo Econômico) poderá ser feito via lista de até 999 linhas
API - Motivos Perda: Utilizada para informar os motivos de perda do instrumento financeiro
A API somente poderá ser executada se a situação da interface estive como FINALIZADA
Parâmetros da chamada:
Empresa
Competência no formato AAAAMM
Interface - Deverá ser uma interface válida e que esteja com situação Validada
IPOC da Operação - Deverá existir na base de dados do Rating na competência e interface informada
Motivo da Perda - conforme anexo 44 do 3040
Valor da perda
Caso hajam mais de um motivo, deverão ser realizadas 2 chamadas da API
Se ocorrer duplicidade nos motivos, será considerado o ultimo enviado na API
API - Motivos Alocação: Utilizada para informar os motivos de alocação do instrumento financeiro
A API somente poderá ser executada se a situação da interface estive como FINALIZADA
Parâmetros da chamada:
Empresa - Obrigatório
Competência no formato AAAAMM - Obrigatório
Interface - Deverá ser uma interface válida e que esteja com situação ativa
IPOC da Operação - Deverá existir na base de dados do Rating na competência e interface informada - Obrigatório
Motivo Alocação - Conforme anexo 42 do 3040 - Obrigatório
Data Alocação formato AAAAMM - Obrigatório
Caso hajam mais de um motivo, deverão ser realizadas 2 chamadas da API
Se ocorrer duplicidade nos motivos, será considerado o ultimo enviado na API
API - Garantias: Destinada a integração das Garantias
Parâmetros da chamada:
Empresa - Obrigatório
Competência no formato AAAAMM - Obrigatório
Interface - Deverá ser uma interface válida e que esteja com situação ativa - Obrigatório
IPOC da Operação - Deverá existir na base de dados do Rating na competência e interface informada - Obrigatório - Ou
CD_CLI - código do cliente no cadastro do básico - Obrigatório
NR_CTR - Numero contrato da operação formatado com 10 dígitos (zeros a esquerda) - Obrigatório
SG_MOD - Sigla da modalidade da operação - Obrigatório
NR_ADE_LIB - Numero do Adlib da operação formatado com 3 dígitos (zeros a esquerda) - Obrigatório
CD_IPOC - Obrigatório
Informações da Garantia
Código da taxa referencial ou indicador conforme Anexo 05 do 3040 - Obrigatório
Código da variação cambial conforme anexo 06 do 3040 - Obrigatório
Código da faixa de valor da operação conforme anexo 14 do 3040 - Obrigatório
Código do tipo de garantia conforme anexo 12 do 3040 - Obrigatório
Valor da garantia - Obrigatório
Data da ultima avaliação da garantia
Código do tipo de pessoa do prestador de garantia fidejussória
Percentual de garantia - Garantidor fidejussário
Valor da garantia na data de reavaliação
Carteira da garantia - Carteira utilizada para cálculo de provisão mínima requerida - Resolução BCB 309/2023 (Anexo 43) se não informado gravar default entre anexo 12 e o anexo 43 - conforme regra publicada no TDN referente a carteiras e modalidades - Obrigatório
CD_IPOC - Obrigatório
API - Consulta Valores Provisão - Pré-Calculo - Disponível quando o processamento da data base, no rating esteja com a fase 2 - Calculo das Provisões com situação Finalizado.
O andamento do processamento poderá ser acompanhada pela Tela do PB - Processamento Rating
Parâmetros de chamada:
Empresa - Obrigatório
Data Movimento no formato AAAAMM - Obrigatório
IPOC da Operação - Obrigatório - Ou
CD_CLI - código do cliente no cadastro do básico - Obrigatório
NR_CTR - Numero contrato da operação formatado com 10 dígitos (zeros a esquerda) - Obrigatório
SG_MOD - Sigla da modalidade da operação - Obrigatório
NR_ADE_LIB - Numero do Adlib da operação formatado com 3 dígitos (zeros a esquerda) - Obrigatório
Dados Retornados:
Valor Perda Esperada
Valor Perda Adicional
Valor Perda Incorrida
Estagio
Carteira Provisão
Os dados estarão gravados na tabela T425ROPE e poderá ser acessada através dos campos:
CD_EMP - Empresa
DT_MOV - Data Movimento no formato AAAAMM
CD_IPOC ou
CD_CLI
NR_CTR
SG_MOD
NR_ADE_LIB
Campos com as informações das Provisões:
VR_PRD_ESP - Valor Perda Esperada
VR_PRD_ADC - Valor Perda Adicional
VR_PRD_INC - Valor Perda Incorrida
CD_EST_INS_FIN
API - Ajusta Valores Provisão - Disponível quando o processamento da data base, no rating esteja com a fase 2 - estejam com situação Finalizado e a fase 6 - geração do 3040 não esteja finalizada
O andamento do processamento poderá ser acompanhada pela Tela do PB - Processamento Rating
Parâmetros de chamada:
Empresa - Obrigatório
Data Movimento no formato AAAAMM - Obrigatório
IPOC da Operação - Obrigatório - ou
CD_CLI código do cliente no cadastro do básico - Obrigatório
NR_CTR - Numero contrato da operação - Obrigatório
SG_MOD - Sigla da modalidade da operação - Obrigatório
NR_ADE_LIB - Numero do Adlib da operação - Obrigatório
Parâmetro a ser enviado
Valor Perda Esperada ou
Percentual Perda Esperada
Percentual LGD
Percentual Perda Adicional
Valor Perda Adicional
Percentual Perda Incorrida
Valor Perda Incorrida
Quando recebermos uma requisição de alteração de uma provisão já calcula o Rating passará a usar este novo valor para os instrumentos (operações) e a situação de processamento será executado novamente (marcação feita de forma automática pela API)
API - Consulta Valores Provisão 3040 - Esta solicitação somente será aceita caso a fase 6 (Geração 3040) do processamento do rating esteja com situação finalizada.
Parâmetros de chamada:
Empresa - Obrigatório
Data Movimento no formato AAAAMM - Obrigatório
IPOC da Operação - Obrigatório ou
CD_CLI - código do cliente no cadastro do básico - Obrigatório
NR_CTR - Numero contrato da operação - Obrigatório
SG_MOD - Sigla da modalidade da operação - Obrigatório
NR_ADE_LIB - Numero do Adlib da operação - Obrigatório
Dados Retornados API:
Valor Perda Esperada
Valor Perda Adicional
Valor Perda Incorrida
Estagio
Carteira Provisão
Os dados estarão gravados na tabela T425_3040 e poderá ser acessada através dos campos quando a situação do Processamento do Rating para a competência desejada esteja com a etapa Gravação Dados 3040 como Finalizada :
CD_EMP - Empresa
DT_MOV - Data Movimento no formato AAAAMM
CD_IPOC ou
CD_CLI - código do cliente no cadastro do básico
NR_CTR - Numero contrato da operação
SG_MOD - Sigla da modalidade da operação
NR_ADE_LIB - Numero do Adlib da operação
Campos com as informações das Provisões:
VR_PRD_ESP - Valor Perda Esperada
VR_PRD_ADC - Valor Perda Adicional
VR_PRD_INC - Valor Perda Incorrida
CD_EST_INS_FIN - Estagio
CD_CAR_PRV - Carteira Provisão
API - Operações
codigoempresa Código Empresa Rating
siglaInterface Sigla Interface
datamovimento DATA MOVIMENTO NO FORMATO AAAAMM
codigoCliente CODIGO CLIENTE NO CADASTRO BASICO
numCicBasico NUMERO CIC BASE (8 NUMEROS DO CNPJ OU CPF)
siglaModalidade SIGLA MODALIDADE DA OPERAÇÃO
numContrato NUMERO CONTRATO OPERAÇÃO
numAdesaoLiberacao NUMERO ADELIB
codigoIpoc CODIGO IPOC
tipoPessoa CODIGO TIPO PESSOA (F ou Jj)
codigoUnidadeOperacao CODIGO UNIDADE OPERACIONAL
carteiraContabil SIGLA CARTEIRA CONTABIL
codigoEefOperacao CODIGO EEF OPERACAO
unidadeOperacao CODIGO UNIDADE OPERACIONAL
codigoNaturezaOperacao CODIGO NATUREZA DA OPERACAO CFE ANEXO 02
codigoModalidadeOperacao CODIGO MODALIDADE OPERACAO CFE ANEXO 03
dataEmissaoOperacao DATA OPERACAO
dataVencimentoOperacao DATA VENCIMENTO OPERACAO
siglaGrupoEconomico SIGLA GRUPO ECONOMICO
nomeCliente NOME DO CLIENTE
valorContabilOperacao VALOR CONTABIL OPERACAO
valorAVencerAteTrintaDias VALOR A VENCER 30DIAS
valorAVencerAteSessentaDias VALOR A VENCER 60DIAS
valorAVencerAteNoventaDias VALOR A VENCER 90DIAS
valorAVencerAteCentoEOitentaDias VALOR A VENCER 180DIAS
valorAVencerAteTrezentosESessentaDias VALOR A VENCER 360DIAS
valorAVencerAteSetessentosEVinteDias VALOR A VENCER 720DIAS
valorAVencerAteMilEOitentaDias VALOR A VENCER 1080DIAS
valorAVencerAteMilQuatrossentosEQuarentaDias VALOR A VENCER 1440DIAS
valorAVencerAteMilEOitossentosDias VALOR A VENCER 1800DIAS
valorAVencerAteCincoMilEQuatrossentosDias VALOR A VENCER 5400DIAS
valorAVencerAcimaCincoMilEQuatrossentosDias VALOR A VENCER ACIMA 5400DIAS
valorAVencerPrazoIndeterminado VALOR A VENCER PRAZO INDETERMINADO
valorVencidoAteCatorzeDias VALOR VENCIDO 14DIAS
valorVencidoAteTrintaDias VALOR VENCIDO 30DIAS
valorVencidoAteSessentaDias VALOR VENCIDO 60DIAS
valorVencidoAteNoventaDias VALOR VENCIDO 90DIAS
valorVencidoAteCentoEVinteDias VALOR VENCIDO 120DIAS
valorVencidoAteCentoECinquentaDias VALOR VENCIDO 150DIAS
valorVencidoAteCentoEOitentaDias VALOR VENCIDO 180DIAS
valorVencidoAteDuzentosEQuarentaDias VALOR VENCIDO 240DIAS
valorVencidoAteTrezentosDias VALOR VENCIDO 300DIAS
valorVencidoAteTrezentosESessentaDias VALOR VENCIDO 360DIAS
valorVencidoAteQuinhentosEQuarentaDias VALOR VENCIDO 540DIAS
valorVencidoAcimaQuinhentosEQuarentaDias VALOR VENCIDO ACIMA 540DIAS
valorPrejuizoUltimosDozeMeses VALOR PREJUIZO ULTIMOS 12MESES
valorPrejuizoAcimaDozeMeses VALOR PREJUIZO ACIMA 12MESES
dataParcelaEmAberto DATA VENCIMENTO PARCELA EM ABERTO
valorParcelaEmAberto VALOR PARCELA EM ABERTO
valorTituloDescontadoMesAnterior VALOR TITULO DESCONTADO MES ANTERIOR
valorTituloPagoMesAnterior VALOR TITULO PAGO MES ANTERIOR
valorTaxaEfetivaAnual VALOR TAXA EFETIVA ANUAL
idRatingDeMercado IDENTIFICADOR RTG MERCADO
codigoCaracteristicasEpeciaisOperacao CODIGO OUTRAS CARACTERÍSTICAS PRINCIPAL CFE ANEXO 08
codigoDesempenhoOperacao CODIGO DESEMPENHO OPERACAO CFE ANEXO 28
codigoOutraCaracteristicasEspeciaisOperacao CODIGO OUTRO CARTEIRA ESP CFE ANEXO 08
codigoOrigemRecurso CODIGO ORIGEM RECURSOS CFE ANEXO 04
porteCliente CODIGO PORTE CONFORME ANEXO 24 OU 25
codigoTipoControlador CODIGO TIPO CONTROLADOR CFE ANEXO 10
codigoTipoPessoa CODIGO TIPO PESSOA CFE ANEXO 11
codigoTaxaReferencial CODIGO TAXA REFERENCIA
codigoVariacaoCambial CODIGO VARIACAO CAMBIAL
dataInicioRelacionamentoCliente DATA RELCLI
autorizacaoCliente IDENTIFICADOR AUTORIZAÇÃO CLIENTE
vinculoMoedaEstrangeira IDENTIFICADOR MOEDA ESTRANGEIRA
cepConcessao NUMERO CEPCONCESSÃO ????
numeroCpfOuCnpj NUMERO CPJ CNPJ
codigoUfConcessao CODIGO UF CON
valorPrejuizoAcimaQuarentaEOitoMeses VALOR PREJUIZO ACIMA 48MESES
valorLimiteCreditoAteTrezentosESessentaDias VALOR LIMITE CREDITO ATE 360 DIAS
valorLimiteCreditoAcimaTrezentosESessentaDias VALOR LIMITE CREDITO ACIMA 360 DIAS
valorCreditoLiberadoAteTrezentosESessentaDias VALOR CREDITO LIBERADO ATE 360DIAS
valorCreditoLiberadoAcimaTrezentosESessentaDias VALOR CREDITO LIBERADO ACIMA 360DIAS
codigoFaixaValorOperacao CODIGO FAIXA VALOR OPERACAO
siglaClassificacaoCliente SIGLA CLASSIFICACAO CLIENTE
codigoCosif CODIGO COSIF
descricaoProduto DESCRICAO PRODUTO
quantidadeParcelasAtrasadas QUANTIDADE PARCELAS EM ATRASO
valorFaturamentoAnual VALOR FATURA ANUAL
percentualIndexador PERCENTUAL IDX CFE ANEXO 05
valorContratoOperacao VALOR CONTRATO OPE
saldoDevedor SALDO DEVEDOR
quantidadeDiasAtraso QUANTIDADE DIAS ATRASO
idSaidaSistemaCredito IDENTIFICADOR SAIDA SISTEMA CREDITO
dataProximaParcela DATA PROXIMA PARCELA
valorProximaParcela VALOR PROXIMA PARCELA
numeroParcelasContrato NUMERO PARCELAS CONTRATO
idCessaoParcial IDENTIFICADOR CESSAO PARCIAL
valorContratoOperacao VALOR BRUTO CONTABIL
idParteRelacionada IDENTIFICADOR PARTE RELACIONADA
classificacaoContabilInstrumento CODIGO DA CLASSIFICAÇAO CONTABIL CFE ANEXO 40
codigoEstagioInstrumentoFiscal CODIGO ESTAGIOO INSTRUMENTO FINANCEIRO CFE ANEXO 41
quantidadeInstrumentoFinanceiro QUANTIDADE ADQUIRIDA DO INSTRUMENTO FINANCEIRO SOMENTE SE MODALIDADE 18
valorContabilBruto VALOR CONTABIL BRUTO - CFE ART.. 73 (TJE pura) ou art. 75 (TJE diferenciada) da Resolução BCB nº 352/2023
valorPerdaAcumulada VALOR PERDA ACUMULADA (SE INFORMADA DEVERÁ EXISTIR MOTIVO DE PERDA)
valorJusto VALOR JUSTO
valorTaxaEfetiva VALOR TAXA EFETIVA
valorRendimentoMes VALOR RENDIMENTO MES
codigoAlocacaoEstagio CODIGO DE ALOCACAO DE ESTAGIO - Art. 47, I, § 1º da Resolução CMN nº 4.966/2021.
codigoCarteiraProvisionada CODIGO CARTEIRA DE PROVISAO - CFE ANEXO 43
identificadorTratamentoRisco IDENTIFICADOR TRATAMENTO DE RISCO - Art. 42 da Resolução CMN nº 4.966/2021.
valorPercentualPd PERCENTUAL LGD
valorPercentualLgd PERCENTUAL PDD
nomeClienteExterno NOME CLIENTE EXTERIOR
tipoIdentificadorClienteExterno TIPO IDENTIFICADOR EXTERIOR
codigoIdentificadorExterno CODIGO IDENTIFICADOR EXTERIOR CFE ANEXO 30
cnpjLiderBrasileira CNPJ EMPRESA LIDER
codigoPais CODIGO PAIS EXTERIOR
valorPerdaEsperada VALOR PERDA ESPERADA
valorPerdaIncorrida VALOR PERDA INCORRIDA
valorPerdaAdicional VALOR PERDA ADICIONAL
identificadorAtivoProblematico INDICADOR ATIVO PROBLEMATICO
dataAtraso DATA EM QUE O TITULO SE TORNOU INADIMPLIDO
dataFalencia DATA FALENCIA
API Integração Créditos: Destinada a realizar a integração entre o Créditos e Rating.
Todas as Operações, Informações Adicionais, Sicor serão integradas de forma automática.