メインコンテンツへスキップ

API概要

lim REST APIは、プログラムから会計操作を実行するためのHTTP APIです。AI Agent、外部システム、カスタムアプリケーションとの連携に使用します。

ベースURL

https://api.uselim.com/v1

認証

すべてのリクエストにはAPIキーが必要です。Authorization ヘッダーにBearerトークンとして設定します:
curl -H "Authorization: Bearer lim_sk_..." \
  https://api.uselim.com/v1/journals

APIキーの取得

lim auth create-api-key --name "my-integration"
APIキーは会社単位で発行されます。キーを安全に管理し、公開リポジトリにコミットしないでください。

主要エンドポイント

仕訳

メソッドパス説明
POST/v1/journals仕訳の作成
GET/v1/journals仕訳の一覧
GET/v1/journals/:id仕訳の詳細
PATCH/v1/journals/:id仕訳の更新
POST/v1/journals/:id/reverse仕訳の取消

自然言語入力

メソッドパス説明
POST/v1/add自然言語で仕訳を追加

レポート

メソッドパス説明
GET/v1/reports/trial-balance試算表
GET/v1/reports/profit-loss損益計算書
GET/v1/reports/balance-sheet貸借対照表
GET/v1/reports/cash-flowキャッシュフロー計算書
GET/v1/reports/runway資金繰り予測

勘定科目

メソッドパス説明
GET/v1/accounts勘定科目の一覧
POST/v1/accounts勘定科目の作成
PATCH/v1/accounts/:code勘定科目の更新

リクエスト例

自然言語で仕訳を追加

curl -X POST https://api.uselim.com/v1/add \
  -H "Authorization: Bearer lim_sk_..." \
  -H "Content-Type: application/json" \
  -d '{"text": "AWS 11000円 クレジットカード"}'

レスポンス

{
  "id": "je_01J7...",
  "date": "2026-03-15",
  "status": "posted",
  "lines": [
    {
      "account_code": "7100",
      "account_name": "通信費",
      "debit": 10000,
      "credit": 0
    },
    {
      "account_code": "1540",
      "account_name": "仮払消費税",
      "debit": 1000,
      "credit": 0
    },
    {
      "account_code": "2100",
      "account_name": "未払金",
      "debit": 0,
      "credit": 11000
    }
  ],
  "engine": {
    "method": "rule_match",
    "confidence": 99,
    "rule_id": "rule_aws_monthly"
  }
}

レスポンス形式

すべてのレスポンスはJSONで返されます。ページネーション対応のリストAPIでは以下の形式です:
{
  "data": [...],
  "pagination": {
    "total": 142,
    "page": 1,
    "per_page": 50,
    "has_more": true
  }
}

エラーハンドリング

{
  "error": {
    "code": "validation_error",
    "message": "Amount must be a positive integer",
    "field": "amount"
  }
}
ステータスコード説明
200成功
201作成成功
400リクエストエラー
401認証エラー
403権限エラー
404リソースが見つからない
429レート制限

レート制限

プランリクエスト/分
Free60
Pro600
Enterpriseカスタム

次のステップ