POST/v1/finance/invoices

請求書を一覧表示する

finance_invoices

組織の請求書、貸方票、領収書を、フィルター（期間、方向、カテゴリ、取引先、通貨、ドキュメントの種類、支払済み、期限超過、要確認、番号と当事者による検索）、並べ替え、換算レート付きの報告通貨での金額とともに、ページごとに返します。ユーザーがアクセスできるドキュメントだけが含まれます。次のページを取得するには、同じフィルターでnext_cursorをcursorとして渡してください。財務データにアクセスできるデータプロファイルが必要です。

認証

AuthorizationヘッダーでAPIキーを送信します：Authorization: Bearer <キー>。

ヘッダーパラメーター

X-View-Asstring
adminロールのAPIキー専用です。データプロファイル<profile>[:viewer|verifier|editor]（例：employee:viewer）としてリクエストを実行します。インストールキーではこのヘッダーを使えません（403）。

Cookieパラメーター

kb_view_asstring
セッションの「View as」モードのCookie。POST /auth/view-asで設定し、DELETE /auth/view-asで解除します。

リクエストボディ

application/json

オブジェクト：FinanceListRequest

filtersFinanceFilter
date_basisstring
指定できる値: documentpayment
デフォルト："document"
orderstring
指定できる値: date_descdate_ascamount_descamount_asc
デフォルト："date_desc"
currency_modeFinanceCurrencyMode
limitinteger
デフォルト：100≥ 1, ≤ 1000
cursorstring
languagestring
カテゴリのラベルの言語、en|ru。

レスポンス

200請求書の1ページ

レスポンスヘッダー

RateLimit-Policy
適用中の制限。IETFのドラフトdraft-ietf-httpapi-ratelimit-headersの形式で、"<name>";q=<quota>;w=<window in seconds>の項目をカンマで区切って並べます。keyはAPIキーのリクエストレートです（クォータはバースト、ウィンドウはバーストが完全に回復するまでの時間。セッションではuser、認証情報がない場合はip）。minute、day、monthは、UTCの暦の上での1分・1日・1か月ごとの組織のクォータです。
RateLimit
RateLimit-Policyの各制限の残り："<name>";r=<remaining>;t=<seconds until reset>。
X-RateLimit-Limit
RateLimit-Policyのうち最も厳しい項目（残りのリクエスト数が最も少ない項目）の上限。
X-RateLimit-Remaining
最も厳しい制限での残りのリクエスト数。
X-RateLimit-Reset
最も厳しい制限がリセットされるまでの秒数。

application/json

オブジェクト：FinanceInvoicePage

invoicesarray of FinanceInvoiceRow必須
totalinteger必須
フィルターに一致する請求書の総数。
next_cursorstring
次のページのカーソル。このフィールドがない場合は、最後のページです。
currencystring
reportingフィールドの報告通貨（reportingモード）。
warningsarray of string
警告コード。FinanceReport.warningsと同じです。
has_moreboolean
次のページがあるかどうか。リクエストでlimitまたはcursorを渡した場合に含まれます。

400リクエストが無効です：パラメーターの値またはオブジェクトの状態により、この操作を実行できません（`detail`はメッセージ）。

レスポンスヘッダー

RateLimit-Policy
適用中の制限。IETFのドラフトdraft-ietf-httpapi-ratelimit-headersの形式で、"<name>";q=<quota>;w=<window in seconds>の項目をカンマで区切って並べます。keyはAPIキーのリクエストレートです（クォータはバースト、ウィンドウはバーストが完全に回復するまでの時間。セッションではuser、認証情報がない場合はip）。minute、day、monthは、UTCの暦の上での1分・1日・1か月ごとの組織のクォータです。
RateLimit
RateLimit-Policyの各制限の残り："<name>";r=<remaining>;t=<seconds until reset>。
X-RateLimit-Limit
RateLimit-Policyのうち最も厳しい項目（残りのリクエスト数が最も少ない項目）の上限。
X-RateLimit-Remaining
最も厳しい制限での残りのリクエスト数。
X-RateLimit-Reset
最も厳しい制限がリセットされるまでの秒数。

application/json

オブジェクト：Error

401認証情報が送信されていない（セッションCookieもAPIキーもない）か、キーが見つかりません。

レスポンスヘッダー

RateLimit-Policy
適用中の制限。IETFのドラフトdraft-ietf-httpapi-ratelimit-headersの形式で、"<name>";q=<quota>;w=<window in seconds>の項目をカンマで区切って並べます。keyはAPIキーのリクエストレートです（クォータはバースト、ウィンドウはバーストが完全に回復するまでの時間。セッションではuser、認証情報がない場合はip）。minute、day、monthは、UTCの暦の上での1分・1日・1か月ごとの組織のクォータです。
RateLimit
RateLimit-Policyの各制限の残り："<name>";r=<remaining>;t=<seconds until reset>。
X-RateLimit-Limit
RateLimit-Policyのうち最も厳しい項目（残りのリクエスト数が最も少ない項目）の上限。
X-RateLimit-Remaining
最も厳しい制限での残りのリクエスト数。
X-RateLimit-Reset
最も厳しい制限がリセットされるまでの秒数。

