br-data

br-data

Pacote de arquivos de dados nacionais em formato JSON.

O objetivo desse repositório é centralizar em um único lugar de forma organizada e padronizada as tabelas de dados fornecidas pelos órgãos públicos brasileiros. E dessa forma facilitar a utilização desses dados em sistemas de TI.

Tabela de Dados Disponíveis

Tabela	Descrição
NCM	Nomenclatura Comum do Mercosul utilizada obrigatoriamente desde 01/01/2010 para categorizar os produtos em documentos fiscais Ver receita.fazenda.gov.br
CEST	Código Especificador da Substituição Tributária criado para estabelecer uma sistemática de uniformização e identificação das mercadorias e bens que são passíveis de Substituição Tributária e antecipação de ICMS. Ele é usado documentos fiscais conforme o Convênio ICMS 92, de 20 de agosto de 2015
NBS	Nomenclatura Brasileira de Serviços, intangíveis e outras operações que produzam variações no patrimônio (Ver mdic.gov.br)

Formato dos arquivos

Os arquivos de dados estão disponibilizados na pasta data\<nome dos dados> e separados em três arquivos diferentes. Sendo que todos eles utilizam codificação UTF-8 e o caracter LF como quebra de linha (padrão UNIX).

data.json:

Arquivo JSON contendo um array de objetos onde cada objeto representa uma linha da tabela de dados

data.csv:

Arquivo CSV contendo o mesmo conteúdo do arquivo data.json utilizando vírgula (,) como separador de colunas e aspas duplas (") em campos de texto.

history.json:

Arquivo JSON contendo um array de objetos. Ao atualizar o data.json deverá ser adicionado um item no inicio desse array contendo as propriedades:

Campo	Descricao
dataDeAtualizacao	Data da atualização do arquivo. Ex.: "2016-08-17"
descricao	Descrição da atualização realizada explicando citando a fonte utilizada. Ex.: "Atualizado até os convênios ICMS 92/2015, 139/15, 146/15, 16/16, 53/16."
referencias	Array com as urls de uma ou mais referências utilizadas como base para a atualização. Ex.: ["https://investexportbrasil.dpr.gov.br/ProdutosServicos/frmPesquisaProdutosServicosFull.aspx"]
dataDePublicacao	Data da publicação da referência mais recente utilizada na atualização. Ex.: "2016-08-01"

Utilizando os dados

Através da API Javascript

Instale utilizando npm:

npm install --save br-data

Exemplo de uso:

const brData = require('br-data');

// Recebe como parametro o nome da pasta de dados e retorna o conteúdo json do arquivo `data.json`
const ncms = brData.get('ncm');

// Recebe como parametro o nome da pasta de dados e retorna o conteúdo json do arquivo `history.json`
const ncmsHistory = brData.getHistory('ncm');

Importando os dados na sua base

Você também pode importar os dados dos arquivos data.json ou data.csv diretamente na base de dados do seu sistema.

Contribuíndo

Solicitamos todo apoio possível para manter os dados atualizados. Esperamos receber pull requests contendo atualizações dos arquivos existentes e novos arquivos de dados. Pedimos apenas atenção para que padrão de Formato dos arquivos especificado nesse readme seja sempre atendido.

Coverter JSON para CSV:

Se você criou/alterou um arquivo data.json, não se esqueça de criar/atualizar a versão em CSV do mesmo antes de enviar o pull request.

Para fazer isso sugerimos usar a biblioteca zemirco/json2csv instalando-a globalmente com npm -g json2csv. Feito isso basta executar o comando abaixo no diretório do arquivo data.json substituindo o parametro passado em -f pela lista de colunas desejada:

json2csv -i data.json -f codigo,codigoPai,descricao,nivel,ehFolha -o data.csv

Changelog

1.0.1 (2016-08-24)

<a name="0.0.1"></a>