Descrição
O dataset de consulta ao SINTEGRA retorna os dados extraídos da consulta ao SINTEGRA (Sistema Integrado de Informações Sobre Operações Interestaduais com Mercadorias e Serviços) no site oficial do governo. O Sintegra faz um controle informatizado das operações de entradas e saídas interestaduais que são realizadas por contribuintes de ICMS (Imposto sobre Circulação de Mercadorias e Serviços), concentrando essas informações e as comunicando para os fiscos estaduais, a Secretaria da Fazenda e a Receita Federal. É a partir deste registro que empresas e produtores rurais podem emitir notas fiscais para seus clientes.
Origem da Informação
As informações retornadas nesta consulta provém de dados capturados diretamente das secretarias da fazenda de cada estado.
Tabela de preços para esse dataset
| Consultas Realizadas no Mês | Valor por consulta |
|---|---|
| 1 - 10000 | R$ 0,090 |
| 10001 - 50000 | R$ 0,085 |
| 50001 - 100000 | R$ 0,081 |
| 100001 - 500000 | R$ 0,077 |
| 500001 - 1000000 | R$ 0,073 |
| 1000001 - 5000000 | R$ 0,069 |
| 5000001 - 10000000 | R$ 0,066 |
| 10000001 - 50000000 | R$ 0,063 |
| 50000001 e acima | R$ 0,060 |
Parâmetros de consulta
A tabela abaixo detalha os campos aceitos na consulta a este dataset.
| Campo | Descrição | Valores Possíveis | Tipo de Campo |
|---|---|---|---|
| doc | Documento de identificação | CPF | 🛑 Obrigatório |
| uf | Trata-se da Unidade Federativa (UF) do Estado onde se realizará a consulta. Caso não seja informada, utilizaremos por padrão a que consta no endereço principal associado internamente ao CPF. | Estado/UF da fonte a realizar a consulta. Ex: RJ, SP, MG, etc. | ⚠️ Semi-Obrigatório |
| fillmotheraddress | Flag booleana para buscar o UF da entidade com base no endereço indireto da mãe, caso a entidade não tenha um endereço associado diretamente internamente. Esta flag por padrão é false, e serve como opt-in caso o UF não seja fornecido (e não exista um endereço diretamente associado), pois um endereço indireto dos pais não é 100% assertivo (se a pessoa se mudou morando bem longe dos pais, por exemplo). | true, false | ℹ️ Opcional |
| fillworkaddress | Flag booleana para buscar o UF da entidade com base no endereço indireto do trabalho, caso a entidade não tenha um endereço associado diretamente internamente. Esta flag por padrão é false, e serve como opt-in caso o UF não seja fornecido (e não exista um endereço diretamente associado), pois um endereço indireto do trabalho não é 100% assertivo (se a pessoa trabalhar remotamente, por exemplo). | true, false | ℹ️ Opcional |
| birthdate | Data de Nascimento | yyyy-MM-dd | ℹ️ Opcional |
| dateformat | Formato da Data | yyyy-MM-dd, dd/MM/yyyy | ℹ️ Opcional |
Clique aqui para saber mais sobre os parâmetros de consulta da Plataforma de Dados.
Abaixo está um exemplo de como realizar a chamada apenas com os parâmetros obrigatórios:
{
"Datasets": "ondemand_sintegra_person",
"q": "doc{CPF}"
}
Notas de Mudanças nos Dados Retornados
A consulta Sintegra disponibilizada cobria anteriormente a fonte centralizada Sefaz CCC, porém, como a captura pública dessa fonte se tornou inviável, as consultas nas respectivas fontes públicas estaduais do Sintegra foram reintegradas (todavia, apenas nos estados em que é possível/viável tal captura pública de dados). Devido a essa mudança na fonte Sintegra capturada (deixando de ser centralizada para ser específica nos estados/UFs), pode existir variações nos formatos de dados entre essas fontes estaduais, além é claro, em relação aos dados entregues pela antiga fonte centralizada CCC anteriormente capturada (majoritariamente com os dados IE históricos e agregados/unificados 'de todos estados' não sendo mais entregues). Sobre essas variações, para facilitar, por exemplo, a decodificar o status de uma Inscrição / Registro Estadual Sintegra, pode se utilizar o campo booleano HasActiveStatus (sendo true ou false), uma vez que o formato do dado do Status (situação cadastral) da IE varia, também, entre as fontes estaduais do Sintegra - esse campo booleano então é computado ao parsear os variados status IE retornados das fontes estaduais.
Lista de UFs suportados pela consulta
Descrição dos campos do objeto principal de retorno
Alguns campos são sufixados por um número inteiro começando com zero, para designar que fazem parte do mesmo objeto no grupo de prefixo. O grupo de prefixo "Historic." designa as mudanças históricas do documento e inscrições estaduais associadas, enquanto o prefixo "StatesData." designa o mesmo documento em diferentes UFs e inscrições estaduais vinculadas. Já para o prefixo "StateRegistrationEntry.", é uma forma mais simplificada que agrega as informações de "StatesData." por UF (se presente).
| Campo | Descrição |
|---|---|
| Origin | Fonte dos Dados Entregues |
| InputParameters | Parâmetros de entrada |
| QueryDate | Data da consulta realizada |
| QueryResultData.IdNumber | Número de identificação (CPF) |
| QueryResultData.State | Estado |
| QueryResultData.OfficialName | Nome do indivíduo |
| QueryResultData.BusinessName | Nome da fazenda |
| QueryResultData.FoundingDate | Data de Fundação |
| QueryResultData.StateRegistration | Inscrição Estadual |
| QueryResultData.Address.AddressCore.{i} | Núcleo do endereço |
| QueryResultData.Address.Number.{i} | Número de porta do endereço |
| QueryResultData.Address.Complement.{i} | Complemento do endereço |
| QueryResultData.Address.Neighborhood.{i} | Bairro do endereço |
| QueryResultData.Address.City.{i} | Cidade |
| QueryResultData.Address.State.{i} | Estado |
| QueryResultData.Address.ZipCode.{i} | CEP |
| QueryResultData.Address.Country.{i} | País |
| QueryResultData.Status | Status |
| QueryResultData.HasActiveStatus | Flag booleana indicando se a IE está ativa/habilitada |
| QueryResultData.Statusdate | Data do Status |
| QueryResultData.Tributationregime | Regime de tributação |
| QueryResultData.Maincnae | Código CNAE de atividade principal |
| Stateregistrationinformationasrecipient | Informação da IE como destinatário |
| Companysize | Porte da empresa registrada |
| Presumedcredit | Crédito presumido |
| Producertype | Flag indicando se é do tipo produtor |
| Historic.Nsu.{i} | Número de movimentação do histórico (campo depreciado) |
| Historic.DocNumber.{i} | Número de documento do histórico (campo depreciado) |
| Historic.DocNumberStatus.{i} | Status do documento no histórico (campo depreciado) |
| Historic.State.{i} | Estado/UF do documento no histórico (campo depreciado) |
| Historic.StateRegistrationNumber.{i} | Número de inscrição estadual histórico (campo depreciado) |
| Historic.StateRegistrationStatus.{i} | Status da inscrição estadual histórica (campo depreciado) |
| Historic.ICMSRule.{i} | Regime tributário histórico (campo depreciado) |
| Historic.Reason.{i} | Motivo do registro histórico (campo depreciado) |
| Historic.StatusDate.{i} | Data de situação (campo depreciado) |
| Historic.UpdateDate.{i} | Data de atualização (campo depreciado) |
| StatesData.DocNumber.{i} | Número do mesmo documento em todas UF (campo depreciado) |
| StatesData.DocNumberStatus.{i} | Status do mesmo documento em todas UF (campo depreciado) |
| StatesData.AddressState.{i} | Estado/UF (endereço) de entrada para o documento (campo depreciado) |
| StatesData.StateOfRegistration.{i} | Estado/UF de entrada para o documento (campo depreciado) |
| StatesData.StateRegistrationNumber.{i} | Inscrição estadual para o estado/UF de entrada (campo depreciado) |
| StatesData.StateRegistrationStatus.{i} | Status da inscriçãoe estadual para o estado/UF de entrada (campo depreciado) |
| StatesData.StateRegistrationType.{i} | Tipo da inscrição estadual para o estado/UF de entrada (campo depreciado) |
| StateRegistrationEntry.{UF}.Number | Inscrição estadual para um UF específico (se houver entrada de dados, campo depreciado) |
| StateRegistrationEntry.{UF}.Status | Status da inscrição estadual para um UF específico (se houver entrada de dados, campo depreciado) |
| StateRegistrationEntry.{UF}.Type | Tipo da inscrição estadual para um UF específico (se houver entrada de dados, campo depreciado) |
| RawResultFile_{OfficialName} | Link para URL de evidência (campo sufixado pelo nome oficial registrado) |
| RawResultFileType_{OfficialName} | Tipo da evidência, sendo html, pdf, json, etc (campo sufixado pelo nome oficial registrado) |
| QueryResultData.DetailedErrorMessage | Mensagem de erro mais detalhada (se presente) sobre a consulta |