application/json

オブジェクト：Error

403この操作は許可されていません：ロールの権限が足りない、コレクションやカードへのアクセス権がない、リクエストが「View as」モードで実行されている、または組織が停止中か削除済みです（`detail`は`code: org_suspended | org_deleted`を持つオブジェクト）。

レスポンスヘッダー

RateLimit-Policy
適用中の制限。IETFのドラフトdraft-ietf-httpapi-ratelimit-headersの形式で、"<name>";q=<quota>;w=<window in seconds>の項目をカンマで区切って並べます。keyはAPIキーのリクエストレートです（クォータはバースト、ウィンドウはバーストが完全に回復するまでの時間。セッションではuser、認証情報がない場合はip）。minute、day、monthは、UTCの暦の上での1分・1日・1か月ごとの組織のクォータです。
RateLimit
RateLimit-Policyの各制限の残り："<name>";r=<remaining>;t=<seconds until reset>。
X-RateLimit-Limit
RateLimit-Policyのうち最も厳しい項目（残りのリクエスト数が最も少ない項目）の上限。
X-RateLimit-Remaining
最も厳しい制限での残りのリクエスト数。
X-RateLimit-Reset
最も厳しい制限がリセットされるまでの秒数。

application/json

オブジェクト：Error

429リクエストが多すぎる（`api.rate_limited`）、組織の1分・1日・1か月のクォータを使い切った（`api.quota_exceeded`。`error.details`には`quota`、`limit`、`reset_at`が含まれます）、組織の上限に達した、または回答サービスが混雑しています（`answers.engine_busy`）。`Retry-After`ヘッダーの時間だけ待ってください。

レスポンスヘッダー

Retry-After
リクエストを再試行するまでに待つ秒数。
RateLimit-Policy
適用中の制限。IETFのドラフトdraft-ietf-httpapi-ratelimit-headersの形式で、"<name>";q=<quota>;w=<window in seconds>の項目をカンマで区切って並べます。keyはAPIキーのリクエストレートです（クォータはバースト、ウィンドウはバーストが完全に回復するまでの時間。セッションではuser、認証情報がない場合はip）。minute、day、monthは、UTCの暦の上での1分・1日・1か月ごとの組織のクォータです。
RateLimit
RateLimit-Policyの各制限の残り："<name>";r=<remaining>;t=<seconds until reset>。
X-RateLimit-Limit
RateLimit-Policyのうち最も厳しい項目（残りのリクエスト数が最も少ない項目）の上限。
X-RateLimit-Remaining
最も厳しい制限での残りのリクエスト数。
X-RateLimit-Reset
最も厳しい制限がリセットされるまでの秒数。

application/json

オブジェクト：Error

503このリクエストが依存するサービスが一時的に利用できません。しばらくしてから再試行してください。

レスポンスヘッダー

RateLimit-Policy
適用中の制限。IETFのドラフトdraft-ietf-httpapi-ratelimit-headersの形式で、"<name>";q=<quota>;w=<window in seconds>の項目をカンマで区切って並べます。keyはAPIキーのリクエストレートです（クォータはバースト、ウィンドウはバーストが完全に回復するまでの時間。セッションではuser、認証情報がない場合はip）。minute、day、monthは、UTCの暦の上での1分・1日・1か月ごとの組織のクォータです。
RateLimit
RateLimit-Policyの各制限の残り："<name>";r=<remaining>;t=<seconds until reset>。
X-RateLimit-Limit
RateLimit-Policyのうち最も厳しい項目（残りのリクエスト数が最も少ない項目）の上限。
X-RateLimit-Remaining
最も厳しい制限での残りのリクエスト数。
X-RateLimit-Reset
最も厳しい制限がリセットされるまでの秒数。

application/json

オブジェクト：Error

エラーコード

すべてのリクエストに共通のコードに加えて、このエンドポイントがerror.codeで返すことのあるコード。

安全な再試行

POSTとPATCHのたびにIdempotency-Keyヘッダー（UUIDなど）を送信してください。24時間以内に同じキーで再試行すると、リクエストをもう一度実行せずに、保存済みのレスポンスが返ります。

レート制限

レスポンスには、RateLimitヘッダーとRateLimit-Policyヘッダー、以前のX-RateLimit-Limit、X-RateLimit-Remaining、X-RateLimit-Resetが含まれます。429レスポンスにはRetry-After（秒）が含まれます。その時間だけ待ってから再試行してください。

← finance · APIリファレンス

curl -X POST 'https://api.sursa.com/v1/finance/invoices' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"filters":{"from":"2026-10-24","to":"2026-10-24","directions":["in"]},"date_basis":"document","order":"date_desc"}' \
  -H "Authorization: Bearer $SURSA_API_KEY"

試してみる

APIキー

キーはこのタブのメモリにだけ保持され、https://api.sursa.comにだけ送信されます。

リクエストは組織の実際のデータに対して実行されます。

X-View-As header

Idempotency-Key

空欄の場合は、リクエストごとに新しいキーが生成されます。

リクエストボディ（JSON）