# Scalebase API > Scalebaseへ接続するAPIのリファレンスです ## API利用規約 [API利用規約はこちら](https://scalebase.com/terms/api/) ## Scalebaseヘルプ Scalebaseの製品・概念説明、基本操作方法などについては [こちら](https://alpinc.notion.site/Scalebase-7aa524f5cbea43d2a57d030 ## API Information - Version: 1.0.0 - Base URL (Sandbox): https://api.sandbox.scalebase.com - Base URL (Production): https://api.scalebase.com - Authentication: Bearer Token (API Key) - Rate Limit: 50 req/min per environment - Format: JSON - Date Format: RFC 3339 (responses in UTC) ## Resources - scalebase.public.v1.AmendmentService: Amendment V1 - scalebase.public.v1.BillingService: Billing - scalebase.public.v1.CatalogItemService: CatalogItem - scalebase.public.v1.ContractService: Contract V1 - scalebase.public.v1.CustomerService: Customer - scalebase.public.v1.CustomerStaffService: CustomerStaff - scalebase.public.v1.CustomFieldService: CustomField - scalebase.public.v1.ExpectedBillingService: ExpectedBilling - scalebase.public.v1.FincodeService: Fincode - scalebase.public.v1.PaymentMethodService: PaymentMethod - scalebase.public.v1.ProductService: Product - scalebase.public.v1.ProviderService: Provider - scalebase.public.v1.UsageService: Usage - scalebase.public.v1.ZzHealthService: ZzHealth - scalebase.public.v2.AmendmentService: Amendment V2 - scalebase.public.v2.ContractService: Contract V2 ## Endpoints - GET /hc: ヘルスチェック - POST /v1/amendment/addoptionitem: オプションアイテムの追加 - POST /v1/amendment/cancelamendment: 改定の取消 - POST /v1/amendment/cancelcontract: 契約の解約 - POST /v1/amendment/canceloption: オプションアイテムの解約 - POST /v1/amendment/changemainitem: メインアイテムの乗り換え - POST /v1/amendment/changeoptionitem: オプションアイテムの乗り換え - POST /v1/amendment/changequantity: 契約アイテムの契約数の更新 - POST /v1/amendment/customizeoptionitem: オプションアイテムの編集 - GET /v1/amendment/list: 改定の一覧取得 - POST /v1/amendment/list: 改定の一覧取得 - GET /v1/amendment/listbycontract: 契約に紐づく改定の一覧取得 - POST /v1/amendment/listbycontract: 契約に紐づく改定の一覧取得 - GET /v1/amendment/listbycontractoptionalid: 契約管理IDに紐づく改定の一覧取得 - POST /v1/amendment/listbycontractoptionalid: 契約管理IDに紐づく改定の一覧取得 - POST /v1/amendment/renewcontractitem: 契約アイテムの更新 - POST /v1/billing/batchrecordpayments: 一括入金処理 - POST /v1/billing/batchupdatestatuses: 請求ステータスの一括更新 - POST /v1/billing/create: 請求の生成 - GET /v1/billing/get: 請求の取得 - POST /v1/billing/get: 請求の取得 - GET /v1/billing/list: 請求の一覧取得 - POST /v1/billing/list: 請求の一覧取得 - GET /v1/billing/listbycontract: 契約に紐づく請求の一覧取得 - POST /v1/billing/listbycontract: 契約に紐づく請求の一覧取得 - GET /v1/billing/search: 請求の検索 - POST /v1/billing/search: 請求の検索 - GET /v1/catalogitem/get: カタログアイテムの取得 - POST /v1/catalogitem/get: カタログアイテムの取得 - GET /v1/catalogitem/list: カタログアイテムの一覧取得 - POST /v1/catalogitem/list: カタログアイテムの一覧取得 - POST /v1/contract/alias: 契約管理ID変更 - POST /v1/contract/confirmdraft: 契約の下書き解除 - POST /v1/contract/create: 契約の作成 - GET /v1/contract/get: 契約の取得 - POST /v1/contract/get: 契約の取得 - GET /v1/contract/getbyoptionalid: 契約管理IDを指定した契約の取得 - POST /v1/contract/getbyoptionalid: 契約管理IDを指定した契約の取得 - GET /v1/contract/list: 契約の一覧取得 - POST /v1/contract/list: 契約の一覧取得 - GET /v1/contract/listbycustomer: 顧客に紐づく契約の一覧取得 - POST /v1/contract/listbycustomer: 顧客に紐づく契約の一覧取得 - GET /v1/contract/listbycustomerid: 顧客に紐づく契約の一覧取得 - POST /v1/contract/listbycustomerid: 顧客に紐づく契約の一覧取得 - GET /v1/contract/search: 契約の検索 - POST /v1/contract/search: 契約の検索 - POST /v1/customer/alias: 顧客の管理ID更新 - POST /v1/customer/create: 顧客の作成 - POST /v1/customer/delete: 顧客の削除 - GET /v1/customer/fincode/get: fincode顧客の取得 - POST /v1/customer/fincode/get: fincode顧客の取得 - POST /v1/customer/fincode/link: fincode顧客の紐づけ - POST /v1/customer/fincode/unlink: fincode顧客の紐づけ解除 - GET /v1/customer/get: 顧客の取得 - POST /v1/customer/get: 顧客の取得 - GET /v1/customer/list: 顧客の一覧取得 - POST /v1/customer/list: 顧客の一覧取得 - PATCH /v1/customer/update: 顧客の更新 - POST /v1/customerstaff/alias: 顧客担当者の管理ID更新 - POST /v1/customerstaff/create: 顧客担当者の作成 - POST /v1/customerstaff/delete: 顧客担当者の削除 - GET /v1/customerstaff/get: 顧客担当者の取得 - POST /v1/customerstaff/get: 顧客担当者の取得 - GET /v1/customerstaff/list: 顧客担当者の一覧取得 - POST /v1/customerstaff/list: 顧客担当者の一覧取得 - PATCH /v1/customerstaff/update: 顧客担当者の更新 - GET /v1/customfield/master/list: カスタムフィールドマスターの一覧取得 - POST /v1/customfield/master/list: カスタムフィールドマスターの一覧取得 - POST /v1/customfield/resource/batchupdate: カスタムフィールド一括更新 - GET /v1/customfield/resource/get: 対象リソースのカスタムフィールド取得 - POST /v1/customfield/resource/get: 対象リソースのカスタムフィールド取得 - PATCH /v1/customfield/resource/update: カスタムフィールド更新 - POST /v1/expectedbilling/changequantity: 契約数変更に伴う請求予定の再計算（単一の請求予定を返す） - GET /v1/expectedbilling/listbycontract: 請求予定の一覧取得 - POST /v1/expectedbilling/listbycontract: 請求予定の一覧取得 - POST /v1/expectedbilling/renewalwithquantitychange: 契約更新と数量変更に伴う請求予定の計算 - GET /v1/hc: ヘルスチェック - GET /v1/paymentmethod/get: 決済方法の取得 - POST /v1/paymentmethod/get: 決済方法の取得 - GET /v1/paymentmethod/list: 決済方法の一覧取得 - POST /v1/paymentmethod/list: 決済方法の一覧取得 - POST /v1/product/create: プロダクトの作成 - GET /v1/product/get: プロダクトの取得 - POST /v1/product/get: プロダクトの取得 - GET /v1/provider/get: プロバイダーの取得 - POST /v1/provider/get: プロバイダーの取得 - POST /v1/usage/daily/upsert: 使用量(日毎)の更新 - POST /v1/usage/daily/upsertbycontractandusageunit: 契約と使用量単位による使用量(日毎)の更新 - POST /v1/usage/daily/upsertbyoptionalid: 契約と使用量単位による使用量(日毎)の更新(非推奨) - GET /v1/usageunit/get: 使用量単位の取得 - POST /v1/usageunit/get: 使用量単位の取得 - GET /v1/usageunit/list: 使用量単位一覧の取得 - POST /v1/usageunit/list: 使用量単位一覧の取得 - POST /v2/amendment/cancelcontractservice: 契約サービスの解約 - POST /v2/contract/confirmdraft: 契約の下書き解除 - POST /v2/contract/create: 契約の作成 - GET /v2/contract/get: 契約の取得 - POST /v2/contract/get: 契約の取得 - GET /v2/contract/getbyoptionalid: 契約管理IDを指定した契約の取得 - POST /v2/contract/getbyoptionalid: 契約管理IDを指定した契約の取得 - GET /v2/contract/list: 契約の一覧取得 - POST /v2/contract/list: 契約の一覧取得 - GET /v2/contract/listatdate: 契約の一覧取得（契約サービスタイムライン上での日付指定あり） - POST /v2/contract/listatdate: 契約の一覧取得（契約サービスタイムライン上での日付指定あり） - POST /v2/contract/service/add: 契約のサービス追加 - POST /v2/contract/updatepaymentmethod: 決済方法変更 ## Links - [Full API Reference (HTML)](./index.html) - [OpenAPI Specification (JSON)](./openapi.json) - [Complete AI-readable documentation](./llms-full.txt)