Relatório Avançado PJ
Relatório completo de análise de crédito para Pessoa Jurídica incluindo identificação, QSA, dados negativos (PEFIN, REFIN, protestos, cheques), ações judiciais, falências, score de crédito e histórico comercial.
Produto
RELATORIO_AVANCADO_TOP_SCORE_PJ
Endpoint
POST /client/business-information
Tipo
Pessoa Jurídica
Formato
JSON
Guia de Implementação
Documentação completa, exemplos e informações complementares
Dados Cadastrais – Informações de Empresa
Dados Cadastrais
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| identificationReport | ||
| updateDate | String ($date) | Data da última atualização das informações |
| statusRegistration | String | Situação do CNPJ consultado |
| companyName | String | Nome da empresa consultada |
| companyAlias | String | Nome fantasia da empresa consultada |
| Address | ||
| addressLine | String | Endereço da empresa |
| zipCode | String | CEP |
| district | String | Bairro |
| city | String | Cidade |
| state | String | Estado |
| phone | ||
| areaCode | String | Código de área |
| phoneNumber | String | Número de telefone |
| companyUrl | String | Site Oficial da empresa consultada |
| partnership | String | Tipo da sociedade que a empresa participa |
| companyRegister | String | Registro da empresa consultada |
| companyRegisterDate | String | Data do registro da empresa |
| companyFoundation | String ($date) | Data da fundação da empresa |
| numberEmployees | Integer | Quadro de funcionários efetivos da empresa |
| taxOption | String | Opção tributária da empresa |
| stateRegistration | String | Inscrição estadual da empresa |
| economicActivity | String | Área de atuação da empresa |
| importPurchases | Number($double) | Porcentagem da importação sobre compras |
| exportSales | Number($double) | Porcentagem da exportação sobre vendas |
| cnae | String | Classificação Nacional de Atividades Econômicas |
| serasaActiveCode | String | Código da área de atuação registrado na base Serasa Experian |
| branchOffices | String | Número de filiais da empresa consultada |
| nireNumber | String | Registro de legalidade da empresa |
| predecessorList | ||
| predecessorName | String | Nome da empresa antecessora |
| predecessorDate | String ($date) | Data da empresa antecessora |
| legalNatureCode | String | Código da Natureza Jurídica |
Quadro Social Administrativo
Possíveis campos de retorno para quadro social e administrativo da empresa:
Quadro Social e Administrativo
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| companyData | ||
| socialCapitalValue | Number($double) | Capital social da empresa |
| accomplishedValue | Number($double) | Capital realizado da empresa |
| informationUpdateDate | String | Data de atualização das informações |
| countryOrigin | String | País de origem |
| controlType | String | Tipo de controle da empresa |
| nature | String | Natureza da empresa |
| partnersList | ||
| documentType | String | Tipo do documento do sócio (CPF ou CNPJ) |
| documentId | String | Número do documento do sócio |
| name | String | Nome/Razão social do sócio |
| sinceDate | String ($date) | Data de entrada do sócio na empresa |
| nationality | String | Nacionalidade do sócio |
| restrictionSign | Boolean | Indicativo de anotações do sócio |
| documentConsistency | Boolean | Indicativo de inconsistência do sócio |
| capitalTotalValue | Number($double) | Capital total do sócio |
| capitalVoterValue | Number($double) | Capital votante do sócio |
| directorsList | ||
| documentType | String | Tipo do documento do administrador (CPF ou CNPJ) |
| documentId | String | Número do documento do administrador |
| name | String | Nome/Razão social do administrador |
| role | String | Cargo do administrador |
| maritalStatus | String | Estado civil do administrador (apenas para CPF’s) |
| sinceDate | String ($date) | Data de entrada do administrador na empresa |
| mandateStart | String ($date) | Data de início de mandato do administrador |
| mandateEnd | String ($date) | Data de final de mandato do administrador |
| nationality | String | Nacionalidade do administrador |
| restrictionSign | Boolean | Indicativo de anotações do sócio |
| documentConsistency | Boolean | Indicativo de inconsistência do sócio |
Possíveis campos de retorno para dados das últimas 5 anotações negativas dos tipos: Pendência Financeira, Restrição Financeira, Dívida Vencida, Cheque sem Fundo, Protesto, Ação Judicial e Falência.
Anotações Negativas – Pendências Financeiras (PEFIN)
Anotações Negativas (Pendência Financeira - PEFIN)
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| pefinResponse | ||
| occurrenceDate | String ($date) | Data da ocorrência |
| legalNatureId | String | Código da Natureza |
| legalNature | String | Natureza da dívida |
| contractId | String | Identificador do contrato |
| creditorName | String | Nome do credor |
| amount | Number($double) | Valor da dívida |
| federalUnit | String | Estado |
| principal | Boolean | Principal (true) ou Avalista (false) |
| summary | ||
| firstOcurrence | String ($date) | Data da negativação mais recente |
| lastOcurrence | String ($date) | Data da negativação mais antiga |
| count | Integer($int32) | Quantidade total de pendências financeiras |
| balance | Number($double) | Valor total de pendências financeiras |
Anotações Negativas – Restrições Financeiras (REFIN)
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| refinResponse | ||
| occurrenceDate | String ($date) | Data da ocorrência |
| legalNatureId | String | Código da Natureza |
| legalNature | String | Natureza da dívida |
| contractId | String | Identificador do contrato |
| creditorName | String | Nome do credor |
| amount | Number($double) | Valor da dívida |
| principal | Boolean | Principal (true) ou Avalista (false) |
| summary | ||
| firstOcurrence | String ($date) | Data da negativação mais recente |
| lastOcurrence | String ($date) | Data da negativação mais antiga |
| count | Integer($int32) | Quantidade total de restrições financeiras |
| balance | Number($double) | Valor total de restrições financeiras |
Anotações Negativas – Dívidas Vencidas (Convem)
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| collectionRecordsResponse | ||
| occurrenceDate | String ($date) | Data da ocorrência |
| legalNatureId | String | Código da Natureza |
| legalNature | String | Natureza da dívida |
| debtMode | String | Identificador da natureza da dívida |
| contractId | String | Identificador do contrato |
| creditorName | String | Nome do credor |
| amount | Number($double) | Valor da dívida |
| city | String | Cidade |
| federalUnit | String | Estado |
| principal | Boolean | Principal (true) ou Avalista (false) |
| summary | ||
| firstOcurrence | String ($date) | Data da negativação mais recente |
| lastOcurrence | String ($date) | Data da negativação mais antiga |
| count | Integer($int32) | Quantidade total de dívidas vencidas |
| balance | Number($double) | Valor total de dívidas vencidas |
Anotações Negativas – Cheques Sem Fundo (CCF)
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| checkResponse | ||
| occurrenceDate | String ($date) | Data da ocorrência |
| alinea | Integer($int32) | Identificador do motivo da devolução do cheque |
| bankName | String | Nome do banco |
| bankAgencyId | Integer($int32) | Número da agência |
| checkNumber | String | Número do cheque |
| checkCount | Integer($int32) | Quantidade de cheques |
| city | String | Cidade |
| federalUnit | String | Estado |
| summary | ||
| firstOcurrence | String ($date) | Data da negativação mais recente |
| lastOcurrence | String ($date) | Data da negativação mais antiga |
| count | Integer($int32) | Quantidade total de cheques sem fundo |
| balance | Number($double) | Valor total de cheques sem fundo |
Anotações Negativas – Protestos
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| notaryResponse | ||
| occurrenceDate | String ($date) | Data da ocorrência |
| amount | number($double) | Valor da dívida |
| officeNumber | String | Numero do Cartório |
| city | String | Cidade |
| federalUnit | String | Estado |
| summary | ||
| firstOcurrence | String ($date) | Data da negativação mais recente |
| lastOcurrence | String ($date) | Data da negativação mais antiga |
| count | integer($int32) | Quantidade total de protestos |
| balance | number($double) | Valor total dos protestos |
Anotações Negativas – Acões Judiciais
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| judgementFilingsResponse | ||
| occurrenceDate | String ($date) | Data da ocorrência |
| legalNatureId | String | Código da Natureza |
| legalNature | String | Natureza da dívida |
| amount | Number($double) | Valor da dívida |
| distributor | String | Número do distribuidor |
| civilCourt | String | Identificador da vara judicial |
| city | String | Cidade |
| state | String | Estado |
| summary | ||
| firstOcurrence | String ($date) | Data da negativação mais recente |
| lastOcurrence | String ($date) | Data da negativação mais antiga |
| count | Integer($int32) | Quantidade total de ações judiciais |
| balance | Number($double) | Valor total das ações judiciais |
Anotações Negativas – Falências
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| bankruptsResponse | ||
| eventDate | String ($date) | Data da falência |
| eventType | String | Tipo de falência |
| origin | String | Origem |
| city | String | Cidade de origem da falência |
| state | String | Estado de origem da falência |
| summary | ||
| firstOcurrence | String ($date) | Data da negativação mais recente |
| lastOcurrence | String ($date) | Data da negativação mais antiga |
| count | Integer | Quantidade total de falências |
| balance | Number($double) | Valor total das falências |
Mais Anotações – Pendências Financeiras (PEFIN)
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| pefinResponse | ||
| occurrenceDate | String ($date) | Data da ocorrência |
| legalNatureId | String | Identificador da natureza da dívida |
| legalNature | String | Natureza da dívida |
| contractId | String | Identificador do contrato |
| creditorName | String | Nome do credor |
| amount | number($double) | Valor da dívida |
| federalUnit | String | Estado |
| principal | boolean | Principal (true) ou Avalista (false) |
| summary | ||
| firstOcurrence | String ($date) | Data da negativação mais recente |
| lastOcurrence | String ($date) | Data da negativação mais antiga |
| count | integer($int32) | Quantidade total de pendências financeiras |
| balance | number($double) | Valor total de pendências financeiras |
Mais Anotações – Restrições Financeiras (REFIN)
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| refinResponse | ||
| occurrenceDate | String ($date) | Data da ocorrência |
| legalNatureId | String | Identificador da natureza da dívida |
| legalNature | String | Natureza da dívida |
| contractId | String | Identificador do contrato |
| creditorName | String | Nome do credor |
| amount | number($double) | Valor da dívida |
| principal | boolean | Principal (true) ou Avalista (false) |
| summary | ||
| firstOcurrence | String ($date) | Data da negativação mais recente |
| lastOcurrence | String ($date) | Data da negativação mais antiga |
| count | integer($int32) | Quantidade total de restrições financeiras |
| balance | number($double) | Valor total de restrições financeiras |
Mais Anotações – Dívidas Vencidas (Convem)
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| collectionRecordsResponse | ||
| occurrenceDate | String ($date) | Data da ocorrência |
| legalNatureId | String | Identificador da natureza da dívida |
| legalNature | String | Natureza da dívida |
| contractId | String | Identificador do contrato |
| amount | number($double) | Valor da dívida |
| city | String | Cidade |
| federalUnit | String | Estado |
| principal | boolean | Principal (true) ou Avalista (false) |
| summary | ||
| firstOcurrence | String ($date) | Data da negativação mais recente |
| lastOcurrence | String ($date) | Data da negativação mais antiga |
| count | integer($int32) | Quantidade total de dívidas vencidas |
| balance | number($double) | Valor total de dívidas vencidas |
Mais Anotações – Cheques Sem Fundo (CCF)
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| checkResponse | ||
| occurrenceDate | String ($date) | Data da ocorrência |
| alinea | integer($int32) | Identificador do motivo da devolução do cheque |
| bankId | integer($int32) | Identificador do banco |
| bankName | String | Nome do banco |
| bankAgencyId | integer($int32) | Número da agência |
| checkNumber | String | Número do cheque |
| checkCount | integer($int32) | Quantidade de cheques |
| city | String | Cidade |
| federalUnit | String | Estado |
| summary | ||
| firstOcurrence | String ($date) | Data da negativação mais recente |
| lastOcurrence | String ($date) | Data da negativação mais antiga |
| count | integer($int32) | Quantidade total de cheques sem fundo |
| balance | number($double) | Valor total de cheques sem fundo |
Mais Anotações – Protestos
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| notaryResponse | ||
| occurrenceDate | String ($date) | Data da ocorrência |
| amount | number($double) | Valor da dívida |
| officeNumber | String | Número do cartório |
| city | String | Cidade |
| federalUnit | String | Estado |
| summary | ||
| firstOcurrence | String ($date) | Data da negativação mais recente |
| lastOcurrence | String ($date) | Data da negativação mais antiga |
| count | integer($int32) | Quantidade total de protestos |
| balance | number($double) | Valor total dos protestos |
Mais Anotações – Ações
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| judgementFilingsResponse | ||
| occurrenceDate | String ($date) | Data da ocorrência |
| legalNatureId | String | Identificação de natureza jurídica |
| legalNature | String | Descrição Natureza Jurídica ID da ocorrência |
| civilCourt | String | Corte Civil |
| amount | number($double) | Valor da dívida |
| distributor | String | Distribuidor |
| principal | boolean | Principal (true) ou Avalista (false) |
| city | String | Cidade |
| State | String | Estado |
| Summary | ||
| count | integer($int32) | Quantidade total de Ações |
| Balance | number($double) | Valor total dos ações |
| firstOccurrence | String ($date) | Data da ação mais antiga |
| lastOccurrence | String ($date) | Data da ação mais recente |
Mais Anotações – Falências
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| bankruptsResponse | ||
| eventDate | String ($date) | Data da ocorrência |
| eventType | String | CNPJ da empresa registrado noBrasil |
| origin | String | Origem da anotação |
| city | String | Cidade onde a empresa está localizada |
| state | String | Estado onde a empresa estálocalizada |
| varaCourt | String | Identificador da vara judicial da falência |
| Summary | ||
| count | integer($int32) | Quantidade total de registros |
| Balance | number($double) | Valor total dos registros |
| irstOccurrence | String ($date) | Data da ação mais antiga |
| lastOccurrence | String ($date) | Data da ação mais recente |
Score Positivo
Possíveis campos de retorno para Score Positivo (HPJ8):
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| score | ||
| score | Integer | Pontuação do score |
| scoreModel | String | Modelo de score: Score Positivo |
| defaultRate | String | Probabilidade de não pagamento |
| message | String | Mensagem informativa |
Consultas à Serasa
Possíveis campos de retorno para Consultas à Serasa com informações das últimas 5 consultas detalhadas ao CNPJ consultado e o resumo da quantidade de consultas no mês atual e dos último 13 meses.
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| inquiryCompanyResponse | ||
| occurrenceDate | String ($date) | Data da consulta |
| companyName | String | Número do CNPJ consultante |
| companyDocumentId | String | Nome do CNPJ consultante |
| daysQuantity | String | Quantidade de consultas no dia |
| quantity | ||
| actual | Integer | Quantidade de consulta do mês atual |
| historical | ||
| inquiryDate | String ($date) | Data dos meses anteriores |
| occurrences | Integer | Quantidade de consulta dos meses anteriores |
Indicador de recuperação crédito
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| score | ||
| score | Integer | Pontuação do score |
| scoreModel | String | Modelo de score: Score Positivo |
| defaultRate | String | Probabilidade de não pagamento |
| message | String | Mensagem informativa |
Histórico de Pagamento Comercial Avançado Analítico
Essa feature é exibida apenas dentro dos relatórios analíticos.
Possíveis campos de retorno para dados (Histórico de Pagamento Comercial Avançado Analítico)
Bloco de Informações do Segmento – Visão Cedente (segmentData > assignor)
Bloco de Informações do Segmento – Visão Sacado (segmentData > drawee)
Bloco de Informações do Segmento – Visão Individual (segmentData > individual)
| Histórico de Pagamento Comercial Avançado | ||
|---|---|---|
| Nome do Campo | Tipo | Descrição |
| paymentHistory> | ||
| titlesQuantity> | String | |
| rangeCode | String | Código da faixa de valores dos títulos |
| name | String | Nome da pontuação da faixa de valores dos títulos |
| range | String | Faixa de valores dos títulos |
| percentage | String | Faixa de valores percentual dos títulos |
| averageRangeCode | String | Código de alcance médio |
| averageRangeDescription | String | Descrição do intervalo médio |
| averageRangePercentage | String | Porcentagem de alcance médio |
| monthDetail> | ||
| months> | ||
| month | String | Mês |
| periodList> | ||
| rangeCode | String | Código da faixa de valores |
| name | String | Nome da Pontuação da faixa de valores |
| range | String | Faixa de valores |
| rangeValueFrom | Faixa do valor “De” | |
| rangeValueTo | Faixa do valor “Até” | |
| percentage | String | Faixa de valor percentual |
| percentageFrom | Faixa de valor percentual “De” | |
| percentageTo | Faixa de valor percentual “Até” | |
| summary> | ||
| punctual | Informações de pagamento: “Pontual” | |
| period8To15 | Informações de pagamento: “De 8 a 15 dias” | |
| period16To30 | Informações de pagamento: “De 16 a 30 dias” | |
| period31To60 | Informações de pagamento: “De 31 a 60 dias” | |
| periodGT60 | Informações de pagamento: “Acima de 60 dias” | |
| spotPayment | Informações de pagamento: “A Vista” | |
| total | Informações de pagamento: “Total” | |
| periodDescription | String | Descrição do período |
| totalValueRangeCode | String | Código de intervalo de valor total |
| totalValueRangeDescription | String | Descrição do intervalo de valor total |
| totalValueFrom | integer | Valor do pagamento “De” |
| totalValueTo | integer | Valor do pagamento “Até” |
| averageValueRangeCode | String | Código de intervalo de valor médio |
| averageValueRangeDescription | String | Descrição do intervalo de valor médio |
| percentageValueFrom | number | Percentual de pagamento “De” |
| percentageValueTo | number | Percentual de pagamento “Até” |
| historicalAverageRangeFrom | integer | Histórico de intervalo médio “De” |
| historicalAverageRangeTo | integer | Histórico de intervalo médio “Até” |
| originCode | integer | Código da faixa |
| averageDelayPeriods> | Prazo médio de atraso | |
| periodList> | ||
| period | String | Período médio de atraso (dias) |
| averageDelayDaysFrom | integer | Faixa período médio de atraso (dias) “De” |
| averageDelayDaysTo | integer | Faixa período médio de atraso (dias) “Até” |
| summary> | ||
| AverageDelayPeriodSummary> | ||
| averageDelayDaysFrom | integer | Resumo da faixa período médio de atraso (dias)“De” |
| averageDelayDaysTo | integer | Resumo da faixa período médio de atraso (dias) “Ate” |
| mainSuppliers> | ||
| lastUpdateDate | String ($date) | Data da última atualização do Fornecedor Principal |
| mainSuppliersList> | ||
| supplierName | String | Nome do Fornecedor |
| supplierDocument | String | Documento do Fornecedor |
| relationshipSuppliersPeriods> | ||
| lastUpdateDate | String ($date) | Data da última atualização das relações com os fornecedores |
| relationshipSuppliersPeriodList> | ||
| relationshipPeriodDescription | String | Descrição das relações com os fornecedores |
| relationshipSourceQuantity | number | Quantidade de fontes de relacionamentos com os fornecedores |
| summary | ||
| sourcesTotal | number | Quantidade de fontes de informação |
| paymentHistorySources | Quantidade de fontes de informação – Histórico de Pagamento | |
| paymentHistoryValuesSources | Quantidade de fontes de informação – Histórico de Pagamento (Valores em R$) | |
| evolutionCommitmentsSources | Quantidade de fontes de informação – Evolução de Compromisso | |
| businessReferencesSources | Quantidade de fontes de informação – Referenciais de Negócios | |
| spotPaymentBusinessReferencesSources | Quantidade de fontes de informação – Referenciais de Negócios com Pagamento à Vista | |
| evolutionCommitmentsSuppliers> | ||
| lastUpdateDate | String ($date) | Data da última atualização da Evolução de Compromissos |
| evolutionCommitmentsSuppliersList> | ||
| yearCommitment | String | Ano do compromisso |
| monthCommitment | String | Mês do compromisso |
| descriptionMonthCommitment | String | Descrição do mês de compromisso |
| trackCodeToExpire | String | Código do acompanhamento da expiração |
| trackDescriptionToExpire | String | Descrição da faixa expirada |
| valueCommitmentsDueFrom | String | Valor compromissos devidos de |
| valueCommitmentsDueTo | String | Valor compromissos devidos para |
| totalMonthRangeCode | String | Código do intervalo total do mês |
| totalMonthRangeDescription | String | Descrição do intervalo total do mês |
| totalMonthlyRangeValueFrom | String | Valor total do intervalo mensal de |
| totalMonthlyRangeValueTo | String | Valor total do intervalo mensal até |
| segmentInformation | String | Informação do segmento |
| summary> | ||
| total> | ||
| periodDescription | Descrição do período | |
| upcomingValueRangeCode | Código da faixa dos valores a vencer | |
| upcomingValueRangeDescription | Descrição da faixa dos valores a vencer | |
| upcomingValueFrom | Valor a vencer “De” | |
| upcomingValueTo | Valor a vencer “Até” | |
| upcomingPercentageValueFrom | Valor percentual “De” | |
| upcomingPercentageValueTo | Valor percentual “Até” | |
| businessReferences> | ||
| lastUpdateDate | String | Data da última atualização de referenciais de negócios |
| businessReferencesList> | ||
| businessDescription | String | Descrição do negócio |
| yearPotentialDate | String | Data potencial - ano |
| monthPotentialDate | String | Data potencial - mês |
| potentialValueRangeCode | String | Código de intervalo de valor potencial |
| potentialValueRangeDescription | String | Descrição do intervalo de valores potencial |
| potentialValueFrom | String | Valor potencial de |
| potentialValueTo | String | Valor potencial para |
| potentialMidrangeCode | String | Código potencial de médio porte |
| potentialMidrangeDescription | String | Descrição potencial de médio porte |
| potentialMidrangeValueFrom | String | Valor médio potencial de |
| potentialMidrangeValueTo | String | Valor médio potencial para |
| segmentInformation | String | Informação do segmento |
| segmentData> | ||
| assignor> | Blocos de informações cedentes | |
| paymentHistory> | ||
| monthDetail> | ||
| months> | ||
| month | String | Mês |
| periodList> | ||
| rangeCode | String | Código da faixa de valores |
| name | String | Nome da Pontuação da faixa de valores |
| range | String | Faixa de valores |
| rangeValueFrom | Faixa do valor “De” | |
| rangeValueTo | Faixa do valor “Até” | |
| percentage | String | Faixa de valor percentual |
| percentageFrom | Faixa de valor percentual “De” | |
| percentageTo | Faixa de valor percentual “Até” | |
| summary> | ||
| punctual | Informações de pagamento: “Pontual” | |
| period8To15 | Informações de pagamento: “De 8 a 15 dias” | |
| period16To30 | Informações de pagamento: “De 16 a 30 dias” | |
| period31To60 | Informações de pagamento: “De 31 a 60 dias” | |
| periodGT60 | Informações de pagamento: “Acima de 60 dias” | |
| spotPayment | Informações de pagamento: “A Vista” | |
| total | Informações de pagamento: “Total” | |
| periodDescription | String | Descrição do período |
| totalValueRangeCode | String | Código de intervalo de valor total |
| totalValueRangeDescription | String | Descrição do intervalo de valor total |
| totalValueFrom | integer | Valor do pagamento “De” |
| totalValueTo | integer | Valor do pagamento “Até” |
| averageValueRangeCode | String | Código de intervalo de valor médio |
| averageValueRangeDescription | String | Descrição do intervalo de valor médio |
| percentageValueFrom | number | Percentual de pagamento “De” |
| percentageValueTo | number | Percentual de pagamento “Até” |
| historicalAverageRangeFrom | integer | Histórico de intervalo médio “De” |
| historicalAverageRangeTo | integer | Histórico de intervalo médio “Até” |
| originCode | integer | Código da faixa |
| averageDelayPeriod> | ||
| periodList> | ||
| AverageDelayPeriodItem> | ||
| period | String | Período médio de atraso (dias) |
| averageDelayDaysFrom | integer | Faixa período médio de atraso (dias) De |
| averageDelayDaysTo | integer | Faixa período médio de atraso (dias) Ate |
| summary> | ||
| AverageDelayPeriodSummary> | ||
| averageDelayDaysFrom | integer | Resumo da faixa período médio de atraso (dias) De |
| averageDelayDaysTo | integer | Resumo da faixa período médio de atraso (dias) Ate |
| evolutionCommitmentsSuppliers> | ||
| lastUpdateDate | String ($date) | Data da última atualização da Evolução de Compromissos |
| evolutionCommitmentsSuppliersList> | ||
| yearCommitment | String | Ano do compromisso |
| monthCommitment | String | Mês do compromisso |
| descriptionMonthCommitment | String | Descrição do mês de compromisso |
| trackCodeToExpire | String | Código do acompanhamento da expiração |
| trackDescriptionToExpire | String | Descrição da faixa expirada |
| valueCommitmentsDueFrom | String | Valor compromissos devidos de |
| valueCommitmentsDueTo | String | Valor compromissos devidos para |
| totalMonthRangeCode | String | Código do intervalo total do mês |
| totalMonthRangeDescription | String | Descrição do intervalo total do mês |
| totalMonthlyRangeValueFrom | String | Valor total do intervalo mensal de |
| totalMonthlyRangeValueTo | String | Valor total do intervalo mensal até |
| segmentInformation | String | Informação do segmento |
| summary> | ||
| total> | ||
| periodDescription | Descrição do período | |
| upcomingValueRangeCode | Código da faixa dos valores a vencer | |
| upcomingValueRangeDescription Descrição da faixa dos valores a vencer | ||
| upcomingValueFrom | Valor a vencer “De” | |
| upcomingValueTo | Valor a vencer “Até” | |
| upcomingPercentageValueFrom | Valor percentual “De” | |
| upcomingPercentageValueTo | Valor percentual “Até” | |
| businessReferences> | ||
| lastUpdateDate | String | Data da última atualização de referenciais de negócios |
| businessReferencesList> | ||
| businessDescription | String | Descrição do negócio |
| yearPotentialDate | String | Data potencial - ano |
| monthPotentialDate | String | Data potencial - mês |
| potentialValueRangeCode | String | Código de intervalo de valor potencial |
| potentialValueRangeDescription | String | Descrição do intervalo de valores potencial |
| potentialValueFrom | String | Valor potencial de |
| potentialValueTo | String | Valor potencial para |
| potentialMidrangeCode | String | Código potencial de médio porte |
| potentialMidrangeDescription | String | Descrição potencial de médio porte |
| potentialMidrangeValueFrom | String | Valor médio potencial de |
| potentialMidrangeValueTo | String | Valor médio potencial para |
| segmentInformation | String | Informação do segmento |
| relationshipSuppliersPeriods> | ||
| lastUpdateDate | String | |
| relationshipSuppliersPeriodList> | String | |
| relationshipPeriodDescription | String | Descrição do período de relacionamento |
| relationshipSourceQuantity | integer | Número de fontes de relacionamento |
| summary> | ||
| sourcesTotal | integer | Quantidade de fontes de informação |
| paymentHistorySources | integer | Quantidade de fontes de informação – Histórico de Pagamento |
| paymentHistoryValuesSources | integer | Quantidade de fontes de informação – histórico de Pagamento (Valores em R$) |
| evolutionCommitmentsSources | integer | Quantidade de fontes de informação – Evolução de Compromisso |
| businessReferencesSources | integer | Quantidade de fontes de informação – Referenciais de Negócios |
| spotPaymentBusinessReferencesSources | integer | Quantidade de fontes de informação – Referenciais de Negócios com Pagamento à Vista |
| evolutionCommitmentsSuppliersUpcoming> | ||
| monthDetail> | ||
| months> | ||
| month | String | Mês |
| periodList> | ||
| rangeCode | String | Código da faixa de valores |
| name | String | Nome da Pontuação da faixa de valores |
| range | String | Faixa de valores |
| rangeValueFrom | Faixa do valor “De” | |
| rangeValueTo | Faixa do valor “Até” | |
| percentage | String | Faixa de valor percentual |
| percentageFrom | Faixa de valor percentual “De” | |
| percentageTo | Faixa de valor percentual “Até” | |
| summary> | ||
| periodTo10 | Informações de pagamento: “Até 10 dias” | |
| period10To30 | Informações de pagamento: “De 10 a 30 dias” | |
| period30To45 | Informações de pagamento: “De 30 a 45 dias” | |
| period45To60 | Informações de pagamento: “De 45 a 60 dias” | |
| periodGT60 | Informações de pagamento: “Acima de 60 dias” | |
| total | Informações de pagamento: “Total” | |
| periodDescription | String | Descrição do período |
| upcomingValueRangeCode | String | Código de intervalo de valor futuro |
| upcomingValueRangeDescription | String | Descrição do intervalo de valores futuros |
| upcomingValueFrom | number | Valor futuro “De” |
| upcomingValueTo | number | Valor futuro “Até” |
| upcomingPercentageValueFrom | integer | Valor futuro do percentual “De” |
| upcomingPercentageValueTo | integer | Valor futuro do percentual “Até” |
| individual> | Blocos visão individual | |
| individualPaymentHistory> | ||
| lastUpdateDate | String | Retorna a data da última atualização. |
| suppliers> | ||
| supplierDescription | String | Código do fornecedor |
| lastUpdateDate | String | Retorna a data da última atualização |
| largestValueDate | string | Data de maior valor |
| largestValueRangeCode | string | Código do intervalo de maior valor |
| largestValueRangeCodeDescription | string | Descrição do código de intervalo especificado |
| largestValueFrom | integer | Valor inicial do intervalo |
| largestValueTo | integer | Valor final do intervalo |
| daysOverdueDate | string | Data aproximada de dias em atraso |
| daysOverdueRangeCode | string | Código de intervalo de dias em atraso |
| daysOverdueRangeCodeDescription | string | Descrição do código de intervalo especificado |
| daysOverdueFrom | integer | Valor inicial do intervalo |
| daysOverdueTo | integer | Valor final do intervalo |
| daysOverdueSignal | string | Sinal de dias de atraso |
| totalPaymentsRangeCode | string | Código sobre esta faixa de pagamentos totais |
| totalPaymentsRangeCodeDescription | string | Descrição sobre este código de intervalo |
| totalPaymentsFrom | integer | Valor inicial do intervalo |
| totalPaymentsTo | integer | Valor final do intervalo |
| totalPaymentsOverdueRangeCode | string | Código de intervalo de pagamentos totais em atraso |
| totalPaymentsOverdueRangeCodeDescription | string | Descrição do código do intervalo de pagamentos totais vencidos |
| totalPaymentsOverdueFrom | integer | Total de pagamentos em atraso “De” |
| totalPaymentsOverdueTo | integer | Total de pagamentos em atraso “Para” |
| averageOverdueDaysRangeCode | string | Código de intervalo de dias médios de atraso |
| averageOverdueDaysRangeCodeDescription | string | Descrição do código do intervalo de dias médios de atraso |
| averageOverdueDaysFrom | integer | Média de dias de atraso a partir “De” |
| averageOverdueDaysTo | integer | Média de dias de atraso “Para” |
| originCode | string | código de segmento |
| individualBusinessReferences> | ||
| lastUpdateDate | string | Returns the date of last update |
| suppliers> | ||
| IndividualBusinessReferencesData> | ||
| supplierDescription | string | Código do fornecedor |
| lastUpdateDate | string | Retorna a data da última atualização |
| lastPurchaseDate | string | Retorna a data da última compra |
| lastPurchaseRangeCode | string | Código de intervalo da última compra |
| lastPurchaseRangeCodeDescription | string | Descrição do código de intervalo da última compra |
| lastPurchaseValueFrom | integer | Valor inicial da última compra |
| lastPurchaseValueTo | integer | Valor final da última compra |
| dateLargestInvoice | string | Data da maior fatura |
| largestInvoiceRangeCode | string | Código de intervalo da maior fatura |
| largestInvoiceRangeCodeDescription | string | Descrição do código de intervalo da maior fatura |
| largestInvoiceValueFrom | integer | Valor inicial da maior fatura |
| largestInvoiceValueTo | integer | Valor final da maior fatura |
| largestAccumulationRangeCode | string | Código de intervalo da maior fatura |
| largestAccumulationRangeCodeDescription | string | Descrição do código de intervalo da maior fatura |
| largestAccumulationValueFrom | integer | Valor inicial da maior fatura |
| largestAccumulationValueTo | integer | Valor final da maior fatura |
| spotInstallmentIndicator | string | Indicador do tipo de pagamento (P = Parcelado / A = À vista) |
| originCode | string | Código de segmento |
| summary> | ||
| lastPurchase | Informações: “Última Compra” | |
| largestInvoice | Informações: “Maior Fatura” | |
| largestAccumulation | Informações: “Maior Acúmulo” | |
| periodDescription | string | descrição do período |
| totalValueRangeCode | string | código de intervalo de valor total |
| totalValueRangeDescription | string | Descrição do intervalo de valor total |
| totalValueFrom | integer | Valor total “De” |
| totalValueTo | integer | Valor total “Para” |
| averageValueRangeCode | string | Código de intervalo de valor médio |
| averageValueRangeDescription | string | Descrição do intervalo de valor médio |
| percentageValueFrom | number | Valor percentual de |
| percentageValueTo | number | Valor percentual para |
| averagePaymentDelayPeriodRangeValueFrom | integer | Valor médio do intervalo do período de atraso de pagamento “De” |
| averagePaymentDelayPeriodRangeValueTo | integer | Valor médio do intervalo do período de atraso de pagamento “Para” |
| historicalAverageRangeFrom | integer | Taxa média histórica “De” |
| historicalAverageRangeTo | integer | Taxa média histórica “Para” |
| originCode | integer | Código de origem |
| individualEvolutionCommitmentsSuppliers> | ||
| lastUpdateDate | string | Descrição do fornecedor |
| suppliers> | ||
| supplierDescription | string | Descrição do fornecedor |
| lastUpdateDate | string | Última data de atualização |
| upcomingValuesRangeCode | string | Código de intervalo de valores futuros |
| upcomingValuesRangeDescription | string | Descrição do intervalo de valores futuros |
| upcomingValuesFrom | integer | Valores a vencer “De” |
| upcomingValuesTo | integer | Valores a vencer “Para” |
| originCode | string | Código de origem |
| summary> | ||
| upcoming> | ||
| periodDescription | string | Descrição do período |
| totalValueRangeCode | string | Código de intervalo de valor total |
| totalValueRangeDescription | string | Descrição do intervalo de valor total |
| totalValueFrom | integer | Valor do pagamento “De” |
| totalValueTo | integer | Valor do pagamento “Até” |
| averageValueRangeCode | string | Código de intervalo de valor médio |
| averageValueRangeDescription | string | Descrição do intervalo de valor médio |
| percentageValueFrom | number | Percentual de pagamento “De” |
| percentageValueTo | number | Percentual de pagamento “Até” |
| historicalAverageRangeFrom | integer | Histórico de intervalo médio “De” |
| historicalAverageRangeTo | integer | Histórico de intervalo médio “Até” |
| originCode | integer | Código da faixa |
| individualRelationshipSuppliersPeriods> | ||
| lastUpdateDate | ||
| suppliers> | ||
| supplierDescription | string | Descrição do fornecedor |
| lastUpdateDate | string | Retorna a data da última atualização |
| consumerSinceDate | string | Data sobre o início do relacionamento |
| originCode | string | Código de segmento |
Informações Adicionais
As informações adicionais serão exibidas apenas para os relatórios analíticos quando houver alguma situação irregular com a reciprocidade do cliente.
"additionalInformationReport":{ "reciprocityData":{ "reciprocityMessageDescription":"ATENÇÃO!!! VOCE NÃO ESTÁ VISUALIZANDO O BLOCO 'EVOLUCAO DE COMPROMISSOS'. SUA EMPRESA ENCONTRA-SE EM ATRASO COM O ENVIO DOS DADOS DESDE dd/MM/yyyy. AO REGULARIZAR O ENVIO, O REFERIDO BLOCO VOLTARÁ A SER EXIBIDO AUTOMATICAMENTE." } }
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| additionalInformationReport > reciprocityData | ||
| reciprocityMessageDescription | string | Descrição da mensagem de reciprocidade |
RETORNO DAS FEATURES OPCIONAIS
Limite de Crédito (HLC1)
Possíveis campos de retorno para o score Limite de Crédito, modelo HLC1.
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| scores > scoreResponse | ||
| score | integer | Pontuação do score |
| scoreModel | string | Modelo do score |
| message | string | Mensagem informativa |
Gasto Estimado com Positivo
Possíveis campos de retorno para o score Gasto Estimado com Positivo.
| Campo | Tipo | Descrição |
|---|---|---|
| score > scoreResponse | ||
| scoreModel | string | Modelo do score |
| scoreParam | ||
| key | string | Título (label) do Gasto Estimado |
| value | string | Gasto Estimado Anual da Empresa |
| message | string | Mensagem informativa |
Score Positivo
Possíveis campos de retorno para o score Score Positivo, modelos HPJ8 e HPJ9.
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| scores > scoreResponse | ||
| scoreModel | string | Modelo do score |
| scoreParam | ||
| key | string | Título (label) do Gasto Estimado |
| value | string | Gasto Estimado Anual da Empresa |
| message | string | Mensagem informativa |
Pontualidade de Pagamento (HIP2)
Possíveis campos de retorno para o score Pontualidade de Pagamento, modelo HIP2.
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| scoreResponse | ||
| score | integer | Pontuação do score |
| scoreModel | string | Modelo do score |
| defaultRate | string | Probabilidade de inadimplência |
| message | string | Mensagem informativa |
| Capacidade |
Capacidade Mensal de Pagamento (HCP1)
Possíveis campos de retorno para o score Capacidade Mensal de Pagamento, modelo HCP1.
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| scoreResponse | ||
| score | integer | Pontuação do score |
| scoreModel | string | Modelo do score |
| defaultRate | string | Probabilidade de inadimplência |
| message | string | Mensagem informativa |
Faturamento Estimado com Positivo
Possíveis campos de retorno para o score Faturamento Estimado com Positivo.
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| scores > scoreResponse | ||
| score | Integer | Pontuação do score |
| scoreModel | string | Modelo do score |
| scoreParam | ||
| key | string | Título (label) do Faturamento Estimado |
| value | string | Valor correspondente ao label |
| message | string | Mensagem informativa |
Participação em Empresas
Possíveis campos de retorno para Participação em Empresas, exibindo até 6 registros
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| participateds | ||
| participatedDocumentId | string | CNPJ da empresa participada |
| digitDocument | string | Dígito do CNPJ da empresa participada |
| documentSequence | string | Número da sequência da empresa participada |
| participatedName | string | Razão social da empresa participada |
| statusCompany | string | Status da empresa participada |
| squareCompany | string | Código da praça da empresa participada |
| restrictionSign | boolean | Indicador de negativo da empresa participada |
| updateDate | string | Data da atualização das informações |
| address | ||
| city | Cidade da empresa participada | |
| state | Estado da empresa participada | |
| participants | ||
| documentId | string | Número do documento do participante (CPF ou CNPJ) |
| documentSequence | string | Número da sequência do documento do participante |
| digitDocument | string | Dígito do documento do participante |
| participantName | string | Nome/Razão social do participante |
| participationType | string | Tipo do vínculo do participante com a empresa |
| participationPercentageCapital | number | Percentual de participação do participante |
| restrictionSign | boolean | Indicador de negativo do participante |
| companySituationCode | string | Status do participante |
| resume | ||
| participationPercentageCapitalTotal | number | Percentual total dos participantes na empresa |
Anotações e Consultas SPC
Possíveis campos de retorno para Anotações e Consultas SPC, exibindo os 5 últimos registros mais recentes para Anotações SPC, as 5 últimas consultas detalhadas para Consultas SPC e as informações do mês atual e os últimos 6 meses para as consultas resumidas.
Anotações SPC
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| spcAnnotations | ||
| inclusionDate | string | Data de inclusão |
| occurrenceDate | string | Data da ocorrência |
| contractId | string | Identificador do contrato |
| principal | boolean | Principal (true) ou Avalista (false) |
| spcAnnotations | ||
| inclusionDate | string | Data de inclusão |
| occurrenceDate | string | Data da ocorrência |
| contractId | string | Identificador do contrato |
| principal | boolean | Principal (true) ou Avalista (false) |
| creditorName | string | Nome do credor da anotação |
| amount | number | Valor da anotação |
| city | string | Cidade |
| federalUnit | string | Estado |
| origin | string | Origem da anotação |
| summary | ||
| firstOcurrence | string | Data da negativação mais recente |
| lastOcurrence | string | Data da negativação mais antiga |
| count | integer | Quantidade total das anotações |
| balance | number | Valor total das anotações |
Consultas SPC
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| spcMarketInquiries | ||
| occurrenceDate | string | Data da consulta |
| companyName | string | Nome do CNPJ consultante |
| companyDocumentId | string | Número do CNPJ consultante |
| daysQuantity | string | Quantidade de consultas no dia |
| inquiryQuantity | ||
| actual | Integer | Quantidade de consulta do mês atual |
| creditInquiriesQuantity | ||
| inquiryDate | string | Data dos últimos 6 meses |
| occurrences | integer | Quantidade de consulta dos últimos 6 meses |
Recomendação e Limite de Crédito Possíveis campos de retorno para Recomendação e Limite de Crédito
Recomendação e Limite de Crédito
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| code | Integer | Código de retorno do status |
| message | string | Mensagem de retorno do status |
| data | Dados de retorno da recomendação | |
| proposalNumber | string | Número da proposta valor dinâmico |
| document | string | CNPJ da empresa |
| companyName | string | Nome da empresa |
| transactionValue | number | Valor da operação |
| creationDate | string | Data de criação da proposta |
| saleType | string | Tipo da venda se é cliente novo ou recorrente |
| saleTypeCode | Integer | Código do tipo da venda |
| riskLevelCode | Integer | Nível de risco da empresa |
| recommendationType | string | Tipo da recomendação: 1 - positiva 2 - negativa ou 3 - análise manual |
| recommendationSaleType | string | Mensagem do tipo de recomendação |
| recommendedLimitValue | number | Valor do limite de crédito recomendado |
| analyzedCriteria | Critério de análise | |
| documentActive | boolean | CNPJ ativo ou não |
| statusRegistration | boolean | Status junto a Receita Federal |
| foundationTime | boolean | Data da fundação |
| noRestrictiveActive | boolean | Se não tem restritivo |
QSA – Quadro Social e Administrativo Possíveis campos de retorno para dados (Informações de Sócios e Administradores), exibindo até 10 sócios e adminstradores.
QSA - Quadro Social e Administrativo
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| companyData | ||
| socialCapitalValue | number | Capital social da empresa |
| accomplishedValue | number | Capital realizado da empresa |
| informationUpdateDate | string | Data de atualização das informações |
| countryOrigin | string | País de origem |
| controlType | string | Tipo de controle da empresa |
| nature | string | Natureza da empresa |
| partnerCompleteReport > partnersList | ||
| documentType | string | Tipo do documento do sócio (CPF ou CNPJ) |
| documentId | string | Número do documento do sócio |
| name | string | Nome completo / Razão social do sócio |
| sinceDate | string | Data de entrada do sócio na empresa |
| nationality | string | Nacionalidade do sócio |
| restrictionSign | boolean | Indicativo de anotações negativas do sócio |
| documentConsistency | boolean | Indicativo de inconsistência do sócio |
| capitalTotalValue | number | Capital total do sócio |
| capitalVoterValue | number | Capital votante do sócio |
| directorCompleteReport > directorsList | ||
| documentType | string | Tipo do documento do administrador (CPF ou CNPJ) |
| documentId | string | Número do documento do administrador |
| name | string | Nome / Razão social do administrador |
| role | string | Cargo do administrador |
| sinceDate | string | Data de entrada do administrador na empresa |
| mandateStart | string | Data de início de mandato do administrador |
| mandateEnd | string | Data de final de mandato do administrador |
| nationality | string | Nacionalidade do administrador |
| maritalStatus | string | Estado civil do administrador (apenas para CPF’s) |
| restrictionSign | boolean | Indicativo de anotações negativas do administrador |
| documentConsistency | boolean | Indicativo de inconsistência do administrador |
| informationUpdateDate | string | Data de Atualização dos Administradores |
| typeOfMandate | string | Tipo do mandato indeterminado |
| summary | ||
| firstOccurrence | string | Não se aplica |
| lastOccurrence | string | Não se aplica |
| count | integer | Quantidade total de administradores da empresa |
| balance | number | Não se aplica |
| infoMessages | ||
| message | string | Mensagens Informativas para empresas que não possuem Quadro Societário (Vide anexo I) |
QSA + Completo - Quadro Social Administrativo Mais Completo
Possíveis campos de retorno para dados (Informações completas de Sócios e Administradores), exibindo até 10 sócios e adminstradores.
QSA - Quadro Social Administrativo Mais Completo
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| shareCapital | ||
| capitalValue | number | Capital social da empresa |
| realizedCapitalValue | number | Capital realizado da empresa |
| origin | string | País de origem |
| control | string | Tipo de controle da empresa |
| nature | string | Natureza da empresa |
| updateDate | string | Data de atualização das informações |
| partners | ||
| kindPerson | string | Tipo do documento do sócio (F = pessoa física / J = pessoa jurídica) |
| document | string | Número do documento do sócio (CPF ou CNPJ, apenas documento raiz) |
| documentBranch | string | Filial do CNPJ (apenas para sócios do tipo pessoa jurídica) |
| documentDigit | string | Dígito verificador do documento CPF ou CNPJ |
| documentSequence | string | Número da sequência do documento |
| name | string | Nome completo / Razão social do sócio |
| entryDate | string | Data de entrada do sócio |
| nationality | string | Nacionalidade do sócio |
| percentageVotingCapital | number | Percentual do capital votante do sócio |
| percentageCapital | number | Percentual do capital total do sócio |
| restrictionIndicator | boolean | Indicativo de anotações negativas do sócio |
| relationship | string | Vínculo do sócio com a empresa (A = administrador / S = sócio / D = sócio administrador) |
| foundationDate | string | Data de entrada na sociedade (apenas para sócio do tipo pessoa jurídica) |
| address | ||
| addressLine | string | Endereço |
| zipCode | string | CEP |
| district | string | Bairro |
| country | string | País |
| city | string | Cidade |
| state | string | Estado |
| countryCode | string | Código do país |
| phone | ||
| areaCode | string | Código de área |
| phoneNumber | string | Número de telefone |
| debts | ||
| debtType | string | Tipo de débito do sócio (quais negativações o sócio possui) |
| summary | ||
| firstOccurrence | string | Data da negativação mais recente |
| lastOccurrence | string | Data da negativação mais antiga |
| count | integer | Quantidade total de negativações |
| balance | number | Valor total das negativações |
| administrators | ||
| kindPerson | string | Tipo do documento do administrador (F = pessoa física / J = pessoa jurídica) |
| document | string | Número do documento do administrador (CPF ou CNPJ, apenas documento raiz) |
| documentBranch | string | Filial do CNPJ (apenas para administradores do tipo pessoa jurídica) |
| documentDigit | string | Dígito verificador do documento CPF ou CNPJ |
| documentSequence | string | Número da sequência do documento |
| name | string | Nome completo / Razão social do administrador |
| office | string | Descrição do cargo |
| nationality | string | Nacionalidade |
| maritalStatus | string | Estado civil |
| startDateTerm | string | Data inicial do mandato |
| endDateTerm | string | Data final do mandato |
| entryDate | string | Data de entrada do administrador |
| restrictionIndicator | boolean | Indicador de restrição |
| updateDate | string | Data de atualização do administrador |
| birthDate | string | Data de nascimento |
| relationship | string | Vínculo do administrador (A = administrador / S = sócio / D = sócio administrador) |
| address | ||
| addressLine | string | Endereço do administrador |
| zipCode | string | CEP |
| district | string | Bairro |
| country | string | País |
| city | string | Cidade |
| state | string | Estado |
| countryCode | string | Código do país |
| phone | ||
| areaCode | string | Código de área |
| phoneNumber | string | Número de telefone |
| debts | ||
| debtType | string | Tipo de débito do sócio (quais negativações o sócio possui) |
| summary | ||
| firstOccurrence | string | Data da negativação mais recente |
| lastOccurrence | string | Data da negativação mais antiga |
| count | integer | Quantidade total de negativações |
| balance | number | Valor total das negativações |
| infoMessages | ||
| message | string | Mensagens Informativas para empresas que não possuem Quadro Societário (Vide anexo I) |
Histórico de Pagamento Comercial Avançado Possíveis campos de retorno para dados (Histórico de Pagamento Comercial Avançado)
Histórico de Pagamento Comercial Avançado
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| paymentHistory | ||
| titlesQuantity | string | Quantidade de títulos |
| rangeCode | string | Código da faixa de valores dos títulos |
| name | string | Nome da pontuação da faixa de valores dos títulos |
| range | string | Faixa de valores dos títulos |
| percentage | string | Faixa de valores percentual dos títulos |
| averageRangeCode | string | Código de alcance médio |
| averageRangeDescription | string | Descrição do intervalo médio |
| averageRangePercentage | string | Porcentagem de alcance médio |
| monthDetail | ||
| months | ||
| month | string | Mês |
| periodList | ||
| rangeCode | string | Código da faixa de valores |
| name | string | Nome da Pontuação da faixa de valores |
| range | string | Faixa de valores |
| rangeValueFrom | string | Faixa do valor “De” |
| rangeValueTo | string | Faixa do valor “Até” |
| percentage | string | Faixa de valor percentual |
| percentageFrom | string | Faixa de valor percentual “De” |
| percentageTo | string | Faixa de valor percentual “Até” |
| summary | ||
| punctual | Informações de pagamento: “Pontual” | |
| period8To15 | Informações de pagamento: “De 8 a 15 dias” | |
| period16To30 | Informações de pagamento: “De 16 a 30 dias” | |
| period31To60 | Informações de pagamento: “De 31 a 60 dias” | |
| periodGT60 | Informações de pagamento: “Acima de 60 dias” | |
| spotPayment | Informações de pagamento: “À Vista” | |
| total | Informações de pagamento: “Total” | |
| periodDescription | string | Descrição do período |
| totalValueRangeCode | string | Código de intervalo de valor total |
| totalValueRangeDescription | string | Descrição do intervalo de valor total |
| totalValueFrom | integer | Valor do pagamento “De” |
| totalValueTo | integer | Valor do pagamento “Até” |
| averageValueRangeCode | string | Código de intervalo de valor médio |
| averageValueRangeDescription | string | Descrição do intervalo de valor médio |
| percentageValueFrom | number | Percentual de pagamento “De” |
| percentageValueTo | number | Percentual de pagamento “Até” |
| historicalAverageRangeFrom | integer | Histórico de intervalo médio “De” |
| historicalAverageRangeTo | integer | Histórico de intervalo médio “Até” |
| originCode | integer | Código da faixa |
| averageDelayPeriods > Prazo médio de atraso | ||
| periodList | ||
| period | string | Período médio de atraso (dias) |
| averageDelayDaysFrom | integer | Faixa período médio de atraso (dias) “De” |
| averageDelayDaysTo | integer | Faixa período médio de atraso (dias) “Até” |
| summary | ||
| averageDelayDaysFrom | integer | Resumo da faixa período médio de atraso (dias) “De” |
| averageDelayDaysTo | integer | Resumo da faixa período médio de atraso (dias) “Até” |
| mainSuppliers | ||
| lastUpdateDate | string | Data da última atualização do Fornecedor Principal |
| mainSuppliersList | ||
| supplierName | string | Nome do Fornecedor |
| supplierDocument | string | Documento do Fornecedor |
| relationshipSuppliersPeriods | ||
| lastUpdateDate | string | Data da última atualização das relações com os fornecedores |
| relationshipSuppliersPeriodList | ||
| relationshipPeriodDescription | string | Descrição das relações com os fornecedores |
| relationshipSourceQuantity | number | Quantidade de fontes de relacionamentos com os fornecedores |
| summary | ||
| sourcesTotal | number | Quantidade de fontes de informação |
| paymentHistorySources | number | Quantidade de fontes de informação – Histórico de Pagamento |
| paymentHistoryValuesSources | number | Quantidade de fontes de informação – Histórico de Pagamento (Valores em R$) |
| evolutionCommitmentsSources | number | Quantidade de fontes de informação – Evolução de Compromisso |
| businessReferencesSources | number | Quantidade de fontes de informação – Referenciais de Negócios |
| spotPaymentBusinessReferencesSources | number | Quantidade de fontes de informação – Referenciais de Negócios com Pagamento à Vista |
| evolutionCommitmentsSuppliers | ||
| lastUpdateDate | string | Data da última atualização da Evolução de Compromissos |
| evolutionCommitmentsSuppliersList | ||
| yearCommitment | string | Ano do compromisso |
| monthCommitment | string | Mês do compromisso |
| descriptionMonthCommitment | string | Descrição do mês de compromisso |
| trackCodeToExpire | string | Código da faixa a vencer |
| trackDescriptionToExpire | string | Descrição da faixa a vencer |
| valueCommitmentsDueFrom | string | Valor compromissos a vencer “De” |
| valueCommitmentsDueTo | string | Valor compromissos a vencer “Para” |
| totalMonthRangeCode | string | Código do intervalo total do mês |
| totalMonthRangeDescription | string | Descrição do intervalo total do mês |
| totalMonthlyRangeValueFrom | string | Valor total do intervalo mensal “De” |
| totalMonthlyRangeValueTo | string | Valor total do intervalo mensal “Até” |
| segmentInformation | string | Informação do segmento |
| summary | ||
| total | ||
| periodDescription | string | Descrição do período |
| upcomingValueRangeCode | string | Código da faixa dos valores a vencer |
| upcomingValueRangeDescription | string | Descrição da faixa dos valores a vencer |
| upcomingValueFrom | string | Valor a vencer “De” |
| upcomingValueTo | string | Valor a vencer “Até” |
| upcomingPercentageValueFrom | string | Valor percentual “De” |
| upcomingPercentageValueTo | string | Valor percentual “Até” |
| businessReferences | ||
| lastUpdateDate | string | Data da última atualização de referenciais de negócios |
| businessReferencesList | ||
| businessDescription | string | Descrição do negócio |
| yearPotentialDate | string | Data potencial - ano |
| monthPotentialDate | string | Data potencial - mês |
| potentialValueRangeCode | string | Código de intervalo de valor potencial |
| potentialValueRangeDescription | string | Descrição do intervalo de valores potencial |
| potentialValueFrom | string | Valor potencial “De” |
| potentialValueTo | string | Valor potencial “Para” |
| potentialMidrangeCode | string | Código potencial de médio porte |
| potentialMidrangeDescription | string | Descrição potencial de médio porte |
| potentialMidrangeValueFrom | string | Valor médio potencial “De” |
| potentialMidrangeValueTo | string | Valor médio potencial “Para” |
| segmentInformation | string | Informação do segmento |
Perfil Financeiro Possíveis campos de retorno para Perfil Financeiro
Perfil Financeiro
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| companyIdentification | ||
| lastUpdateDate | string($date) | Data de atualização |
| document | string | Número do CNPJ da empresa |
| companyName | string | Razão social da empresa |
| consultationDate | string($date) | Data da consulta |
| consultationTime | string | Horário da consulta (HHmmSS) |
| balanceControl | ||
| balanceSheetDate | string($date) | Data do balanço |
| balanceType | Integer($int32) | Código do tipo de balanço |
| balanceTypeDescription | String | Descrição do tipo de balanço |
| demonstrativeType | Integer($int32) | Código do tipo de demonstrativo (1 = Balanço, 2 = Balancete) |
| demonstrativeTypeDescription | String | Descrição do tipo de demonstrativo (1 = Balanço, 2 = Balancete) |
| demonstrativePeriod | Integer($int32) | Período do demonstrativo (em meses) |
| valueUnit | Integer($int32) | Código do valor da unidade (0 = Unidade, 1 = Milhares, 2 = Milhões, 3 = Bilhões) |
| currency | Integer($int32) | Código da moeda |
| currencyDescription | String | Descrição da moeda |
| assetAccounts | ||
| accountLevelCode | Integer($int32) | Código do ativo |
| accountNumber | Integer($int32) | Número do ativo |
| accountName | string | Nome do ativo |
| accountValue | number($float) | Valor do ativo |
| brightnessIndicator | string | Indicativo de Brilho |
| liabilityAccounts | ||
| accountLevelCode | Integer($int32) | Código do ativo |
| accountNumber | Integer($int32) | Número do ativo |
| accountName | string | Nome do ativo |
| accountValue | number($float) | Valor do ativo |
| brightnessIndicator | string | Indicativo de Brilho |
| incomeStatementAccounts | ||
| accountLevelCode | Integer($int32) | Código do ativo |
| accountNumber | Integer($int32) | Número do ativo |
| accountName | string | Nome do ativo |
| accountValue | number($float) | Valor do ativo |
| brightnessIndicator | string | Indicativo de Brilho |
| financialIndices | ||
| indexCategoryCode | Integer($int32) | Código da categoria do índice |
| indexCode | Integer($int32) | Código do índice |
| indexDescription | string | Descrição do índice |
| balanceSheetIndex | string | Índice do balanço |
| standardBalanceSheetIndex | string | Índice padrão do balanço |
| drawee |
Indice Relacionamento Mercado Setor PJ (HRMS)
Possíveis campos de retorno para o score Indice Relacionamento Mercado Setor PJ, modelo HRMS.
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| scores > scoreResponse | ||
| scoreModel | string | Modelo do score |
| codeMessage | integer | Código da mensagem informativa |
| message | string | Mensagem informativa |
| codeGeneralSector | string | Código Geral do Setor |
| messageGeneralSector | string | Mensagem Geral do Setor |
| codeFinancialSector | string | Código do Setor Financeiro |
| messageFinancialSector | string | Mensagem do Setor Financeiro |
| codeWholesaleSector | string | Código do setor atacadista |
| messageWholesaleSector | string | Mensagem do setor atacadista |
| codeCommercialSector | string | Código do Setor Comercial |
| messageCommercialSector | string | Mensagem do Setor Comercial |
| codeIndustrialSector | string | Código do Setor Industrial |
| messageIndustrialSector | string | Mensagem do Setor Industrial |
| codeServiceSector | string | Código do Setor de Serviços |
| messageServiceSector | string | Mensagem do setor de serviços |
Risco Novas Empresas Possíveis campos de retorno para Risco Novas Empresas (HNE1):89
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| scores > scoreResponse | ||
| scoreModel | string | Modelo do score |
| message | string | Mensagem informativa |
Classificação de Risco Possíveis campos de retorno para Classificação de Risco
Classificação de Risco
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| riskRating | Dados de retorno da Classificação de Risco | |
| companySizeCode | string | Código do tamanho da empresa consultada |
| descriptionCompanySizeCode | string | Descrição do tamanho da empresa consultada |
| dateAttributionRating | string($date) | Data de atribuição da classificação |
| origin | number | Origem da classificação |
| descriptionOrigin | string | Descrição da origem da classificação |
| classRisk | string | Classe de risco |
| defaultProbability | Integer(int32) | Probabilidade padrão |
| averageDefaultProbability | Integer(int32) | Probabilidade padrão média |
| messageInformative | string | Mensagem informativa |
| scoreModel | string | Modelo de score |
Score de Fraude Possíveis campos de retorno para Score de Fraude PJ:
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| scoresFraud > scoresFraudResponse | ||
| scoreModel | string | Modelo do score |
| score | integer($int32) | Valor do score |
| recommendationRisk | string | Campo do risco de recomendação com os possíveis valores: NO_DECISION, VERY_HIGH, MODERATE, LOW, VERY_LOW |
| message | string | Mensagem do modelo de score requisitado |
Score Customizado
Possíveis campos de retorno para Score Customizado:
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| scores > scoreResponse | ||
| score | Integer | Pontuação do Score |
| scoreModel | String | Modelo de Score |
| range | String | Valor do intervalo de Score |
| defaultRate | String | Probabilidade de não pagamento |
| codeMessage | Integer | Código da mensagem de Score |
| message | String | Mensagem de Score |
FEATURE_HISTORICO_PAGAMENTO_FINANCEIRO_RELATO
Apresenta as informações sobre os hábitos de pagamento com o mercado: Principais Fornecedores, Histórico de Pagamento - Quantidade de Títulos e Valores, Evolução de Compromissos e Referenciais de Negócios.
Possíveis campos de retorno para FEATURE_HISTORICO_PAGAMENTO_FINANCEIRO_RELATO:
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| financialPaymentHistoryFeature > result > paymentCommitment > past | Object | |
| creditorsQuantity | Integer($int32) | Quantidade de Credores |
| financialPaymentHistoryFeature > result > paymentCommitment > past > totalCommitments | Object | Compromisso |
| range | String | Faixa |
| value | String | Valor |
| percentage | String | Percentagem |
| financialPaymentHistoryFeature > result > paymentCommitment > past > commitmentsQuantity | Object | Quantidade de Compromissos |
| range | String | Faixa |
| value | String | Valor |
| percentage | String | Percentagem |
| financialPaymentHistoryFeature > result > paymentCommitment > past > installment | Object | Pagamento Parcelado |
| paid | Float | Pago |
| due | Float | A Vencer |
| overdue | Float | Em Atraso |
| financialPaymentHistoryFeature > result > paymentCommitment > past > paymentMode | ArrayList | Modalidade de Crédito |
| name | String | Nome |
| percentage | Float | Percentagem |
| financialPaymentHistoryFeature > result > paymentCommitment > active | Object | |
| creditorsQuantity | Integer($int32) | Quantidade de Credores |
| financialPaymentHistoryFeature > result > paymentCommitment > active > totalCommitments | Object | Compromisso |
| range | String | Faixa |
| value | String | Valor |
| percentage | String | Percentagem |
| financialPaymentHistoryFeature > result > paymentCommitment > active > commitmentsQuantity | Object | Quantidade de Compromissos |
| range | String | Faixa |
| value | String | Valor |
| percentage | String | Percentagem |
| financialPaymentHistoryFeature > result > paymentCommitment > active > installment | Object | Pagamento Parcelado |
| paid | Float | Pago |
| due | Float | A Vencer |
| overdue | Float | Em Atraso |
| financialPaymentHistoryFeature > result > paymentCommitment > active > paymentMode | ArrayList | Modalidade de Crédito |
| name | String | Nome |
| percentage | Float | Percentagem |
| financialPaymentHistoryFeature > result > paymentBehavior > payment > past > total | Object | |
| range | String | Faixa |
| value | String | Valor |
| percentage | String | Percentagem |
| financialPaymentHistoryFeature > result > paymentBehavior > payment > past > revolvingCredit | Object | Crédito Rotativo |
| range | String | Faixa |
| value | String | Valor |
| percentage | String | Percentagem |
| financialPaymentHistoryFeature > result > paymentBehavior > payment > past > installmentPayment > punctualPayment | Object | Pagamento Pontual |
| range | String | Faixa |
| value | String | Valor |
| percentage | String | Percentagem |
| financialPaymentHistoryFeature > result > paymentBehavior > payment > past > installmentPayment > upTo30Days | Object | Até 30 Dias |
| range | String | Faixa |
| value | String | Valor |
| percentage | String | Percentagem |
| financialPaymentHistoryFeature > result > paymentBehavior > payment > past > installmentPayment > from30To60Days | Object | De 30 a 60 Dias |
| range | String | Faixa |
| value | String | Valor |
| percentage | String | Percentagem |
| financialPaymentHistoryFeature > result > paymentBehavior > payment > past > installmentPayment > above60Days | Object | Acima de 60 Dias |
| range | String | Faixa |
| value | String | Valor |
| percentage | String | Percentagem |
| financialPaymentHistoryFeature > result > paymentBehavior > payment > active | Object | |
| revolvingCredit | Float | Crédito Rotativo |
| punctualPayment | Float | Pagamento Pontual |
| upTo30Days | Float | Até 30 Dias |
| from30To60Days | Float | De 30 a 60 Dias |
| above60Days | Float | Acima de 60 Dias |
| financialPaymentHistoryFeature > result > paymentBehavior > payment > active > ranges | Object | Faixas |
| revolvingCredit | String | Crédito Rotativo |
| punctualPayment | String | Pagamento Pontual |
| latePayment | String | Pagamento Atrasado |
| financialPaymentHistoryFeature > result > paymentBehavior > payment > active > total | Object | |
| range | String | Faixa |
| value | String | Valor |
| percentage | String | Percentagem |
| financialPaymentHistoryFeature > result > paymentBehavior > payment > active > auxiliaries > revolvingCredit | Object | |
| range | String | Faixa |
| value | String | Valor |
| percentage | String | Percentagem |
| financialPaymentHistoryFeature > result > paymentBehavior > payment > active > auxiliaries > punctualPayment | Object | |
| range | String | Faixa |
| value | String | Valor |
| percentage | String | Percentagem |
| financialPaymentHistoryFeature > result > paymentBehavior > payment > active > auxiliaries > upTo30Days | Object | |
| range | String | Faixa |
| value | String | Valor |
| percentage | String | Percentagem |
| financialPaymentHistoryFeature > result > paymentBehavior > payment > active > auxiliaries > above30Days | Object | |
| range | String | Faixa |
| value | String | Valor |
| percentage | String | Percentagem |
| financialPaymentHistoryFeature > result > paymentBehavior > expirationBehavior | Object | |
| upTo30Days | Float | Até 30 Dias |
| from30To60Days | Float | De 30 a 60 Dias |
| from60To90Days | Float | De 60 a 90 Dias |
| above90Days | Float | Acima de 90 Dias |
| financialPaymentHistoryFeature > result > paymentBehavior > expirationBehavior > total | Object | |
| range | String | Faixa |
| value | String | Valor |
| percentage | String | Percentagem |
| financialPaymentHistoryFeature > result > paymentBehavior > contractBehavior | Object | Comportamento de Contratos |
| paid | Float | Pago |
| due | Float | A Vencer |
| overdue | Float | Em Atraso |
| financialPaymentHistoryFeature > result > paymentBehavior > contractBehavior > total | Object | |
| range | String | Faixa |
| value | String | Valor |
| percentage | String | Percentagem |
Indicadores de Recebíveis
Entenda o comportamento de uso dos recebíveis de cartão e encontre novas oportunidades de negócio.
Possíveis campos de retorno para Indicadores de Recebíveis:
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| noConsentIndicator | ||
| docIdRequested | String | CPF ou CNPJ do estabelecimento comercial que realiza vendas por meio de máquinas de cartão |
| descriptionResult | String | Resultado da descrição dos índices |
| updateDate | String($date) | Data da última atualização dos indicadores |
| noConsentIndicator > noConsentIndexes | ||
| hasFutureExpectedBalance | Boolean | Informa se o CNPJ consultado possui recebimentos futuros de pagamentos efetuados e edição de cartão |
| hasFutureFreeBalance | Boolean | Informa se o CNPJ consultado possui recebimentos futuros de pagamentos efetuados e edição de cartão |
| hasFutureWarrantyContract | Boolean | Informa se o CNPJ consultado possui recebimentos futuros de cartão de crédito empenhados como garantia de operações de crédito. |
| hasFutureAntecipationGranted | Boolean | Informa se o CNPJ consultou os recebimentos futuros antecipados de cartão de crédito. |
Dívidas com Órgãos Públicos
A feature Dívidas com Órgãos Públicos - Empresas irá retornar até 1000 anotações tributáveis e não-tributáveis registradas em órgãos e entidades federais do Brasil. A inexistência de registro não implica reconhecimento de regularidade de situação, nem dispensa a apresentação dos documentos exigidos em lei, decreto ou demais atos normativos. O retorno da informação com 'nada consta' ou demonstrando a não existência de anotações negativas estão sujeitas à cobrança, conforme valores contratualmente estipulados.
Possíveis campos de retorno para Dividas com Órgãos Públicos:
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| debtsPublicAgencies > debtsPublicAgenciesCommitments | ArrayList | |
| occurrenceDate | String | Data da Ocorrência |
| hour | String | Hora |
| origin | String | Origem |
| contract | String | Contrato |
| uf | String | UF |
| value | Number | Valor |
| guarantor | String | Avalista |
| modality | String | Modalidade |
| dueDate | String | Data Vencimento |
Localização
Aumente as chances de contato com seus clientes e fornecedores utilizando a opção de Endereços e Telefones Adicionais.
Possíveis campos de retorno para Localizacao:
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| location > addresses > addresses | ArrayList | |
| updateDate | String($date) | Data de atualização das informações |
| addressType | String | Tipo de endereço |
| addressTitle | String | Título do endereço |
| addressName | String | Nome do endereço |
| addressNumber | String | Número do endereço |
| addressComplement | String | Complemento de endereço |
| neighborhood | String | Vizinhança |
| city | String | Cidade |
| federalUnit | String | Estado |
| zipCode | String | Código Postal |
| relatedTo | String | Relacionado a |
| location > addresses > message | ||
| consultationDate | String($date) | Data da Consulta |
| consultationTime | String | Horário de consulta |
| textMessage | String | Mensagem de texto |
| location > phones > phones | ArrayList | |
| updateDate | String($date) | Data de atualização das informações |
| areaCode | String | Código de área |
| number | String | Número de telefone |
| relatedTo | String | Relacionado a |
| location > phones > message | ||
| consultationDate | String($date) | Data da Consulta |
| consultationTime | String | Horário de consulta |
| textMessage | String | Mensagem de texto |
Consultas Detalhadas à Serasa
Veja até 30 últimas consultas de todos os segmentos de mercado, inclusive de Instituições Financeiras, Indústrias, Comércio, Serviços e Outros.
Possíveis campos de retorno para Consultas Detalhadas à Serasa:
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| facts > inquiryCompanyResponse > results | ArrayList | |
| companyAlias | String | Nome do alias da empresa de consultoria |
| companyName | String | Nome legal da empresa de consultoria |
| daysQuantity | Int32 | Quantidade de dias desde a última consulta |
| occurrenceDate | String($date) | Data da ocorrência. Mask yyyy-MM-dd |
| companyDocumentId | String | ID do documento da empresa que consultou um documento registrado, no Brasil CNPJ |
| facts > inquiryCompanyResponse > quantity | ||
| actual | Integer | Quantidade real de consultas mensais |
| bankActual | Integer | Quantidade de consulta do mês real do banco |
| facts > inquiryCompanyResponse > quantity > historical | ArrayList | |
| bankOccurrences | Int32 | Quantidade de ocorrência bancária |
| inquiryDate | String | Mask yyyy-MM. Ano e mês vêm em campos diferentes |
| occurrences | Int32 | Quantidade de ocorrência do período |
Score dos Sócios
Informa a probabilidade de um indivíduo pagar seus compromissos financeiros nos próximos 12 meses. Essa probabilidade é calculada com base nos dados existentes na Serasa Experian no momento da consulta, e se aplica exclusivamente aos sócios PF de pequenas e médias empresas.
Possíveis campos de retorno para Score dos Sócios:
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| partnersScores > companyData | ||
| documentId | String | ID do documento da empresa |
| port | String | O porto da empresa |
| partnersScores > partnersScores | ArrayList | |
| name | String | Nome do parceiro |
| document | String | Documento do parceiro |
| score | Number | Valor da pontuação do parceiro. |
| paymentSuccessPercentage | Number | Porcentagem de pagamentos bem-sucedidos. |
| scoreClassification | String | Classificação da pontuação do parceiro. |
Anotações e Consultas SPC dos Sócios e Administradores
Apresenta as dívidas vencidas e não pagas pelos sócios da empresa consultada e informadas pelos clientes do SPC Brasil. E apresenta também a quantidade de consultas a crédito feitas para os sócios da empresa consultada no SPC Brasil.
Possíveis campos de retorno para Anotações e Consultas SPC dos Sócios e Administradores:
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| spcPartnersAnnotationsReport > result | ArrayList | |
| documentId | String | Número do Documento do Sócio – CPF/CNPJ |
| name | String | Nome da empresa |
| documentConsistency | Boolean | Consistência do documento |
| annotationsQuantity | Integer | Quantidade total de anotações |
| annotationsValue | Number | Quantidade total de anotações |
| lastAnnotationDate | String | Data da anotaçao mais recente |
| spcPartnersAnnotationsReport > result (ArrayList) > partnerSPCAnnotationsData | ArrayList | Listagem com dados das anotações de do sócio da empresa |
| contract | String | Número do contrato |
| operationType | String | Tipo de Operação (C=COMPRADOR/F=FIADOR/A=AVALISTA) |
| annotationValue | Number | Valor da anotação |
| city | String | Cidade |
| uf | String | Estado |
| associated | String | Nome Associado Credor |
| annotationOrigin | String | Origem da Anotação |
| message | String | Mensagem Quando Informação Indisponível |
| spcPartnersAnnotationsReport > partnerSPCInquiriesResult | ArrayList | |
| documentId | String | Número do Documento do Sócio – CPF/CNPJ |
| documentConsistency | Boolean | Consistência do documento |
| name | String | Nome da empresa |
| inquiriesPartnerQuantity | Integer | Quantidade total de consultas do sócio |
| spcPartnersAnnotationsReport > partnerSPCInquiriesResult > partnerSPCInquiriesData | ArrayList | |
| consultationDate | String($date) | Data da consulta |
| name | String | Nome da empresa |
| inquiriesPartnerQuantity | Integer | Quantidade total de consultas do sócio |
| message | String | Mensagem quando informação indisponível |
| spcPartnersAnnotationsReport > partnerSPCInquiriesResult > partnerSPCInquiriesPerMonthData | ArrayList | |
| inquiryYear | Integer | Ano da consulta |
| inquiryMonth | Integer | Mês da consulta |
| descriptionMonth | String | Descrição do mês de consulta |
| inquiriesPartnerQuantity | Integer | Quantidade total de consultas |
Situação Fiscal
Apresenta dados fiscais provenientes da Receita Federal, Sintegra e Suframa, aumentando a segurança no processo de concessão de crédito de forma a evitar negócios com empresas em situação irregular no Fisco.
Possíveis campos de retorno para Situação Fiscal:
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| fiscalSituation | ||
| document | String | Documento solicitado |
| fiscalSituation > sintegra | ArrayList | Dados da empresa em sintegra |
| observation | String | Observações sobre a empresa em sintegra |
| fiscalSituation > sintegra (ArrayList) > situation | ||
| registrationNumber | String | Número de registro estadual |
| situationDate | String($date) | Data de status |
| situationCode | String | Código de situação |
| fiscalSituation > sintegra (ArrayList) > identification | ||
| websiteConsultationNumber | String | Número de consulta do site |
| websiteConsultationDate | String($date) | Data de consulta ao site |
| corporateName | String | Razão social |
| fiscalSituation > sintegra (ArrayList) > economicActivity | ||
| description | String | Descrição do CNAE |
| fiscalSituation > sintegra (ArrayList) > message | ArrayList | |
| code | Integer($int32) | Código de erro |
| description | String | Mensagem de erro |
| fiscalSituation > suframa | ArrayList | Dados da empresa em suframa |
| registrationNumber | String | Número de registro da Suframa |
| consultationDate | String($date) | Data da consulta no suframa |
| suframaNumber | String | Número Suframa |
| registrationSituation | String | Situação de registro em suframa |
| fiscalSituation > suframa (ArrayList) > message | ArrayList | |
| code | Integer($int32) | Código de erro |
| description | String | Mensagem de erro |
| fiscalSituation > federalRevenue | Situação da empresa perante a Receita Federal | |
| fiscalSituation > federalRevenue > identification | Informações de identificação da empresa no site da receita federal | |
| consultationDate | String($date) | Data de consulta na receita federal |
| description | String | Descrição da situação da receita federal |
| corporateName | String | Razão social |
| situationDate | String($date) | Status date |
| simpleChoose | String | Se uma empresa escolhe o simples |
| situationCode | String | Código da Situação - 0 INAPTA, 2 ATIVA, 4 NULA, 6 SUSPENSA, 7 BAIXADA, 9 CANCELADA |
| fiscalSituation > federalRevenue > identification > cnae | Descrição do CNAE | |
| code | String | Código CNAE |
| segment | String | Segmento CNAE |
| description | String | Descrição do CNAE |
| fiscalSituation > federalRevenue > cnaeSecondary | ArrayList | CNAEs secundários |
| code | String | Código CNAE |
| segment | String | Segmento CNAE |
| description | String | Descrição do CNAE |
| fiscalSituation > federalRevenue > message | ArrayList | Mensagens sobre informações da receita federal |
| code | Integer($int32) | Código de erro |
| description | String | Mensagem de erro |
| fiscalSituation > errorMessage | ArrayList | Mensagens de erro para pedidos de registro, pedidos e processamento |
| code | Integer($int32) | Código de erro |
| description | String | Mensagem de erro |
Comportamento de Pagamento do Setor
Conheça o Comportamento de Pagamento de um grupo de empresas de um mesmo setor, região e porte nos últimos 13 meses.
Possíveis campos de retorno para Comportamento de Pagamento do Setor:
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| sectorPaymentBehavior > latePayments | Bloco de informações sobre pagamento atrasado | |
| referenceDate | String($date) | Data de referência |
| percentageInSight | Number | Porcentagem em dinheiro, com 2 casas decimais |
| averageCashValue | Number | Valor médio em dinheiro, com 2 casas decimais |
| percentage8To15 | Number | Porcentagem 8 – 15, com 2 casas decimais |
| averageValue8To15 | Number | Valor médio 8 – 15, com 2 casas decimais |
| percentage16To30 | Number | Porcentagem 16 – 30, com 2 casas decimais |
| averageValue16To30 | Number | Valor médio 16 – 30, com 2 casas decimais |
| percentage31To60 | Number | Porcentagem 31 – 60, com 2 casas decimais |
| averageValue31To60 | Number | Valor médio 31 – 60, com 2 casas decimais |
| percentageAbove60 | Number | Porcentagem acima de 60, com 2 casas decimais |
| averageValueAbove60 | Number | Valor médio acima de 60, com 2 casas decimais |
| totalPercentage | Number | Porcentagem total, com 2 casas decimais |
| totalAverageValue | Number | Valor total médio, com 2 casas decimais |
| averageDelayPeriodInDays | Number | Período médio de atraso em dias, com 2 casas decimais |
| sectorPaymentBehavior > futureMaturities | Bloco de informações sobre maturidade futura | |
| referenceDate | String($date) | Data de referência |
| percentageUpTo10 | Number | Porcentagem até 10, com 2 casas decimais |
| averageValueUpTo10 | Number | Valor médio até 10, com 2 casas decimais |
| percentage11To30 | Number | Porcentagem 11 – 30, com 2 casas decimais |
| averageValue11To30 | Number | Valor médio 11 – 30, com 2 casas decimais |
| percentage31To45 | Number | Porcentagem 31 – 45, com 2 casas decimais |
| averageValue31To45 | Number | Valor médio 31 – 45, com 2 casas decimais |
| percentage46To60 | Number | Porcentagem 46 – 60, com 2 casas decimais |
| averageValue46To60 | Number | Valor médio 46 – 60, com 2 casas decimais |
| percentageAbove60 | Number | Porcentagem acima de 60, com 2 casas decimais |
| averageValueAbove60 | Number | Valor médio acima de 60, com 2 casas decimais |
| totalPercentage | Number | Porcentagem total, com 2 casas decimais |
| totalAverageValue | Number | Valor médio total, com 2 casas decimais |
| sectorPaymentBehavior > noCalculation | Bloco contendo mensagem explicativa de Não Cálculo | |
| referenceDate | String | Data de referência |
| messageCode | Intewger | Código de mensagem sem cálculo |
| messageText | String | Texto de mensagem sem cálculo |
Mosaic PJ Conheça o Mosaic Business, entenda em profundidade o perfil da empresa consultada e tenha mais segurança em sua tomada de decisão.
Possible return fields for Mosaic PJ:
| Field Name | Type | Description |
|---|---|---|
| mosaic | ||
| code | String | Brazilian Society Classification Code |
| group | String | Brazilian Society Classification Group |
| description | String | Brazilian Society Classification Description |
Score de Crédito Setorial
Conheça o Serasa Score Setorial que apresenta a Classificação de Risco do Setor de atuação da Empresa Consultada.
Possíveis campos de retorno para Score de Crédito Setorial:
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| sectorizedScore | ||
| scoreModel | String | scoreModel, que é um parâmetro selecionado para url |
| scoreBrazil | String | score Brasil |
| prinadBrazil | String | Prinad Brasil |
| prinadRegion | String | Região de Prinad |
| scoreRegion | String | Score Região |
| scoreUf | String | Score Uf |
| prinadUf | String | Prinad Uf |
| ufMatriz | String | Uf Matriz |
| brazil | String | Brasil |
| message | String | Nome do parceiro |
| region | String(Enum) | Região Ex: [ "N", "NE", "NO", "SE", "S", "CO" ] |
Alerta Cadastral de Sócios e Administradores
Alerta Cadastral Sócios e Administradores pode auxiliar o contratante na realização de uma transação comercial mais segura e ágil ao avaliar alterações no quadro societário e administrado cadastrais nos últimos 12 meses e inconsistências comerciais identificadas até o momento da consulta.
Possíveis campos de retorno para Alerta Cadastral de Sócios e Administradores:
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| partnerAdminRegistrationAlerts > partners > changeAlerts > alerts | ArrayList | Alertas de Mudança |
| code | Integer | Código de Mudança |
| name | String | Nome do Parceiro |
| document | String | Documento do Parceiro |
| documentType | String | Tipo de Pessoa (J - Jurídica ou F - Física) |
| changeIndicator | String | Indica uma mudança de parceiro (E - incluído ou S - saiu) |
| changeDate | String($date) | Data em que a mudança ocorreu |
| partnerAdminRegistrationAlerts > partners > changeAlerts > summary | Object | Resumo dos Alertas de Mudança |
| code | Integer | Código de Mudança |
| alertsQuantity | Integer | Quantidade de Alertas |
| alertGenerationDate | String($date) | Data em que o alerta foi gerado |
| startDate | String($date) | Data de Início |
| endDate | String($date) | Data de Término |
| partnerAdminRegistrationAlerts > partners > changeAlerts > message | Object | Mensagem dos Alertas de Mudança |
| code | Integer | Código da Mensagem |
| message | String | Mensagem sobre o alerta |
| partnerAdminRegistrationAlerts > partners > inconsistencyAlerts > alerts | ArrayList | Alertas de Inconsistência |
| code | Integer | Código de Inconsistência |
| alertCode | String | Código do Alerta ("0" - Provisório ou "1" - Confirmado) |
| name | String | Nome do Parceiro |
| document | String | Documento do Parceiro |
| documentType | String | Tipo de Pessoa (J - Jurídica ou F - Física) |
| inconsistencyDate | String($date) | Data em que a inconsistência ocorreu |
| inconsistencyMessage | String | Frase explicando sobre a inconsistência |
| partnerAdminRegistrationAlerts > partners > inconsistencyAlerts > summary | Object | Resumo dos Alertas de Inconsistência |
| code | Integer | Código de Mudança |
| alertsQuantity | Integer | Quantidade de Alertas |
| alertGenerationDate | String($date) | Data em que o alerta foi gerado |
| startDate | String($date) | Data de Início |
| endDate | String($date) | Data de Término |
| partnerAdminRegistrationAlerts > partners > inconsistencyAlerts > message | Object | Mensagem dos Alertas de Inconsistência |
| code | Integer | Código da Mensagem |
| message | String | Mensagem sobre o alerta |
| partnerAdminRegistrationAlerts > partners > deathAlerts > alerts | ArrayList | Alertas de Óbito |
| code | Integer | Código de Mudança |
| document | String | Documento do Parceiro |
| deathCode | String | Código de Óbito |
| deathDate | String($date) | Data Informada do Óbito |
| partnerAdminRegistrationAlerts > partners > deathAlerts > summary | Object | Resumo dos Alertas de Óbito |
| code | Integer | Código de Mudança |
| alertsQuantity | Integer | Quantidade de Alertas |
| alertGenerationDate | String($date) | Data em que o alerta foi gerado |
| startDate | String($date) | Data de Início |
| endDate | String($date) | Data de Término |
| partnerAdminRegistrationAlerts > partners > deathAlerts > message | Object | Mensagem dos Alertas de Óbito |
| code | Integer | Código da Mensagem |
| message | String | Mensagem sobre o alerta |
| partnerAdminRegistrationAlerts > administrators > changeAlerts > alerts | ArrayList | Alertas de Mudança |
| code | Integer | Código de Mudança |
| name | String | Nome do Parceiro |
| document | String | Documento do Parceiro |
| documentType | String | Tipo de Pessoa (J - Jurídica ou F - Física) |
| changeIndicator | String | Indica uma mudança de parceiro (E - incluído ou S - saiu) |
| changeDate | String($date) | Data em que a mudança ocorreu |
| partnerAdminRegistrationAlerts > administrators > changeAlerts > summary | Object | Resumo dos Alertas de Mudança |
| code | Integer | Código de Mudança |
| alertsQuantity | Integer | Quantidade de Alertas |
| alertGenerationDate | String($date) | Data em que o alerta foi gerado |
| startDate | String($date) | Data de Início |
| endDate | String($date) | Data de Término |
| partnerAdminRegistrationAlerts > administrators > changeAlerts > message | Object | Mensagem dos Alertas de Mudança |
| code | Integer | Código da Mensagem |
| message | String | Mensagem sobre o alerta |
| partnerAdminRegistrationAlerts > administrators > inconsistencyAlerts > alerts | ArrayList | Alertas de Inconsistência |
| code | Integer | Código de Inconsistência |
| alertCode | String | Código do Alerta ("0" - Provisório ou "1" - Confirmado) |
| name | String | Nome do Parceiro |
| document | String | Documento do Parceiro |
| documentType | String | Tipo de Pessoa (J - Jurídica ou F - Física) |
| inconsistencyDate | String($date) | Data em que a inconsistência ocorreu |
| inconsistencyMessage | String | Frase explicando sobre a inconsistência |
| partnerAdminRegistrationAlerts > administrators > inconsistencyAlerts > summary | Object | Resumo dos Alertas de Inconsistência |
| code | Integer | Código de Mudança |
| alertsQuantity | Integer | Quantidade de Alertas |
| alertGenerationDate | String($date) | Data em que o alerta foi gerado |
| startDate | String($date) | Data de Início |
| endDate | String($date) | Data de Término |
| partnerAdminRegistrationAlerts > administrators > inconsistencyAlerts > message | Object | Mensagem dos Alertas de Inconsistência |
| code | Integer | Código da Mensagem |
| message | String | Mensagem sobre o alerta |
| partnerAdminRegistrationAlerts > administrators > deathAlerts > alerts | ArrayList | Alertas de Óbito |
| code | Integer | Código de Mudança |
| document | String | Documento do Parceiro |
| deathCode | String | Código de Óbito |
| deathDate | String($date) | Data Informada do Óbito |
| partnerAdminRegistrationAlerts > administrators > deathAlerts > summary | Object | Resumo dos Alertas de Óbito |
| code | Integer | Código de Mudança |
| alertsQuantity | Integer | Quantidade de Alertas |
| alertGenerationDate | String($date) | Data em que o alerta foi gerado |
| startDate | String($date) | Data de Início |
| endDate | String($date) | Data de Término |
| partnerAdminRegistrationAlerts > administrators > deathAlerts > message | Object | Mensagem dos Alertas de Óbito |
| code | Integer | Código da Mensagem |
| message | String | Mensagem sobre o alerta |
Alerta Cadastral de Empresas
Alerta Cadastral da Empresa pode auxiliar o contratante na realização de uma transação comercial mais segura e ágil ao avaliar alterações cadastrais da empresa nos últimos 12 meses e inconsistências comerciais identificadas até o momento da consulta.
Possíveis campos de retorno para Alerta Cadastral de Empresas:
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| companyRegistrationAlerts > alerts > nameAlerts > summary | Object | Resumo dos Alertas de Nome |
| code | Integer | Código de Mudança |
| alertsQuantity | Integer | Quantidade de Alertas |
| alertGenerationDate | String($date) | Data em que o alerta foi gerado |
| startDate | String($date) | Data de Início |
| endDate | String($date) | Data de Término |
| companyRegistrationAlerts > alerts > nameAlerts > message | Object | Mensagem dos Alertas de Nome |
| code | Integer | Código da Mensagem |
| message | String | Mensagem sobre o alerta |
| companyRegistrationAlerts > alerts > nameAlerts > alerts | ArrayList | Alertas de Nome |
| code | Integer | Código do Alerta de Nome |
| previousCompanyName | String | Nome da Empresa Anterior |
| currentCompanyName | String | Nome da Empresa Atual |
| changeDate | String($date) | Data da Mudança |
| companyRegistrationAlerts > alerts > cnaeAlerts > summary | Object | Resumo dos Alertas de CNAE |
| code | Integer | Código de Mudança |
| alertsQuantity | Integer | Quantidade de Alertas |
| alertGenerationDate | String($date) | Data em que o alerta foi gerado |
| startDate | String($date) | Data de Início |
| endDate | String($date) | Data de Término |
| companyRegistrationAlerts > alerts > cnaeAlerts > message | Object | Mensagem dos Alertas de CNAE |
| code | Integer | Código da Mensagem |
| message | String | Mensagem sobre o alerta |
| companyRegistrationAlerts > alerts > cnaeAlerts > alerts | ArrayList | Alertas de CNAE |
| code | Integer | Código do Alerta de CNAE |
| currentCnaeCode | Integer | Código CNAE Atual |
| currentCnaeDigit | Integer | Dígito CNAE Atual |
| currentCnaeDescription | String | Descrição CNAE Atual |
| previousCnaeCode | Integer | Código CNAE Anterior |
| previousCnaeDigit | Integer | Dígito CNAE Anterior |
| previousCnaeDescription | String | Descrição CNAE Anterior |
| changeDate | String($date) | Data da Mudança |
| companyRegistrationAlerts > alerts > addressAlerts > summary | Object | Resumo dos Alertas de Endereço |
| code | Integer | Código de Mudança |
| alertsQuantity | Integer | Quantidade de Alertas |
| alertGenerationDate | String($date) | Data em que o alerta foi gerado |
| startDate | String($date) | Data de Início |
| endDate | String($date) | Data de Término |
| companyRegistrationAlerts > alerts > addressAlerts > message | Object | Mensagem dos Alertas de Endereço |
| code | Integer | Código da Mensagem |
| message | String | Mensagem sobre o alerta |
| companyRegistrationAlerts > alerts > addressAlerts > alerts | ArrayList | Alertas de Endereço |
| code | Integer | Código do Alerta de Endereço |
| currentAddressName | String | Nome do Endereço Atual |
| currentAddressComplement | String | Complemento do Endereço Atual |
| currentNeighborhood | String | Bairro Atual |
| currentZipCode | Integer | CEP Atual |
| currentFederalUnit | String | Unidade Federal Atual |
| currentMailbox | Integer | Caixa Postal Atual |
| currentMailboxZipCode | Integer | CEP da Caixa Postal Atual |
| previousAddressName | String | Nome do Endereço Anterior |
| previousAddressComplement | String | Complemento do Endereço Anterior |
| previousNeighborhood | String | Bairro Anterior |
| previousZipCode | Integer | CEP Anterior |
| previousFederalUnit | String | Unidade Federal Anterior |
| previousMailbox | Integer | Caixa Postal Anterior |
| previousMailboxZipCode | Integer | CEP da Caixa Postal Anterior |
| changeDate | String($date) | Data da Mudança |
| companyRegistrationAlerts > alerts > businessStructureAlerts > summary | Object | Resumo dos Alertas de Estrutura Empresarial |
| code | Integer | Código de Mudança |
| alertsQuantity | Integer | Quantidade de Alertas |
| alertGenerationDate | String($date) | Data em que o alerta foi gerado |
| startDate | String($date) | Data de Início |
| endDate | String($date) | Data de Término |
| companyRegistrationAlerts > alerts > businessStructureAlerts > message | Object | Mensagem dos Alertas de Estrutura Empresarial |
| code | Integer | Código da Mensagem |
| message | String | Mensagem sobre o alerta |
| companyRegistrationAlerts > alerts > businessStructureAlerts > alerts | ArrayList | Alertas de Estrutura Empresarial |
| code | Integer | Código do Alerta de Estrutura Empresarial |
| currentBusinessStructure | String | Estrutura Empresarial Atual |
| previousBusinessStructure | String | Estrutura Empresarial Anterior |
| changeDate | String($date) | Data da Mudança |
| companyRegistrationAlerts > alerts > fiscalClassificationAlerts > summary | Object | Resumo dos Alertas de Classificação Fiscal |
| code | Integer | Código de Mudança |
| alertsQuantity | Integer | Quantidade de Alertas |
| alertGenerationDate | String($date) | Data em que o alerta foi gerado |
| startDate | String($date) | Data de Início |
| endDate | String($date) | Data de Término |
| companyRegistrationAlerts > alerts > fiscalClassificationAlerts > message | Object | Mensagem dos Alertas de Classificação Fiscal |
| code | Integer | Código da Mensagem |
| message | String | Mensagem sobre o alerta |
| companyRegistrationAlerts > alerts > fiscalClassificationAlerts > alerts | ArrayList | Alertas de Classificação Fiscal |
| code | Integer | Código do Alerta de Classificação Fiscal |
| currentFiscalClassification | String | Classificação Fiscal Atual |
| previousFiscalClassification | String | Classificação Fiscal Anterior |
| changeDate | String($date) | Data da Mudança |
| companyRegistrationAlerts > alerts > inconsistencyAlerts > summary | Object | Resumo dos Alertas de Inconsistência |
| code | Integer | Código de Mudança |
| alertsQuantity | Integer | Quantidade de Alertas |
| alertGenerationDate | String($date) | Data em que o alerta foi gerado |
| startDate | String($date) | Data de Início |
| endDate | String($date) | Data de Término |
| companyRegistrationAlerts > alerts > inconsistencyAlerts > message | Object | Mensagem dos Alertas de Inconsistência |
| code | Integer | Código da Mensagem |
| message | String | Mensagem sobre o alerta |
| companyRegistrationAlerts > alerts > inconsistencyAlerts > alerts | ArrayList | Alertas de Inconsistência |
| code | Integer | Código de Inconsistência |
| alertCode | String | Código do Alerta ("0" - Provisório ou "1" - Confirmado) |
| inconsistencyMessage | String | Frase explicando sobre a inconsistência |
| changeDate | String($date) | Data da Mudança |
Score empresa e setor
Esta feature traz o score positivo junto com o score setorial, de forma a avaliar o documento consultado comparativamente a empresas do mesmo setor.
Possíveis campos de retorno para Score empresa e setor:
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| score | ||
| score | Integer | Valor do score |
| scoreModel | String | Modelo usado para obter o score |
| defaultRate | String | Probabilidade de não pagamento |
| codeMessage | Integer | código da mensagem do score |
| message | String | mensagem do score |
| sectorizedScore | ||
| scoreModel | String | scoreModel, que é um parâmetro selecionado para url |
| scoreBrazil | String | score Brasil |
| prinadBrazil | String | Prinad Brasil |
| prinadRegion | String | Região de Prinad |
| scoreRegion | String | Score Região |
| scoreUf | String | Score Uf |
| prinadUf | String | Prinad Uf |
| ufMatriz | String | Uf Matriz |
| brazil | String | Brasil |
| message | String | Nome do parceiro |
| region | String(Enum) | Região: [ "N", "NE", "NO", "SE", "S", "CO" ] |
Vendas com cartão
Apresenta informações sobre as últimas vendas com cartão de crédito feitas pela empresa consultada.
Possíveis campos de retorno para Vendas com cartão:
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| cardSales > corporates | ArrayList | Representa um item de venda de cartão com detalhes relevantes |
| document | String | CNPJ da empresa |
| address | String | Endereço da empresa |
| network | String | Rede |
| segment | String | O segmento do item de venda de cartão |
| city | String | A cidade onde ocorreu a atividade de venda de cartão |
| updateDate | String | A data da última atualização do item de venda de cartão, no formato ISO 8601 |
| firstTransactionDate | String | A data da primeira transação relacionada ao item de venda de cartão, no formato ISO 8601 |
| lastTransactionPeriod | String | O período da última transação para este item de venda de cartão |
| brandName | String | O nome da marca associada ao cartão |
| companyName | String | O nome da empresa vinculada ao item de venda de cartão |
| remittanceNumber | String | O número de remessa associado às transações |
| belongsToGroup | String | Indica se o item de venda de cartão pertence a um grupo específico |
| postalCode | String | O código postal do endereço relacionado ao item de venda de cartão |
| mainChannel | String | O canal principal através do qual o item de venda de cartão é processado |
| state | String | O estado onde ocorreu a atividade de venda de cartão |
| phone | String | O número de telefone de contato associado ao item de venda de cartão |
| status | Integer | O status atual do item de venda de cartão (por exemplo, ativo, inativo) |
| transactions | Object | Um mapa de transações relacionadas ao item de venda de cartão, com propriedades adicionais representando detalhes da transação. |
| transactions > _18_22 | Object | Detalhe da transação para _18_22 |
| thu | Boolean | Indica o status da transação: _18_22 (por exemplo, concluída, pendente) para quinta-feira |
| tue | Boolean | Indica o status da transação: _18_22 (por exemplo, concluída, pendente) para terça-feira |
| wed | Boolean | Indica o status da transação: _18_22 (por exemplo, concluída, pendente) para quarta-feira |
| sat | Boolean | Indica o status da transação: _18_22 (por exemplo, concluída, pendente) para sábado |
| fri | Boolean | Indica o status da transação: _18_22 (por exemplo, concluída, pendente) para sexta-feira |
| mon | Boolean | Indica o status da transação: _18_22 (por exemplo, concluída, pendente) para segunda-feira |
| sun | Boolean | Indica o status da transação: _18_22 (por exemplo, concluída, pendente) para domingo |
| transactions > _06_12 | Object | Transaction detail for _06_12 |
| thu | Boolean | Indica o status da transação: _06_12 (por exemplo, concluída, pendente) para quinta-feira |
| tue | Boolean | Indica o status da transação: _06_12 (por exemplo, concluída, pendente) para terça-feira |
| wed | Boolean | Indica o status da transação: _06_12 (por exemplo, concluída, pendente) para quarta-feira |
| sat | Boolean | Indica o status da transação: _06_12 (por exemplo, concluída, pendente) para sábado |
| fri | Boolean | Indica o status da transação: _06_12 (por exemplo, concluída, pendente) para sexta-feira |
| mon | Boolean | Indica o status da transação: _06_12 (por exemplo, concluída, pendente) para segunda-feira |
| sun | Boolean | Indica o status da transação: _06_12 (por exemplo, concluída, pendente) para domingo |
| transactions > _12_18 | Object | Transaction detail for _12_18 |
| thu | Boolean | Indica o status da transação: _12_18 (por exemplo, concluída, pendente) para quinta-feira |
| tue | Boolean | Indica o status da transação: _12_18 (por exemplo, concluída, pendente) para terça-feira |
| wed | Boolean | Indica o status da transação: _12_18 (por exemplo, concluída, pendente) para quarta-feira |
| sat | Boolean | Indica o status da transação: _12_18 (por exemplo, concluída, pendente) para sábado |
| fri | Boolean | Indica o status da transação: _12_18 (por exemplo, concluída, pendente) para sexta-feira |
| mon | Boolean | Indica o status da transação: _12_18 (por exemplo, concluída, pendente) para segunda-feira |
| sun | Boolean | Indica o status da transação: _12_18 (por exemplo, concluída, pendente) para domingo |
| transactions > _22_00 | Object | Transaction detail for _22_00 |
| thu | Boolean | Indica o status da transação: _22_00 (por exemplo, concluída, pendente) para quinta-feira |
| tue | Boolean | Indica o status da transação: _22_00 (por exemplo, concluída, pendente) para terça-feira |
| wed | Boolean | Indica o status da transação: _22_00 (por exemplo, concluída, pendente) para quarta-feira |
| sat | Boolean | Indica o status da transação: _22_00 (por exemplo, concluída, pendente) para sábado |
| fri | Boolean | Indica o status da transação: _22_00 (por exemplo, concluída, pendente) para sexta-feira |
| mon | Boolean | Indica o status da transação: _22_00 (por exemplo, concluída, pendente) para segunda-feira |
| sun | Boolean | Indica o status da transação: _22_00 (por exemplo, concluída, pendente) para domingo |
| transactions > _00_06 | Object | Transaction detail for _00_06 |
| thu | Boolean | Indica o status da transação: _00_06 (por exemplo, concluída, pendente) para quinta-feira |
| tue | Boolean | Indica o status da transação: _00_06 (por exemplo, concluída, pendente) para terça-feira |
| wed | Boolean | Indica o status da transação: _00_06 (por exemplo, concluída, pendente) para quarta-feira |
| sat | Boolean | Indica o status da transação: _00_06 (por exemplo, concluída, pendente) para sábado |
| fri | Boolean | Indica o status da transação: _00_06 (por exemplo, concluída, pendente) para sexta-feira |
| mon | Boolean | Indica o status da transação: _00_06 (por exemplo, concluída, pendente) para segunda-feira |
| sun | Boolean | Indica o status da transação: _00_06 (por exemplo, concluída, pendente) para domingo |
Indicador de Longevidade Empresarial
Indica a probabilidade de uma empresa encerrar as operações nos próximos 12 meses, contribuindo para a redução da inadimplência. Ao identificar empresas com maior risco de fechamento, os clientes podem evitar a concessão de crédito a negócios que possivelmente não conseguirão honrar seus compromissos.
Possíveis campos de retorno para Indicador de Longevidade Empresarial:
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| perspective | String | Refere-se à visão ou expectativa quanto à capacidade da empresa de continuar operando e prosperando ao longo do tempo. Isso envolve a análise de vários fatores que podem influenciar sua sobrevivência e sucesso a longo prazo |
| cessationProbability | Number | Refere-se à probabilidade ou risco de uma empresa cessar suas operações |
| marketPractice | String | Refere-se aos métodos, estratégias e comportamentos padrão que as empresas adotam para operar com sucesso em seu setor |
| interpretationMessage | String | Usado para descrever a análise da longevidade da empresa |
| longevityScoreModel | String | Modelo de pontuação da longevidade da empresa |
| referenceScoreModel | String | Modelo de pontuação de referência |
| points | Number | Pontuação de longevidade |
| score | Number | Número da pontuação |
AGRO_SCORE_PJ
Possíveis campos de retorno para Score Agro PJ:
| Nome do Campo | Tipo | Descrição | |
|---|---|---|---|
| score | integer | Valor do score | |
| scoreModel | string | Modelo utilizado para obter o score | |
| messageCodeChronology | string | Código da mensagem de cronologia do score | |
| messagePositive | string | Mensagem positiva do score | |
| range | string | Faixa do score | |
| defaultRate | string | Probabilidade de inadimplência | |
| codeMessage | integer | Código da mensagem do score | |
| messages | objeto | ||
| message | String | Mensagem | |
| code | String | código da mensagem | |
| message | string | Mensagem do score | |
| billing | boolean | É faturado | |
| codeGeneralSector | string | Código do setor geral | |
| messageGeneralSector | string | Mensagem do setor geral | |
| codeFinancialSector | string | Código do setor financeiro | |
| messageFinancialSector | string | Mensagem do setor financeiro | |
| codeWholesaleSector | string | Código do setor atacadista | |
| messageWholesaleSector | string | Mensagem do setor atacadista | |
| codeCommercialSector | string | Código do setor comercial | |
| messageCommercialSector | string | Mensagem do setor comercial | |
| codeIndustrialSector | string | Código do setor industrial | |
| messageIndustrialSector | string | Mensagem do setor industrial | |
| codeServiceSector | string | Código do setor de serviços | |
| messageServiceSector | string | Mensagem do setor de serviços | |
| scoreParam | objeto | ||
| key | String | Chave do parametro de score | |
| value | String | Valor do parametro score |
DOCUMENTOS DE APOIO
Para as empresas que não possuem Quadro Societário, são exibidas as seguintes mensagens informativas conforme o tipo de sociedade:
| Mensagem |
|---|
| Pelas características societárias, a empresa não apresenta acionistas/sócios |
| Mensagem personalizada (customização por parte da empresa consultada) |
| Pelas características societárias a informação não se aplica |
Tabela de Naturezas Das Anotações Concentre
| Tipo Anotação | Codigo Natureza | Descrição Natureza |
|---|---|---|
| Protestos | Falta de Pagamento | |
| Ações | BA EX FE FM JB JE JF TR | Busca e Apreensão Execução Execução Fiscal Estadual Execução Fiscal Municipal Busca e Apreensão - Pequenas Causas Execução - Pequenas Causas Execução Fiscal Federal Execução de Título Judicial Trabalhista |
| Falências/Concordatas | AF CD CR CS FD FR RC RE RH RR | Auto Falência Concordata Deferida Concordata Requerida Concordata Suspensiva Falência Decretada Falência Requerida Recuperação Judicial Concedida Recuperação Extrajudicial Requerida Recuperação Extrajudicial Homologada Recuperação Judicial Requerida |
| ACHEI | 12 13 14 | Cheques sem fundo - 2ª Apresentação Conta Encerrada Prática Espúria |
Tabela de Naturezas Das Anotações REFIN
| Código Natureza | Descrição |
|---|---|
| AD | adiantamento a depositantes - c/c devedores em geral |
| AG | empréstimos agrícolas e industriais - financiamentos de custeio de investimentos agrícolas e industriais |
| AR | arrendamentos, inclusive leasing |
| CA | operações de câmbio - operações e financiamentos de câmbio em geral |
| CB | CDC outros bens móveis |
| CH | adiantamento a depositantes - cheques sem fundos acolhidos |
| CL | CDC veículos leves |
| CM | CDC motocicletas e motonetas |
| CR | impedidos pelo Banco Central de obtenção de crédito rural |
| CT | cartão de crédito |
| CV | CDC veículos pesados: tratores, ônibus, caminhões, barcos e aviões |
| C2 | consórcio veículos pesados: tratores, ônibus, caminhões, barcos e aviões |
| C3 | consórcio veículos leves |
| C4 | consórcio motocicletas e motonetas |
| C5 | consórcio outros bens móveis |
| EC | empréstimos em contas - c/c garantidas, financiamentos de capital de giro, programas especiais, etc |
| FI | créditos e financiamentos - empréstimos a pessoas físicas, financiamentos ao consumidor final, etc |
| IM | operações imobiliárias em geral, inclusive de sociedades de poupança |
| IP | débito IPVA |
| LL | leasing veículos leves |
| LM | leasing motocicletas e motonetas |
| LV | leasing veículos pesados: tratores, ônibus, caminhões, barcos e aviões |
| OJ | operações ajuizadas |
| OO | outras operações - diversas operações que não se enquadram nas demais |
| RE | operações de repasse - operações 63, FINAME, REINVEST, RECON, PROALCOOL, etc |
| SR | seguro de risco decorrido |
| TD | títulos descontados - descontos de duplicatas, promissórias e outros títulos |
| Notas |
|---|
| 1) Esta tabela de naturezas agrupa as diversas modalidades operacionais, de modo apermitir o enquadramento das operações em geral, realizadas não só pelos bancos comerciais,como também pelas demais empresas do conglomerado financeiro. |
| 2) Ao código da natureza da operação poderá opcionalmente ser acrescentada a identificação daempresa do conglomerado em que a operação foi realizada, conforme padrões abaixo: V – banco de investimento I – crédito imobiliário C – corretora de valores T - turismo F – financeira P – poupança S – seguradora Se esta identificação não for colocada, a operação será considerada do Banco Comercial. |
Tabela de Naturezas Das Anotações PEFIN
Tabela de Naturezas Operacionais
| Código | Descrição Natureza | Abreviação 12 POS. |
|---|---|---|
| AD | adiantamento a depositantes - conta corrente devedora | ADIANT CONTA |
| AG | empréstimo / financiamento agrícola / rural-comercial, industrial e custeio | EMPRESTIMOS |
| AL | Aluguel | ALUGUEL |
| AR | arrendamento, inclusive leasing | LEASING |
| C1 | consórcio imóvel | CONS IMOVEIS |
| C2 | consórcio veículos pesados: tratores, ônibus, caminhões, barcos e aviões | CONS VEI PES |
| C3 | consórcio veículos | CONS VEICULO |
| C4 | consórcio motocicletas e motonetas | CONS MOTOS |
| C5 | consórcio outros bens móveis | CONS BENS |
| C6 | consórcio passagens aéreas | CONS AEREO |
| CA | operações de financiamento de câmbio em geral | OPER CAMBIO |
| CB | CDC outros bens móveis | CDC BENS |
| CC | Cota condominial | CONDOMINIO |
| CD | Crédito direto – crediário | CREDIARIO |
| CL | CDC veículos leves | CDC V LEVE |
| CM | CDC motocicletas e motonetas | CDC MOTOS |
| CO | Consórcio contemplado | CONS CONTEMP |
| CP | crédito pessoal | CRED PESSOAL |
| CR | impedidos de crédito rural pelo BACEN | IMPEDIDO BC |
| CT | operações com cartão de crédito | CRED CARTAO |
| CV | CDC veículos pesados: tratores, ônibus, caminhões, barcos e aviões | CDC V PES |
| DC | dívidas originárias de cheques | DIVIDAS CHEQ |
| DE | dívidas originárias de cheque eletrônico | CHEQUE ELET |
| DP | Duplicata | DUPLICATA |
| EC | empréstimos em conta, conta corrente garantida, capital de giro, programa especial | EMPRES CONTA |
| EE | energia elétrica - faturas de fornecimento de luz | ENERGIA ELET |
| EG | empréstimo consignado | EMPR CONSIG |
| FG | gás - faturas de fornecimento de gás | FAT GAS |
| FI | créditos e financiamentos | FINANCIAMENTO |
| HO | despesas com hospitais | HOSPITAIS |
| IE | instituição de ensino: bolsa restituível | INST ENSINO |
| IM | operações imobiliárias | OPER IMOBIL |
| LL | Leasing veículos leves | LEAS VEICULO |
| LM | Leasing motocicletas e motonetas | LEAS MOTOS |
| LV | Leasing veículos pesados: tratores, ônibus, caminhões, barcos e aviões | LEAS VEI PES |
| ME | mensalidades escolares | MENS ESCOLAR |
| NF | notas fiscais | NOTA FISCAL |
| OA | operações agrícolas – negociações produtos rurais, insumos, sementes, etc | OPER AGRIC |
| OJ | operações ajuizadas | OPER AJUIZAD |
| OO | outras operações | OUTRAS OPER |
| RE | operações de repasse, FINAME, 63, RECON, PROALCOOL | REPASSES |
| RR | arrecadadores - prestadores de serviços | ARRECADADOR |
| SB | saneamento básico - faturas de fornecimento de água | FAT AGUA |
| SF | seguro fiança locatícia | SEG FIANCA |
| AD | adiantamento a depositantes - conta corrente devedora | ADIANT CONTA |
| AG | empréstimo / financiamento agrícola / rural-comercial, industrial e custeio | EMPRESTIMOS |
| AL | Aluguel | ALUGUEL |
| AR | arrendamento, inclusive leasing | LEASING |
| C1 | consórcio imóvel | CONS IMOVEIS |
| C2 | consórcio veículos pesados: tratores, ônibus, caminhões, barcos e aviões | CONS VEI PES |
| C3 | consórcio veículos | CONS VEICULO |
| C4 | consórcio motocicletas e motonetas | CONS MOTOS |
| C5 | consórcio outros bens móveis | CONS BENS |
| C6 | consórcio passagens aéreas | CONS AEREO |
| CA | operações de financiamento de câmbio em geral | OPER CAMBIO |
| CB | CDC outros bens móveis | CDC BENS |
| CC | Cota condominial | CONDOMINIO |
| CD | Crédito direto – crediário | CREDIARIO |
| CL | CDC veículos leves | CDC V LEVE |
| CM | CDC motocicletas e motonetas | CDC MOTOS |
| CO | Consórcio contemplado | CONS CONTEMP |
| CP | crédito pessoal | CRED PESSOAL |
| CR | impedidos de crédito rural pelo BACEN | IMPEDIDO BC |
| CT | operações com cartão de crédito | CRED CARTAO |
| CV | CDC veículos pesados: tratores, ônibus, caminhões, barcos e aviões | CDC V PES |
| DC | dívidas originárias de cheques | DIVIDAS CHEQ |
| DE | dívidas originárias de cheque eletrônico | CHEQUE ELET |
| DP | Duplicata | DUPLICATA |
| EC | empréstimos em conta, conta corrente garantida, capital de giro, programa especial | EMPRES CONTA |
| EE | energia elétrica - faturas de fornecimento de luz | ENERGIA ELET |
| EG | empréstimo consignado | EMPR CONSIG |
| FG | gás - faturas de fornecimento de gás | FAT GAS |
| FI | créditos e financiamentos | FINANCIAMENTO |
| HO | despesas com hospitais | HOSPITAIS |
| IE | instituição de ensino: bolsa restituível | INST ENSINO |
| IM | operações imobiliárias | OPER IMOBIL |
| LL | Leasing veículos leves | LEAS VEICULO |
| LM | Leasing motocicletas e motonetas | LEAS MOTOS |
| LV | Leasing veículos pesados: tratores, ônibus, caminhões, barcos e aviões | LEAS VEI PES |
| ME | mensalidades escolares | MENS ESCOLAR |
| NF | notas fiscais | NOTA FISCAL |
| OA | operações agrícolas – negociações produtos rurais, insumos, sementes, etc | OPER AGRIC |
| OJ | operações ajuizadas | OPER AJUIZAD |
| OO | outras operações | OUTRAS OPER |
| RE | operações de repasse, FINAME, 63, RECON, PROALCOOL | REPASSES |
| RR | arrecadadores - prestadores de serviços | ARRECADADOR |
| SB | saneamento básico - faturas de fornecimento de água | FAT AGUA |
| SF | seguro fiança locatícia | SEG FIANCA |
| SG | seguro garantia | SEG GARANTIA |
| SQ | seguro quebra de garantia | SEG QUEBRA |
| SR | seguro de risco decorrido | SEGURO RISCO |
| SS | mensalidade de plano/seguro de saúde | SEGURO SAUDE |
| TC | termo de confissão de dívida descumprido | CONFISS DIV |
| TD | títulos descontados, duplicatas, promissórias, etc | TIT DESCONTA |
| TE | serviços de telefonia móvel pessoal / celular – outras contas após rescisão do contrato | TELEF MO |
| TF | serviços de telefonia fixa – outras contas após rescisão do contrato | TELEF FX |
| TI | serviços de dados e internet (speedy, aluguel de canais de dados e fibra ótica) | SERV DADOS |
| TM | serviços de telefonia móvel pessoal / celular – rescisão 221/00 | TELEF MOVEL |
| TP | serviços de telefonia / vendas de produtos – vendas de aparelhos, instalação, aluguel de aparelhos | SERV TELEFON |
| TR | serviços de telefonia – renegociação da dívida | RENEG DIVIDA |
| TT | serviços de telefonia fixa – rescisão 085/98 | TELEF FIXA |
| VM | prestação de serviços - vendas de mercadorias | VENDA MERCAD |
Tabela de Naturezas Das Anotações Convem Devedores Tabela de Códigos e Descrições
| Código | Descrição |
|---|---|
| BC | COBRANCA CAUCIONADA |
| BD | COBRANCA DESCONTADA |
| BS | COBRANCA SIMPLES |
| CC | CONTRATO DE CAMBIO |
| CCC | CEDULA DE CREDITO COMERCIAL |
| CCE | CEDULA DE CREDITO A EXPORTACAO |
| CCI | CEDULA DE CREDITO INDUSTRIAL |
| CCR | CEDULA DE CREDITO RURAL |
| CD | CONFISSAO DE DIVIDA |
| CDE | CERT EN76 JE |
| CH | CHEQUE |
| CHP | CEDULA HIPOTECARIA |
| CJV | CONTA JUDICIALMENTE VERIFICADA |
| CM | CONTRATO DE MUTUO |
| CPH | CEDULA RURAL PIGNORATICIA HIPOTECARIA |
| CRH | CEDULA RURAL HIPOTECARIA |
| CRP | CEDULA RURAL PIGNORATICIA |
| CS | CONTA DE PRESTACAO DE SERVICO |
| DM | DUPLICATA DE VENDA MERCANTIL |
| DMI | DUPLICATA DE VENDA MERCANTIL POR INDICACAO |
| DR | DUPLICATA RURAL |
| DRI | DUPLICATA RURAL DE INDICACAO |
| DS | DUPLICATA DE PRESTACAO DE SERVIÇOS |
| DSI | DUPLICATA DE PRESTACAO DE SERVIÇOS POR INDICACAO |
| DV | DIVERSOS - QUANDO NAO ENQUADRAR NA RELACAO ACIMA |
| LC | LETRA DE CAMBIO |
| LCN | LETRA DE CAMBIO SEM ACEITE |
| NCC | NOTA DE CREDITO COMERCIAL |
| NCE | NOTA DE CREDITO A EXPORTACAO |
| NCI | NOTA DE CREDITO INDUSTRIAL |
| NCR | NOTA DE CREDITO RURAL |
| NP | NOTA PROMISSORIA |
| NPR | NOTA PROMISSORIA RURAL |
| SJ | SENTENCA JUDICIAL |
| TA | TERMO DE ACORDO |
| TM | TRIPLICATA DE VENDA MERCANTIL |
| TS | TRIPLICATA DE PRESTACAO DE SERVIÇOS |
| W | WARRANT |
Tabela de Códigos de Segmentos Tabela de Códigos e Descrições
| Código | Descrição |
|---|---|
| 001 | FORN SINAPEL |
| 002 | TEXTIL |
| 004 | CALCADOS |
| 005 | CREDINFOR |
| 006 | CONFECCOES E MALHARIA |
| 007 | TECELAGEM |
| 008 | RESINAS |
| 009 | TINTAS |
| 010 | CAMA MESA E BANHO |
| 011 | ABAFARMA |
| 012 | PRODS. P/ SAUDE ANIMAL |
| 013 | ALIMENTOS |
| 014 | INDS. CONSTRUCAO CIVIL |
| 015 | COMBUSTIVEIS |
| 016 | AGROQUIMICOS |
| 017 | ATACADISTAS |
| 018 | INDUSTRIAS DE MOVEIS |
| 019 | ASPACER |
| 020 | AGRONEGOCIOS |
| 021 | SINAPEL GRUPO II |
| 022 | CREDIAUTO |
| 024 | ARTIGOS ESPORTIVOS |
| 025 | ANDAP - ASSOC NAC DIST AUTO PEGAS |
| 026 | LINGERIE |
| 027 | REFRIGERACAO |
| 028 | FACTORINGS |
| 029 | RELOGIOS |
| 030 | MODA |
| 031 | GCNA - NUTRICAO ANIMAL |
| 032 | AGRONEGOCIOS GOIANIA |
| 034 | AFUB ASSOC FAB DE URNAS FUNERARIAS DO BRASIL |
| 035 | VINICOLAS |
| 036 | UTILIDADES DOMESTICAS |
| 038 | TRANSPORTES EXPRESSOS - COURIERS |
| 039 | INFOCRED |
| 040 | CREDICON |
| 041 | PAPELARIA |
| 042 | BRINQUEDOS |
| 043 | PLASTICOS P/ USO DOMISTICO |
| 044 | AGERFIN |
| 045 | CADERNOS |
| 046 | MEDICO HOSPITALAR |
| 047 | ASFALTO |
Tabela de Mensagens de Reciprocidade
| Mensagem |
|---|
| ATENÇÃO!!! VOCE NÃO ESTÁ VISUALIZANDO O BLOCO 'EVOLUCAO DE COMPROMISSOS'. SUA EMPRESA ENCONTRA-SE EM ATRASO COM O ENVIO DOS DADOS DESDE dd/MM/yyyy. AO REGULARIZAR O ENVIO, O REFERIDO BLOCO VOLTARÁ A SER EXIBIDO AUTOMATICAMENTE. |
Tabela de códigos - Participação
Possíveis retornos de participationType:
participationType
| Código | Descrição |
|---|---|
| AC | ACIONISTA |
| SC | SOCIO |
| TIT | TITULAR |
| GR | GERENTE |
| AD | ADMINISTRADOR |
| CS | CONSELHEIRO |