Flutter财务管理插件invoiceninja的使用

Flutter财务管理插件invoiceninja的使用

描述

通过Flutter应用创建PDF发票并接受付款。

功能

• 在移动、Web和桌面Flutter应用中接受在线支付。
• 支持多种支付网关，包括Stripe、PayPal等。
• 创建专业的PDF发票。
• 包含一个自助服务客户端门户。
• 更多功能…

安装

在pubspec.yaml文件中添加以下依赖：

dependencies:
  invoiceninja: ^0.0.10

导入

在你的Dart文件中导入包：

import 'package:invoiceninja/invoiceninja.dart';

该包提供了两个主要类：

• InvoiceNinja: 支持公共“店面”路由，允许读取产品列表并创建/查找客户和发票。使用此类时访问权限受限。
• InvoiceNinjaAdmin: 支持REST Admin API，使用基于令牌的安全机制。使用此类需要API令牌来访问账户。

Storefront API配置

// 配置公司密钥和URL
InvoiceNinja.configure(
  'KEY', // 设置您的公司密钥或使用'KEY'进行测试
  url: 'https://demo.invoiceninja.com', // 设置您自己的应用程序URL
  debugEnabled: true, // 启用调试模式
);

加载产品列表

final products = await InvoiceNinja.products.load(); // 异步加载产品列表

按键查找产品

final product = await InvoiceNinja.products.findByKey('product_key'); // 根据产品键查找产品

创建/保存客户

var client = Client.forContact(email: 'test@example.com'); // 创建客户对象
client = await InvoiceNinja.clients.save(client); // 保存客户到服务器

创建/保存发票

var invoice = Invoice.forClient(client, products: [product]); // 创建发票对象
invoice = await InvoiceNinja.invoices.save(invoice); // 保存发票到服务器

显示PDF发票

launch(
  'https://docs.google.com/gview?embedded=true&url=${invoice.pdfUrl}',
  forceWebView: true,
); // 打开PDF发票链接

接受付款

var invoiceKey = invoice.key;
launch(invoice.url);

// ...

final invoice = await InvoiceNinja.invoices.findByKey(invoiceKey);
if (invoice.isPaid) {
  // 处理已支付的发票逻辑
}

Admin API配置

// 配置API令牌和URL
InvoiceNinjaAdmin.configure(
  'TOKEN', // 设置您的API令牌或使用'TOKEN'进行测试
  url: 'https://demo.invoiceninja.com', // 设置您自己的应用程序URL
  debugEnabled: true, // 启用调试模式
);

按电子邮件查找客户

final client = await InvoiceNinjaAdmin.clients.findByEmail(email); // 根据电子邮件查找客户

加载所有发票

final payments = await InvoiceNinjaAdmin.payments.load(); // 加载所有支付记录

加载支付列表

final payments = await InvoiceNinjaAdmin.payments.load(); // 加载支付列表

按ID查找支付

final payment = await InvoiceNinjaAdmin.payments.findById(id); // 根据ID查找支付

创建/保存发票并自动计费

var invoice = Invoice.forClient(client, products: [product]);
invoice = await InvoiceNinjaAdmin.invoices.save(invoice, action: InvoiceAction.autoBill); // 创建并保存发票，同时自动计费

示例代码

以下是完整的示例代码，展示了如何使用invoiceninja插件创建和管理发票：

import 'package:flutter/material.dart';
import 'package:invoiceninja/invoiceninja.dart';
import 'package:invoiceninja/models/client.dart';
import 'package:invoiceninja/models/invoice.dart';
import 'package:invoiceninja/models/product.dart';
import 'package:url_launcher/url_launcher.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Invoice Ninja',
      theme: ThemeData(
        brightness: Brightness.dark,
      ),
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  MyHomePage({Key? key}) : super(key: key);

  [@override](/user/override)
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> with WidgetsBindingObserver {
  List<Product> _products = [];

  String _email = '';
  Product? _product;
  Invoice? _invoice;

  [@override](/user/override)
  initState() {
    super.initState();
    WidgetsBinding.instance.addObserver(this);

    // 配置Invoice Ninja
    InvoiceNinja.configure(
      'KEY', // 设置您的公司密钥或使用'KEY'进行测试
      url: 'https://demo.invoiceninja.com', // 设置您自己的应用程序URL
      debugEnabled: true,
    );

    // 加载产品列表
    InvoiceNinja.products.load().then((products) {
      setState(() {
        _products = products;
      });
    });
  }

  void _createInvoice() async {
    if (_product == null) {
      return;
    }

    // 创建并保存客户
    var client = Client.forContact(email: _email);
    client = await InvoiceNinja.clients.save(client);

    // 创建并保存发票
    var invoice = Invoice.forClient(client, products: [_product!]);
    invoice = await InvoiceNinja.invoices.save(invoice);

    setState(() {
      _invoice = invoice;
    });
  }

  void _viewPdf() {
    if (_invoice == null) {
      return;
    }

    // 查看PDF发票
    launch(
      'https://docs.google.com/gview?embedded=true&url=${_invoice!.pdfUrl}',
      forceWebView: true,
    );
  }

  void _viewPortal() {
    if (_invoice == null) {
      return;
    }

    final invitation = _invoice!.invitations.first;
    launch(invitation.url);
  }

  [@override](/user/override)
  void didChangeAppLifecycleState(AppLifecycleState state) async {
    if (_invoice == null || state != AppLifecycleState.resumed) {
      return;
    }

    final invoice = await InvoiceNinja.invoices.findByKey(_invoice!.key);

    if (invoice.isPaid) {
      // 处理已支付的发票逻辑
    }
  }

  [@override](/user/override)
  void dispose() {
    WidgetsBinding.instance.removeObserver(this);
    super.dispose();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Invoice Ninja Example'),
      ),
      body: SingleChildScrollView(
        child: Padding(
          padding: const EdgeInsets.all(16),
          child: Card(
            child: Padding(
              padding: const EdgeInsets.all(16),
              child: Column(
                mainAxisSize: MainAxisSize.min,
                crossAxisAlignment: CrossAxisAlignment.stretch,
                children: [
                  TextFormField(
                    decoration: InputDecoration(
                      labelText: 'Email',
                      suffixIcon: Icon(Icons.email),
                    ),
                    onChanged: (value) => setState(() => _email = value),
                    keyboardType: TextInputType.emailAddress,
                  ),
                  DropdownButtonFormField<Product>(
                    decoration: InputDecoration(
                      labelText: 'Product',
                    ),
                    onChanged: (value) => setState(() => _product = value),
                    items: _products
                        .map((product) => DropdownMenuItem(
                              child: Text(product.productKey),
                              value: product,
                            ))
                        .toList(),
                  ),
                  SizedBox(height: 16),
                  OutlinedButton(
                    child: Text('Create Invoice'),
                    onPressed: (_email.isNotEmpty && _product != null)
                        ? () => _createInvoice()
                        : null,
                  ),
                  OutlinedButton(
                    child: Text('View PDF'),
                    onPressed: (_invoice != null) ? () => _viewPdf() : null,
                  ),
                  OutlinedButton(
                    child: Text('View Portal'),
                    onPressed: (_invoice != null) ? () => _viewPortal() : null,
                  ),
                ],
              ),
            ),
          ),
        ),
      ),
    );
  }
}