2.2. Dicionário de Indicadores SCR¶

Cada mês consultado com sucesso traz, em periodos[].indicadores, uma lista de pares { codigoIndicador, valor }. Esta página lista os códigos documentados e descreve os demais campos do período.

{
  "codigoIndicador": "carteira_vencer",
  "valor": 15234.56
}

Como ler os indicadores¶

Os códigos documentados são os 45 da tabela abaixo, independentes do provedor do SCR. Ignore um código que não esteja na tabela: não o trate como erro nem leia codigoIndicador como um enumerado fechado.
Cada código aparece no máximo uma vez por período.
Indicador ausente significa "sem valor", não zero: o mês não trouxe aquela informação. Não preencha com 0 no seu lado sem essa ressalva.
Os valores são monetários, como number, sem separador de milhar.
A lista não tem ordem garantida: localize cada indicador pelo codigoIndicador.

Grupos¶

Os quatro primeiros grupos são os da tela de detalhe da consulta na plataforma; os demais organizam os indicadores que a tela mostra em Outros Indicadores. Os grupos servem só para organizar a exibição — eles não aparecem na resposta da API.

Grupo	O que reúne
Carteira a vencer	Parcelas ainda não vencidas, por prazo até o vencimento
Carteira vencida	Parcelas vencidas, por tempo de atraso
Totais	Os totais consolidados do titular no mês
Moeda estrangeira	Operações em moeda estrangeira, por prazo
Prejuízo por prazo	O prejuízo separado pelo tempo desde a baixa
Composição da responsabilidade	As parcelas que formam a responsabilidade total
Créditos e limites por prazo	Créditos a liberar e limites de crédito separados por prazo
Títulos de crédito	Operações com títulos de crédito, por tipo de título
Operações em discussão	Valores de operações contestadas pelo titular ou discutidas judicialmente

Dicionário de indicadores¶

Código	Descrição	Grupo
`carteira_vencer_ate30_vencidos_ate14`	Carteira a vencer em até 30 dias e vencidos até 14 dias	Carteira a vencer
`carteira_vencer_31a60`	Carteira a vencer de 31 a 60 dias	Carteira a vencer
`carteira_vencer_61a90`	Carteira a vencer de 61 a 90 dias	Carteira a vencer
`carteira_vencer_91a180`	Carteira a vencer de 91 a 180 dias	Carteira a vencer
`carteira_vencer_181a360`	Carteira a vencer de 181 a 360 dias	Carteira a vencer
`carteira_vencer_acima360`	Carteira a vencer acima de 360 dias	Carteira a vencer
`carteira_vencer_prazo_indeterminado`	Carteira a vencer com prazo indeterminado	Carteira a vencer
`carteira_vencido_15a30`	Carteira vencida de 15 a 30 dias	Carteira vencida
`carteira_vencido_31a60`	Carteira vencida de 31 a 60 dias	Carteira vencida
`carteira_vencido_61a90`	Carteira vencida de 61 a 90 dias	Carteira vencida
`carteira_vencido_91a180`	Carteira vencida de 91 a 180 dias	Carteira vencida
`carteira_vencido_181a360`	Carteira vencida de 181 a 360 dias	Carteira vencida
`carteira_vencido_acima360`	Carteira vencida acima de 360 dias	Carteira vencida
`carteira_vencer`	Carteira a vencer (total)	Totais
`carteira_vencido`	Carteira vencida (total)	Totais
`prejuizo`	Prejuízo (total)	Totais
`creditos_a_liberar`	Créditos a liberar (total)	Totais
`limite_credito`	Limite de crédito (total)	Totais
`risco_indireto_vendor`	Risco indireto vendor	Totais
`risco_total`	Risco total	Totais
`responsabilidade_total`	Responsabilidade total	Totais
`moeda_estrangeira_15a30`	Moeda estrangeira de 15 a 30 dias	Moeda estrangeira
`moeda_estrangeira_31a60`	Moeda estrangeira de 31 a 60 dias	Moeda estrangeira
`moeda_estrangeira_61a90`	Moeda estrangeira de 61 a 90 dias	Moeda estrangeira
`moeda_estrangeira_91a180`	Moeda estrangeira de 91 a 180 dias	Moeda estrangeira
`moeda_estrangeira_181a360`	Moeda estrangeira de 181 a 360 dias	Moeda estrangeira
`moeda_estrangeira_acima360`	Moeda estrangeira acima de 360 dias	Moeda estrangeira
`moeda_estrangeira`	Total em moeda estrangeira	Moeda estrangeira
`prejuizo_ate12meses`	Prejuízo até 12 meses	Prejuízo por prazo
`prejuizo_acima12meses`	Prejuízo acima de 12 meses	Prejuízo por prazo
`carteira_credito`	Carteira de crédito	Composição da responsabilidade
`repasses`	Repasses	Composição da responsabilidade
`coobrigacoes`	Coobrigações	Composição da responsabilidade
`creditos_a_liberar_ate360`	Créditos a liberar em até 360 dias	Créditos e limites por prazo
`creditos_a_liberar_acima360`	Créditos a liberar acima de 360 dias	Créditos e limites por prazo
`limite_credito_ate360`	Limite de crédito com vencimento em até 360 dias	Créditos e limites por prazo
`limite_credito_acima360`	Limite de crédito com vencimento acima de 360 dias	Créditos e limites por prazo
`titulo_credito`	Títulos de crédito (total)	Títulos de crédito
`titulo_credito_cpr`	Títulos de crédito — CPR (Cédula de Produto Rural)	Títulos de crédito
`titulo_credito_en`	Títulos de crédito — EN	Títulos de crédito
`titulo_credito_debentures`	Títulos de crédito — debêntures	Títulos de crédito
`titulo_credito_nota_comercial`	Títulos de crédito — nota comercial	Títulos de crédito
`titulo_credito_outros`	Títulos de crédito — outros	Títulos de crédito
`vlr_operacoes_discordancia`	Valor das operações em discordância	Operações em discussão
`vlr_operacoes_sob_judice`	Valor das operações sob júdice	Operações em discussão

Demais campos do período¶

Abrangência¶

Campo	Tipo	Descrição
percentualDocumentosProcessados	number / null	Percentual dos documentos das instituições que já foi processado pelo SCR para o mês
percentualVolumeProcessado	number / null	Percentual do volume financeiro que já foi processado pelo SCR para o mês
quantidadeInstituicoes	integer / null	Quantidade de instituições com operações do titular no mês
quantidadeOperacoes	integer / null	Quantidade de operações do titular no mês

Percentuais abaixo de 100 indicam que o mês ainda não está completo no SCR — comum no mês mais recente. Em um mês com Falha, os quatro campos vêm null.

Modalidades (`periodos[].modalidades`)¶

Detalhamento das operações por modalidade, conforme a classificação do SCR.

Campo	Tipo	Descrição
tipo	string / null	Tipo da operação, como informado pelo SCR
modalidade	string / null	Código da modalidade da operação
dominio	string / null	Código do domínio da classificação
subdominio	string / null	Código do subdomínio da classificação
valorVencimento	number	Valor da modalidade

Os códigos de tipo, modalidade, dominio e subdominio são os do SCR e chegam como texto, sem tradução.

Mensagens (`periodos[].mensagens`)¶

Avisos que o SCR e o provedor devolvem para o mês — por exemplo, sobre informações ainda em processamento.

Campo	Tipo	Descrição
codigo	string / null	Código da mensagem, quando houver
mensagem	string / null	Texto da mensagem

Trate o texto das mensagens com o mesmo sigilo do resultado: ele faz parte da consulta.