logo
Documentation Powered by Redocly

Scalebase API (1.0.0)

Download OpenAPI specification:Download

License: Apache License 2.0

Scalebaseへ接続するAPIのリファレンスです

Scalebaseヘルプ

Scalebaseの製品・概念説明、基本操作方法などについては こちら をご確認ください

APIエンドポイント

Sandbox

https://api.sandbox.scalebase.com

Production

https://api.scalebase.com

APIキー

Scalebase上で発行したAPIキーをBearer Tokenとして設定することでリクエスト可能です。 APIキーの作成はこちらから

リクエスト

レートリミットについて

お客様ごとの環境1つで実行される全API合計で 50req / min となります。リクエスト数の上限緩和などはご相談ください

日時を指定するパラメータについて

RFC 3339 のフォーマットの日時を指定できます(タイムゾーンも指定可)。
$ date --iso-8601=seconds
2000-01-23T12:34:56+09:00
リクエストされた時刻はJSTとして解釈します

レスポンス

エラー情報について

  • code gRPC Status Codeに従います
  • message サーバーからのメッセージが入ります
  • detail オブジェクトのjsonが入ります

日時を返却するパラメータについて

日時に関するレスポンスは、RFC 3339 のフォーマットで返却され Protocol Buffers Json Mapping に従い、常にUTC(Zulu time)で正規化され返却されます。

Amendment V1

オプションアイテムの追加

指定したカタログアイテムをオプションアイテムとして契約に追加します。

Request Body schema: application/json
contractId
required
string (対象の契約ID)
primalContractItemId
string ((DEPRECATED: contract_item_id をお使いください) 親となる契約アイテムID)
contractItemId
required
string (親となる契約アイテムID)
effectiveStartDate
required
string <date-time> (改定の有効開始日(RFC 3339 format))
required
object (アイテムカスタマイズ情報)

Responses

Request samples

