API リファレンス
REST API のエンドポイント、必要な権限、入力・応答と Webhook のスキーマを確認できます。
cart:write はカートの参照も含みます。カートは購入前の下書きのため、参照と編集を同じ権限で扱います。
エンドポイント
社名から法人番号を調べる
GET/api/v1/companies/search
basic は有効な API キーの基本権限を表し、追加のスコープ指定は不要です。
必要な権限：基本権限（追加指定不要）
パラメータ
q（クエリ・必須）string1〜200 文字。社名または法人番号。最小文字数：
1最大文字数：
200limit（クエリ・任意）integer1〜50、既定 20最小値：
1最大値：
50cursor（クエリ・任意）string前回の nextCursor（数字のみ）パターン：
^[0-9]+$
応答
200
companies: Company[]・nextCursor: string | null。続きがなければ null。
application/json
object
companies任意array配列の要素
参照先：Company
objectcn任意string13 桁の法人番号（先頭 0 不可）name任意string社名closed任意boolean閉鎖法人かprefecture任意string | null都道府県city任意string | null市区町村industry任意string | null業種capital任意string資本金の表示値（未取得は —）founded任意string設立日または —archiveDate任意string | null提供できる履歴事項アーカイブの取得日時recentArchive任意object | null直近取得済みの場合の案内reasonCode任意stringrecent_archiveacquiredOn任意string取得日message任意string案内文
registrationReasonCode任意string | nullregistration_blocked：本日の取得が保留registrationBlockedOn任意string | null保留日registrationWarning任意string | null登記手続きに関する案内signal任意object登記受付の観測情報state任意string | nullreceipt_after・receipt_near・no_receipt_in_covered・unverifiedbureau任意string局名の表示値coveredThrough任意string観測範囲の終了日または空文字last_receipt_on任意string | null観測した最新の登記受付日
acquiredByOwnOrg任意boolean所属法人が最新取得した履歴があるかreason任意stringnot_available・not_registered_corporationentrustable任意booleanWeb の取得代行を案内できるか
nextCursor任意string | null
400
400：検索語が空・長すぎる、limit・cursor が不正。検索機能が利用できない場合は 503。
application/json
参照先：Error
object
error必須string
法人情報・アーカイブの有無を確認する
GET/api/v1/companies/{cn}
basic は有効な API キーの基本権限を表し、追加のスコープ指定は不要です。
必要な権限：基本権限（追加指定不要）
パラメータ
cn（パス・必須）string13 桁の法人番号（パス）パターン：
^[1-9][0-9]{12}$
応答
200
company: Company | null。該当する法人がなければ null。
application/json
object
company任意いずれかの型
参照先：Company
objectcn任意string13 桁の法人番号（先頭 0 不可）name任意string社名closed任意boolean閉鎖法人かprefecture任意string | null都道府県city任意string | null市区町村industry任意string | null業種capital任意string資本金の表示値（未取得は —）founded任意string設立日または —archiveDate任意string | null提供できる履歴事項アーカイブの取得日時recentArchive任意object | null直近取得済みの場合の案内reasonCode任意stringrecent_archiveacquiredOn任意string取得日message任意string案内文
registrationReasonCode任意string | nullregistration_blocked：本日の取得が保留registrationBlockedOn任意string | null保留日registrationWarning任意string | null登記手続きに関する案内signal任意object登記受付の観測情報state任意string | nullreceipt_after・receipt_near・no_receipt_in_covered・unverifiedbureau任意string局名の表示値coveredThrough任意string観測範囲の終了日または空文字last_receipt_on任意string | null観測した最新の登記受付日
acquiredByOwnOrg任意boolean所属法人が最新取得した履歴があるかreason任意stringnot_available・not_registered_corporationentrustable任意booleanWeb の取得代行を案内できるか
null
見積を確認する
POST/api/v1/quote
basic は有効な API キーの基本権限を表し、追加のスコープ指定は不要です。
必要な権限：基本権限（追加指定不要）
リクエスト本文（必須）
application/json
object
cart必須array最大 50 件最大要素数：
50配列の要素
objectcn必須string法人番号choice必須stringlatest または new・archive。応答は new・archive・redownload選択値：
new・latest・archivemanual任意boolean取得方法を明示指定するなら truedocType任意stringhistory・closed。既定 historydocumentId任意string過去時点・閉鎖事項を選ぶ文書 UUIDforceNewClosed任意boolean閉鎖事項を新規取得するかtrack任意stringprovision・entrusted。購入申請は provision のみ。
settings必須object見積条件maxAgeDays任意number30・90・180・365unverified任意stringarchive・newentrustedDeclaration任意object取得代行の同意情報termsVersion任意string同意した取得代行約款の版
applyVouchers任意boolean引換券を使う。既定 true
応答
200
Quote（下の見積の項目）。購入は実行しません。
application/json
参照先：Quote
object
lines任意array見積明細配列の要素
objectcompany任意上の法人情報 参照先：Company
objectcn任意string13 桁の法人番号（先頭 0 不可）name任意string社名closed任意boolean閉鎖法人かprefecture任意string | null都道府県city任意string | null市区町村industry任意string | null業種capital任意string資本金の表示値（未取得は —）founded任意string設立日または —archiveDate任意string | null提供できる履歴事項アーカイブの取得日時recentArchive任意object | null直近取得済みの場合の案内reasonCode任意stringrecent_archiveacquiredOn任意string取得日message任意string案内文
registrationReasonCode任意string | nullregistration_blocked：本日の取得が保留registrationBlockedOn任意string | null保留日registrationWarning任意string | null登記手続きに関する案内signal任意object登記受付の観測情報state任意string | nullreceipt_after・receipt_near・no_receipt_in_covered・unverifiedbureau任意string局名の表示値coveredThrough任意string観測範囲の終了日または空文字last_receipt_on任意string | null観測した最新の登記受付日
acquiredByOwnOrg任意boolean所属法人が最新取得した履歴があるかreason任意stringnot_available・not_registered_corporationentrustable任意booleanWeb の取得代行を案内できるか
choice任意stringnew・archive・redownload選択値：
new・archive・redownloadmanual任意boolean取得方法を明示指定したかreason任意string選定理由reasonCode任意string | nullrecent_archive・registration_blocked・already_owned などの選定理由acquiredOn任意string | nullアーカイブ取得日voucher任意boolean引換券を使うかamount任意number明細金額（円）unitAmount任意number1 文書の単価（円）authorizationAmount任意number | null与信の上限額（円）docType任意stringhistory・closedclosedRecordRef任意string | null閉鎖事項の参照値quantityUncertain任意boolean文書数が未確定かtrack任意stringprovision・entrustedfreeRedownload任意boolean権利があり無料で再取得できるかdocumentId任意string | null選択した文書 ID。archive・redownload の場合に返る。timepointKind任意string | nulllatest・past・closedheadOffice任意string | null選択時点の本店requestedDocumentId任意string | null指定された文書 ID
newCount任意number最新取得件数archiveCount任意numberアーカイブ件数vouchersUsed任意number使用引換券数total任意number合計額（円）authorizationTotal任意number与信上限額（円）estimatedVouchers任意number発行見込みの引換券数taxAmount任意number内消費税（円）consent任意object承認時の見積照合値authorizationTotal任意number確認した与信上限額linesHash任意string確認した明細のハッシュ
monthly_remaining任意number月間の残り取得可能数monthly_reserved任意number予約中の取得数base_cap任意number基本の月間上限monthly_used任意number月間使用済み数monthly_cap任意number月間上限数prepaid_remaining任意number現在有効な月間加算件数entrustedSalesOpen任意boolean取得代行の受付可否entrustedSalesTestAllowed任意boolean取得代行のテスト受付可否
400
400：cart が配列でない・50 件を超える、settings がオブジェクトでない、applyVouchers が boolean でない。
application/json
参照先：Error
object
error必須string
API カートを取得する
GET/api/v1/cart
cart:write はカートの参照も含みます。カートは購入前の下書きのため、参照と編集を同じ権限で扱います。
必要な権限：cart:write
パラメータ・リクエスト本文はありません。
応答
200
items: object[]（cn: string・kind: new | archive・added_via_key_id: string・added_at: string・quote: Quote | null・error: string | null）。quote: Quote | null はカート全体の見積。提供できない明細は error=not_available。
application/json
参照先：Cart
object
items任意arrayAPI カートの品目配列の要素
objectcn任意string法人番号kind任意stringnew・archiveadded_via_key_id任意string追加した API キーの UUIDadded_at任意string追加日時quote任意この品目の見積
いずれかの型
参照先：Quote
objectlines任意array見積明細配列の要素
objectcompany任意上の法人情報 参照先：Company
objectcn任意string13 桁の法人番号（先頭 0 不可）name任意string社名closed任意boolean閉鎖法人かprefecture任意string | null都道府県city任意string | null市区町村industry任意string | null業種capital任意string資本金の表示値（未取得は —）founded任意string設立日または —archiveDate任意string | null提供できる履歴事項アーカイブの取得日時recentArchive任意object | null直近取得済みの場合の案内reasonCode任意stringrecent_archiveacquiredOn任意string取得日message任意string案内文
registrationReasonCode任意string | nullregistration_blocked：本日の取得が保留registrationBlockedOn任意string | null保留日registrationWarning任意string | null登記手続きに関する案内signal任意object登記受付の観測情報state任意string | nullreceipt_after・receipt_near・no_receipt_in_covered・unverifiedbureau任意string局名の表示値coveredThrough任意string観測範囲の終了日または空文字last_receipt_on任意string | null観測した最新の登記受付日
acquiredByOwnOrg任意boolean所属法人が最新取得した履歴があるかreason任意stringnot_available・not_registered_corporationentrustable任意booleanWeb の取得代行を案内できるか
choice任意stringnew・archive・redownload選択値：
new・archive・redownloadmanual任意boolean取得方法を明示指定したかreason任意string選定理由reasonCode任意string | nullrecent_archive・registration_blocked・already_owned などの選定理由acquiredOn任意string | nullアーカイブ取得日voucher任意boolean引換券を使うかamount任意number明細金額（円）unitAmount任意number1 文書の単価（円）authorizationAmount任意number | null与信の上限額（円）docType任意stringhistory・closedclosedRecordRef任意string | null閉鎖事項の参照値quantityUncertain任意boolean文書数が未確定かtrack任意stringprovision・entrustedfreeRedownload任意boolean権利があり無料で再取得できるかdocumentId任意string | null選択した文書 ID。archive・redownload の場合に返る。timepointKind任意string | nulllatest・past・closedheadOffice任意string | null選択時点の本店requestedDocumentId任意string | null指定された文書 ID
newCount任意number最新取得件数archiveCount任意numberアーカイブ件数vouchersUsed任意number使用引換券数total任意number合計額（円）authorizationTotal任意number与信上限額（円）estimatedVouchers任意number発行見込みの引換券数taxAmount任意number内消費税（円）consent任意object承認時の見積照合値authorizationTotal任意number確認した与信上限額linesHash任意string確認した明細のハッシュ
monthly_remaining任意number月間の残り取得可能数monthly_reserved任意number予約中の取得数base_cap任意number基本の月間上限monthly_used任意number月間使用済み数monthly_cap任意number月間上限数prepaid_remaining任意number現在有効な月間加算件数entrustedSalesOpen任意boolean取得代行の受付可否entrustedSalesTestAllowed任意boolean取得代行のテスト受付可否
nullerror任意string | null見積できない場合は not_available
quote任意カート全体の見積。見積できない場合は null
いずれかの型
参照先：Quote
objectlines任意array見積明細配列の要素
objectcompany任意上の法人情報 参照先：Company
objectcn任意string13 桁の法人番号（先頭 0 不可）name任意string社名closed任意boolean閉鎖法人かprefecture任意string | null都道府県city任意string | null市区町村industry任意string | null業種capital任意string資本金の表示値（未取得は —）founded任意string設立日または —archiveDate任意string | null提供できる履歴事項アーカイブの取得日時recentArchive任意object | null直近取得済みの場合の案内reasonCode任意stringrecent_archiveacquiredOn任意string取得日message任意string案内文
registrationReasonCode任意string | nullregistration_blocked：本日の取得が保留registrationBlockedOn任意string | null保留日registrationWarning任意string | null登記手続きに関する案内signal任意object登記受付の観測情報state任意string | nullreceipt_after・receipt_near・no_receipt_in_covered・unverifiedbureau任意string局名の表示値coveredThrough任意string観測範囲の終了日または空文字last_receipt_on任意string | null観測した最新の登記受付日
acquiredByOwnOrg任意boolean所属法人が最新取得した履歴があるかreason任意stringnot_available・not_registered_corporationentrustable任意booleanWeb の取得代行を案内できるか
choice任意stringnew・archive・redownload選択値：
new・archive・redownloadmanual任意boolean取得方法を明示指定したかreason任意string選定理由reasonCode任意string | nullrecent_archive・registration_blocked・already_owned などの選定理由acquiredOn任意string | nullアーカイブ取得日voucher任意boolean引換券を使うかamount任意number明細金額（円）unitAmount任意number1 文書の単価（円）authorizationAmount任意number | null与信の上限額（円）docType任意stringhistory・closedclosedRecordRef任意string | null閉鎖事項の参照値quantityUncertain任意boolean文書数が未確定かtrack任意stringprovision・entrustedfreeRedownload任意boolean権利があり無料で再取得できるかdocumentId任意string | null選択した文書 ID。archive・redownload の場合に返る。timepointKind任意string | nulllatest・past・closedheadOffice任意string | null選択時点の本店requestedDocumentId任意string | null指定された文書 ID
newCount任意number最新取得件数archiveCount任意numberアーカイブ件数vouchersUsed任意number使用引換券数total任意number合計額（円）authorizationTotal任意number与信上限額（円）estimatedVouchers任意number発行見込みの引換券数taxAmount任意number内消費税（円）consent任意object承認時の見積照合値authorizationTotal任意number確認した与信上限額linesHash任意string確認した明細のハッシュ
monthly_remaining任意number月間の残り取得可能数monthly_reserved任意number予約中の取得数base_cap任意number基本の月間上限monthly_used任意number月間使用済み数monthly_cap任意number月間上限数prepaid_remaining任意number現在有効な月間加算件数entrustedSalesOpen任意boolean取得代行の受付可否entrustedSalesTestAllowed任意boolean取得代行のテスト受付可否
null
カートを空にする
DELETE/api/v1/cart
cart:write はカートの参照も含みます。カートは購入前の下書きのため、参照と編集を同じ権限で扱います。
必要な権限：cart:write
パラメータ・リクエスト本文はありません。
応答
200
removed: number（削除した件数）。
application/json
object
removed任意integer
カートに追加する
POST/api/v1/cart/items
cart:write はカートの参照も含みます。カートは購入前の下書きのため、参照と編集を同じ権限で扱います。
必要な権限：cart:write
リクエスト本文（必須）
application/json
object
items必須array1〜50 件最小要素数：
1最大要素数：
50配列の要素
objectcn必須string13 桁の法人番号kind必須stringlatest または new・archive。latest は new の別名、応答は new選択値：
new・latest・archivetrack任意stringprovision。取得代行は対象外。
応答
200
results: object[]。各要素は cn: string | null・kind: string | null・ok: boolean・status: added | already_in_cart | rejected・error: string | null（already_in_cart では省略）。error は invalid_item・entrusted_requires_web_terms・not_available・order_limit・monthly_cap。
application/json
参照先：CartResult
object
results任意array指定品目ごとの追加結果配列の要素
objectcn任意string | null法人番号。不正入力では null の場合あり。kind任意string | null受理した種別。latest は new に正規化。ok任意boolean追加済み・すでに登録済みなら truestatus任意stringadded・already_in_cart・rejectederror任意string | nullinvalid_item・entrusted_requires_web_terms・not_available・order_limit・monthly_cap。already_in_cart では項目なし。
400
400：items が配列でない・件数が範囲外。個別の追加結果は HTTP 200 の results で確認。
application/json
参照先：Error
object
error必須string
カートから法人を削除する
DELETE/api/v1/cart/items/{cn}
cart:write はカートの参照も含みます。カートは購入前の下書きのため、参照と編集を同じ権限で扱います。
必要な権限：cart:write
パラメータ
cn（パス・必須）string法人番号（パス）パターン：
^[1-9][0-9]{12}$kind（クエリ・任意）stringクエリ。new・archive。省略で両方削除。
応答
200
removed: number（削除した件数）。
application/json
object
removed任意integer
法人番号から購入申請する
POST/api/v1/purchase-requests
必要な権限：purchase
パラメータ
Idempotency-Key（ヘッダ・必須）stringヘッダ。空白のみ不可、最大 200 文字。パターン：
\S最小文字数：
1最大文字数：
200
リクエスト本文（必須）
application/json
object
追加項目：false
items任意array1〜50 件。from_cart と排他。最小要素数：
1最大要素数：
50配列の要素
objectcn必須string13 桁の法人番号kind必須stringlatest・archive選択値：
latest・archivetrack任意stringprovision のみ
from_cart任意booleantrue で API カートを固定して申請。items は指定しない。固定値：
true
いずれか一つの型
必須：items
必須：from_cart
応答
200
request_id: string・status: pending_approval | ordered | cancelled・order_ids: string[]（ordered のみ）・reason: string（値があるときのみ）。HTTP 200。
application/json
参照先：PurchaseCreated
object
request_id必須string形式：
uuidstatus必須string選択値：
pending_approval・ordered・cancelledorder_ids任意array配列の要素
string形式：
uuidreason任意string選択値：
expired・terms_changed・auto_approval_not_retried・entrusted_requires_web_terms・auto_setting_owner_inactive・auto_purchase_disabled・auto_saved_card_required・auto_limit_exceeded・auto_payment_requires_action・auto_payment_declined・permission_required
400
400：冪等キーなし・空入力・未知のトップレベル項目・items と from_cart の併用。409：同じキーで別の内容。422：items_rejected。
application/json
参照先：Error
object
error必須string
422
品目を拒否。申請全体を作成せず items に理由を返す。
application/json
object
error任意固定値：
items_rejecteditems任意array配列の要素
objectcn任意string | nullkind任意string | nullreason任意string選択値：
invalid_item・entrusted_requires_web_terms・not_available・already_owned・duplicate_company・order_limit・monthly_cap・daily_limit
このキーの申請を一覧する
GET/api/v1/purchase-requests
必要な権限：purchase
パラメータ・リクエスト本文はありません。
応答
200
requests: PurchaseRequest[]。新しい順、最大 100 件。このキーで作成した申請のみ。
application/json
object
requests任意array配列の要素
参照先：PurchaseRequest
objectrequest_id任意string申請 UUIDstatus任意stringpending_approval・approved・rejected・expired・cancelled選択値：
pending_approval・approved・rejected・expired・cancelledamount_jpy任意number申請時の与信上限額（円）expires_at任意string承認期限created_at任意string作成日時approval_url任意stringWeb 承認ページの絶対 URLitems任意array申請内容配列の要素
objectcn任意string法人番号kind任意stringlatest・archivetrack任意stringprovision
order_ids任意array承認後の注文 UUID配列の要素
stringorders任意array決済状況配列の要素
objectorder_id任意string注文 UUIDpayment_status任意stringpending_authorization・authorized・captured・capture_failed・canceledreapplication_required任意boolean取消済みで再申請が必要か
order_items任意array文書の取得状況配列の要素
objectorder_id任意string注文 UUIDcn任意string法人番号kind任意stringlatest・archivestatus任意stringprocessing・available・unavailabledocument_id任意stringPDF と同じ提供判定を通った権利付与済み明細にのみ返す文書 UUID
auto_approved任意boolean承認なし購入を適用したかauto_payment_ready任意boolean自動決済の開始準備ができたかreason任意string | null承認なし購入を適用できない理由
申請・決済・取得の状態を確認する
GET/api/v1/purchase-requests/{id}
必要な権限：purchase
パラメータ
id（パス・必須）string申請 UUID（パス）形式：
uuid
応答
200
PurchaseRequest（下の申請の項目）。作成時の ordered はここでは approved。
application/json
参照先：PurchaseRequest
object
request_id任意string申請 UUIDstatus任意stringpending_approval・approved・rejected・expired・cancelled選択値：
pending_approval・approved・rejected・expired・cancelledamount_jpy任意number申請時の与信上限額（円）expires_at任意string承認期限created_at任意string作成日時approval_url任意stringWeb 承認ページの絶対 URLitems任意array申請内容配列の要素
objectcn任意string法人番号kind任意stringlatest・archivetrack任意stringprovision
order_ids任意array承認後の注文 UUID配列の要素
stringorders任意array決済状況配列の要素
objectorder_id任意string注文 UUIDpayment_status任意stringpending_authorization・authorized・captured・capture_failed・canceledreapplication_required任意boolean取消済みで再申請が必要か
order_items任意array文書の取得状況配列の要素
objectorder_id任意string注文 UUIDcn任意string法人番号kind任意stringlatest・archivestatus任意stringprocessing・available・unavailabledocument_id任意stringPDF と同じ提供判定を通った権利付与済み明細にのみ返す文書 UUID
auto_approved任意boolean承認なし購入を適用したかauto_payment_ready任意boolean自動決済の開始準備ができたかreason任意string | null承認なし購入を適用できない理由
承認待ち申請を取り消す
DELETE/api/v1/purchase-requests/{id}
必要な権限：purchase
パラメータ
id（パス・必須）string申請 UUID（パス）形式：
uuid
応答
200
PurchaseRequest。status=cancelled。期限を過ぎていた場合は expired。決済済み注文の取消 API ではありません。
application/json
参照先：PurchaseRequest
object
request_id任意string申請 UUIDstatus任意stringpending_approval・approved・rejected・expired・cancelled選択値：
pending_approval・approved・rejected・expired・cancelledamount_jpy任意number申請時の与信上限額（円）expires_at任意string承認期限created_at任意string作成日時approval_url任意stringWeb 承認ページの絶対 URLitems任意array申請内容配列の要素
objectcn任意string法人番号kind任意stringlatest・archivetrack任意stringprovision
order_ids任意array承認後の注文 UUID配列の要素
stringorders任意array決済状況配列の要素
objectorder_id任意string注文 UUIDpayment_status任意stringpending_authorization・authorized・captured・capture_failed・canceledreapplication_required任意boolean取消済みで再申請が必要か
order_items任意array文書の取得状況配列の要素
objectorder_id任意string注文 UUIDcn任意string法人番号kind任意stringlatest・archivestatus任意stringprocessing・available・unavailabledocument_id任意stringPDF と同じ提供判定を通った権利付与済み明細にのみ返す文書 UUID
auto_approved任意boolean承認なし購入を適用したかauto_payment_ready任意boolean自動決済の開始準備ができたかreason任意string | null承認なし購入を適用できない理由
文書の解析データを取得する
GET/api/v1/documents/{id}/data
必要な権限：data:read
パラメータ
id（パス・必須）string文書 UUID（パス）。注文・明細 ID と異なります。形式：
uuid
応答
200
rows・excluded。文書と解析データの項目は下記。
application/json
参照先：DocumentData
object
rows任意array提供可能な文書配列の要素
objectdocument_id任意string文書 IDcorporate_number任意string法人番号file_name任意string既定の PDF 名data任意参照先：ParsedData
objectdoc_type任意string | nullhistory・closedtrade_name任意string | null商号corporate_number任意string | null法人番号company_number任意string | null会社法人等番号established_on任意string | null設立日acquired_at任意string | null取得日時representative_name任意string役員から組み立てた代表者名officer_count任意number | null役員の人数last_changed_on任意string | null履歴内の最新変更日parse_status任意string | null解析状況warnings任意string | null解析上の注意capital_jpy任意number | null資本金（円）issued_shares任意number | null発行済株式数share_transfer_restriction任意string | null株式譲渡制限purposes任意array目的配列の要素
stringofficers任意array配列の要素
objectname任意string | null役員名title任意string | null役職appointed_on任意string | null就任日status任意string | null役員の状態
branches任意array配列の要素
objectname任意string | null支店名
history任意array配列の要素
objectkind任意string | null履歴の種類changed_on任意string | null変更日（initial の場合あり）registered_on任意string | null登記日before任意string | null変更前after任意string | null変更後summary任意string | null変更の要約
excluded任意array提供対象から除いた文書配列の要素
objectdocument_id任意string文書 IDreason任意string除外理由
登記情報の PDF を取得する
GET/api/v1/documents/{id}/pdf
必要な権限：pdf:read
パラメータ
id（パス・必須）string文書 UUID（パス）形式：
uuid
応答
200
application/pdf のバイナリ。Content-Disposition: attachment（filename と filename*）。Cache-Control: private, no-store。
application/pdf
string
形式：binary
400
400：ID が不正。403：権利・提供可否の確認・所属確認などの条件を満たさない。404：認可後にファイルが見つからない（Not found）。429：PDF の頻度上限。
application/json
参照先：Error
object
error必須string
Webhook イベント
order_item.available
明細が確定し、現在提供可能になったときに通知します。
設定した通知先への POST 通知です。x-required-scope の none は受信に API キー権限が不要なことを示します。署名を元の本文バイト列で検証し、送信時刻との差を 5 分以内に制限してください。Toki-Webhook-Id を少なくとも 24 時間保持して重複を排除します。
必要な権限：API キー権限は不要
パラメータ
Toki-Webhook-Id（ヘッダ・必須）配信イベントの UUID。テスト時もヘッダの実イベント ID で重複排除します。
string形式：
uuidToki-Webhook-Timestamp（ヘッダ・必須）送信時の Unix 秒。
stringパターン：
^[0-9]+$Toki-Webhook-Signature（ヘッダ・必須）v1= + HMAC-SHA256(secret, timestamp + "." + raw_body) の小文字 16 進数。secret は UTF-8 で使用します。
stringパターン：
^v1=[0-9a-f]{64}$
リクエスト本文（必須）
application/json
object
event_id必須stringイベント UUID。テスト本文はゼロ UUID形式：
uuidtype必須stringイベント名選択値：
order_item.availableoccurred_at必須stringイベント発生日時（JST、ISO 8601）形式：
date-timeorder_id必須string注文 UUID。注文イベント・auto_purchase.executed・document.pdf形式：
uuiditem_id必須string明細 UUID。order_item.available・document.pdf。形式：
uuidcounts必須object注文・申請イベントの件数items必須integer申請系は申請品目数、available は当該 1 明細、completed は注文の対象明細全体、followup は先に登記完了待ちだった対象のみ最小値：
0acquired必須integer取得できた数。注文イベントのみ。最小値：
0registration必須integer登記完了待ち数。注文イベントのみ。最小値：
0failed必須integer取得できなかった数。注文イベントのみ。最小値：
0
test任意booleanテスト送信時のみ true。ping には付かない。固定値：
true
応答
2XX
署名検証後、イベントを永続化して受信を確認します。
order.completed
通常の処理が終了したときに通知します。登記完了待ちを含む場合があります。全件成功の意味ではありません。
設定した通知先への POST 通知です。x-required-scope の none は受信に API キー権限が不要なことを示します。署名を元の本文バイト列で検証し、送信時刻との差を 5 分以内に制限してください。Toki-Webhook-Id を少なくとも 24 時間保持して重複を排除します。
必要な権限：API キー権限は不要
パラメータ
Toki-Webhook-Id（ヘッダ・必須）配信イベントの UUID。テスト時もヘッダの実イベント ID で重複排除します。
string形式：
uuidToki-Webhook-Timestamp（ヘッダ・必須）送信時の Unix 秒。
stringパターン：
^[0-9]+$Toki-Webhook-Signature（ヘッダ・必須）v1= + HMAC-SHA256(secret, timestamp + "." + raw_body) の小文字 16 進数。secret は UTF-8 で使用します。
stringパターン：
^v1=[0-9a-f]{64}$
リクエスト本文（必須）
application/json
object
event_id必須stringイベント UUID。テスト本文はゼロ UUID形式：
uuidtype必須stringイベント名選択値：
order.completedoccurred_at必須stringイベント発生日時（JST、ISO 8601）形式：
date-timeorder_id必須string注文 UUID。注文イベント・auto_purchase.executed・document.pdf形式：
uuidcounts必須object注文・申請イベントの件数items必須integer申請系は申請品目数、available は当該 1 明細、completed は注文の対象明細全体、followup は先に登記完了待ちだった対象のみ最小値：
0acquired必須integer取得できた数。注文イベントのみ。最小値：
0registration必須integer登記完了待ち数。注文イベントのみ。最小値：
0failed必須integer取得できなかった数。注文イベントのみ。最小値：
0
test任意booleanテスト送信時のみ true。ping には付かない。固定値：
true
応答
2XX
署名検証後、イベントを永続化して受信を確認します。
order.registration_followup
order.completed で登記完了待ちだった対象の追跡がすべて終了したときに通知します。
設定した通知先への POST 通知です。x-required-scope の none は受信に API キー権限が不要なことを示します。署名を元の本文バイト列で検証し、送信時刻との差を 5 分以内に制限してください。Toki-Webhook-Id を少なくとも 24 時間保持して重複を排除します。
必要な権限：API キー権限は不要
パラメータ
Toki-Webhook-Id（ヘッダ・必須）配信イベントの UUID。テスト時もヘッダの実イベント ID で重複排除します。
string形式：
uuidToki-Webhook-Timestamp（ヘッダ・必須）送信時の Unix 秒。
stringパターン：
^[0-9]+$Toki-Webhook-Signature（ヘッダ・必須）v1= + HMAC-SHA256(secret, timestamp + "." + raw_body) の小文字 16 進数。secret は UTF-8 で使用します。
stringパターン：
^v1=[0-9a-f]{64}$
リクエスト本文（必須）
application/json
object
event_id必須stringイベント UUID。テスト本文はゼロ UUID形式：
uuidtype必須stringイベント名選択値：
order.registration_followupoccurred_at必須stringイベント発生日時（JST、ISO 8601）形式：
date-timeorder_id必須string注文 UUID。注文イベント・auto_purchase.executed・document.pdf形式：
uuidcounts必須object注文・申請イベントの件数items必須integer申請系は申請品目数、available は当該 1 明細、completed は注文の対象明細全体、followup は先に登記完了待ちだった対象のみ最小値：
0acquired必須integer取得できた数。注文イベントのみ。最小値：
0registration必須integer登記完了待ち数。注文イベントのみ。最小値：
0failed必須integer取得できなかった数。注文イベントのみ。最小値：
0
test任意booleanテスト送信時のみ true。ping には付かない。固定値：
true
応答
2XX
署名検証後、イベントを永続化して受信を確認します。
purchase_request.pending_approval
承認待ち申請を作成したとき、または自動決済に追加認証が必要で承認待ちへ戻ったときに通知します。
設定した通知先への POST 通知です。x-required-scope の none は受信に API キー権限が不要なことを示します。署名を元の本文バイト列で検証し、送信時刻との差を 5 分以内に制限してください。Toki-Webhook-Id を少なくとも 24 時間保持して重複を排除します。
必要な権限：API キー権限は不要
パラメータ
Toki-Webhook-Id（ヘッダ・必須）配信イベントの UUID。テスト時もヘッダの実イベント ID で重複排除します。
string形式：
uuidToki-Webhook-Timestamp（ヘッダ・必須）送信時の Unix 秒。
stringパターン：
^[0-9]+$Toki-Webhook-Signature（ヘッダ・必須）v1= + HMAC-SHA256(secret, timestamp + "." + raw_body) の小文字 16 進数。secret は UTF-8 で使用します。
stringパターン：
^v1=[0-9a-f]{64}$
リクエスト本文（必須）
application/json
object
event_id必須stringイベント UUID。テスト本文はゼロ UUID形式：
uuidtype必須stringイベント名選択値：
purchase_request.pending_approvaloccurred_at必須stringイベント発生日時（JST、ISO 8601）形式：
date-timepurchase_request_id必須string申請 UUID。申請イベントと auto_purchase.executed形式：
uuidcounts必須object注文・申請イベントの件数items必須integer申請系は申請品目数、available は当該 1 明細、completed は注文の対象明細全体、followup は先に登記完了待ちだった対象のみ最小値：
0
amount_jpy必須integer申請時の上限額（円）。申請イベントと auto_purchase.executed最小値：
0test任意booleanテスト送信時のみ true。ping には付かない。固定値：
true
応答
2XX
署名検証後、イベントを永続化して受信を確認します。
purchase_request.approved
メンバーが Web で承認したときに通知します。決済・取得完了ではありません。承認なし購入で自動承認された場合はこのイベントではなく auto_purchase.executed が届きます。
設定した通知先への POST 通知です。x-required-scope の none は受信に API キー権限が不要なことを示します。署名を元の本文バイト列で検証し、送信時刻との差を 5 分以内に制限してください。Toki-Webhook-Id を少なくとも 24 時間保持して重複を排除します。
必要な権限：API キー権限は不要
パラメータ
Toki-Webhook-Id（ヘッダ・必須）配信イベントの UUID。テスト時もヘッダの実イベント ID で重複排除します。
string形式：
uuidToki-Webhook-Timestamp（ヘッダ・必須）送信時の Unix 秒。
stringパターン：
^[0-9]+$Toki-Webhook-Signature（ヘッダ・必須）v1= + HMAC-SHA256(secret, timestamp + "." + raw_body) の小文字 16 進数。secret は UTF-8 で使用します。
stringパターン：
^v1=[0-9a-f]{64}$
リクエスト本文（必須）
application/json
object
event_id必須stringイベント UUID。テスト本文はゼロ UUID形式：
uuidtype必須stringイベント名選択値：
purchase_request.approvedoccurred_at必須stringイベント発生日時（JST、ISO 8601）形式：
date-timepurchase_request_id必須string申請 UUID。申請イベントと auto_purchase.executed形式：
uuidcounts必須object注文・申請イベントの件数items必須integer申請系は申請品目数、available は当該 1 明細、completed は注文の対象明細全体、followup は先に登記完了待ちだった対象のみ最小値：
0
amount_jpy必須integer申請時の上限額（円）。申請イベントと auto_purchase.executed最小値：
0test任意booleanテスト送信時のみ true。ping には付かない。固定値：
true
応答
2XX
署名検証後、イベントを永続化して受信を確認します。
purchase_request.rejected
承認待ち申請が却下または申請キーで取消されたときに通知します。
設定した通知先への POST 通知です。x-required-scope の none は受信に API キー権限が不要なことを示します。署名を元の本文バイト列で検証し、送信時刻との差を 5 分以内に制限してください。Toki-Webhook-Id を少なくとも 24 時間保持して重複を排除します。
必要な権限：API キー権限は不要
パラメータ
Toki-Webhook-Id（ヘッダ・必須）配信イベントの UUID。テスト時もヘッダの実イベント ID で重複排除します。
string形式：
uuidToki-Webhook-Timestamp（ヘッダ・必須）送信時の Unix 秒。
stringパターン：
^[0-9]+$Toki-Webhook-Signature（ヘッダ・必須）v1= + HMAC-SHA256(secret, timestamp + "." + raw_body) の小文字 16 進数。secret は UTF-8 で使用します。
stringパターン：
^v1=[0-9a-f]{64}$
リクエスト本文（必須）
application/json
object
event_id必須stringイベント UUID。テスト本文はゼロ UUID形式：
uuidtype必須stringイベント名選択値：
purchase_request.rejectedoccurred_at必須stringイベント発生日時（JST、ISO 8601）形式：
date-timepurchase_request_id必須string申請 UUID。申請イベントと auto_purchase.executed形式：
uuidcounts必須object注文・申請イベントの件数items必須integer申請系は申請品目数、available は当該 1 明細、completed は注文の対象明細全体、followup は先に登記完了待ちだった対象のみ最小値：
0
amount_jpy必須integer申請時の上限額（円）。申請イベントと auto_purchase.executed最小値：
0test任意booleanテスト送信時のみ true。ping には付かない。固定値：
true
応答
2XX
署名検証後、イベントを永続化して受信を確認します。
purchase_request.expired
承認待ちの申請が期限切れなどで失効したときに通知します。
設定した通知先への POST 通知です。x-required-scope の none は受信に API キー権限が不要なことを示します。署名を元の本文バイト列で検証し、送信時刻との差を 5 分以内に制限してください。Toki-Webhook-Id を少なくとも 24 時間保持して重複を排除します。
必要な権限：API キー権限は不要
パラメータ
Toki-Webhook-Id（ヘッダ・必須）配信イベントの UUID。テスト時もヘッダの実イベント ID で重複排除します。
string形式：
uuidToki-Webhook-Timestamp（ヘッダ・必須）送信時の Unix 秒。
stringパターン：
^[0-9]+$Toki-Webhook-Signature（ヘッダ・必須）v1= + HMAC-SHA256(secret, timestamp + "." + raw_body) の小文字 16 進数。secret は UTF-8 で使用します。
stringパターン：
^v1=[0-9a-f]{64}$
リクエスト本文（必須）
application/json
object
event_id必須stringイベント UUID。テスト本文はゼロ UUID形式：
uuidtype必須stringイベント名選択値：
purchase_request.expiredoccurred_at必須stringイベント発生日時（JST、ISO 8601）形式：
date-timepurchase_request_id必須string申請 UUID。申請イベントと auto_purchase.executed形式：
uuidcounts必須object注文・申請イベントの件数items必須integer申請系は申請品目数、available は当該 1 明細、completed は注文の対象明細全体、followup は先に登記完了待ちだった対象のみ最小値：
0
amount_jpy必須integer申請時の上限額（円）。申請イベントと auto_purchase.executed最小値：
0test任意booleanテスト送信時のみ true。ping には付かない。固定値：
true
応答
2XX
署名検証後、イベントを永続化して受信を確認します。
auto_purchase.executed
承認なし購入の全注文で与信が確定したときに通知します。PDF の取得完了通知ではありません。order_id は代表の 1 注文です。
設定した通知先への POST 通知です。x-required-scope の none は受信に API キー権限が不要なことを示します。署名を元の本文バイト列で検証し、送信時刻との差を 5 分以内に制限してください。Toki-Webhook-Id を少なくとも 24 時間保持して重複を排除します。
必要な権限：API キー権限は不要
パラメータ
Toki-Webhook-Id（ヘッダ・必須）配信イベントの UUID。テスト時もヘッダの実イベント ID で重複排除します。
string形式：
uuidToki-Webhook-Timestamp（ヘッダ・必須）送信時の Unix 秒。
stringパターン：
^[0-9]+$Toki-Webhook-Signature（ヘッダ・必須）v1= + HMAC-SHA256(secret, timestamp + "." + raw_body) の小文字 16 進数。secret は UTF-8 で使用します。
stringパターン：
^v1=[0-9a-f]{64}$
リクエスト本文（必須）
application/json
object
event_id必須stringイベント UUID。テスト本文はゼロ UUID形式：
uuidtype必須stringイベント名選択値：
auto_purchase.executedoccurred_at必須stringイベント発生日時（JST、ISO 8601）形式：
date-timeorder_id必須string注文 UUID。注文イベント・auto_purchase.executed・document.pdf形式：
uuidpurchase_request_id必須string申請 UUID。申請イベントと auto_purchase.executed形式：
uuidcounts必須object注文・申請イベントの件数items必須integer申請系は申請品目数、available は当該 1 明細、completed は注文の対象明細全体、followup は先に登記完了待ちだった対象のみ最小値：
0
amount_jpy必須integer申請時の上限額（円）。申請イベントと auto_purchase.executed最小値：
0test任意booleanテスト送信時のみ true。ping には付かない。固定値：
true
応答
2XX
署名検証後、イベントを永続化して受信を確認します。
webhook.ping
通知先の登録・URL 変更・疎通の再確認時に送信します。購読イベントには含めません。
設定した通知先への POST 通知です。x-required-scope の none は受信に API キー権限が不要なことを示します。署名を元の本文バイト列で検証し、送信時刻との差を 5 分以内に制限してください。Toki-Webhook-Id を少なくとも 24 時間保持して重複を排除します。
必要な権限：API キー権限は不要
パラメータ
Toki-Webhook-Id（ヘッダ・必須）配信イベントの UUID。テスト時もヘッダの実イベント ID で重複排除します。
string形式：
uuidToki-Webhook-Timestamp（ヘッダ・必須）送信時の Unix 秒。
stringパターン：
^[0-9]+$Toki-Webhook-Signature（ヘッダ・必須）v1= + HMAC-SHA256(secret, timestamp + "." + raw_body) の小文字 16 進数。secret は UTF-8 で使用します。
stringパターン：
^v1=[0-9a-f]{64}$
リクエスト本文（必須）
application/json
object
event_id必須stringイベント UUID。テスト本文はゼロ UUID形式：
uuidtype必須stringイベント名選択値：
webhook.pingoccurred_at必須stringイベント発生日時（JST、ISO 8601）形式：
date-time
応答
2XX
署名検証後、イベントを永続化して受信を確認します。
document.pdf
PDF 配信が有効で、両方の同意が現行版の通知先に、明細が提供可能になった時点で送ります。検出済みの明細は、あとから有効化しても配信対象に追加しません。
設定した通知先への POST 通知です。x-required-scope の none は受信に API キー権限が不要なことを示します。署名を元の本文バイト列で検証し、送信時刻との差を 5 分以内に制限してください。Toki-Webhook-Id を少なくとも 24 時間保持して重複を排除します。
必要な権限：API キー権限は不要
パラメータ
Toki-Webhook-Id（ヘッダ・必須）配信イベントの UUID。テスト時もヘッダの実イベント ID で重複排除します。
string形式：
uuidToki-Webhook-Timestamp（ヘッダ・必須）送信時の Unix 秒。
stringパターン：
^[0-9]+$Toki-Webhook-Signature（ヘッダ・必須）v1= + HMAC-SHA256(secret, timestamp + "." + raw_body) の小文字 16 進数。secret は UTF-8 で使用します。
stringパターン：
^v1=[0-9a-f]{64}$
リクエスト本文（必須）
application/json
object
event_id必須stringイベント UUID。テスト本文はゼロ UUID形式：
uuidtype必須stringイベント名選択値：
document.pdfoccurred_at必須stringイベント発生日時（JST、ISO 8601）形式：
date-timeorder_id必須string注文 UUID。注文イベント・auto_purchase.executed・document.pdf形式：
uuiditem_id必須string明細 UUID。order_item.available・document.pdf。形式：
uuidtest任意booleanテスト送信時のみ true。ping には付かない。固定値：
truedocument_id必須stringdocument.pdf：文書 UUID形式：
uuidfile_name必須stringdocument.pdf：REST の既定名と同じ、取得日（JST）_商号_種別.pdfcontent_type必須stringdocument.pdf：application/pdf選択値：
application/pdfsize_bytes必須integerdocument.pdf：Base64 復号後の PDF バイト数。最大 10 MiB（10,485,760 bytes）最小値：
1最大値：
10485760sha256必須stringdocument.pdf：復号後の PDF の SHA-256、小文字 16 進数パターン：
^[0-9a-f]{64}$pdf_base64必須stringdocument.pdf：PDF の標準 Base64。JSON 本文は約 4/3 倍になります。エンコーディング：
base64メディア型：
application/pdf
応答
2XX
署名検証後、イベントを永続化して受信を確認します。
スキーマ一覧
Company
object
cn任意string13 桁の法人番号（先頭 0 不可）name任意string社名closed任意boolean閉鎖法人かprefecture任意string | null都道府県city任意string | null市区町村industry任意string | null業種capital任意string資本金の表示値（未取得は —）founded任意string設立日または —archiveDate任意string | null提供できる履歴事項アーカイブの取得日時recentArchive任意object | null直近取得済みの場合の案内reasonCode任意stringrecent_archiveacquiredOn任意string取得日message任意string案内文
registrationReasonCode任意string | nullregistration_blocked：本日の取得が保留registrationBlockedOn任意string | null保留日registrationWarning任意string | null登記手続きに関する案内signal任意object登記受付の観測情報state任意string | nullreceipt_after・receipt_near・no_receipt_in_covered・unverifiedbureau任意string局名の表示値coveredThrough任意string観測範囲の終了日または空文字last_receipt_on任意string | null観測した最新の登記受付日
acquiredByOwnOrg任意boolean所属法人が最新取得した履歴があるかreason任意stringnot_available・not_registered_corporationentrustable任意booleanWeb の取得代行を案内できるか
Quote
object
lines任意array見積明細配列の要素
objectcompany任意上の法人情報 参照先：Company
objectcn任意string13 桁の法人番号（先頭 0 不可）name任意string社名closed任意boolean閉鎖法人かprefecture任意string | null都道府県city任意string | null市区町村industry任意string | null業種capital任意string資本金の表示値（未取得は —）founded任意string設立日または —archiveDate任意string | null提供できる履歴事項アーカイブの取得日時recentArchive任意object | null直近取得済みの場合の案内reasonCode任意stringrecent_archiveacquiredOn任意string取得日message任意string案内文
registrationReasonCode任意string | nullregistration_blocked：本日の取得が保留registrationBlockedOn任意string | null保留日registrationWarning任意string | null登記手続きに関する案内signal任意object登記受付の観測情報state任意string | nullreceipt_after・receipt_near・no_receipt_in_covered・unverifiedbureau任意string局名の表示値coveredThrough任意string観測範囲の終了日または空文字last_receipt_on任意string | null観測した最新の登記受付日
acquiredByOwnOrg任意boolean所属法人が最新取得した履歴があるかreason任意stringnot_available・not_registered_corporationentrustable任意booleanWeb の取得代行を案内できるか
choice任意stringnew・archive・redownload選択値：
new・archive・redownloadmanual任意boolean取得方法を明示指定したかreason任意string選定理由reasonCode任意string | nullrecent_archive・registration_blocked・already_owned などの選定理由acquiredOn任意string | nullアーカイブ取得日voucher任意boolean引換券を使うかamount任意number明細金額（円）unitAmount任意number1 文書の単価（円）authorizationAmount任意number | null与信の上限額（円）docType任意stringhistory・closedclosedRecordRef任意string | null閉鎖事項の参照値quantityUncertain任意boolean文書数が未確定かtrack任意stringprovision・entrustedfreeRedownload任意boolean権利があり無料で再取得できるかdocumentId任意string | null選択した文書 ID。archive・redownload の場合に返る。timepointKind任意string | nulllatest・past・closedheadOffice任意string | null選択時点の本店requestedDocumentId任意string | null指定された文書 ID
newCount任意number最新取得件数archiveCount任意numberアーカイブ件数vouchersUsed任意number使用引換券数total任意number合計額（円）authorizationTotal任意number与信上限額（円）estimatedVouchers任意number発行見込みの引換券数taxAmount任意number内消費税（円）consent任意object承認時の見積照合値authorizationTotal任意number確認した与信上限額linesHash任意string確認した明細のハッシュ
monthly_remaining任意number月間の残り取得可能数monthly_reserved任意number予約中の取得数base_cap任意number基本の月間上限monthly_used任意number月間使用済み数monthly_cap任意number月間上限数prepaid_remaining任意number現在有効な月間加算件数entrustedSalesOpen任意boolean取得代行の受付可否entrustedSalesTestAllowed任意boolean取得代行のテスト受付可否
Cart
object
items任意arrayAPI カートの品目配列の要素
objectcn任意string法人番号kind任意stringnew・archiveadded_via_key_id任意string追加した API キーの UUIDadded_at任意string追加日時quote任意この品目の見積
いずれかの型
参照先：Quote
objectlines任意array見積明細配列の要素
objectcompany任意上の法人情報 参照先：Company
objectcn任意string13 桁の法人番号（先頭 0 不可）name任意string社名closed任意boolean閉鎖法人かprefecture任意string | null都道府県city任意string | null市区町村industry任意string | null業種capital任意string資本金の表示値（未取得は —）founded任意string設立日または —archiveDate任意string | null提供できる履歴事項アーカイブの取得日時recentArchive任意object | null直近取得済みの場合の案内reasonCode任意stringrecent_archiveacquiredOn任意string取得日message任意string案内文
registrationReasonCode任意string | nullregistration_blocked：本日の取得が保留registrationBlockedOn任意string | null保留日registrationWarning任意string | null登記手続きに関する案内signal任意object登記受付の観測情報state任意string | nullreceipt_after・receipt_near・no_receipt_in_covered・unverifiedbureau任意string局名の表示値coveredThrough任意string観測範囲の終了日または空文字last_receipt_on任意string | null観測した最新の登記受付日
acquiredByOwnOrg任意boolean所属法人が最新取得した履歴があるかreason任意stringnot_available・not_registered_corporationentrustable任意booleanWeb の取得代行を案内できるか
choice任意stringnew・archive・redownload選択値：
new・archive・redownloadmanual任意boolean取得方法を明示指定したかreason任意string選定理由reasonCode任意string | nullrecent_archive・registration_blocked・already_owned などの選定理由acquiredOn任意string | nullアーカイブ取得日voucher任意boolean引換券を使うかamount任意number明細金額（円）unitAmount任意number1 文書の単価（円）authorizationAmount任意number | null与信の上限額（円）docType任意stringhistory・closedclosedRecordRef任意string | null閉鎖事項の参照値quantityUncertain任意boolean文書数が未確定かtrack任意stringprovision・entrustedfreeRedownload任意boolean権利があり無料で再取得できるかdocumentId任意string | null選択した文書 ID。archive・redownload の場合に返る。timepointKind任意string | nulllatest・past・closedheadOffice任意string | null選択時点の本店requestedDocumentId任意string | null指定された文書 ID
newCount任意number最新取得件数archiveCount任意numberアーカイブ件数vouchersUsed任意number使用引換券数total任意number合計額（円）authorizationTotal任意number与信上限額（円）estimatedVouchers任意number発行見込みの引換券数taxAmount任意number内消費税（円）consent任意object承認時の見積照合値authorizationTotal任意number確認した与信上限額linesHash任意string確認した明細のハッシュ
monthly_remaining任意number月間の残り取得可能数monthly_reserved任意number予約中の取得数base_cap任意number基本の月間上限monthly_used任意number月間使用済み数monthly_cap任意number月間上限数prepaid_remaining任意number現在有効な月間加算件数entrustedSalesOpen任意boolean取得代行の受付可否entrustedSalesTestAllowed任意boolean取得代行のテスト受付可否
nullerror任意string | null見積できない場合は not_available
quote任意カート全体の見積。見積できない場合は null
いずれかの型
参照先：Quote
objectlines任意array見積明細配列の要素
objectcompany任意上の法人情報 参照先：Company
objectcn任意string13 桁の法人番号（先頭 0 不可）name任意string社名closed任意boolean閉鎖法人かprefecture任意string | null都道府県city任意string | null市区町村industry任意string | null業種capital任意string資本金の表示値（未取得は —）founded任意string設立日または —archiveDate任意string | null提供できる履歴事項アーカイブの取得日時recentArchive任意object | null直近取得済みの場合の案内reasonCode任意stringrecent_archiveacquiredOn任意string取得日message任意string案内文
registrationReasonCode任意string | nullregistration_blocked：本日の取得が保留registrationBlockedOn任意string | null保留日registrationWarning任意string | null登記手続きに関する案内signal任意object登記受付の観測情報state任意string | nullreceipt_after・receipt_near・no_receipt_in_covered・unverifiedbureau任意string局名の表示値coveredThrough任意string観測範囲の終了日または空文字last_receipt_on任意string | null観測した最新の登記受付日
acquiredByOwnOrg任意boolean所属法人が最新取得した履歴があるかreason任意stringnot_available・not_registered_corporationentrustable任意booleanWeb の取得代行を案内できるか
choice任意stringnew・archive・redownload選択値：
new・archive・redownloadmanual任意boolean取得方法を明示指定したかreason任意string選定理由reasonCode任意string | nullrecent_archive・registration_blocked・already_owned などの選定理由acquiredOn任意string | nullアーカイブ取得日voucher任意boolean引換券を使うかamount任意number明細金額（円）unitAmount任意number1 文書の単価（円）authorizationAmount任意number | null与信の上限額（円）docType任意stringhistory・closedclosedRecordRef任意string | null閉鎖事項の参照値quantityUncertain任意boolean文書数が未確定かtrack任意stringprovision・entrustedfreeRedownload任意boolean権利があり無料で再取得できるかdocumentId任意string | null選択した文書 ID。archive・redownload の場合に返る。timepointKind任意string | nulllatest・past・closedheadOffice任意string | null選択時点の本店requestedDocumentId任意string | null指定された文書 ID
newCount任意number最新取得件数archiveCount任意numberアーカイブ件数vouchersUsed任意number使用引換券数total任意number合計額（円）authorizationTotal任意number与信上限額（円）estimatedVouchers任意number発行見込みの引換券数taxAmount任意number内消費税（円）consent任意object承認時の見積照合値authorizationTotal任意number確認した与信上限額linesHash任意string確認した明細のハッシュ
monthly_remaining任意number月間の残り取得可能数monthly_reserved任意number予約中の取得数base_cap任意number基本の月間上限monthly_used任意number月間使用済み数monthly_cap任意number月間上限数prepaid_remaining任意number現在有効な月間加算件数entrustedSalesOpen任意boolean取得代行の受付可否entrustedSalesTestAllowed任意boolean取得代行のテスト受付可否
null
CartResult
object
results任意array指定品目ごとの追加結果配列の要素
objectcn任意string | null法人番号。不正入力では null の場合あり。kind任意string | null受理した種別。latest は new に正規化。ok任意boolean追加済み・すでに登録済みなら truestatus任意stringadded・already_in_cart・rejectederror任意string | nullinvalid_item・entrusted_requires_web_terms・not_available・order_limit・monthly_cap。already_in_cart では項目なし。
PurchaseRequest
object
request_id任意string申請 UUIDstatus任意stringpending_approval・approved・rejected・expired・cancelled選択値：
pending_approval・approved・rejected・expired・cancelledamount_jpy任意number申請時の与信上限額（円）expires_at任意string承認期限created_at任意string作成日時approval_url任意stringWeb 承認ページの絶対 URLitems任意array申請内容配列の要素
objectcn任意string法人番号kind任意stringlatest・archivetrack任意stringprovision
order_ids任意array承認後の注文 UUID配列の要素
stringorders任意array決済状況配列の要素
objectorder_id任意string注文 UUIDpayment_status任意stringpending_authorization・authorized・captured・capture_failed・canceledreapplication_required任意boolean取消済みで再申請が必要か
order_items任意array文書の取得状況配列の要素
objectorder_id任意string注文 UUIDcn任意string法人番号kind任意stringlatest・archivestatus任意stringprocessing・available・unavailabledocument_id任意stringPDF と同じ提供判定を通った権利付与済み明細にのみ返す文書 UUID
auto_approved任意boolean承認なし購入を適用したかauto_payment_ready任意boolean自動決済の開始準備ができたかreason任意string | null承認なし購入を適用できない理由
DocumentData
object
rows任意array提供可能な文書配列の要素
objectdocument_id任意string文書 IDcorporate_number任意string法人番号file_name任意string既定の PDF 名data任意参照先：ParsedData
objectdoc_type任意string | nullhistory・closedtrade_name任意string | null商号corporate_number任意string | null法人番号company_number任意string | null会社法人等番号established_on任意string | null設立日acquired_at任意string | null取得日時representative_name任意string役員から組み立てた代表者名officer_count任意number | null役員の人数last_changed_on任意string | null履歴内の最新変更日parse_status任意string | null解析状況warnings任意string | null解析上の注意capital_jpy任意number | null資本金（円）issued_shares任意number | null発行済株式数share_transfer_restriction任意string | null株式譲渡制限purposes任意array目的配列の要素
stringofficers任意array配列の要素
objectname任意string | null役員名title任意string | null役職appointed_on任意string | null就任日status任意string | null役員の状態
branches任意array配列の要素
objectname任意string | null支店名
history任意array配列の要素
objectkind任意string | null履歴の種類changed_on任意string | null変更日（initial の場合あり）registered_on任意string | null登記日before任意string | null変更前after任意string | null変更後summary任意string | null変更の要約
excluded任意array提供対象から除いた文書配列の要素
objectdocument_id任意string文書 IDreason任意string除外理由
ParsedData
object
doc_type任意string | nullhistory・closedtrade_name任意string | null商号corporate_number任意string | null法人番号company_number任意string | null会社法人等番号established_on任意string | null設立日acquired_at任意string | null取得日時representative_name任意string役員から組み立てた代表者名officer_count任意number | null役員の人数last_changed_on任意string | null履歴内の最新変更日parse_status任意string | null解析状況warnings任意string | null解析上の注意capital_jpy任意number | null資本金（円）issued_shares任意number | null発行済株式数share_transfer_restriction任意string | null株式譲渡制限purposes任意array目的配列の要素
stringofficers任意array配列の要素
objectname任意string | null役員名title任意string | null役職appointed_on任意string | null就任日status任意string | null役員の状態
branches任意array配列の要素
objectname任意string | null支店名
history任意array配列の要素
objectkind任意string | null履歴の種類changed_on任意string | null変更日（initial の場合あり）registered_on任意string | null登記日before任意string | null変更前after任意string | null変更後summary任意string | null変更の要約
PurchaseCreated
object
request_id必須string形式：
uuidstatus必須string選択値：
pending_approval・ordered・cancelledorder_ids任意array配列の要素
string形式：
uuidreason任意string選択値：
expired・terms_changed・auto_approval_not_retried・entrusted_requires_web_terms・auto_setting_owner_inactive・auto_purchase_disabled・auto_saved_card_required・auto_limit_exceeded・auto_payment_requires_action・auto_payment_declined・permission_required
Error
object
error必須string