のために: 管理者
管理キーを使用して請求書を読み込む
所属する拠点の発行済み請求書の一覧を作成し、そのうちの1つを金額、支払い、返金状況とともに確認し、ご自身の会計処理や報告に役立ててください。
この記事では4 セクション
始める前に
このページでは、請求書の読み方について説明しています。操作の流れは https://prd-api-manage.caseactive.com/v1/<hub id> の下に記載されています。このキーを使用すると、すべての発行された請求書を確認できます。ただし、未承認の請求書や、決済されていない請求書は対象外です。また、請求書の作成、変更、返金、支払いなどの操作はできません。
電話
| 電話 | その機能 |
|---|---|
GET /invoices | 発行された請求書の一覧です。最新のものから表示されています。 |
GET /invoices/<case_id>/<invoice_id> | 1つの請求書を読みます。 |
| パラメータ | その機能 | 必須 | デフォルト |
|---|---|---|---|
status | この状態の請求書のみが適用されます:open、paid、void、uncollectible、またはprocessing | いいえ。 | 全部 |
case_id | 1件の請求書のみです。 | いいえ。 | すべてのケースについて |
limit | 1ページに表示される請求書の数は、最大で1000件です。 | いいえ。 | 20 |
start_key | 前のページにあるstartKey | いいえ。 | 最初のページ |
まだ多くの請求書が残っています。どうぞお電話ください。 nextLink, または送信してください。 startKey そのように start_key. このリストには、日付によるフィルタリングや、請求書が最後に変更された時期に関するフィルタリングはありません。前回の同期以来に変更された内容を確認したい場合は、支払いや返金の情報も含めて検索してください。 case_invoices テーブルに乗っているもの filter_by=updated_on:> その後に、Unix秒単位で表される最後の同期の時刻が表示されます。変更内容は、保存された後数秒後に検索対象になりますので、各ウィンドウを開く際には、最後のウィンドウが終了する少し前に開始してください。 filter_by=refund_status:=succeeded 返金を受け取るためには、こちらをご覧ください。 管理キーを使って、該当するケースやユーザーを検索します。.
請求書
すべての金額は、アメリカドルで表される整数のセントです。96300というのは、963.00ドルに相当します。
{
"data": {
"case_id": "cc-1a2b3c4d5e6f70",
"invoice_id": "invoice::20260915143000_ab12cd34ef5678",
"host_id": "ca-7e6d5c4b3a2f10",
"name": "September legal services",
"description": "Consultation and filing for Jane Sample's claim",
"invoice_number": "INV-1042",
"po_number": "PO-778",
"terms": "Net 15",
"host_ref_id": "acct-1042",
"notes": "Thank you for your business.",
"participants_ids": ["cu-4f1c2a9e8b7d60"],
"user_id": "cu-9d8c7b6a5f4e30",
"status": "paid",
"due_date": "2026-09-30T17:00:00+00:00",
"transactions": {
"transactions": [
{"transaction_type": "charge", "description": "Consultation (hours)", "value": 35000, "quantity": 2, "currency": "usd"},
{"transaction_type": "charge", "description": "Court filing fee", "value": 30000, "quantity": 1, "currency": "usd"}
],
"discount": 0.1,
"tax": 0.07
},
"subtotal": 100000,
"discount": 0.1,
"discount_amount": 10000,
"discounted_amount": 90000,
"tax": 0.07,
"tax_amount": 6300,
"total": 96300,
"payment_gateway": "stripe",
"stripe_payment": {"user_id": "cu-4f1c2a9e8b7d60", "fees": 2863, "stripe_fee": 2823, "application_fee": 40, "net": 93437},
"payment_attempts": [{"datetime": "2026-09-20T14:05:12+00:00", "success": true, "user_id": "cu-4f1c2a9e8b7d60"}],
"completed_on": "2026-09-20T14:05:20+00:00",
"published": 1,
"created_on": "2026-09-15T14:30:00+00:00",
"updated_on": "2026-09-20T14:05:20+00:00"
}
}
| 分野 | 中身 |
|---|---|
invoice_id, case_id | 請求書と、それに添付されている書類も読んでみてください。両方を一緒に読んでみましょう。 |
name, description | そのタイトルと説明 |
invoice_number, po_number, terms, notes, host_ref_id | 請求書に記入されています。host_ref_idは、その参照IDです。 |
participants_ids | それが対象とする人々とは、 |
user_id | それを作ったのは誰なのでしょうか? |
status | open:支払いを待っている状態です。 paid:オンラインで支払われたか、または支払い済みと表示されています。 void:キャンセルされた状態です。 uncollectibleとprocessing:スタッフが設定した値です。 paidとvoid:最終的な値です。 |
due_date | 期限が来た時 |
transactions | その構成要素は、chargeまたはcreditのようなものです。さらに、description、セント単位でのvalue、そしてquantityという値もあります。そして、適用される利率もあります。 |
subtotal | 負債を差し引いた後の残高は、決して0未満にはなりません。 |
discount, discount_amount, discounted_amount | 割引率を分数で表すと、0.1は10%です。また、割引後の金額も、セント単位で表されます。そして、割引後の合計金額もあります。 |
tax, tax_amount | 税率を分数で表した形0.07 7%)であり、割引後の金額に対する税額は、セント単位で表されます。 |
total | 支払うべき金額は、セントでいくらですか? |
payment_gateway | stripeは、オンラインで支払われた場合です。manualは、スタッフが支払いを確認した場合です。 |
stripe_payment | オンラインでの支払いの場合、誰が支払ったのか、およびその手数料や、純額はいくらか。 |
payment_attempts | オンラインで支払いを試みるたびに、その際の状況や、うまくいったかどうか、そしてなぜうまくいかなかったのかを確認する必要があります。 |
refunded | 返金がある場合は、その金額はstatus(pending, succeeded, failed, またはcanceled)で表されます。また、amountはセント単位で表され、reasonも同様です。請求書の状態は常にpaidのままです。 |
completed_on | 支払いが完了した場合、または無効になった場合 |
電話が拒否された場合
| 状態 | message | なぜ |
|---|---|---|
| 404 | InvoiceDoesNotExistException | そのケースには、そのIDが記載されている請求書はありません。 |
| 400 | InvoiceNotPublishedException | この請求書は、手形です。 |
| 400 | SchemaFieldsException | statusは、5つのうちの1つではありません。 |
| 400 | InvalidStartKeyException | start_keyは、このリストから来たものではありません。 |
エラー内容やその他のコードについては、APIのエラーやステータスコードの処理方法を参照してください。