Content type
application/json
{
  • "contractId": "string",
  • "primalContractItemId": "string",
  • "contractItemId": "string",
  • "effectiveStartDate": "2019-08-24T14:15:22Z",
  • "item": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

改定の取消

指定した改定を取り消します

Request Body schema: application/json
amendmentId
required
string (改定ID)

Responses

Request samples

Content type
application/json
{
  • "amendmentId": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

契約の解約

指定した契約を途中解約します

Request Body schema: application/json
contractId
required
string (契約ID)
contractOptionalId
required
string (契約管理ID(契約IDの代わりに指定可))
effectiveStartDate
required
string <date-time> (改定の有効開始日)
Array of objects (解約時の終了月日割設定) [ items ]
memo
string (改定メモ)

Responses

Request samples

Content type
application/json
{
  • "contractId": "string",
  • "contractOptionalId": "string",
  • "effectiveStartDate": "2019-08-24T14:15:22Z",
  • "oldDailyRates": [
    ],
  • "memo": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

オプションアイテムの解約

指定したオプションアイテムを途中解約します

Request Body schema: application/json
contractId
required
string (契約ID)
contractOptionalId
required
string (契約管理ID(契約IDの代わりに指定可))
optionItemId
required
string (オプションアイテムID)
effectiveStartDate
required
string <date-time> (改定の有効開始日)
Array of objects (解約時の終了月日割設定) [ items ]
memo
string (改定メモ)

Responses

Request samples

Content type
application/json
{
  • "contractId": "string",
  • "contractOptionalId": "string",
  • "optionItemId": "string",
  • "effectiveStartDate": "2019-08-24T14:15:22Z",
  • "lastAvailabilityDailyRates": [
    ],
  • "memo": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

メインアイテムの乗り換え

指定したメインアイテムに乗り換えます

Request Body schema: application/json
contractId
required
string (契約ID)
contractOptionalId
string (契約管理ID(契約IDの代わりに指定可))
mainItemId
required
string (メインアイテムID)
required
object (メインアイテム)
memo
string (改定メモ)

Responses

Request samples

Content type
application/json
{
  • "contractId": "string",
  • "contractOptionalId": "string",
  • "mainItemId": "string",
  • "item": {
    },
  • "memo": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

契約アイテムの契約数の更新

指定した契約アイテムの契約数を更新します。

Request Body schema: application/json
contractId
string (契約ID)
contractOptionalId
string (契約管理ID(契約IDの代わりに指定可))
contractChargeItemId
string (契約課金項目ID)
effectiveStartDate
string <date-time>
quantity
integer <int32> (変更後の契約数)
memo
string (改定メモ)
object (ChangeQuantityRequest.DailyRate)

Responses

Request samples

Content type
application/json
{
  • "contractId": "string",
  • "contractOptionalId": "string",
  • "contractChargeItemId": "string",
  • "effectiveStartDate": "2019-08-24T14:15:22Z",
  • "quantity": 0,
  • "memo": "string",
  • "changeQuantityDailyRate": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

オプションアイテムの編集

指定したオプションアイテムを編集します

Request Body schema: application/json
contractId
required
string (契約ID)
contractOptionalId
required
string (契約管理ID(契約IDの代わりに指定可))
optionItemId
required
string
effectiveStartDate
required
string <date-time> (改定の有効開始日)
Array of objects (契約課金項目) [ items ]
memo
string (改定メモ)

Responses

Request samples

Content type
application/json
{
  • "contractId": "string",
  • "contractOptionalId": "string",
  • "optionItemId": "string",
  • "effectiveStartDate": "2019-08-24T14:15:22Z",
  • "chargeItems": [
    ],
  • "memo": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

改定の一覧取得

プロバイダーに紐づく改定の一覧を取得します

query Parameters
pageToken
string

一覧取得に使用するトークン

pageSize
required
integer <int32>

一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100]

orderBy.field
string
Default: "FIELD_UNSPECIFIED"
Enum: "FIELD_UNSPECIFIED" "FIELD_ID" "FIELD_EXECUTE_DATE" "FIELD_EFFECTIVE_START_DATE"
  • FIELD_ID: ID
  • FIELD_EXECUTE_DATE: 改定実行日
  • FIELD_EFFECTIVE_START_DATE: 改定の有効開始日
orderBy.direction
string
Default: "DIRECTION_UNSPECIFIED"
Enum: "DIRECTION_UNSPECIFIED" "DIRECTION_ASCENDING" "DIRECTION_DESCENDING"
  • DIRECTION_ASCENDING: 昇順
  • DIRECTION_DESCENDING: 降順

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

改定の一覧取得

プロバイダーに紐づく改定の一覧を取得します

Request Body schema: application/json
pageToken
string (一覧取得に使用するトークン)
pageSize
required
integer <int32> (一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100])
object (ソート条件)

Responses

Request samples

Content type
application/json
{
  • "pageToken": "string",
  • "pageSize": 0,
  • "orderBy": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

契約管理IDに紐づく改定の一覧取得

契約管理IDに紐づく改定を一覧取得します。

query Parameters
contractOptionalId
required
string

契約管理ID

pageToken
string

一覧取得に使用するトークン

pageSize
integer <int32>

一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100]

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

契約管理IDに紐づく改定の一覧取得

契約管理IDに紐づく改定を一覧取得します。

Request Body schema: application/json
contractOptionalId
required
string (契約管理ID)
pageToken
string (一覧取得に使用するトークン)
pageSize
integer <int32> (一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100])

Responses

Request samples

Content type
application/json
{
  • "contractOptionalId": "string",
  • "pageToken": "string",
  • "pageSize": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

契約アイテムの更新

指定した契約アイテムを更新します。

Request Body schema: application/json
contractId
required
string (契約ID)
contractItemId
required
string (契約アイテムID)

Responses

Request samples

Content type
application/json
{
  • "contractId": "string",
  • "contractItemId": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

Billing

請求ステータスの一括更新

複数の請求のステータスを一括で変更します。

Request Body schema: application/json
object (請求IDリストによる指定)
object (検索条件による指定)
status
required
string (- STATUS_UNBILLED: 請求待ち - STATUS_INVOICE_CREATED: 請求書作成済み - STATUS_POSTED: 入金待ち)
Default: "STATUS_UNSPECIFIED"
Enum: "STATUS_UNSPECIFIED" "STATUS_UNBILLED" "STATUS_INVOICE_CREATED" "STATUS_POSTED"

Responses

Request samples

Content type
application/json
{
  • "byIds": {
    },
  • "byCondition": {
    },
  • "status": "STATUS_UNSPECIFIED"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

請求の生成

指定された契約から請求を生成します。

Request Body schema: application/json
required
Array of objects (対象契約のリスト) [ items ]
holdInvoiceCreation
boolean (請求書作成を保留するかどうか)

Responses

Request samples

Content type
application/json
{
  • "targetContracts": [
    ],
  • "holdInvoiceCreation": true
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

請求の取得

指定した請求を取得します。

query Parameters
id
required
string

請求ID

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

請求の取得

指定した請求を取得します。

Request Body schema: application/json
id
required
string (請求ID)

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

請求の一覧取得

請求の一覧を取得します。

query Parameters
pageToken
string

一覧取得に使用するトークン

pageSize
integer <int32>

一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100]

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

請求の一覧取得

請求の一覧を取得します。

Request Body schema: application/json
pageToken
string (一覧取得に使用するトークン)
pageSize
integer <int32> (一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100])

Responses

Request samples

Content type
application/json
{
  • "pageToken": "string",
  • "pageSize": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

契約に紐づく請求の一覧取得

指定された顧客に紐づく請求の一覧を取得します。

query Parameters
id
required
string

契約ID

optionalId
required
string

契約管理ID(契約IDの代わりに指定可)

pageToken
string

一覧取得に使用するトークン

pageSize
integer <int32>

一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100]

orderBy.field
string
Default: "FIELD_UNSPECIFIED"
Enum: "FIELD_UNSPECIFIED" "FIELD_ID" "FIELD_BILLING_DATE"
  • FIELD_ID: 請求ID
  • FIELD_BILLING_DATE: 請求日
orderBy.direction
string
Default: "DIRECTION_UNSPECIFIED"
Enum: "DIRECTION_UNSPECIFIED" "DIRECTION_ASCENDING" "DIRECTION_DESCENDING"
  • DIRECTION_ASCENDING: 昇順
  • DIRECTION_DESCENDING: 降順

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

契約に紐づく請求の一覧取得

指定された顧客に紐づく請求の一覧を取得します。

Request Body schema: application/json
id
required
string (契約ID)
optionalId
required
string (契約管理ID(契約IDの代わりに指定可))
pageToken
string (一覧取得に使用するトークン)
pageSize
integer <int32> (一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100])
object (ソート条件)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "optionalId": "string",
  • "pageToken": "string",
  • "pageSize": 0,
  • "orderBy": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

請求の検索

請求を検索して一覧を取得します。

query Parameters
pageToken
string

一覧取得に使用するトークン

pageSize
required
integer <int32>

一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100]

query
string

検索クエリ example:

status=STATUS_UNBILLED

status: [any|*|下記のパターン] が指定可能

STATUS_UNSPECIFIED
STATUS_HOLD_INVOICE_CREATION
STATUS_UNBILLED
STATUS_POSTED
STATUS_PARTIALLY_PAID
STATUS_PAID
STATUS_PAYMENT_EXCLUDED
STATUS_PAYMENT_DUE
STATUS_PAYMENT_UNNECESSARY
STATUS_PARTIALLY_UNPAID
STATUS_PAYMENT_REFUNDED
STATUS_PAID_WITH_CARD
STATUS_INVOICE_CREATED
STATUS_INVOICE_DELETED
STATUS_INVALIDATED
STATUS_ANY
orderBy.field
string
Default: "FIELD_UNSPECIFIED"
Enum: "FIELD_UNSPECIFIED" "FIELD_ID" "FIELD_BILLING_DATE"
  • FIELD_ID: 請求ID
  • FIELD_BILLING_DATE: 請求日
orderBy.direction
string
Default: "DIRECTION_UNSPECIFIED"
Enum: "DIRECTION_UNSPECIFIED" "DIRECTION_ASCENDING" "DIRECTION_DESCENDING"
  • DIRECTION_ASCENDING: 昇順
  • DIRECTION_DESCENDING: 降順

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

請求の検索

請求を検索して一覧を取得します。

Request Body schema: application/json
pageToken
string (一覧取得に使用するトークン)
pageSize
required
integer <int32> (一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100])
query
string (template: :10:8: executing "" at <.EnumType>: can't evaluate field EnumType in type *descriptor.Field)
Array of objects (フィルター) [ items ]
object (ソート条件)

Responses

Request samples

Content type
application/json
{
  • "pageToken": "string",
  • "pageSize": 0,
  • "query": "string",
  • "filter": [
    ],
  • "orderBy": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

CatalogItem

カタログアイテムの取得

指定したカタログアイテムを取得します。

query Parameters
id
string

カタログアイテムID

optionalId
string

カタログアイテム管理ID(カタログアイテムIDの代わりに指定可)

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

カタログアイテムの取得

指定したカタログアイテムを取得します。

Request Body schema: application/json
id
string (カタログアイテムID)
optionalId
string (カタログアイテム管理ID(カタログアイテムIDの代わりに指定可))

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "optionalId": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

カタログアイテムの一覧取得

カタログアイテムの一覧を取得します。

query Parameters
pageToken
string

一覧取得に使用するトークン

pageSize
required
integer <int32>

一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100]

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

カタログアイテムの一覧取得

カタログアイテムの一覧を取得します。

Request Body schema: application/json
pageToken
string (一覧取得に使用するトークン)
pageSize
required
integer <int32> (一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100])

Responses

Request samples

Content type
application/json
{
  • "pageToken": "string",
  • "pageSize": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

Contract V1

契約管理ID変更

契約管理IDを変更する

Request Body schema: application/json
id
required
string (契約ID)
optionalId
string (契約管理ID)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "optionalId": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

契約の作成

新規に契約を作成します。 buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE

Request Body schema: application/json
optionalId
string (契約管理ID)
required
object (顧客)
required
Array of objects (メインとなるアイテム) [ items ]
Array of objects (請求担当者（配列の先頭が主請求担当者、優先順位: 1. billingCustomerStaffs -> 2. extensions.billingDestination -> 3. customer.customerStaff）) [ items ]
Array of objects (納入先担当者（配列の先頭が主納入先担当者）) [ items ]
paymentMethodId
string (決済手段ID(指定しない場合はデフォルトの決済手段が適用されます))
paymentMethodOptionalId
string (決済手段管理ID(決済手段IDの代わりに指定可))
object (拡張機能)

Responses

Request samples

Content type
application/json
{
  • "optionalId": "string",
  • "customer": {
    },
  • "mainItems": [
    ],
  • "billingCustomerStaffs": [
    ],
  • "shippingCustomerStaffs": [
    ],
  • "paymentMethodId": "string",
  • "paymentMethodOptionalId": "string",
  • "extensions": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

契約の取得

指定されたIDを持つ契約を取得します。

query Parameters
id
required
string

契約ID

version
integer <int32>

契約バージョン。指定がなければ最新バージョンの契約が返却される

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

契約の取得

指定されたIDを持つ契約を取得します。

Request Body schema: application/json
id
required
string (契約ID)
version
integer <int32> (契約バージョン。指定がなければ最新バージョンの契約が返却される)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

契約管理IDを指定した契約の取得

契約管理IDを指定して契約を取得します。

query Parameters
optionalId
required
string

契約管理ID

version
integer <int32>

契約バージョン。指定がなければ最新バージョンの契約が返却される

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

契約管理IDを指定した契約の取得

契約管理IDを指定して契約を取得します。

Request Body schema: application/json
optionalId
required
string (契約管理ID)
version
integer <int32> (契約バージョン。指定がなければ最新バージョンの契約が返却される)

Responses

Request samples

Content type
application/json
{
  • "optionalId": "string",
  • "version": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

契約の一覧取得

契約の一覧を取得します。

query Parameters
pageToken
string

一覧取得に使用するトークン

pageSize
integer <int32>

一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100]

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

契約の一覧取得

契約の一覧を取得します。

Request Body schema: application/json
pageToken
string (一覧取得に使用するトークン)
pageSize
integer <int32> (一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100])

Responses

Request samples

Content type
application/json
{
  • "pageToken": "string",
  • "pageSize": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

顧客に紐づく契約の一覧取得

顧客に紐づく契約を一覧取得します。

query Parameters
customerId
required
string

顧客ID

customerOptionalId
string

顧客管理ID(顧客IDの代わりに指定可)

pageToken
string

一覧取得に使用するトークン

pageSize
integer <int32>

一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100]

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

顧客に紐づく契約の一覧取得

顧客に紐づく契約を一覧取得します。

Request Body schema: application/json
customerId
required
string (顧客ID)
customerOptionalId
string (顧客管理ID(顧客IDの代わりに指定可))
pageToken
string (一覧取得に使用するトークン)
pageSize
integer <int32> (一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100])

Responses

Request samples

Content type
application/json
{
  • "customerId": "string",
  • "customerOptionalId": "string",
  • "pageToken": "string",
  • "pageSize": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

顧客に紐づく契約の一覧取得

顧客に紐づく契約を一覧取得します。

query Parameters
customerId
required
string

顧客ID

customerOptionalId
string

顧客管理ID(顧客IDの代わりに指定可)

pageToken
string

一覧取得に使用するトークン

pageSize
integer <int32>

一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100]

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

顧客に紐づく契約の一覧取得

顧客に紐づく契約を一覧取得します。

Request Body schema: application/json
customerId
required
string (顧客ID)
customerOptionalId
string (顧客管理ID(顧客IDの代わりに指定可))
pageToken
string (一覧取得に使用するトークン)
pageSize
integer <int32> (一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100])

Responses

Request samples

Content type
application/json
{
  • "customerId": "string",
  • "customerOptionalId": "string",
  • "pageToken": "string",
  • "pageSize": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

契約の検索

契約を検索して一覧を取得します。

query Parameters
pageToken
string

一覧取得に使用するトークン

pageSize
integer <int32>

一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100]

orderBy.field
string
Default: "FIELD_UNSPECIFIED"
Enum: "FIELD_UNSPECIFIED" "FIELD_ID" "FIELD_CONTRACT_END_DATE"
  • FIELD_ID: 請求ID
  • FIELD_CONTRACT_END_DATE: 契約終了日
orderBy.direction
string
Default: "DIRECTION_UNSPECIFIED"
Enum: "DIRECTION_UNSPECIFIED" "DIRECTION_ASCENDING" "DIRECTION_DESCENDING"
  • DIRECTION_ASCENDING: 昇順
  • DIRECTION_DESCENDING: 降順

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

契約の検索

契約を検索して一覧を取得します。

Request Body schema: application/json
pageToken
string (一覧取得に使用するトークン)
pageSize
integer <int32> (一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100])
Array of objects (フィルター example: ``` { "contractEndDate": { "gte": "2025-01-23T00:00:00+09:00" }} { "contractItemEndDate": { "gte": "2025-01-31T15:00:00.000Z" }} ```) [ items ]
object (ソート条件)

Responses

Request samples

Content type
application/json
{
  • "pageToken": "string",
  • "pageSize": 0,
  • "filter": [
    ],
  • "orderBy": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

Customer

顧客の管理ID更新

顧客の管理IDを更新する

Request Body schema: application/json
id
required
string (顧客ID)
optionalId
string (顧客管理ID(未指定の場合、管理IDの割当を解除))

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "optionalId": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

顧客の作成

新規に顧客を作成します。

Request Body schema: application/json
optionalId
string (顧客管理ID)
name
required
string (顧客名)
object (営業担当者)

Responses

Request samples

Content type
application/json
{
  • "optionalId": "string",
  • "name": "string",
  • "salesRepresentative": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

顧客の削除

顧客を削除します。

Request Body schema: application/json
id
string (顧客ID)
optionalId
string (顧客管理ID(顧客IDの代わりに指定可))

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "optionalId": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

顧客の取得

顧客を取得します。

query Parameters
id
string

顧客ID

optionalId
string

顧客管理ID(顧客IDの代わりに指定可)

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

顧客の取得

顧客を取得します。

Request Body schema: application/json
id
string (顧客ID)
optionalId
string (顧客管理ID(顧客IDの代わりに指定可))

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "optionalId": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

顧客の一覧取得

顧客の一覧を取得します。

query Parameters
pageToken
string

一覧取得に使用するトークン

pageSize
required
integer <int32>

一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100]

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

顧客の一覧取得

顧客の一覧を取得します。

Request Body schema: application/json
pageToken
string (一覧取得に使用するトークン)
pageSize
required
integer <int32> (一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100])

Responses

Request samples

Content type
application/json
{
  • "pageToken": "string",
  • "pageSize": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

顧客の更新

顧客を更新します。

Request Body schema: application/json

顧客

id
string (顧客ID)
optionalId
string (顧客管理ID（更新時、顧客IDの代わりに指定可）)
name
string (顧客名（更新可）)
object (営業担当者)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "optionalId": "string",
  • "name": "string",
  • "salesRepresentative": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

CustomerStaff

顧客担当者の管理ID更新

顧客担当者の管理IDを更新する

Request Body schema: application/json
id
required
string (顧客担当者ID)
optionalId
string (顧客担当者管理ID(未指定の場合、管理IDの設定を解除))
customerId
required
string (顧客ID)
customerOptionalId
string (顧客管理ID(顧客IDの代わりに指定可))

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "optionalId": "string",
  • "customerId": "string",
  • "customerOptionalId": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

顧客担当者の作成

新規に顧客担当者を作成します。

Request Body schema: application/json
customerId
required
string (顧客ID)
customerOptionalId
string (顧客管理ID(顧客IDの代わりに指定可))
optionalId
string (顧客担当者管理ID)
object (名前)
department
string (部門)
title
string (肩書)
phoneNumber
string (電話番号)
emailAddress
string (メールアドレス)
object (住所)

Responses

Request samples

Content type
application/json
{
  • "customerId": "string",
  • "customerOptionalId": "string",
  • "optionalId": "string",
  • "name": {
    },
  • "department": "string",
  • "title": "string",
  • "phoneNumber": "string",
  • "emailAddress": "string",
  • "address": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

顧客担当者の削除

顧客担当者を削除します。

Request Body schema: application/json
id
required
string (顧客担当者ID)
optionalId
string (顧客担当者管理ID(顧客担当者IDの代わりに指定可))
customerId
required
string (顧客ID)
customerOptionalId
string (顧客管理ID(顧客IDの代わりに指定可))

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "optionalId": "string",
  • "customerId": "string",
  • "customerOptionalId": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

顧客担当者の取得

顧客担当者を取得します。

query Parameters
id
required
string

顧客担当者ID

optionalId
string

顧客担当者管理ID(顧客担当者IDの代わりに指定可)

customerId
string

顧客ID

customerOptionalId
string

顧客管理ID(顧客IDの代わりに指定可)

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

顧客担当者の取得

顧客担当者を取得します。

Request Body schema: application/json
id
required
string (顧客担当者ID)
optionalId
string (顧客担当者管理ID(顧客担当者IDの代わりに指定可))
customerId
string (顧客ID)
customerOptionalId
string (顧客管理ID(顧客IDの代わりに指定可))

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "optionalId": "string",
  • "customerId": "string",
  • "customerOptionalId": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

顧客担当者の一覧取得

顧客担当者の一覧を取得します。

query Parameters
customerId
required
string

顧客ID

customerOptionalId
string

顧客管理ID(顧客IDの代わりに指定可)

pageToken
string

一覧取得に使用するトークン

pageSize
required
integer <int32>

一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100]

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

顧客担当者の一覧取得

顧客担当者の一覧を取得します。

Request Body schema: application/json
customerId
required
string (顧客ID)
customerOptionalId
string (顧客管理ID(顧客IDの代わりに指定可))
pageToken
string (一覧取得に使用するトークン)
pageSize
required
integer <int32> (一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100])

Responses

Request samples

Content type
application/json
{
  • "customerId": "string",
  • "customerOptionalId": "string",
  • "pageToken": "string",
  • "pageSize": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

顧客担当者の更新

顧客担当者を更新します。

Request Body schema: application/json

顧客担当者

id
string (顧客担当者ID)
customerId
string (顧客ID)
optionalId
string (顧客担当者管理ID（更新時、顧客担当者IDの代わりに指定可）)
object (名前)
department
string (部門（更新可）)
title
string (肩書（更新可）)
phoneNumber
string (電話番号（更新可）)
emailAddress
string (メールアドレス（更新可）)
object (住所)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "customerId": "string",
  • "optionalId": "string",
  • "name": {
    },
  • "department": "string",
  • "title": "string",
  • "phoneNumber": "string",
  • "emailAddress": "string",
  • "address": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

CustomField

カスタムフィールドマスターの一覧取得

カスタムフィールドマスターを一覧取得します。

query Parameters
pageToken
string

一覧取得に使用するトークン

pageSize
required
integer <int32>

一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100]

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

カスタムフィールドマスターの一覧取得

カスタムフィールドマスターを一覧取得します。

Request Body schema: application/json
pageToken
string (一覧取得に使用するトークン)
pageSize
required
integer <int32> (一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100])

