Public API | Notion

Scalebaseペイメントの Public API を使うと、取引先・商品・入金・債権・消込を外部システムから操作できます。このページでは、できること・できないことの一覧と、詳細仕様の参照先を説明します。

概要

詳細なリクエスト・レスポンスの仕様、認証方法、エラーコードは開発者向けサイト Scalebaseペイメント API リファレンスを参照してください。APIキーの発行は担当CSにご相談ください。

<aside> ⚠️

Public API はアルファ版（v1alpha1）です。仕様が変わることがあります。

</aside>

対象	できること	エンドポイント
事業者	APIキーに紐づく事業者のID・表示名を取得	`POST /v1alpha1/owner/get`
取引先	作成・取得・検索・部分更新	`POST /v1alpha1/partner/create`／`get`／`search`、`PATCH /v1alpha1/partner/update`
商品	作成・取得・検索・部分更新	`POST /v1alpha1/product/create`／`get`／`search`、`PATCH /v1alpha1/product/update`
入金	作成・一括作成・取得・検索・更新	`POST /v1alpha1/deposit/create`／`bulk_create`／`get`／`search`、`PATCH /v1alpha1/deposit/update`
債権	取得・検索	`POST /v1alpha1/receivable/get`／`search`
消込	実行・取消・取得・検索	`POST /v1alpha1/reconciliation/reconcile`／`cancel`／`get`／`search`

項目	備考
取引先の住所・連絡先・送付方法・引き落とし口座・支払方法	APIで扱えるのは取引先名・取引先コード・社内メモだけです
商品の仕訳勘定（勘定科目・補助科目・部門）	作成後に画面から設定してください
請求書の作成・送付	画面・CSVインポート、またはScalebaseとの連携で作成します
債権・収益の生成、仕訳エクスポート	画面の一括操作から実行します

<aside> 💡

部分更新（update）では、指定しなかった項目は変更されず、null を指定した項目はクリアされます。商品名のように必須の項目には null を指定できません
入金の検索では作成日（createdAtFrom／createdAtTo）で絞り込めます。終了日に指定した当日分も含まれます
入金データの登録方法（CSV・画面・API）の使い分けは入金データの登録と名寄せを参照してください </aside>