审计数据API

一个符合AICPA审计数据标准的API,支持AI助手通过模型上下文协议(MCP)集成,适用于财务审计和数据分析场景。

  • by GenAICPA
  • JavaScript
  • 本地部署
  • 4 星标
  • 更新于
在 GitHub 查看 GenAICPA/aicpa-audit-data-api

使用说明

AICPA审计数据API

全面实施AICPA审计数据标准(2012-2015),并为AI助手集成模型上下文协议(MCP)服务器。

🚀 特性

  • 遵从标准:实施AICPA-ADS规范
  • AI就绪:为Claude等AI助手提供完整的MCP集成
  • 生产准备就绪:全面的错误处理和验证
  • 互动演示:用于测试API终结点的Web界面
  • Docker支持:易于集装箱化部署

📋 快速开始

先决条件

  • Node.js 18+
  • npm或纱线

安装

  1. 克隆存储库

    git clone https://github.com/GenAICPA/aicpa-audit-data-api.git
    cd aicpa-audit-data-api
    
  2. 启动API服务器

    cd api-server
    cp .env.example .env
    npm install
    npm start
    
  3. 启动MCP服务器 (在新航站楼)

    cd mcp-server
    cp .env.example .env
    npm install
    npm start
    
  4. 访问演示 打开http://localhost:3000在您的浏览器中

Docker设置

docker-compose up -d

📚 文档

🔧 API终点

端点 描述 参数
/api/v1/general-ledger/trial-balance 试算表数据 entityId,endDate
/api/v1/general-ledger/chart-of-accounts 科目表 实体Id,级别
/api/v1/general-ledger/detail 总账交易 实体Id、开始日期、结束日期
/api/v1/subledgers/accounts-receivable AR账龄数据 entityId,截至日期
/api/v1/subledgers/accounts-payable AP详细信息 entityId,截至日期

🤖 MCP集成

该项目包括一个模型上下文协议服务器,使AI助手能够使用自然语言与审计数据进行交互:

// Example AI interactions
"What's the current cash position for DEMO-CORP-001?"
"Calculate liquidity ratios as of December 31, 2024"  
"Show me all revenue transactions from Q4"

📊 标准符合性

  • AICPA-ADS-GL-v1.0:总账标准
  • AICPA-ADS-AR-v1.0:应收账款标准
  • AICPA-ADS-AP-v1.0:应付账款标准
  • XBRL-JSON:数据交换格式
  • ISO-8601:日期格式

🧪 测试

# API Server tests
cd api-server && npm test

# MCP Server tests  
cd mcp-server && npm test

🤝 贡献

  1. 分叉存储库
  2. 创建要素分支(git checkout -b feature/amazing-feature)
  3. 提交更改(git commit -m 'Add amazing feature')
  4. 推送到分支(git push origin feature/amazing-feature)
  5. 打开拉取请求

📄 许可证

此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。

🙏 致谢

  • 美国注册会计师协会审计数据标准工作组
  • 模型上下文协议贡献者
  • 开源社区

📞 支持


⭐ 如果你觉得这个repo有用,请将其标记为星号!