Responses

Request samples

Content type
application/json
{
  • "pageToken": "string",
  • "pageSize": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

対象リソースのカスタムフィールド取得

対象リソースのカスタムフィールド取得します。

query Parameters
srn.resourceId
required
string

リソースID

srn.resourceType
required
string
Default: "TYPE_UNSPECIFIED"
Enum: "TYPE_UNSPECIFIED" "TYPE_CUSTOMER" "TYPE_CONTRACT" "TYPE_CONTRACT_SERVICE" "TYPE_CONTRACT_ITEM"

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

対象リソースのカスタムフィールド取得

対象リソースのカスタムフィールド取得します。

Request Body schema: application/json
required
object (Scalebaseリソースネーム(SRN) Scalebaseリソースを一意に識別します。顧客や契約など、Scalebase全体でリソースを明確に指定する場合はSRNが必要になります。)

Responses

Request samples

Content type
application/json
{
  • "srn": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

カスタムフィールド更新

カスタムフィールドの更新を行います。

Request Body schema: application/json

リソース

object (Scalebaseリソースネーム(SRN) Scalebaseリソースを一意に識別します。顧客や契約など、Scalebase全体でリソースを明確に指定する場合はSRNが必要になります。)
object (Scalebaseリソースエイリアス(SRA) Scalebaseリソースネーム(SRN)の代わりに指定可 Scalebaseリソースに割り当てられた可変なエイリアス（管理ID）によってリソースを識別します。)
Array of objects (カスタムフィールド) [ items ]

Responses

Request samples

Content type
application/json
{
  • "srn": {
    },
  • "sra": {
    },
  • "customFields": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

ExpectedBilling

契約数変更に伴う請求予定の再計算（単一の請求予定を返す）

注意事項:

  • 契約サービスのメインアイテムに属する課金項目のみ指定が可能です。オプションアイテムの請求予定の取得には現時点で非対応です
Request Body schema: application/json
id
required
string (契約ID)
optionalId
string (契約管理ID(IDの代わりに指定可))
contractChargeItemId
required
string (契約の課金項目ID（ContractChargeItemId）)
effectiveStartDate
required
string <date-time> (有効開始日 (RFC3339))
quantity
required
integer <int32> (新しい数量)
object (日割設定)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "optionalId": "string",
  • "contractChargeItemId": "string",
  • "effectiveStartDate": "2019-08-24T14:15:22Z",
  • "quantity": 0,
  • "changeQuantityDailyRate": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

請求予定の一覧取得

契約に紐づく請求予定一覧

query Parameters
id
required
string

契約ID

optionalId
string

契約管理ID(IDの代わりに指定可)

pageToken
string

一覧取得に使用するトークン

pageSize
integer <int32>

一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100]

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

請求予定の一覧取得

契約に紐づく請求予定一覧

Request Body schema: application/json
id
required
string (契約ID)
optionalId
string (契約管理ID(IDの代わりに指定可))
pageToken
string (一覧取得に使用するトークン)
pageSize
integer <int32> (一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100])

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "optionalId": "string",
  • "pageToken": "string",
  • "pageSize": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

契約更新と数量変更に伴う請求予定の計算

注意事項:

  • 契約サービスのメインアイテムに属する課金項目のみ指定が可能です。オプションアイテムの請求予定の取得には現時点で非対応です
Request Body schema: application/json
id
required
string (契約ID)
optionalId
string (契約管理ID(IDの代わりに指定可))
contractChargeItemId
required
string (契約の課金項目ID（ContractChargeItemId）)
quantity
required
integer <int32> (新しい数量)
object (日割設定)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "optionalId": "string",
  • "contractChargeItemId": "string",
  • "quantity": 0,
  • "changeQuantityDailyRate": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

PaymentMethod

決済方法の取得

決済方法を取得します。

query Parameters
id
string

決済方法ID

optionalId
string

決済方法管理ID(決済方法IDの代わりに指定可)

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

決済方法の取得

決済方法を取得します。

Request Body schema: application/json
id
string (決済方法ID)
optionalId
string (決済方法管理ID(決済方法IDの代わりに指定可))

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "optionalId": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

決済方法の一覧取得

決済方法の一覧を取得します。

query Parameters
pageToken
string

一覧取得に使用するトークン [デフォルト: 10 / 最小: 1 / 最大: 100]

pageSize
required
integer <int32>

一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100]

