ivankahl/ynab-slip-uploader

YNAB收据上传工具

镜像概述

YNAB Slip Uploader是一款利用Google *** AI处理收据图片，并自动在YNAB（You Need A Budget）预算管理工具中创建交易记录的服务，帮助用户简化记账流程。

核心功能

• 处理收据图片（JPEG、PNG、WebP格式）及PDF文件
• 借助*** AI提取交易详情（如金额、日期、商户名称）
• 自动对交易及明细项进行分类
• 支持拆分交易的明细项处理
• 通过基础认证保护API接口

使用场景

• 个人/家庭预算管理：快速将纸质/电子收据转化为YNAB交易记录
• 小商户记账：批量处理收据并自动导入YNAB，减少手动录入工作量
• 财务自动化：整合收据处理与预算管理，提升记账效率

配置说明

前置条件

需准备以下信息：

• Google *** AI API密钥（可从https://aistudio.google.com/app/apikey%E8%8E%B7%E5%8F%96%EF%BC%89
• YNAB API密钥（可从YNAB开发者设置获取）
• YNAB预算ID（查看YNAB预算页面时URL中的ID）

Docker部署示例

shell
docker run \
    -e APP_API_KEY=你的API用户名 \
    -e APP_API_SECRET=你的API密码 \
    -e GEMINI_API_KEY=你的Gemini密钥 \
    -e GEMINI_MODEL=gemini-2.0-flash-exp \
    -e YNAB_API_KEY=你的YNAB密钥 \
    -e YNAB_BUDGET_ID=你的YNAB预算ID \
    -p 3000:3000 \
    ivankahl/ynab-slip-uploader

验证服务运行

访问/healthz端点，若返回OK则服务正常启动。

上传收据示例

使用curl上传收据：

shell
curl -X POST 'http://localhost:3000/upload' \
  -H 'Authorization: Basic $(echo -n "你的API用户名:你的API密码" | base64)' \
  -F 'account=银行支票账户' \
  -F 'file=@/路径/到/收据.pdf' \
  --fail

成功时会返回包含交易详情的JSON响应，例如：

json
{
  "category": " groceries",
  "memo": "购买苹果和芒果",
  "storeName": "Woolworths",
  "totalAmount": 86.97,
  "transactionDate": "2024-01-08",
  "lineItems": [
    {
      "category": " groceries",
      "lineItemTotalAmount": 11.99,
      "productName": "苹果",
      "quantity": 1
    }
  ]
}

环境变量配置

许可证

本镜像基于MIT许可证分发。