NFE Decoder
NFE Decoder is a Dart library designed to scrape and extract information from Nota Fiscal Eletrônica (NFE) URLs, providing a structured way to access invoice details.
Features
- Decode NFE URLs and retrieve detailed invoice data.
- Supports multiple state-specific NFE formats.
- Provides a clean API for integration into larger projects or use as a standalone library.
Installation
To use the NFE Decoder in your project, add it to your pubspec.yaml:
dependencies:
nfe_decoder: ^latest_version
Then, run:
pub get
Usage
Here's a basic example of how to use the Decoder class to extract information from an NFE URL:
import 'package:nfe_decoder/nfe_decoder.dart';
void main() async {
var decoder = Decoder('some_nfe_url');
var nfe = await decoder.scrapeNfe();
print(nfe);
}
For more detailed examples and advanced configurations, please refer to the documentation.
Available Decoders
AcreAlagoasAmapáAmazonasBahiaCearáDistrito FederalEspírito SantoGoiásMaranhãoMato Grosso do SulMato GrossoMinas GeraisParanáParaíbaParáPernambucoPiauíRio Grande do NortexRio Grande do SulRio de JaneiroRondôniaRoraimaSanta CatarinaSergipeSão PauloTocantins
Documentation
Detailed documentation can be found here.
Contributing
- Fork the repository.
- Create your feature branch (
git checkout -b feature/fooBar). - Commit your changes (
git commit -am 'Add some fooBar'). - Push to the branch (
git push origin feature/fooBar). - Create a new pull request.
License
This project is licensed under the MIT License. See the LICENSE file for details.
Libraries
- decoder/decoder
- decoder/http_client
- decoder/item_extractor
- decoder/url_builder
- decoder/url_state_extractor
- models/endereco
- models/estabelecimento
- models/forma_pagamento
- models/item
- models/models
- models/nfe
- models/nfe_forma_pagamento
- models/nfe_item
- nfe_decoder
- scraper/base_scraper
- scraper/rs/fields/rs_estabelecimento_scraper
- scraper/rs/fields/rs_informacoes_gerais_scraper
- scraper/rs/fields/rs_item_scraper
- scraper/rs/fields/rs_items_scraper
- scraper/rs/fields/rs_total_nota_scraper
- scraper/rs/rs_scraper
- scraper/scraper_factory