コンテンツへスキップ

Frihet REST API

請求書、顧客、費用、製品、見積もりへのプログラムによるアクセス。スケーラブルな連携のために設計されています。

https://api.frihet.io/v1 v1 — 2026-03-18 OpenAPI 3.1 · 82 paths · 137 operations

開発者向けに作られています

部分更新 PATCH

必要なフィールドのみを更新。Zodで検証された部分スキーマが整合性を保証します。

検索とフィルター

?q=パラメータによる全文検索。正確な結果のためのリソースごとのフィールドマッピング。

バッチ操作

1つのリクエストで最大50のリソースを作成。HTTP 207マルチステータス応答。

べき等性キー

Idempotency-Keyヘッダーを使用してリクエストを安全に再試行できます。キーは24時間認識されます。

レート制限ヘッダー

各応答にX-RateLimit-Limit、Remaining、Reset。それに応じて計画してください。

OpenAPI 3.1仕様

機械可読な仕様が /openapi.yaml にあります。16パス、18スキーマ。SDKを自動生成します。

インテリジェンスエンドポイント

/context、/monthly、/quarterly経由でビジネスコンテキスト、月次概要、四半期税務データ。

VeriFactuの安全な削除

ドラフトではない請求書および見積もりのソフトデリート。スペインの税務コンプライアンスのための完全なトレーサビリティ。

エンドポイント

Method Path
GET /v1/invoices
POST /v1/invoices
PATCH /v1/invoices/:id
DELETE /v1/invoices/:id
POST /v1/invoices/batch
GET /v1/clients
POST /v1/clients
GET /v1/expenses
POST /v1/expenses
GET /v1/products
GET /v1/quotes
GET /v1/context
GET /v1/monthly
GET /v1/quarterly
GET /openapi.yaml

コード例

                import { Frihet } from '@frihet/sdk';

const apiKey = process.env.FRIHET_API_KEY;
if (!apiKey) throw new Error('Set FRIHET_API_KEY before running this example');
const frihet = new Frihet({ apiKey });

// Follow each page's nextCursor until all paid invoices have been read.
let cursor: string | undefined;
do {
  const page = await frihet.invoices.list({ status: 'paid', limit: 25, cursor });
  for (const invoice of page.data) {
    console.log(invoice.documentNumber, invoice.total);
  }
  cursor = page.nextCursor;
} while (cursor);
              

認証

Frihetパネルの「設定 > API」からAPIキーを生成します。AuthorizationヘッダーにBearerトークンとしてキーを含めてください。

Authorization: Bearer fri_...

今日から連携を開始

すべてのプランにAPIアクセスが含まれています。APIキーは「設定」で準備されています。

無料で始める