{"_id":"@anlix/nfe-io","_rev":"2-9f80a4d0e65d3cbdabc1872411c2f1dd","name":"@anlix/nfe-io","dist-tags":{"latest":"2.0.0"},"versions":{"2.0.0":{"name":"@anlix/nfe-io","version":"2.0.0","description":"Official NFe.io API Client for Node.js","homepage":"https://github.com/nfeio/client-nodejs","author":{"name":"Gabriel Marquez","email":"gabriel@nfe.io"},"repository":{"type":"git","url":"git+https://github.com/nfeio/client-nodejs.git"},"bugs:":"https://github.com/nfeio/client-nodejs/issues","engines":{"node":">= v0.8.0"},"main":"lib/nfe.js","devDependencies":{"mocha":"~1.13.0","chai":"~1.8.0","chai-as-promised":"~4.0.0","mocha-as-promised":"~1.4.0"},"dependencies":{"when":"~3.1.0"},"scripts":{"test":"mocha"},"gitHead":"f3072852a25c7266ee7f8bdd3739f1020e767ee1","bugs":{"url":"https://github.com/nfeio/client-nodejs/issues"},"_id":"@anlix/nfe-io@2.0.0","_nodeVersion":"12.19.1","_npmVersion":"7.16.0","dist":{"integrity":"sha512-e0qyXSxadCiyCts0BEbjoDBKPSWBPgOEVFpO/4vhNvu1qZQq5RrCjKlB3msbjausx4bHDwrfiqdYPUBjZC3snQ==","shasum":"02122b085cf3463deed560e43d68317973073d8d","tarball":"https://registry.npmjs.org/@anlix/nfe-io/-/nfe-io-2.0.0.tgz","fileCount":21,"unpackedSize":34178,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgzgrRCRA9TVsSAnZWagAA1r4P/Aongf3cbdlDfCY+E2R/\nXTfsjQoND4CBSErveYvfSccsTMbS2KA8Af9ZWBHxjtkqznLPJMOeVhfuLLNV\nZLdAQYlaqpz8GosEYqizamcu59WAqpvB8cmtR0nVjCxov9nKxZCr7djYxCur\n3kU4Ixlw5bnBT/BGv6PPjtmeRc1n7Ck8QDIuoD0c2rHYGrI7kVYhEcFTCiQX\nsuyD99ZC8VVkVpa9ZA2sdFoIHrYfrYWvM4yA/f/69DdhPpBSKHDXKb1eHlTX\nHEkBtNQ+n1lwZ8pqfrvejTfKQXPT9iS+P7dUdkFzPQJPG9Pdj352jucyh3Bt\nY9x4RMin96JJ9vFZ/x5sDTYb51BVQM/o7K8wCvpr0NbwcC74GWT/umP50JTo\n7mu6enRjQwLoYsyJGzX0V21gU+rZwgluvnj4RzO1hZ9UDWinTFAtSkp7kijy\nQV6Nf7xy6Nc8/ETDHRvbKSlOEzgf9exwLwW38K40M18iP3D213h3Av7KiHHi\ndOFFAYvze2lex0V38v8Mmok+RS751uogsu1A9uo536Y3aZ/RkOx2YAwUSCYm\nNGvgYfzB/aPSUqOocAvYT4o1Vn/IRgHUvF7IC1CYeOKY+Yx/25f/w9qS2WOS\nuYDppbC0vcLEFWijpqrrSfKbclRfLwQdHF0L4KMkbWEO3fKYUK++dM/XrZnZ\naxzQ\r\n=EuXw\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDFzXSJKyteAOEJiC1j1sw92tDPywkAmxu5sQ/4XhydKAIgEwUYcGDpAyDGsxvk/L8qBlt9unaHMh9C/+RoZFuYKl0="}]},"_npmUser":{"name":"anlix","email":"desenvolvimento@anlix.io"},"directories":{},"maintainers":[{"name":"anlix","email":"desenvolvimento@anlix.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nfe-io_2.0.0_1624115921374_0.25858095440467177"},"_hasShrinkwrap":false}},"time":{"created":"2021-06-19T15:18:41.373Z","2.0.0":"2021-06-19T15:18:41.489Z","modified":"2022-04-04T14:13:56.762Z"},"maintainers":[{"email":"desenvolvimento@anlix.io","name":"anlix-io"}],"description":"Official NFe.io API Client for Node.js","homepage":"https://github.com/nfeio/client-nodejs","repository":{"type":"git","url":"git+https://github.com/nfeio/client-nodejs.git"},"author":{"name":"Gabriel Marquez","email":"gabriel@nfe.io"},"bugs":{"url":"https://github.com/nfeio/client-nodejs/issues"},"readme":"# Cliente Node.JS para emissão de notas fiscais eletrônicas de serviço (NFS-e) - NFE.io \n\n## Onde eu posso acessar a documentação da API?\n\n> Acesse a [nossa documentação](https://nfe.io/docs/nota-fiscal-servico/integracao-nfs-e/) para mais detalhes ou acessa a [referência da API](https://nfe.io/doc/rest-api/nfe-v1/).\n\n## Como realizar a instalação do pacote?\n\nNosso pacote é uma dependencia do NPM, e pode ser encontrado no [https://www.npmjs.com/package/nfe-io](https://www.npmjs.com/package/nfe-io)\nPara utilizar nosso pacote, utilize o comando abaixo para instalar:\n\n``` bash\n    npm install nfe-io\n```\n\n## Exemplo de utilização\n\nDepois de baixar o pacote, inclua a dependência em seu arquivo JS, utilizando o código abaixo:\n\n```js\n// Chave de acesso deve ser copiada do painel.\nvar nfe = require('nfe-io')('chave-de-acesso-na-api');\n\n// Exemplo genérico\n// nfe.{ RESOURCE_NAME }.{ METHOD_NAME } ( { PARAMETERS, DATA }, { CALLBACK_FUNCTION } )\n```\n>**Observação:**Todo método aceita um callback opcional como ultimo argumento.\n\n### Como emitir uma Nota Fiscal de Serviço?\nAbaixo, temos um código-exemplo para realizar uma Emissão de Nota Fiscal de Serviço:\n\n```js\nvar nfe = require('nfe-io')('chave-de-acesso-na-api');\n\nnfe.serviceInvoices.create(\n  \n  // ID da empresa, você deve copiar exatamente como está no painel\n  'c73d49f9649046eeba36', \n  \n  // Dados da nota fiscal de serviço\n  {  \n    // Código do serviço de acordo com o a cidade\n    'cityServiceCode': '2690',\n    \n    // Descrição dos serviços prestados\n    'description': 'TESTE EMISSAO',  \n\n    // Valor total do serviços\n    'servicesAmount':  0.01,\n\n    // Dados do Tomador dos Serviços\n    'borrower': {  \n\n      // Tipo do tomador dos serviços, \n      //    opções: 'Undefined', 'NaturalPerson', 'LegalEntity'\n      'type': 'LegalEntity',\n\n      // CNPJ ou CPF em números (opcional para tomadores no exterior)\n      'federalTaxNumber': 191,\n\n      // Nome da pessoa física ou Razão Social da Empresa\n      'name': 'BANCO DO BRASIL SA',\n      \n      // Email para onde deverá ser enviado a nota fiscal\n      'email': 'exemplo@bb.com.br',\n\n      // Endereço do tomador\n      'address': {\n      \t\n      \t// Código do pais com três letras\n        'country': 'BRA',\n        \n        // CEP do endereço (opcional para tomadores no exterior)\n        'postalCode': '70073901',\n         \n        // Logradouro\n        'street': 'Outros Quadra 1 Bloco G Lote 32',\n        \n        // Número (opcional)\n        'number': 'S/N',\n        \n        // Complemento (opcional) \n        'additionalInformation': 'QUADRA 01 BLOCO G',\n\n        // Bairro\n        'district': 'Asa Sul', \n\n\t\t// Cidade é opcional para tomadores no exterior\n        'city': { \n            // Código do IBGE para a Cidade\n            'code': '5300108',\n            // Nome da Cidade\n            'name': 'Brasilia'\n        },\n\n        // Sigla do estado (opcional para tomadores no exterior)\n        'state': 'DF'\n        \n      }\n  }, function(err, invoice) {    \n    err; // null se não ocorreu nenhum erro\n    invoice; // O objeto de retorno da emissão    \n  }\n);\n```\n### Como cancelar uma nota?\n>Em construção!\n\n\n### Como criar uma empresa para realizar a emissão de notas fiscais?\nAbaixo, temos um código-exemplo de criação de uma empresa, para realizar a emissão de nota fiscal:\n\n```js\nvar nfe = require('nfe-io')('chave-de-acesso-na-api');\n\nnfe.companies.create(\n\n  // Dados da pessoa jurídica\n  {\n    // CNPJ ou CPF (opcional para tomadores no exterior)\n    // Atenção: Somente números sem zeros a esquerda\n    'federalTaxNumber': 191, \n\n    // Nome da pessoa física ou Razão Social da Empresa\n    'name': 'BANCO DO BRASIL SA',\n    \n    // Nome fantasia, esse nome será usado no assunto do email\n    'tradeName': 'BANCO DO BRASIL SA',\n        \n    // Número de Inscricação na Prefeitura (CCM) \n    'municipalTaxNumber': '12345',\n    \n    // Tipo do Regime Tributário\n    //   Opções: 'Isento', 'MicroempreendedorIndividual', 'SimplesNacional', 'LucroPresumido', 'LucroReal'\n    'taxRegime': 'SimplesNacional'\n    \n    // Tipo do regime especial de tributação\n    //   Opções: ['Automatico', 'Nenhum', 'MicroempresaMunicipal', 'Estimativa', 'SociedadeDeProfissionais', 'Cooperativa', 'MicroempreendedorIndividual', 'MicroempresarioEmpresaPequenoPorte']\n    'specialTaxRegime': 'Nenhum',\n\n    // Endereço do tomador\n    'address': {\n      \n      // Código do pais com três letras\n      'country': 'BRA',\n      \n      // CEP do endereço (opcional para tomadores no exterior)\n      'postalCode': '70073901',\n       \n      // Logradouro\n      'street': 'Outros Quadra 1 Bloco G Lote 32',\n      \n      // Número (opcional)\n      'number': 'S/N',\n      \n      // Complemento (opcional) \n      'additionalInformation': 'QUADRA 01 BLOCO G',\n\n      // Bairro\n      'district': 'Asa Sul', \n\n      // Cidade é opcional para tomadores no exterior\n      'city': { \n          // Código do IBGE para a Cidade\n          'code': '5300108',\n          // Nome da Cidade\n          'name': 'Brasilia'\n      },\n\n      // Sigla do estado (opcional para tomadores no exterior)\n      'state': 'DF'\n      \n    }\n  }, function(err, entity) {\n    err; // null se não ocorreu nenhum erro\n    entity; // O objeto de retorno da criação\n  }\n);\n```\n\n### Como efetuar o download de uma nota em PDF?\n>Em construção!\n\n### Como validar o Webhook?\n>Em construção!\n\n## Configurações \n\n### Tempo limite para requisições\n`nfe.setTimeout(20000); // in ms` (node's default: `120000ms`);\n \n### Chave de acesso\n`nfe.setApiKey('c73d49f9-6490-46ee-ba36-dcf69f6334fd');` \n\n## Como testar a aplicação?\nPara executar testes, utilize o comando :\n``` bash\nnpm test\n```\n","readmeFilename":"README.md"}