orderBy.field
string
Default: "FIELD_UNSPECIFIED"
Enum: "FIELD_UNSPECIFIED" "FIELD_ID"
  • FIELD_ID: 請求ID
orderBy.direction
string
Default: "DIRECTION_UNSPECIFIED"
Enum: "DIRECTION_UNSPECIFIED" "DIRECTION_ASCENDING" "DIRECTION_DESCENDING"
  • DIRECTION_ASCENDING: 昇順
  • DIRECTION_DESCENDING: 降順

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

決済方法の一覧取得

決済方法の一覧を取得します。

Request Body schema: application/json
pageToken
string (一覧取得に使用するトークン [デフォルト: 10 / 最小: 1 / 最大: 100])
pageSize
required
integer <int32> (一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100])
object (ソート条件)

Responses

Request samples

Content type
application/json
{
  • "pageToken": "string",
  • "pageSize": 0,
  • "orderBy": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

Product

プロダクトの作成

プロダクトを作成します。

Request Body schema: application/json
optionalId
string (プロダクト管理ID)
name
string (プロダクト名)
description
string (プロダクト概要)

Responses

Request samples

Content type
application/json
{
  • "optionalId": "string",
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

プロダクトの取得

指定したプロダクトを取得します。

query Parameters
id
required
string

プロダクトID

optionalId
string

プロダクト管理ID(プロダクトIDの代わりに指定可)

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

プロダクトの取得

指定したプロダクトを取得します。

Request Body schema: application/json
id
required
string (プロダクトID)
optionalId
string (プロダクト管理ID(プロダクトIDの代わりに指定可))

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "optionalId": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

Provider

プロバイダーの取得

プロバイダーを取得します。

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

プロバイダーの取得

プロバイダーを取得します。

Request Body schema: application/json
object (プロバイダー取得リクエスト)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

Usage

使用量(日毎)の更新

指定した使用量を作成or更新します。

Request Body schema: application/json
contractChargeItemId
required
string (契約課金項目ID)
customerId
required
string (顧客ID)
customerOptionalId
string (顧客管理ID(顧客IDの代わりに指定可))
usageUnitId
required
string (使用量単位ID)
usageUnitOptionalId
string (使用量単位管理ID(使用量単位IDの代わりに指定可))
targetDate
required
string <date-time> (対象日(RFC 3339 format))
quantity
required
number <double> (計測された値)

Responses

Request samples

Content type
application/json
{
  • "contractChargeItemId": "string",
  • "customerId": "string",
  • "customerOptionalId": "string",
  • "usageUnitId": "string",
  • "usageUnitOptionalId": "string",
  • "targetDate": "2019-08-24T14:15:22Z",
  • "quantity": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

契約と使用量単位による使用量(日毎)の更新

指定した使用量を作成or更新します。

Request Body schema: application/json
contractOptionalId
required
string (契約管理ID)
usageUnitOptionalId
required
string (使用量単位管理ID)
targetDate
required
string <date-time> (対象日(RFC 3339 format))
quantity
required
number <double> (計測された値)

Responses

Request samples

Content type
application/json
{
  • "contractOptionalId": "string",
  • "usageUnitOptionalId": "string",
  • "targetDate": "2019-08-24T14:15:22Z",
  • "quantity": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

契約と使用量単位による使用量(日毎)の更新(非推奨)

指定した使用量を作成or更新します。同等の機能を提供する /v1/usage/daily/upsertbycontractandusageunit に移行してください。

Request Body schema: application/json
contractOptionalId
required
string (契約管理ID)
usageUnitOptionalId
required
string (使用量単位管理ID)
targetDate
required
string <date-time> (対象日(RFC 3339 format))
quantity
required
number <double> (計測された値)

Responses

Request samples

Content type
application/json
{
  • "contractOptionalId": "string",
  • "usageUnitOptionalId": "string",
  • "targetDate": "2019-08-24T14:15:22Z",
  • "quantity": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

使用量単位の取得

使用量単位を取得します。

query Parameters
id
required
string

使用量単位ID

optionalId
string

使用量単位管理ID(使用量単位IDの代わりに指定可)

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

使用量単位の取得

使用量単位を取得します。

Request Body schema: application/json
id
required
string (使用量単位ID)
optionalId
string (使用量単位管理ID(使用量単位IDの代わりに指定可))

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "optionalId": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

使用量単位一覧の取得

使用量単位一覧を取得します。

query Parameters
pageToken
string

一覧取得に使用するトークン

pageSize
required
integer <int32>

一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100]

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

使用量単位一覧の取得

使用量単位一覧を取得します。

Request Body schema: application/json
pageToken
string (一覧取得に使用するトークン)
pageSize
required
integer <int32> (一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100])

Responses

Request samples

Content type
application/json
{
  • "pageToken": "string",
  • "pageSize": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

ZzHealth

ヘルスチェック

APIの稼働状況を確認します。

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

ヘルスチェック

APIの稼働状況を確認します。

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

Amendment V2

契約サービスの解約

指定した契約サービスを途中解約します

Request Body schema: application/json
contractId
required
string (契約ID)
contractOptionalId
required
string (契約管理ID(契約IDの代わりに指定可))
contractServiceId
required
string (契約サービスID)
effectiveStartDate
required
string <date-time> (改定の有効開始日)
Array of objects (解約時の終了月日割設定) [ items ]
memo
string (改定メモ)

Responses

Request samples

Content type
application/json
{
  • "contractId": "string",
  • "contractOptionalId": "string",
  • "contractServiceId": "string",
  • "effectiveStartDate": "2019-08-24T14:15:22Z",
  • "lastAvailabilityDailyRates": [
    ],
  • "memo": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

Contract V2

契約の作成

新規に契約を作成します。

Request Body schema: application/json
optionalId
string (契約管理ID)
customerId
required
string (顧客ID)
required
Array of objects (契約サービス(複数のメイン・オプションアイテムをサービス単位でグルーピング、最低1件必須)) [ items ]
billingCustomerStaffIds
Array of strings (請求先担当者ID（配列の先頭が請求先主担当、最低1件必須）)
shippingCustomerStaffIds
Array of strings (納入先担当者ID（配列の先頭が納入先主担当）)
paymentMethodId
string (決済方法ID(省略時はデフォルトの決済方法が適用されます))

Responses

Request samples

Content type
application/json
{
  • "optionalId": "string",
  • "customerId": "string",
  • "services": [
    ],
  • "billingCustomerStaffIds": [
    ],
  • "shippingCustomerStaffIds": [
    ],
  • "paymentMethodId": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

契約の取得

指定されたIDを持つ契約を取得します。

query Parameters
id
required
string

契約ID

atPointInServiceTimeline
string <date-time>

契約サービスタイムラインのどの時点での契約を取得するかの指定。 指定しない場合は、契約サービスタイムラインの最も未来の時点での契約の状態が返却される。

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

契約の取得

指定されたIDを持つ契約を取得します。

Request Body schema: application/json
id
required
string (契約ID)
atPointInServiceTimeline
string <date-time> (契約サービスタイムラインのどの時点での契約を取得するかの指定。 指定しない場合は、契約サービスタイムラインの最も未来の時点での契約の状態が返却される。)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "atPointInServiceTimeline": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

契約管理IDを指定した契約の取得

指定された契約管理IDを持つ契約を取得します。

query Parameters
optionalId
required
string

契約管理ID

atPointInServiceTimeline
string <date-time>

契約サービスタイムラインのどの時点での契約を取得するかの指定。 指定しない場合は、契約サービスタイムラインの最も未来の時点での契約の状態が返却される。

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

契約管理IDを指定した契約の取得

指定された契約管理IDを持つ契約を取得します。

Request Body schema: application/json
optionalId
required
string (契約管理ID)
atPointInServiceTimeline
string <date-time> (契約サービスタイムラインのどの時点での契約を取得するかの指定。 指定しない場合は、契約サービスタイムラインの最も未来の時点での契約の状態が返却される。)

Responses

Request samples

Content type
application/json
{
  • "optionalId": "string",
  • "atPointInServiceTimeline": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

契約の一覧取得

条件に一致する契約の一覧を取得します。

query Parameters
sortOrder.field
string
Default: "FIELD_UNSPECIFIED"
Enum: "FIELD_UNSPECIFIED" "FIELD_ID" "FIELD_CONTRACT_END_DATE"
  • FIELD_ID: 契約ID
  • FIELD_CONTRACT_END_DATE: 契約終了日
sortOrder.direction
string
Default: "DIRECTION_UNSPECIFIED"
Enum: "DIRECTION_UNSPECIFIED" "DIRECTION_ASCENDING" "DIRECTION_DESCENDING"
  • DIRECTION_ASCENDING: 昇順
  • DIRECTION_DESCENDING: 降順
offsetToken
string

オフセット情報を含むページングトークン。

pageSize
integer <int32>

一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100]

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

契約の一覧取得

条件に一致する契約の一覧を取得します。

Request Body schema: application/json
Array of objects (契約のフィルタ条件) [ items ]
object (契約のソート条件)
offsetToken
string (オフセット情報を含むページングトークン。)
pageSize
integer <int32> (一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100])

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "sortOrder": {
    },
  • "offsetToken": "string",
  • "pageSize": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

契約の一覧取得（契約サービスタイムライン上での日付指定あり）

条件に一致する契約の一覧を、契約サービスタイムライン上で指定された日付における状態で取得します。

query Parameters
sortOrder.field
string
Default: "FIELD_UNSPECIFIED"
Enum: "FIELD_UNSPECIFIED" "FIELD_ID" "FIELD_CONTRACT_END_DATE"
  • FIELD_ID: 契約ID
  • FIELD_CONTRACT_END_DATE: 契約終了日
sortOrder.direction
string
Default: "DIRECTION_UNSPECIFIED"
Enum: "DIRECTION_UNSPECIFIED" "DIRECTION_ASCENDING" "DIRECTION_DESCENDING"
  • DIRECTION_ASCENDING: 昇順
  • DIRECTION_DESCENDING: 降順
offsetToken
string

オフセット情報を含むページングトークン。

pageSize
integer <int32>

一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100]

atPointInServiceTimeline
required
string <date-time>

契約サービスタイムラインのどの時点での契約を取得するかの指定。

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

契約の一覧取得（契約サービスタイムライン上での日付指定あり）

条件に一致する契約の一覧を、契約サービスタイムライン上で指定された日付における状態で取得します。

Request Body schema: application/json
Array of objects (契約のフィルタ条件) [ items ]
object (契約のソート条件)
offsetToken
string (オフセット情報を含むページングトークン。)
pageSize
integer <int32> (一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100])
atPointInServiceTimeline
required
string <date-time> (契約サービスタイムラインのどの時点での契約を取得するかの指定。)

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "sortOrder": {
    },
  • "offsetToken": "string",
  • "pageSize": 0,
  • "atPointInServiceTimeline": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}

契約のサービス追加

既存の契約に新しいサービス（メインアイテム・オプションアイテム）を追加します。

Request Body schema: application/json
contractId
required
string (契約ID)
required
object (メインとなるアイテム)
Array of objects (追加するオプションアイテム) [ items ]

Responses

Request samples

Content type
application/json
{
  • "contractId": "string",
  • "mainItem": {
    },
  • "optionItems": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}