# Scalebase API — Full API Reference Scalebaseへ接続するAPIのリファレンスです ## API利用規約 [API利用規約はこちら](https://scalebase.com/terms/api/) ## Scalebaseヘルプ Scalebaseの製品・概念説明、基本操作方法などについては [こちら](https://alpinc.notion.site/Scalebase-7aa524f5cbea43d2a57d0304b9a4051c) をご確認ください ## APIエンドポイント ### Sandbox ```https://api.sandbox.scalebase.com``` ### Production ```https://api.scalebase.com``` ## APIキー Scalebase上で発行したAPIキーをBearer Tokenとして設定することでリクエスト可能です。 APIキーの作成は[こちら](https://dashboard.scalebase.com/settings/cooperationservice/apikey)から ## リクエスト ### レートリミットについて お客様ごとの環境1つで実行される全API合計で `50req / min` となります。リクエスト数の上限緩和などはご相談ください ### 日時を指定するパラメータについて [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) のフォーマットの日時を指定できます(タイムゾーンも指定可)。 `$ date --iso-8601=seconds` `2000-01-23T12:34:56+09:00` リクエストされた時刻はJSTとして解釈します ## レスポンス ### エラー情報について - `code` [gRPC Status Code](https://grpc.github.io/grpc/core/md_doc_statuscodes.html)に従います - `message` サーバーからのメッセージが入ります - `detail` オブジェクトのjsonが入ります ### 日時を返却するパラメータについて 日時に関するレスポンスは、[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) のフォーマットで返却され [Protocol Buffers Json Mapping](https://protobuf.dev/programming-guides/proto3/#json) に従い、常にUTC(Zulu time)で正規化され返却されます。 ## AI/LLM向けドキュメント AIエージェントやコーディングアシスタントでAPI仕様を参照する場合は、以下のファイルをご利用ください。 - [llms.txt](./llms.txt) - API概要サマリ（軽量版） - [llms-full.txt](./llms-full.txt) - 全エンドポイント詳細 - [openapi.json](./openapi.json) - OpenAPI仕様（JSON） --- ## 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 - Request/Response Format: JSON - Date Format: RFC 3339 (responses normalized to UTC/Zulu time) - Error Response: {code: gRPC Status Code, message: string, detail: object} --- ## Endpoints ### GET /hc ヘルスチェック APIの稼働状況を確認します。 Operation ID: ZzHealthService_Check2 Tags: scalebase.public.v1.ZzHealthService Parameters: None Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → public.v1.CheckResponse --- ### POST /v1/amendment/addoptionitem オプションアイテムの追加 指定したカタログアイテムをオプションアイテムとして契約に追加します。 Operation ID: V1_AmendmentService_AddOptionItem Tags: scalebase.public.v1.AmendmentService Parameters: - body: AddOptionItemRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → AddOptionItemResponse --- ### POST /v1/amendment/cancelamendment 改定の取消 指定した改定を取り消します Operation ID: V1_AmendmentService_CancelAmendment Tags: scalebase.public.v1.AmendmentService Parameters: - body: CancelAmendmentRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → CancelAmendmentResponse --- ### POST /v1/amendment/cancelcontract 契約の解約 指定した契約を途中解約します Operation ID: V1_AmendmentService_CancelContract Tags: scalebase.public.v1.AmendmentService Parameters: - body: CancelContractRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → CancelContractResponse --- ### POST /v1/amendment/canceloption オプションアイテムの解約 指定したオプションアイテムを途中解約します Operation ID: V1_AmendmentService_CancelOption Tags: scalebase.public.v1.AmendmentService Parameters: - body: CancelOptionRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → CancelOptionResponse --- ### POST /v1/amendment/changemainitem メインアイテムの乗り換え 指定したメインアイテムに乗り換えます Operation ID: V1_AmendmentService_ChangeMainItem Tags: scalebase.public.v1.AmendmentService Parameters: - body: ChangeMainItemRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ChangeMainItemResponse --- ### POST /v1/amendment/changeoptionitem オプションアイテムの乗り換え 指定したオプションアイテムを別のオプションアイテムに乗り換えます。別カタログ・同一カタログ双方へ乗り換え可能です。 Operation ID: V1_AmendmentService_ChangeOptionItem Tags: scalebase.public.v1.AmendmentService Parameters: - body: ChangeOptionItemRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ChangeOptionItemResponse --- ### POST /v1/amendment/changequantity 契約アイテムの契約数の更新 指定した契約アイテムの契約数を更新します。 Operation ID: V1_AmendmentService_ChangeQuantity Tags: scalebase.public.v1.AmendmentService Parameters: - body: ChangeQuantityRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ChangeQuantityResponse --- ### POST /v1/amendment/customizeoptionitem オプションアイテムの編集 指定したオプションアイテムを編集します Operation ID: V1_AmendmentService_CustomizeOptionItem Tags: scalebase.public.v1.AmendmentService Parameters: - body: CustomizeOptionItemRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → CustomizeOptionItemResponse --- ### GET /v1/amendment/list 改定の一覧取得 プロバイダーに紐づく改定の一覧を取得します Operation ID: V1_AmendmentService_ListAmendments2 Tags: scalebase.public.v1.AmendmentService Parameters: - pageToken (query, optional): 一覧取得に使用するトークン - pageSize (query, required): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - orderBy.field (query, optional): - FIELD_ID: ID - FIELD_EXECUTE_DATE: 改定実行日 - FIELD_EFFECTIVE_START_DATE: 改定の有効開始日 - orderBy.direction (query, optional): - DIRECTION_ASCENDING: 昇順 - DIRECTION_DESCENDING: 降順 Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListAmendmentsResponse ### POST /v1/amendment/list 改定の一覧取得 プロバイダーに紐づく改定の一覧を取得します Operation ID: V1_AmendmentService_ListAmendments Tags: scalebase.public.v1.AmendmentService Parameters: - body: ListAmendmentsRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListAmendmentsResponse --- ### GET /v1/amendment/listbycontract 契約に紐づく改定の一覧取得 契約に紐づく改定を一覧取得します。 Operation ID: V1_AmendmentService_ListAmendmentsByContract2 Tags: scalebase.public.v1.AmendmentService Parameters: - id (query, required): 契約ID - optionalId (query, required): 契約管理ID(契約IDの代わりに指定可) - pageToken (query, optional): 一覧取得に使用するトークン - pageSize (query, optional): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListAmendmentsByContractResponse ### POST /v1/amendment/listbycontract 契約に紐づく改定の一覧取得 契約に紐づく改定を一覧取得します。 Operation ID: V1_AmendmentService_ListAmendmentsByContract Tags: scalebase.public.v1.AmendmentService Parameters: - body: ListAmendmentsByContractRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListAmendmentsByContractResponse --- ### GET /v1/amendment/listbycontractoptionalid 契約管理IDに紐づく改定の一覧取得 契約管理IDに紐づく改定を一覧取得します。 Operation ID: V1_AmendmentService_ListAmendmentsByContractOptionalId2 Tags: scalebase.public.v1.AmendmentService Parameters: - contractOptionalId (query, required): 契約管理ID - pageToken (query, optional): 一覧取得に使用するトークン - pageSize (query, optional): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListAmendmentsByContractOptionalIdResponse ### POST /v1/amendment/listbycontractoptionalid 契約管理IDに紐づく改定の一覧取得 契約管理IDに紐づく改定を一覧取得します。 Operation ID: V1_AmendmentService_ListAmendmentsByContractOptionalId Tags: scalebase.public.v1.AmendmentService Parameters: - body: ListAmendmentsByContractOptionalIdRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListAmendmentsByContractOptionalIdResponse --- ### POST /v1/amendment/renewcontractitem 契約アイテムの更新 指定した契約アイテムを更新します。 Operation ID: V1_AmendmentService_RenewContractItem Tags: scalebase.public.v1.AmendmentService Parameters: - body: RenewContractItemRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → RenewContractItemResponse --- ### POST /v1/billing/batchrecordpayments 一括入金処理 複数の請求に対して入金を記録します。 Operation ID: V1_BillingService_BatchRecordPayments Tags: scalebase.public.v1.BillingService Parameters: - body: BatchRecordPaymentsRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → BatchRecordPaymentsResponse --- ### POST /v1/billing/batchupdatestatuses 請求ステータスの一括更新 複数の請求のステータスを一括で変更します。 Operation ID: V1_BillingService_BatchUpdateBillingStatuses Tags: scalebase.public.v1.BillingService Parameters: - body: BatchUpdateBillingStatusesRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → BatchUpdateBillingStatusesResponse --- ### POST /v1/billing/create 請求の生成 指定された契約から請求を生成します。 Operation ID: V1_BillingService_CreateBillings Tags: scalebase.public.v1.BillingService Parameters: - body: CreateBillingsRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → CreateBillingsResponse --- ### GET /v1/billing/get 請求の取得 指定した請求を取得します。 Operation ID: V1_BillingService_GetBilling2 Tags: scalebase.public.v1.BillingService Parameters: - id (query, required): 請求ID Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → GetBillingResponse ### POST /v1/billing/get 請求の取得 指定した請求を取得します。 Operation ID: V1_BillingService_GetBilling Tags: scalebase.public.v1.BillingService Parameters: - body: GetBillingRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → GetBillingResponse --- ### GET /v1/billing/list 請求の一覧取得 請求の一覧を取得します。 Operation ID: V1_BillingService_ListBillings2 Tags: scalebase.public.v1.BillingService Parameters: - pageToken (query, optional): 一覧取得に使用するトークン - pageSize (query, optional): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListBillingsResponse ### POST /v1/billing/list 請求の一覧取得 請求の一覧を取得します。 Operation ID: V1_BillingService_ListBillings Tags: scalebase.public.v1.BillingService Parameters: - body: ListBillingsRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListBillingsResponse --- ### GET /v1/billing/listbycontract 契約に紐づく請求の一覧取得 指定された顧客に紐づく請求の一覧を取得します。 Operation ID: V1_BillingService_ListBillingsByContract2 Tags: scalebase.public.v1.BillingService Parameters: - id (query, required): 契約ID - optionalId (query, required): 契約管理ID(契約IDの代わりに指定可) - pageToken (query, optional): 一覧取得に使用するトークン - pageSize (query, optional): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - orderBy.field (query, optional): - FIELD_ID: 請求ID - FIELD_BILLING_DATE: 請求日 - orderBy.direction (query, optional): - DIRECTION_ASCENDING: 昇順 - DIRECTION_DESCENDING: 降順 Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListBillingsByContractResponse ### POST /v1/billing/listbycontract 契約に紐づく請求の一覧取得 指定された顧客に紐づく請求の一覧を取得します。 Operation ID: V1_BillingService_ListBillingsByContract Tags: scalebase.public.v1.BillingService Parameters: - body: ListBillingsByContractRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListBillingsByContractResponse --- ### GET /v1/billing/search 請求の検索 請求を検索して一覧を取得します。 Operation ID: V1_BillingService_SearchBillings2 Tags: scalebase.public.v1.BillingService Parameters: - pageToken (query, optional): 一覧取得に使用するトークン - pageSize (query, required): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - query (query, optional): 検索クエリ 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 (query, optional): - FIELD_ID: 請求ID - FIELD_BILLING_DATE: 請求日 - orderBy.direction (query, optional): - DIRECTION_ASCENDING: 昇順 - DIRECTION_DESCENDING: 降順 Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → SearchBillingsResponse ### POST /v1/billing/search 請求の検索 請求を検索して一覧を取得します。 Operation ID: V1_BillingService_SearchBillings Tags: scalebase.public.v1.BillingService Parameters: - body: SearchBillingsRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → SearchBillingsResponse --- ### GET /v1/catalogitem/get カタログアイテムの取得 指定したカタログアイテムを取得します。 Operation ID: V1_CatalogItemService_GetCatalogItem2 Tags: scalebase.public.v1.CatalogItemService Parameters: - id (query, optional): カタログアイテムID - optionalId (query, optional): カタログアイテム管理ID(カタログアイテムIDの代わりに指定可) Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → GetCatalogItemResponse ### POST /v1/catalogitem/get カタログアイテムの取得 指定したカタログアイテムを取得します。 Operation ID: V1_CatalogItemService_GetCatalogItem Tags: scalebase.public.v1.CatalogItemService Parameters: - body: GetCatalogItemRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → GetCatalogItemResponse --- ### GET /v1/catalogitem/list カタログアイテムの一覧取得 カタログアイテムの一覧を取得します。 Operation ID: V1_CatalogItemService_ListCatalogItems2 Tags: scalebase.public.v1.CatalogItemService Parameters: - pageToken (query, optional): 一覧取得に使用するトークン - pageSize (query, required): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListCatalogItemsResponse ### POST /v1/catalogitem/list カタログアイテムの一覧取得 カタログアイテムの一覧を取得します。 Operation ID: V1_CatalogItemService_ListCatalogItems Tags: scalebase.public.v1.CatalogItemService Parameters: - body: ListCatalogItemsRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListCatalogItemsResponse --- ### POST /v1/contract/alias 契約管理ID変更 契約管理IDを変更する Operation ID: V1_ContractService_AliasContract Tags: scalebase.public.v1.ContractService Parameters: - body: AliasContractRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → AliasContractResponse --- ### POST /v1/contract/confirmdraft 契約の下書き解除 下書き状態の契約を確定し、通常の契約にします。 既に下書きが解除された契約に対して実行した場合も正常に完了します（冪等）。 この操作は不可逆です。一度解除した契約を再び下書きに戻すことはできません。 Operation ID: V1_ContractService_ConfirmDraftContract Tags: scalebase.public.v1.ContractService Parameters: - body: v1.ConfirmDraftContractRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → v1.ConfirmDraftContractResponse --- ### POST /v1/contract/create 契約の作成 新規に契約を作成します。 buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE Operation ID: V1_ContractService_CreateContract Tags: scalebase.public.v1.ContractService Parameters: - body: v1.CreateContractRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → v1.CreateContractResponse --- ### GET /v1/contract/get 契約の取得 指定されたIDを持つ契約を取得します。 Operation ID: V1_ContractService_GetContract2 Tags: scalebase.public.v1.ContractService Parameters: - id (query, required): 契約ID - version (query, optional): 契約バージョン。指定がなければ最新バージョンの契約が返却される Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → v1.GetContractResponse ### POST /v1/contract/get 契約の取得 指定されたIDを持つ契約を取得します。 Operation ID: V1_ContractService_GetContract Tags: scalebase.public.v1.ContractService Parameters: - body: v1.GetContractRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → v1.GetContractResponse --- ### GET /v1/contract/getbyoptionalid 契約管理IDを指定した契約の取得 契約管理IDを指定して契約を取得します。 Operation ID: V1_ContractService_GetContractByOptionalId2 Tags: scalebase.public.v1.ContractService Parameters: - optionalId (query, required): 契約管理ID - version (query, optional): 契約バージョン。指定がなければ最新バージョンの契約が返却される Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → v1.GetContractByOptionalIdResponse ### POST /v1/contract/getbyoptionalid 契約管理IDを指定した契約の取得 契約管理IDを指定して契約を取得します。 Operation ID: V1_ContractService_GetContractByOptionalId Tags: scalebase.public.v1.ContractService Parameters: - body: v1.GetContractByOptionalIdRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → v1.GetContractByOptionalIdResponse --- ### GET /v1/contract/list 契約の一覧取得 契約の一覧を取得します。 Operation ID: V1_ContractService_ListContracts2 Tags: scalebase.public.v1.ContractService Parameters: - pageToken (query, optional): 一覧取得に使用するトークン - pageSize (query, optional): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → v1.ListContractsResponse ### POST /v1/contract/list 契約の一覧取得 契約の一覧を取得します。 Operation ID: V1_ContractService_ListContracts Tags: scalebase.public.v1.ContractService Parameters: - body: v1.ListContractsRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → v1.ListContractsResponse --- ### GET /v1/contract/listbycustomer 顧客に紐づく契約の一覧取得 顧客に紐づく契約を一覧取得します。 Operation ID: V1_ContractService_ListContractsByCustomer2 Tags: scalebase.public.v1.ContractService Parameters: - customerId (query, required): 顧客ID - customerOptionalId (query, optional): 顧客管理ID(顧客IDの代わりに指定可) - pageToken (query, optional): 一覧取得に使用するトークン - pageSize (query, optional): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListContractsByCustomerResponse ### POST /v1/contract/listbycustomer 顧客に紐づく契約の一覧取得 顧客に紐づく契約を一覧取得します。 Operation ID: V1_ContractService_ListContractsByCustomer Tags: scalebase.public.v1.ContractService Parameters: - body: ListContractsByCustomerRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListContractsByCustomerResponse --- ### GET /v1/contract/listbycustomerid 顧客に紐づく契約の一覧取得 顧客に紐づく契約を一覧取得します。 Operation ID: V1_ContractService_ListContractsByCustomer4 Tags: scalebase.public.v1.ContractService Parameters: - customerId (query, required): 顧客ID - customerOptionalId (query, optional): 顧客管理ID(顧客IDの代わりに指定可) - pageToken (query, optional): 一覧取得に使用するトークン - pageSize (query, optional): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListContractsByCustomerResponse ### POST /v1/contract/listbycustomerid 顧客に紐づく契約の一覧取得 顧客に紐づく契約を一覧取得します。 Operation ID: V1_ContractService_ListContractsByCustomer3 Tags: scalebase.public.v1.ContractService Parameters: - body: ListContractsByCustomerRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListContractsByCustomerResponse --- ### GET /v1/contract/search 契約の検索 契約を検索して一覧を取得します。 Operation ID: V1_ContractService_SearchContracts2 Tags: scalebase.public.v1.ContractService Parameters: - pageToken (query, optional): 一覧取得に使用するトークン - pageSize (query, optional): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - orderBy.field (query, optional): - FIELD_ID: 請求ID - FIELD_CONTRACT_END_DATE: 契約終了日 - orderBy.direction (query, optional): - DIRECTION_ASCENDING: 昇順 - DIRECTION_DESCENDING: 降順 Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → SearchContractsResponse ### POST /v1/contract/search 契約の検索 契約を検索して一覧を取得します。 Operation ID: V1_ContractService_SearchContracts Tags: scalebase.public.v1.ContractService Parameters: - body: SearchContractsRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → SearchContractsResponse --- ### POST /v1/customer/alias 顧客の管理ID更新 顧客の管理IDを更新する Operation ID: V1_CustomerService_AliasCustomer Tags: scalebase.public.v1.CustomerService Parameters: - body: AliasCustomerRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → AliasCustomerResponse --- ### POST /v1/customer/create 顧客の作成 新規に顧客を作成します。 Operation ID: V1_CustomerService_CreateCustomer Tags: scalebase.public.v1.CustomerService Parameters: - body: CreateCustomerRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → CreateCustomerResponse --- ### POST /v1/customer/delete 顧客の削除 顧客を削除します。 Operation ID: V1_CustomerService_DeleteCustomer Tags: scalebase.public.v1.CustomerService Parameters: - body: DeleteCustomerRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → DeleteCustomerResponse --- ### GET /v1/customer/fincode/get fincode顧客の取得 顧客のfincode顧客ID紐づけ情報を取得します。 Operation ID: V1_FincodeService_GetLinkedCustomer2 Tags: scalebase.public.v1.FincodeService Parameters: - customerId (query, required): 顧客ID Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → GetLinkedCustomerResponse ### POST /v1/customer/fincode/get fincode顧客の取得 顧客のfincode顧客ID紐づけ情報を取得します。 Operation ID: V1_FincodeService_GetLinkedCustomer Tags: scalebase.public.v1.FincodeService Parameters: - body: GetLinkedCustomerRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → GetLinkedCustomerResponse --- ### POST /v1/customer/fincode/link fincode顧客の紐づけ 顧客にfincode顧客IDを紐づけます。 既に紐づいている場合はエラーを返します（先にUnlinkCustomerで解除してください）。 Operation ID: V1_FincodeService_LinkCustomer Tags: scalebase.public.v1.FincodeService Parameters: - body: LinkCustomerRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → LinkCustomerResponse --- ### POST /v1/customer/fincode/unlink fincode顧客の紐づけ解除 顧客のfincode顧客ID紐づけを解除します。 Operation ID: V1_FincodeService_UnlinkCustomer Tags: scalebase.public.v1.FincodeService Parameters: - body: UnlinkCustomerRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → UnlinkCustomerResponse --- ### GET /v1/customer/get 顧客の取得 顧客を取得します。 Operation ID: V1_CustomerService_GetCustomer2 Tags: scalebase.public.v1.CustomerService Parameters: - id (query, optional): 顧客ID - optionalId (query, optional): 顧客管理ID(顧客IDの代わりに指定可) - crmAccountId (query, optional): 外部CRMサービスのアカウントID(顧客IDの代わりに指定可) Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → GetCustomerResponse ### POST /v1/customer/get 顧客の取得 顧客を取得します。 Operation ID: V1_CustomerService_GetCustomer Tags: scalebase.public.v1.CustomerService Parameters: - body: GetCustomerRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → GetCustomerResponse --- ### GET /v1/customer/list 顧客の一覧取得 顧客の一覧を取得します。 Operation ID: V1_CustomerService_ListCustomers2 Tags: scalebase.public.v1.CustomerService Parameters: - pageToken (query, optional): 一覧取得に使用するトークン - pageSize (query, required): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListCustomersResponse ### POST /v1/customer/list 顧客の一覧取得 顧客の一覧を取得します。 Operation ID: V1_CustomerService_ListCustomers Tags: scalebase.public.v1.CustomerService Parameters: - body: ListCustomersRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListCustomersResponse --- ### PATCH /v1/customer/update 顧客の更新 顧客を更新します。 Operation ID: V1_CustomerService_UpdateCustomer Tags: scalebase.public.v1.CustomerService Parameters: - body: v1.Customer Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → UpdateCustomerResponse --- ### POST /v1/customerstaff/alias 顧客担当者の管理ID更新 顧客担当者の管理IDを更新する Operation ID: V1_CustomerStaffService_AliasCustomerStaff Tags: scalebase.public.v1.CustomerStaffService Parameters: - body: AliasCustomerStaffRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → AliasCustomerStaffResponse --- ### POST /v1/customerstaff/create 顧客担当者の作成 新規に顧客担当者を作成します。 Operation ID: V1_CustomerStaffService_CreateCustomerStaff Tags: scalebase.public.v1.CustomerStaffService Parameters: - body: CreateCustomerStaffRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → CreateCustomerStaffResponse --- ### POST /v1/customerstaff/delete 顧客担当者の削除 顧客担当者を削除します。 Operation ID: V1_CustomerStaffService_DeleteCustomerStaff Tags: scalebase.public.v1.CustomerStaffService Parameters: - body: DeleteCustomerStaffRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → DeleteCustomerStaffResponse --- ### GET /v1/customerstaff/get 顧客担当者の取得 顧客担当者を取得します。 Operation ID: V1_CustomerStaffService_GetCustomerStaff2 Tags: scalebase.public.v1.CustomerStaffService Parameters: - id (query, required): 顧客担当者ID - optionalId (query, optional): 顧客担当者管理ID(顧客担当者IDの代わりに指定可) - crmStaffId (query, optional): 外部CRMサービスの担当者ID(顧客担当者IDの代わりに指定可) - customerId (query, optional): 顧客ID - customerOptionalId (query, optional): 顧客管理ID(顧客IDの代わりに指定可) Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → GetCustomerStaffResponse ### POST /v1/customerstaff/get 顧客担当者の取得 顧客担当者を取得します。 Operation ID: V1_CustomerStaffService_GetCustomerStaff Tags: scalebase.public.v1.CustomerStaffService Parameters: - body: GetCustomerStaffRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → GetCustomerStaffResponse --- ### GET /v1/customerstaff/list 顧客担当者の一覧取得 顧客担当者の一覧を取得します。 Operation ID: V1_CustomerStaffService_ListCustomerStaffs2 Tags: scalebase.public.v1.CustomerStaffService Parameters: - customerId (query, required): 顧客ID - customerOptionalId (query, optional): 顧客管理ID(顧客IDの代わりに指定可) - pageToken (query, optional): 一覧取得に使用するトークン - pageSize (query, required): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListCustomerStaffsResponse ### POST /v1/customerstaff/list 顧客担当者の一覧取得 顧客担当者の一覧を取得します。 Operation ID: V1_CustomerStaffService_ListCustomerStaffs Tags: scalebase.public.v1.CustomerStaffService Parameters: - body: ListCustomerStaffsRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListCustomerStaffsResponse --- ### PATCH /v1/customerstaff/update 顧客担当者の更新 顧客担当者を更新します。 Operation ID: V1_CustomerStaffService_UpdateCustomerStaff Tags: scalebase.public.v1.CustomerStaffService Parameters: - body: v1.CustomerStaff Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → UpdateCustomerStaffResponse --- ### GET /v1/customfield/master/list カスタムフィールドマスターの一覧取得 カスタムフィールドマスターを一覧取得します。 Operation ID: V1_CustomFieldService_ListCustomFieldMasters2 Tags: scalebase.public.v1.CustomFieldService Parameters: - pageToken (query, optional): 一覧取得に使用するトークン - pageSize (query, required): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListCustomFieldMastersResponse ### POST /v1/customfield/master/list カスタムフィールドマスターの一覧取得 カスタムフィールドマスターを一覧取得します。 Operation ID: V1_CustomFieldService_ListCustomFieldMasters Tags: scalebase.public.v1.CustomFieldService Parameters: - body: ListCustomFieldMastersRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListCustomFieldMastersResponse --- ### POST /v1/customfield/resource/batchupdate カスタムフィールド一括更新 複数リソースのカスタムフィールドを一括で更新します。 Operation ID: V1_CustomFieldService_BatchUpdateResources Tags: scalebase.public.v1.CustomFieldService Parameters: - body: BatchUpdateResourcesRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → BatchUpdateResourcesResponse --- ### GET /v1/customfield/resource/get 対象リソースのカスタムフィールド取得 対象リソースのカスタムフィールド取得します。 Operation ID: V1_CustomFieldService_GetResource2 Tags: scalebase.public.v1.CustomFieldService Parameters: - srn.resourceId (query, required): リソースID - srn.resourceType (query, required): string Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → GetResourceResponse ### POST /v1/customfield/resource/get 対象リソースのカスタムフィールド取得 対象リソースのカスタムフィールド取得します。 Operation ID: V1_CustomFieldService_GetResource Tags: scalebase.public.v1.CustomFieldService Parameters: - body: GetResourceRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → GetResourceResponse --- ### PATCH /v1/customfield/resource/update カスタムフィールド更新 カスタムフィールドの更新を行います。 Operation ID: V1_CustomFieldService_UpdateResource Tags: scalebase.public.v1.CustomFieldService Parameters: - body: Resource Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → UpdateResourceResponse --- ### POST /v1/expectedbilling/changequantity 契約数変更に伴う請求予定の再計算（単一の請求予定を返す） 注意事項: - 契約サービスのメインアイテムに属する課金項目のみ指定が可能です。オプションアイテムの請求予定の取得には現時点で非対応です Operation ID: V1_ExpectedBillingService_ChangeQuantityExpectedBilling Tags: scalebase.public.v1.ExpectedBillingService Parameters: - body: ChangeQuantityExpectedBillingRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ChangeQuantityExpectedBillingResponse --- ### GET /v1/expectedbilling/listbycontract 請求予定の一覧取得 契約に紐づく請求予定一覧 Operation ID: V1_ExpectedBillingService_ListExpectedBillingsByContract2 Tags: scalebase.public.v1.ExpectedBillingService Parameters: - id (query, required): 契約ID - optionalId (query, optional): 契約管理ID(IDの代わりに指定可) - pageToken (query, optional): 一覧取得に使用するトークン - pageSize (query, optional): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListExpectedBillingsByContractResponse ### POST /v1/expectedbilling/listbycontract 請求予定の一覧取得 契約に紐づく請求予定一覧 Operation ID: V1_ExpectedBillingService_ListExpectedBillingsByContract Tags: scalebase.public.v1.ExpectedBillingService Parameters: - body: ListExpectedBillingsByContractRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListExpectedBillingsByContractResponse --- ### POST /v1/expectedbilling/renewalwithquantitychange 契約更新と数量変更に伴う請求予定の計算 注意事項: - 契約サービスのメインアイテムに属する課金項目のみ指定が可能です。オプションアイテムの請求予定の取得には現時点で非対応です Operation ID: V1_ExpectedBillingService_RenewalWithQuantityChangeExpectedBilling Tags: scalebase.public.v1.ExpectedBillingService Parameters: - body: RenewalWithQuantityChangeExpectedBillingRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → RenewalWithQuantityChangeExpectedBillingResponse --- ### GET /v1/hc ヘルスチェック APIの稼働状況を確認します。 Operation ID: V1_ZzHealthService_Check Tags: scalebase.public.v1.ZzHealthService Parameters: None Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → public.v1.CheckResponse --- ### GET /v1/paymentmethod/get 決済方法の取得 決済方法を取得します。 Operation ID: V1_PaymentMethodService_GetPaymentMethod2 Tags: scalebase.public.v1.PaymentMethodService Parameters: - id (query, optional): 決済方法ID - optionalId (query, optional): 決済方法管理ID(決済方法IDの代わりに指定可) Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → GetPaymentMethodResponse ### POST /v1/paymentmethod/get 決済方法の取得 決済方法を取得します。 Operation ID: V1_PaymentMethodService_GetPaymentMethod Tags: scalebase.public.v1.PaymentMethodService Parameters: - body: GetPaymentMethodRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → GetPaymentMethodResponse --- ### GET /v1/paymentmethod/list 決済方法の一覧取得 決済方法の一覧を取得します。 Operation ID: V1_PaymentMethodService_ListPaymentMethods2 Tags: scalebase.public.v1.PaymentMethodService Parameters: - pageToken (query, optional): 一覧取得に使用するトークン [デフォルト: 10 / 最小: 1 / 最大: 100] - pageSize (query, required): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - orderBy.field (query, optional): - FIELD_ID: 請求ID - orderBy.direction (query, optional): - DIRECTION_ASCENDING: 昇順 - DIRECTION_DESCENDING: 降順 Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListPaymentMethodsResponse ### POST /v1/paymentmethod/list 決済方法の一覧取得 決済方法の一覧を取得します。 Operation ID: V1_PaymentMethodService_ListPaymentMethods Tags: scalebase.public.v1.PaymentMethodService Parameters: - body: ListPaymentMethodsRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListPaymentMethodsResponse --- ### POST /v1/product/create プロダクトの作成 プロダクトを作成します。 Operation ID: V1_ProductService_CreateProduct Tags: scalebase.public.v1.ProductService Parameters: - body: CreateProductRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → CreateProductResponse --- ### GET /v1/product/get プロダクトの取得 指定したプロダクトを取得します。 Operation ID: V1_ProductService_GetProduct2 Tags: scalebase.public.v1.ProductService Parameters: - id (query, required): プロダクトID - optionalId (query, optional): プロダクト管理ID(プロダクトIDの代わりに指定可) Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → GetProductResponse ### POST /v1/product/get プロダクトの取得 指定したプロダクトを取得します。 Operation ID: V1_ProductService_GetProduct Tags: scalebase.public.v1.ProductService Parameters: - body: GetProductRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → GetProductResponse --- ### GET /v1/provider/get プロバイダーの取得 プロバイダーを取得します。 Operation ID: V1_ProviderService_GetProvider2 Tags: scalebase.public.v1.ProviderService Parameters: None Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → public.v1.GetProviderResponse ### POST /v1/provider/get プロバイダーの取得 プロバイダーを取得します。 Operation ID: V1_ProviderService_GetProvider Tags: scalebase.public.v1.ProviderService Parameters: - body: public.v1.GetProviderRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → public.v1.GetProviderResponse --- ### POST /v1/usage/daily/upsert 使用量(日毎)の更新 指定した使用量を作成or更新します。 Operation ID: V1_UsageService_UpsertDailyUsage Tags: scalebase.public.v1.UsageService Parameters: - body: UpsertDailyUsageRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → UpsertDailyUsageResponse --- ### POST /v1/usage/daily/upsertbycontractandusageunit 契約と使用量単位による使用量(日毎)の更新 指定した使用量を作成or更新します。 Operation ID: V1_UsageService_UpsertDailyUsageByContractAndUsageUnit Tags: scalebase.public.v1.UsageService Parameters: - body: UpsertDailyUsageByContractAndUsageUnitRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → UpsertDailyUsageByContractAndUsageUnitResponse --- ### POST /v1/usage/daily/upsertbyoptionalid 契約と使用量単位による使用量(日毎)の更新(非推奨) 指定した使用量を作成or更新します。同等の機能を提供する /v1/usage/daily/upsertbycontractandusageunit に移行してください。 Operation ID: V1_UsageService_UpsertDailyUsageByOptionalId Tags: scalebase.public.v1.UsageService Parameters: - body: UpsertDailyUsageByOptionalIdRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → UpsertDailyUsageByOptionalIdResponse --- ### GET /v1/usageunit/get 使用量単位の取得 使用量単位を取得します。 Operation ID: V1_UsageService_GetUsageUnit2 Tags: scalebase.public.v1.UsageService Parameters: - id (query, required): 使用量単位ID - optionalId (query, optional): 使用量単位管理ID(使用量単位IDの代わりに指定可) Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → GetUsageUnitResponse ### POST /v1/usageunit/get 使用量単位の取得 使用量単位を取得します。 Operation ID: V1_UsageService_GetUsageUnit Tags: scalebase.public.v1.UsageService Parameters: - body: GetUsageUnitRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → GetUsageUnitResponse --- ### GET /v1/usageunit/list 使用量単位一覧の取得 使用量単位一覧を取得します。 Operation ID: V1_UsageService_ListUsageUnits2 Tags: scalebase.public.v1.UsageService Parameters: - pageToken (query, optional): 一覧取得に使用するトークン - pageSize (query, required): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListUsageUnitsResponse ### POST /v1/usageunit/list 使用量単位一覧の取得 使用量単位一覧を取得します。 Operation ID: V1_UsageService_ListUsageUnits Tags: scalebase.public.v1.UsageService Parameters: - body: ListUsageUnitsRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListUsageUnitsResponse --- ### POST /v2/amendment/cancelcontractservice 契約サービスの解約 指定した契約サービスを途中解約します Operation ID: V2_AmendmentService_CancelContractService Tags: scalebase.public.v2.AmendmentService Parameters: - body: CancelContractServiceRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → CancelContractServiceResponse --- ### POST /v2/contract/confirmdraft 契約の下書き解除 下書き状態の契約を確定し、通常の契約にします。 既に下書きが解除された契約に対して実行した場合も正常に完了します（冪等）。 この操作は不可逆です。一度解除した契約を再び下書きに戻すことはできません。 Operation ID: V2_ContractService_ConfirmDraftContract Tags: scalebase.public.v2.ContractService Parameters: - body: v2.ConfirmDraftContractRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → v2.ConfirmDraftContractResponse --- ### POST /v2/contract/create 契約の作成 新規に契約を作成します。 Operation ID: V2_ContractService_CreateContract Tags: scalebase.public.v2.ContractService Parameters: - body: v2.CreateContractRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → v2.CreateContractResponse --- ### GET /v2/contract/get 契約の取得 指定されたIDを持つ契約を取得します。 Operation ID: V2_ContractService_GetContract2 Tags: scalebase.public.v2.ContractService Parameters: - id (query, required): 契約ID - atPointInServiceTimeline (query, optional): 契約サービスタイムラインのどの時点での契約を取得するかの指定。 指定しない場合は、契約サービスタイムラインの最も未来の時点での契約の状態が返却される。 Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → v2.GetContractResponse ### POST /v2/contract/get 契約の取得 指定されたIDを持つ契約を取得します。 Operation ID: V2_ContractService_GetContract Tags: scalebase.public.v2.ContractService Parameters: - body: v2.GetContractRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → v2.GetContractResponse --- ### GET /v2/contract/getbyoptionalid 契約管理IDを指定した契約の取得 指定された契約管理IDを持つ契約を取得します。 Operation ID: V2_ContractService_GetContractByOptionalId2 Tags: scalebase.public.v2.ContractService Parameters: - optionalId (query, required): 契約管理ID - atPointInServiceTimeline (query, optional): 契約サービスタイムラインのどの時点での契約を取得するかの指定。 指定しない場合は、契約サービスタイムラインの最も未来の時点での契約の状態が返却される。 Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → v2.GetContractByOptionalIdResponse ### POST /v2/contract/getbyoptionalid 契約管理IDを指定した契約の取得 指定された契約管理IDを持つ契約を取得します。 Operation ID: V2_ContractService_GetContractByOptionalId Tags: scalebase.public.v2.ContractService Parameters: - body: v2.GetContractByOptionalIdRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → v2.GetContractByOptionalIdResponse --- ### GET /v2/contract/list 契約の一覧取得 条件に一致する契約の一覧を取得します。 Operation ID: V2_ContractService_ListContracts2 Tags: scalebase.public.v2.ContractService Parameters: - sortOrder.field (query, optional): - FIELD_ID: 契約ID - FIELD_CONTRACT_END_DATE: 契約終了日 - sortOrder.direction (query, optional): - DIRECTION_ASCENDING: 昇順 - DIRECTION_DESCENDING: 降順 - offsetToken (query, optional): オフセット情報を含むページングトークン。 - pageSize (query, optional): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → v2.ListContractsResponse ### POST /v2/contract/list 契約の一覧取得 条件に一致する契約の一覧を取得します。 Operation ID: V2_ContractService_ListContracts Tags: scalebase.public.v2.ContractService Parameters: - body: v2.ListContractsRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → v2.ListContractsResponse --- ### GET /v2/contract/listatdate 契約の一覧取得（契約サービスタイムライン上での日付指定あり） 条件に一致する契約の一覧を、契約サービスタイムライン上で指定された日付における状態で取得します。 Operation ID: V2_ContractService_ListContractsAtDate2 Tags: scalebase.public.v2.ContractService Parameters: - sortOrder.field (query, optional): - FIELD_ID: 契約ID - FIELD_CONTRACT_END_DATE: 契約終了日 - sortOrder.direction (query, optional): - DIRECTION_ASCENDING: 昇順 - DIRECTION_DESCENDING: 降順 - offsetToken (query, optional): オフセット情報を含むページングトークン。 - pageSize (query, optional): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - atPointInServiceTimeline (query, required): 契約サービスタイムラインのどの時点での契約を取得するかの指定。 Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListContractsAtDateResponse ### POST /v2/contract/listatdate 契約の一覧取得（契約サービスタイムライン上での日付指定あり） 条件に一致する契約の一覧を、契約サービスタイムライン上で指定された日付における状態で取得します。 Operation ID: V2_ContractService_ListContractsAtDate Tags: scalebase.public.v2.ContractService Parameters: - body: ListContractsAtDateRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → ListContractsAtDateResponse --- ### POST /v2/contract/service/add 契約のサービス追加 既存の契約に新しいサービス（メインアイテム・オプションアイテム）を追加します。 Operation ID: V2_ContractService_AddContractService Tags: scalebase.public.v2.ContractService Parameters: - body: AddContractServiceRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → AddContractServiceResponse --- ### POST /v2/contract/updatepaymentmethod 決済方法変更 契約の決済方法を変更します。 契約IDまたは契約管理IDのいずれかで契約を指定できます。 Operation ID: V2_ContractService_UpdatePaymentMethod Tags: scalebase.public.v2.ContractService Parameters: - body: UpdatePaymentMethodRequest Responses: - default: An unexpected error response. → rpc.Status - 2XX: A successful response. → UpdatePaymentMethodResponse --- ## Data Models ### AddContractServiceRequest Type: object - contract (object): 契約識別子 - mainItem (object): 追加するメインアイテム - optionItems (array): 追加するオプションアイテム - **contract**: object — 契約識別子 - **mainItem**: object — 追加するメインアイテム - **optionItems**: array — 追加するオプションアイテム --- ### AddContractServiceRequest.CatalogItemIdentifier Type: object - catalogItemId (string): カタログアイテムID - catalogItemOptionalId (string): カタログアイテム管理ID(カタログアイテムIDの代わりに指定可) - **catalogItemId**: string — カタログアイテムID - **catalogItemOptionalId**: string — カタログアイテム管理ID(カタログアイテムIDの代わりに指定可) --- ### AddContractServiceRequest.ChargeItem Type: object - catalogChargeItemId (string): カタログ課金項目ID - name (string): 請求書記載名(省略時はカタログ参照) - quantity (integer): 契約数。すべての料金モデルで使用できます。定額制の場合は1に正規化されます - billAllAtOnce (boolean): 一括請求オプション(省略時はカタログ参照) - optionalId (string): 課金項目管理ID - pricing (object): 料金設定(省略時はカタログ参照) - billingTiming (object): 請求タイミング(省略時はカタログ参照) - billingDueTiming (object): 支払期限タイミング(省略時はカタログ参照) - billingCycle (object): 請求周期(省略時はカタログ参照) - **catalogChargeItemId**: string — カタログ課金項目ID - **name**: string — 請求書記載名(省略時はカタログ参照) - **quantity**: integer — 契約数。すべての料金モデルで使用できます。定額制の場合は1に正規化されます - **billAllAtOnce**: boolean — 一括請求オプション(省略時はカタログ参照) - **optionalId**: string — 課金項目管理ID - **pricing**: object — 料金設定(省略時はカタログ参照) - **billingTiming**: object — 請求タイミング(省略時はカタログ参照) - **billingDueTiming**: object — 支払期限タイミング(省略時はカタログ参照) - **billingCycle**: object — 請求周期(省略時はカタログ参照) --- ### AddContractServiceRequest.ChargeItem.Pricing Type: object - price (integer): 単一価格（定額制または従量制のみ） - tiers (array): ティア（段階的価格設定） - **price**: integer — 単一価格（定額制または従量制のみ） - **tiers**: array — ティア（段階的価格設定） --- ### AddContractServiceRequest.ChargeItem.Tier Type: object - upperLimit (string): 上限値（最後のティアのみ省略可） - feeFormula (object): 料金計算式 - unitPrice (string): 単価。定額制の場合はこの値がそのまま料金となり、従量制の場合は数量との積算で料金が決まる - **upperLimit**: string — 上限値（最後のティアのみ省略可） - **feeFormula**: object — 料金計算式 - **unitPrice**: string — 単価。定額制の場合はこの値がそのまま料金となり、従量制の場合は数量との積算で料金が決まる --- ### AddContractServiceRequest.ChargeItem.Tier.FeeFormula - FEE_FORMULA_PER_UNIT: 従量 - FEE_FORMULA_FLAT_FEE: 定額 Type: string Enum values: FEE_FORMULA_UNSPECIFIED, FEE_FORMULA_PER_UNIT, FEE_FORMULA_FLAT_FEE Enum values: FEE_FORMULA_UNSPECIFIED, FEE_FORMULA_PER_UNIT, FEE_FORMULA_FLAT_FEE --- ### AddContractServiceRequest.ContractIdentifier Type: object - contractId (string): 契約ID - contractOptionalId (string): 契約管理ID（契約IDの代わりに指定可） - **contractId**: string — 契約ID - **contractOptionalId**: string — 契約管理ID（契約IDの代わりに指定可） --- ### AddContractServiceRequest.MainItem Type: object - catalogItemIdentifier (object): - name (string): アイテム名(省略時はカタログ参照) - startDate (string): 契約開始日 - endDate (string): 契約終了日(省略時はカタログの契約期間から算出) - defaultContractTerm (object): 基本契約期間(省略時はカタログ参照) - chargeItems (array): 契約課金項目(省略時はカタログ参照) - availabilityCycle (object): 利用周期(省略時はカタログ参照) - autoRenewal (object): 自動更新設定(省略時はカタログの自動更新設定が継承されます) - **catalogItemIdentifier**: object — - **name**: string — アイテム名(省略時はカタログ参照) - **startDate**: string — 契約開始日 - **endDate**: string — 契約終了日(省略時はカタログの契約期間から算出) - **defaultContractTerm**: object — 基本契約期間(省略時はカタログ参照) - **chargeItems**: array — 契約課金項目(省略時はカタログ参照) - **availabilityCycle**: object — 利用周期(省略時はカタログ参照) - **autoRenewal**: object — 自動更新設定(省略時はカタログの自動更新設定が継承されます) --- ### AddContractServiceRequest.OptionItem Type: object - catalogItemIdentifier (object): - name (string): アイテム名(省略時はカタログ参照) - startDate (string): 契約開始日(省略時はメインの開始日と同一になる) - endDate (string): 契約終了日(省略時はカタログの契約期間から算出、メインアイテムの終了日を超えないよう補正される) - defaultContractTerm (object): 基本契約期間(省略時はカタログの契約期間から適用) - chargeItems (array): 契約課金項目(省略時はカタログ参照) - availabilityCycle (object): 利用周期(省略時はカタログ参照) - autoRenewal (object): 自動更新設定(省略時はカタログの自動更新設定が継承されます) - **catalogItemIdentifier**: object — - **name**: string — アイテム名(省略時はカタログ参照) - **startDate**: string — 契約開始日(省略時はメインの開始日と同一になる) - **endDate**: string — 契約終了日(省略時はカタログの契約期間から算出、メインアイテムの終了日を超えないよう補正される) - **defaultContractTerm**: object — 基本契約期間(省略時はカタログの契約期間から適用) - **chargeItems**: array — 契約課金項目(省略時はカタログ参照) - **availabilityCycle**: object — 利用周期(省略時はカタログ参照) - **autoRenewal**: object — 自動更新設定(省略時はカタログの自動更新設定が継承されます) --- ### AddContractServiceRequest.Term Type: object - value (integer): 期間数 - unit (object): 単位 - **value**: integer — 期間数 - **unit**: object — 単位 --- ### AddContractServiceRequest.Term.Unit - UNIT_MONTHLY: 月 Type: string Enum values: UNIT_UNSPECIFIED, UNIT_MONTHLY Enum values: UNIT_UNSPECIFIED, UNIT_MONTHLY --- ### AddContractServiceResponse Type: object - contract (object): 更新された契約 - **contract**: object — 更新された契約 --- ### AddOptionItemRequest Type: object - contractId (string): 対象の契約ID - primalContractItemId (string): (DEPRECATED: contract_item_id をお使いください) 親となる契約アイテムID - contractItemId (string): 親となる契約アイテムID - effectiveStartDate (string): 改定の有効開始日(RFC 3339 format) - item (object): 追加するアイテム - memo (string): 改定メモ - **contractId**: string — 対象の契約ID - **primalContractItemId**: string — (DEPRECATED: contract_item_id をお使いください) 親となる契約アイテムID - **contractItemId**: string — 親となる契約アイテムID - **effectiveStartDate**: string — 改定の有効開始日(RFC 3339 format) - **item**: object — 追加するアイテム - **memo**: string — 改定メモ --- ### AddOptionItemRequest.ChargeItem Type: object - catalogChargeItemId (string): カタログ課金項目ID - optionalId (string): カタログ課金項目管理ID(半角英数字と_-のみ使用できます) - billAllAtOnce (boolean): 一括請求オプション。指定しなければカタログアイテムに従います - quantity (integer): 契約数。料金モデルが従量制の場合に使用できます - name (string): 課金項目名。指定しなければカタログアイテムに従います - price (integer): 単価。カタログの料金モデルが定額または従量制のみで使用できます。指定しなければカタログアイテムに従います - billingTiming (object): 請求タイミング - billingDueTiming (object): 支払期限タイミング - tiers (array): ティア（段階別価格設定）。ボリューム/段階制の料金モデルで使用します。priceとは排他的です - **catalogChargeItemId**: string — カタログ課金項目ID - **optionalId**: string — カタログ課金項目管理ID(半角英数字と_-のみ使用できます) - **billAllAtOnce**: boolean — 一括請求オプション。指定しなければカタログアイテムに従います - **quantity**: integer — 契約数。料金モデルが従量制の場合に使用できます - **name**: string — 課金項目名。指定しなければカタログアイテムに従います - **price**: integer — 単価。カタログの料金モデルが定額または従量制のみで使用できます。指定しなければカタログアイテムに従います - **billingTiming**: object — 請求タイミング - **billingDueTiming**: object — 支払期限タイミング - **tiers**: array — ティア（段階別価格設定）。ボリューム/段階制の料金モデルで使用します。priceとは排他的です --- ### AddOptionItemRequest.ChargeItem.Tier Type: object - upperLimit (string): ティアの上限値。省略時は上限なし（最後のティア） - kind (object): 料金計算式の種類 - unitPrice (string): 単価（KIND_PER_UNIT時に使用） - price (string): 定額価格（KIND_FLAT_FEE時に使用） - **upperLimit**: string — ティアの上限値。省略時は上限なし（最後のティア） - **kind**: object — 料金計算式の種類 - **unitPrice**: string — 単価（KIND_PER_UNIT時に使用） - **price**: string — 定額価格（KIND_FLAT_FEE時に使用） --- ### AddOptionItemRequest.ChargeItem.Tier.Kind - KIND_UNSPECIFIED: 未指定 - KIND_PER_UNIT: 従量制（単価×数量） - KIND_FLAT_FEE: 定額制 Type: string Enum values: KIND_UNSPECIFIED, KIND_PER_UNIT, KIND_FLAT_FEE Enum values: KIND_UNSPECIFIED, KIND_PER_UNIT, KIND_FLAT_FEE --- ### AddOptionItemRequest.ChargeItem.Timing Type: object - value (integer): 数(負数の場合は前を表す。例: { "value": -1, "unit": "UNIT_MONTHLY" } => 先月) - unit (object): 単位 - monthlyOption (object): UNIT_MONTHLY指定時のオプション - **value**: integer — 数(負数の場合は前を表す。例: { "value": -1, "unit": "UNIT_MONTHLY" } => 先月) - **unit**: object — 単位 - **monthlyOption**: object — UNIT_MONTHLY指定時のオプション --- ### AddOptionItemRequest.ChargeItem.Timing.MonthlyOption - MONTHLY_OPTION_FIRST_DAY_OF_MONTH: alias MONTHLY_OPTION_DAY_1 Type: string Enum values: MONTHLY_OPTION_UNSPECIFIED, MONTHLY_OPTION_DAY_1, MONTHLY_OPTION_DAY_2, MONTHLY_OPTION_DAY_3, MONTHLY_OPTION_DAY_4, MONTHLY_OPTION_DAY_5, MONTHLY_OPTION_DAY_6, MONTHLY_OPTION_DAY_7, MONTHLY_OPTION_DAY_8, MONTHLY_OPTION_DAY_9, MONTHLY_OPTION_DAY_10, MONTHLY_OPTION_DAY_11, MONTHLY_OPTION_DAY_12, MONTHLY_OPTION_DAY_13, MONTHLY_OPTION_DAY_14, MONTHLY_OPTION_DAY_15, MONTHLY_OPTION_DAY_16, MONTHLY_OPTION_DAY_17, MONTHLY_OPTION_DAY_18, MONTHLY_OPTION_DAY_19, MONTHLY_OPTION_DAY_20, MONTHLY_OPTION_DAY_21, MONTHLY_OPTION_DAY_22, MONTHLY_OPTION_DAY_23, MONTHLY_OPTION_DAY_24, MONTHLY_OPTION_DAY_25, MONTHLY_OPTION_DAY_26, MONTHLY_OPTION_DAY_27, MONTHLY_OPTION_DAY_28, MONTHLY_OPTION_DAY_29, MONTHLY_OPTION_DAY_30, MONTHLY_OPTION_DAY_31, MONTHLY_OPTION_FIRST_DAY_OF_MONTH, MONTHLY_OPTION_LAST_DAY_OF_MONTH Enum values: MONTHLY_OPTION_UNSPECIFIED, MONTHLY_OPTION_DAY_1, MONTHLY_OPTION_DAY_2, MONTHLY_OPTION_DAY_3, MONTHLY_OPTION_DAY_4, MONTHLY_OPTION_DAY_5, MONTHLY_OPTION_DAY_6, MONTHLY_OPTION_DAY_7, MONTHLY_OPTION_DAY_8, MONTHLY_OPTION_DAY_9, MONTHLY_OPTION_DAY_10, MONTHLY_OPTION_DAY_11, MONTHLY_OPTION_DAY_12, MONTHLY_OPTION_DAY_13, MONTHLY_OPTION_DAY_14, MONTHLY_OPTION_DAY_15, MONTHLY_OPTION_DAY_16, MONTHLY_OPTION_DAY_17, MONTHLY_OPTION_DAY_18, MONTHLY_OPTION_DAY_19, MONTHLY_OPTION_DAY_20, MONTHLY_OPTION_DAY_21, MONTHLY_OPTION_DAY_22, MONTHLY_OPTION_DAY_23, MONTHLY_OPTION_DAY_24, MONTHLY_OPTION_DAY_25, MONTHLY_OPTION_DAY_26, MONTHLY_OPTION_DAY_27, MONTHLY_OPTION_DAY_28, MONTHLY_OPTION_DAY_29, MONTHLY_OPTION_DAY_30, MONTHLY_OPTION_DAY_31, MONTHLY_OPTION_FIRST_DAY_OF_MONTH, MONTHLY_OPTION_LAST_DAY_OF_MONTH --- ### AddOptionItemRequest.ChargeItem.Timing.Unit - UNIT_DAILY: 日 - UNIT_MONTHLY: 月 Type: string Enum values: UNIT_UNSPECIFIED, UNIT_DAILY, UNIT_MONTHLY Enum values: UNIT_UNSPECIFIED, UNIT_DAILY, UNIT_MONTHLY --- ### AddOptionItemRequest.OptionItem Type: object - catalogItemId (string): カタログアイテムID - endDate (string): 契約終了日(省略時はカタログの契約期間から算出(RFC 3339 format)) - defaultContractTerm (object): 基本契約期間(省略時はカタログの契約期間から適用) - chargeItems (array): 課金項目 - name (string): アイテム名。指定しなければカタログアイテムに従います。 - **catalogItemId**: string — カタログアイテムID - **endDate**: string — 契約終了日(省略時はカタログの契約期間から算出(RFC 3339 format)) - **defaultContractTerm**: object — 基本契約期間(省略時はカタログの契約期間から適用) - **chargeItems**: array — 課金項目 - **name**: string — アイテム名。指定しなければカタログアイテムに従います。 --- ### AddOptionItemRequest.Term Type: object - value (integer): 期間数 - unit (object): 単位 - **value**: integer — 期間数 - **unit**: object — 単位 --- ### AddOptionItemRequest.Term.Unit - UNIT_MONTHLY: 月 Type: string Enum values: UNIT_UNSPECIFIED, UNIT_MONTHLY Enum values: UNIT_UNSPECIFIED, UNIT_MONTHLY --- ### AddOptionItemResponse Type: object - contract (object): 対象の契約 - amendment (object): 改定 - **contract**: object — 対象の契約 - **amendment**: object — 改定 --- ### AddOptionItemResponse.Amendment Type: object - id (string): - **id**: string — --- ### AddOptionItemResponse.Contract Type: object - id (string): - **id**: string — --- ### AliasContractRequest Type: object - id (string): 契約ID - optionalId (string): 契約管理ID - **id**: string — 契約ID - **optionalId**: string — 契約管理ID --- ### AliasContractResponse Type: object - contract (object): 契約 - **contract**: object — 契約 --- ### AliasCustomerRequest Type: object - id (string): 顧客ID - optionalId (string): 顧客管理ID(未指定の場合、管理IDの割当を解除) - **id**: string — 顧客ID - **optionalId**: string — 顧客管理ID(未指定の場合、管理IDの割当を解除) --- ### AliasCustomerResponse Type: object - customer (object): 顧客 - **customer**: object — 顧客 --- ### AliasCustomerStaffRequest Type: object - id (string): 顧客担当者ID - optionalId (string): 顧客担当者管理ID(未指定の場合、管理IDの設定を解除) - customerId (string): 顧客ID - customerOptionalId (string): 顧客管理ID(顧客IDの代わりに指定可) - **id**: string — 顧客担当者ID - **optionalId**: string — 顧客担当者管理ID(未指定の場合、管理IDの設定を解除) - **customerId**: string — 顧客ID - **customerOptionalId**: string — 顧客管理ID(顧客IDの代わりに指定可) --- ### AliasCustomerStaffResponse Type: object - customerStaff (object): 顧客担当者 - **customerStaff**: object — 顧客担当者 --- ### Amendment.Type Type: string Enum values: TYPE_UNSPECIFIED, TYPE_ADD_ITEM, TYPE_CHANGE_ITEM, TYPE_CUSTOMIZE_ITEM, TYPE_CHANGE_CHARGE_ITEM_QUANTITY, TYPE_RENEW_ITEM, TYPE_CANCEL_ITEM Enum values: TYPE_UNSPECIFIED, TYPE_ADD_ITEM, TYPE_CHANGE_ITEM, TYPE_CUSTOMIZE_ITEM, TYPE_CHANGE_CHARGE_ITEM_QUANTITY, TYPE_RENEW_ITEM, TYPE_CANCEL_ITEM --- ### Any Type: object - @type (string): - **@type**: string — --- ### AnyItemHasStatusInFilterClause Type: object - statuses (array): - **statuses**: array — --- ### AutoRenewal Type: object - type (object): 自動更新タイプ - term (object): 自動更新タイミング（typeがENABLEDの場合のみ必須） - **type**: object — 自動更新タイプ - **term**: object — 自動更新タイミング（typeがENABLEDの場合のみ必須） --- ### AutoRenewal.Term Type: object - value (integer): 期間数（自動更新の場合は0以下の値を指定） 契約終了日より前の日付を指定する必要があるため、マイナス値を使用します 例: -10 (契約終了日の10日前に自動更新), -1 (契約終了日の1ヶ月前に自動更新 ※unitがMONTHLYの場合) - unit (object): 単位 - **value**: integer — 期間数（自動更新の場合は0以下の値を指定） 契約終了日より前の日付を指定する必要があるため、マイナス値を使用します 例: -10 (契約終了日の10日前に自動更新), -1 (契約終了日の1ヶ月前に自動更新 ※unitがMONTHLYの場合) - **unit**: object — 単位 --- ### AutoRenewal.Term.Unit Type: string Enum values: UNIT_UNSPECIFIED, UNIT_DAILY, UNIT_MONTHLY Enum values: UNIT_UNSPECIFIED, UNIT_DAILY, UNIT_MONTHLY --- ### AutoRenewal.Type - TYPE_DISABLED: 自動更新しない - TYPE_ENABLED: 自動更新する Type: string Enum values: TYPE_UNSPECIFIED, TYPE_DISABLED, TYPE_ENABLED Enum values: TYPE_UNSPECIFIED, TYPE_DISABLED, TYPE_ENABLED --- ### AutoRenewalSetting 契約アイテム(プラン・定額アドオン)を契約終了時に自動更新するかどうかを表す。 このフィールド自体を省略した場合は、カタログアイテムの自動更新設定がそのまま継承される。 Type: object - type (object): 自動更新タイプ - term (object): 自動更新タイミング(typeがTYPE_ENABLEDの場合のみ必須) - **type**: object — 自動更新タイプ - **term**: object — 自動更新タイミング(typeがTYPE_ENABLEDの場合のみ必須) --- ### AutoRenewalSetting.Term Type: object - value (integer): 期間数。契約終了日当日もしくはそれ以前の日付を表すため、 UNIT_DAILY の場合は0以下、UNIT_MONTHLY の場合は負数(0は不可)を指定する。 例: { "value": -1, "unit": "UNIT_MONTHLY" } => 契約終了日の1ヶ月前に自動更新 - unit (object): 単位 - **value**: integer — 期間数。契約終了日当日もしくはそれ以前の日付を表すため、 UNIT_DAILY の場合は0以下、UNIT_MONTHLY の場合は負数(0は不可)を指定する。 例: { "value": -1, "unit": "UNIT_MONTHLY" } => 契約終了日の1ヶ月前に自動更新 - **unit**: object — 単位 --- ### AutoRenewalSetting.Term.Unit - UNIT_DAILY: 日 - UNIT_MONTHLY: 月 Type: string Enum values: UNIT_UNSPECIFIED, UNIT_DAILY, UNIT_MONTHLY Enum values: UNIT_UNSPECIFIED, UNIT_DAILY, UNIT_MONTHLY --- ### AutoRenewalSetting.Type - TYPE_DISABLED: 自動更新しない - TYPE_ENABLED: 自動更新する Type: string Enum values: TYPE_UNSPECIFIED, TYPE_DISABLED, TYPE_ENABLED Enum values: TYPE_UNSPECIFIED, TYPE_DISABLED, TYPE_ENABLED --- ### AvailabilityCycle Type: object - value (integer): 期間数 - unit (object): 単位 - **value**: integer — 期間数 - **unit**: object — 単位 --- ### AvailabilityCycle.Unit - UNIT_MONTHLY: 月 Type: string Enum values: UNIT_UNSPECIFIED, UNIT_MONTHLY Enum values: UNIT_UNSPECIFIED, UNIT_MONTHLY --- ### BatchRecordPaymentsRequest Type: object - payments (array): 入金情報リスト [最小: 1 / 最大: 1000] - **payments**: array — 入金情報リスト [最小: 1 / 最大: 1000] --- ### BatchRecordPaymentsResponse Type: object - summary (object): 処理結果のサマリー - errors (array): 処理に失敗した請求 - **summary**: object — 処理結果のサマリー - **errors**: array — 処理に失敗した請求 --- ### BatchUpdateBillingStatusesRequest Type: object - byIds (object): 請求IDによる直接指定 - byCondition (object): 検索条件による指定 - status (object): 変更先のステータス - **byIds**: object — 請求IDによる直接指定 - **byCondition**: object — 検索条件による指定 - **status**: object — 変更先のステータス --- ### BatchUpdateBillingStatusesRequest.Status Type: string Enum values: STATUS_UNSPECIFIED, STATUS_UNBILLED, STATUS_INVOICE_CREATED, STATUS_POSTED Enum values: STATUS_UNSPECIFIED, STATUS_UNBILLED, STATUS_INVOICE_CREATED, STATUS_POSTED --- ### BatchUpdateBillingStatusesResponse Type: object - summary (object): 更新結果のサマリー - errors (array): 更新に失敗した請求 - **summary**: object — 更新結果のサマリー - **errors**: array — 更新に失敗した請求 --- ### BatchUpdateResourceItem Type: object - resource (object): リソース - **resource**: object — リソース --- ### BatchUpdateResourcesRequest Type: object - items (array): 更新対象リソースのリスト [最小: 1 / 最大: 100] - resourceType (object): リソース種別（リクエスト内の全アイテムで共通） - **items**: array — 更新対象リソースのリスト [最小: 1 / 最大: 100] - **resourceType**: object — リソース種別（リクエスト内の全アイテムで共通） --- ### BatchUpdateResourcesResponse Type: object - summary (object): 更新結果のサマリー - resources (array): 更新に成功したリソース - errors (array): 更新に失敗したリソース - **summary**: object — 更新結果のサマリー - **resources**: array — 更新に成功したリソース - **errors**: array — 更新に失敗したリソース --- ### Billing.CustomerStaff Type: object - id (string): 担当者ID - customerId (string): 顧客ID - customerName (string): 顧客名 - name (object): 担当者氏名 - emailAddress (string): メールアドレス - phoneNumber (string): 電話番号 - department (string): 部署 - title (string): 肩書 - address (object): 住所 - sortOrder (integer): 請求内の担当者の順序(0=主担当者,1以降=副担当者) - **id**: string — 担当者ID - **customerId**: string — 顧客ID - **customerName**: string — 顧客名 - **name**: object — 担当者氏名 - **emailAddress**: string — メールアドレス - **phoneNumber**: string — 電話番号 - **department**: string — 部署 - **title**: string — 肩書 - **address**: object — 住所 - **sortOrder**: integer — 請求内の担当者の順序(0=主担当者,1以降=副担当者) --- ### Billing.CustomerStaff.Address Type: object - zipCode (string): 郵便番号 - country (object): 国 - prefecture (object): 都道府県 - city (string): 市区郡 - addressLines (array): 町名・番地 - prefectureJa (string): 都道府県(日本語表記) - **zipCode**: string — 郵便番号 - **country**: object — 国 - **prefecture**: object — 都道府県 - **city**: string — 市区郡 - **addressLines**: array — 町名・番地 - **prefectureJa**: string — 都道府県(日本語表記) --- ### Billing.CustomerStaff.Address.Country Type: string Enum values: COUNTRY_UNSPECIFIED, COUNTRY_JP Enum values: COUNTRY_UNSPECIFIED, COUNTRY_JP --- ### Billing.CustomerStaff.Address.Prefecture Type: string Enum values: PREFECTURE_UNSPECIFIED, PREFECTURE_HOKKAIDO, PREFECTURE_AOMORI, PREFECTURE_IWATE, PREFECTURE_MIYAGI, PREFECTURE_AKITA, PREFECTURE_YAMAGATA, PREFECTURE_FUKUSHIMA, PREFECTURE_IBARAKI, PREFECTURE_TOCHIGI, PREFECTURE_GUNMA, PREFECTURE_SAITAMA, PREFECTURE_CHIBA, PREFECTURE_TOKYO, PREFECTURE_KANAGAWA, PREFECTURE_NIIGATA, PREFECTURE_TOYAMA, PREFECTURE_ISHIKAWA, PREFECTURE_FUKUI, PREFECTURE_YAMANASHI, PREFECTURE_NAGANO, PREFECTURE_GIFU, PREFECTURE_SHIZUOKA, PREFECTURE_AICHI, PREFECTURE_MIE, PREFECTURE_SHIGA, PREFECTURE_KYOTO, PREFECTURE_OSAKA, PREFECTURE_HYOGO, PREFECTURE_NARA, PREFECTURE_WAKAYAMA, PREFECTURE_TOTTORI, PREFECTURE_SHIMANE, PREFECTURE_OKAYAMA, PREFECTURE_HIROSHIMA, PREFECTURE_YAMAGUCHI, PREFECTURE_TOKUSHIMA, PREFECTURE_KAGAWA, PREFECTURE_EHIME, PREFECTURE_KOCHI, PREFECTURE_FUKUOKA, PREFECTURE_SAGA, PREFECTURE_NAGASAKI, PREFECTURE_KUMAMOTO, PREFECTURE_OITA, PREFECTURE_MIYAZAKI, PREFECTURE_KAGOSHIMA, PREFECTURE_OKINAWA Enum values: PREFECTURE_UNSPECIFIED, PREFECTURE_HOKKAIDO, PREFECTURE_AOMORI, PREFECTURE_IWATE, PREFECTURE_MIYAGI, PREFECTURE_AKITA, PREFECTURE_YAMAGATA, PREFECTURE_FUKUSHIMA, PREFECTURE_IBARAKI, PREFECTURE_TOCHIGI, PREFECTURE_GUNMA, PREFECTURE_SAITAMA, PREFECTURE_CHIBA, PREFECTURE_TOKYO, PREFECTURE_KANAGAWA, PREFECTURE_NIIGATA, PREFECTURE_TOYAMA, PREFECTURE_ISHIKAWA, PREFECTURE_FUKUI, PREFECTURE_YAMANASHI, PREFECTURE_NAGANO, PREFECTURE_GIFU, PREFECTURE_SHIZUOKA, PREFECTURE_AICHI, PREFECTURE_MIE, PREFECTURE_SHIGA, PREFECTURE_KYOTO, PREFECTURE_OSAKA, PREFECTURE_HYOGO, PREFECTURE_NARA, PREFECTURE_WAKAYAMA, PREFECTURE_TOTTORI, PREFECTURE_SHIMANE, PREFECTURE_OKAYAMA, PREFECTURE_HIROSHIMA, PREFECTURE_YAMAGUCHI, PREFECTURE_TOKUSHIMA, PREFECTURE_KAGAWA, PREFECTURE_EHIME, PREFECTURE_KOCHI, PREFECTURE_FUKUOKA, PREFECTURE_SAGA, PREFECTURE_NAGASAKI, PREFECTURE_KUMAMOTO, PREFECTURE_OITA, PREFECTURE_MIYAZAKI, PREFECTURE_KAGOSHIMA, PREFECTURE_OKINAWA --- ### Billing.CustomerStaff.Name Type: object - firstName (string): 顧客担当者の名 - lastName (string): 顧客担当者の姓 - **firstName**: string — 顧客担当者の名 - **lastName**: string — 顧客担当者の姓 --- ### Billing.Item Type: object - id (string): 請求項目ID - name (string): 請求項目名 - unitPrice (number): 単価 - quantity (string): 数量 - subtotal (number): 小計 - taxPercentage (integer): 税率 - startDate (string): 開始日(RFC 3339 format) - endDate (string): 終了日(RFC 3339 format) - catalogChargeItemId (string): カタログ課金項目ID - **id**: string — 請求項目ID - **name**: string — 請求項目名 - **unitPrice**: number — 単価 - **quantity**: string — 数量 - **subtotal**: number — 小計 - **taxPercentage**: integer — 税率 - **startDate**: string — 開始日(RFC 3339 format) - **endDate**: string — 終了日(RFC 3339 format) - **catalogChargeItemId**: string — カタログ課金項目ID --- ### BillingCondition Type: object - condition (object): 検索条件 - excludeBillingIds (array): 除外する請求IDリスト [最大: 10000] - **condition**: object — 検索条件 - **excludeBillingIds**: array — 除外する請求IDリスト [最大: 10000] --- ### BillingCycle Type: object - value (integer): 期間数 - unit (object): 単位 - **value**: integer — 期間数 - **unit**: object — 単位 --- ### BillingCycle.Unit - UNIT_MONTHLY: 月 Type: string Enum values: UNIT_UNSPECIFIED, UNIT_MONTHLY Enum values: UNIT_UNSPECIFIED, UNIT_MONTHLY --- ### BillingDate Type: object - gte (string): - lte (string): - **gte**: string — - **lte**: string — --- ### BillingIdList Type: object - billingIds (array): 対象請求IDリスト [最小: 1 / 最大: 1000] - **billingIds**: array — 対象請求IDリスト [最小: 1 / 最大: 1000] --- ### BillingOrder Type: object - field (object): - direction (object): - **field**: object — - **direction**: object — --- ### BillingOrder.Direction - DIRECTION_ASCENDING: 昇順 - DIRECTION_DESCENDING: 降順 Type: string Enum values: DIRECTION_UNSPECIFIED, DIRECTION_ASCENDING, DIRECTION_DESCENDING Enum values: DIRECTION_UNSPECIFIED, DIRECTION_ASCENDING, DIRECTION_DESCENDING --- ### BillingOrder.Field - FIELD_ID: 請求ID - FIELD_BILLING_DATE: 請求日 Type: string Enum values: FIELD_UNSPECIFIED, FIELD_ID, FIELD_BILLING_DATE Enum values: FIELD_UNSPECIFIED, FIELD_ID, FIELD_BILLING_DATE --- ### BillingUpdateError Type: object - billingId (string): 請求ID - errorType (object): エラータイプ - message (string): エラーメッセージ - **billingId**: string — 請求ID - **errorType**: object — エラータイプ - **message**: string — エラーメッセージ --- ### BillingUpdateError.ErrorType Type: string Enum values: ERROR_TYPE_UNSPECIFIED, ERROR_TYPE_NOT_FOUND, ERROR_TYPE_INVALID_TRANSITION, ERROR_TYPE_STORE_FAILED Enum values: ERROR_TYPE_UNSPECIFIED, ERROR_TYPE_NOT_FOUND, ERROR_TYPE_INVALID_TRANSITION, ERROR_TYPE_STORE_FAILED --- ### CancelAmendmentRequest Type: object - amendmentId (string): 改定ID - **amendmentId**: string — 改定ID --- ### CancelAmendmentResponse Type: object - contract (object): 対象の契約 - **contract**: object — 対象の契約 --- ### CancelAmendmentResponse.Contract Type: object - id (string): - **id**: string — --- ### CancelContractRequest Type: object - contractId (string): 契約ID - contractOptionalId (string): 契約管理ID(契約IDの代わりに指定可) - effectiveStartDate (string): 改定の有効開始日 - oldDailyRates (array): 解約時の終了月日割設定 - memo (string): 改定メモ - **contractId**: string — 契約ID - **contractOptionalId**: string — 契約管理ID(契約IDの代わりに指定可) - **effectiveStartDate**: string — 改定の有効開始日 - **oldDailyRates**: array — 解約時の終了月日割設定 - **memo**: string — 改定メモ --- ### CancelContractResponse Type: object - contract (object): 対象の契約 - amendments (array): 改定 - **contract**: object — 対象の契約 - **amendments**: array — 改定 --- ### CancelContractResponse.Amendment Type: object - id (string): - **id**: string — --- ### CancelContractResponse.Contract Type: object - id (string): - **id**: string — --- ### CancelContractServiceRequest Type: object - contractId (string): 契約ID - contractOptionalId (string): 契約管理ID(契約IDの代わりに指定可) - contractServiceId (string): 契約サービスID - effectiveStartDate (string): 改定の有効開始日 - lastAvailabilityDailyRates (array): 解約時の終了月日割設定 - memo (string): 改定メモ - **contractId**: string — 契約ID - **contractOptionalId**: string — 契約管理ID(契約IDの代わりに指定可) - **contractServiceId**: string — 契約サービスID - **effectiveStartDate**: string — 改定の有効開始日 - **lastAvailabilityDailyRates**: array — 解約時の終了月日割設定 - **memo**: string — 改定メモ --- ### CancelContractServiceResponse Type: object - amendment (object): 作成された改定 - **amendment**: object — 作成された改定 --- ### CancelContractServiceResponse.Amendment Type: object - id (string): 改定ID - **id**: string — 改定ID --- ### CancelOptionRequest Type: object - contractId (string): 契約ID - contractOptionalId (string): 契約管理ID(契約IDの代わりに指定可) - optionItemId (string): オプションアイテムID - effectiveStartDate (string): 改定の有効開始日 - lastAvailabilityDailyRates (array): 解約時の終了月日割設定 - memo (string): 改定メモ - **contractId**: string — 契約ID - **contractOptionalId**: string — 契約管理ID(契約IDの代わりに指定可) - **optionItemId**: string — オプションアイテムID - **effectiveStartDate**: string — 改定の有効開始日 - **lastAvailabilityDailyRates**: array — 解約時の終了月日割設定 - **memo**: string — 改定メモ --- ### CancelOptionResponse Type: object - contract (object): 対象の契約 - amendment (object): 改定 - **contract**: object — 対象の契約 - **amendment**: object — 改定 --- ### CancelOptionResponse.Amendment Type: object - id (string): - **id**: string — --- ### CancelOptionResponse.Contract Type: object - id (string): - **id**: string — --- ### CatalogChargeItem.DailyRate Type: object - type (object): - fixedRateValue (number): FIXED_RATE指定時の値 - **type**: object — - **fixedRateValue**: number — FIXED_RATE指定時の値 --- ### CatalogChargeItem.DailyRate.Type Type: string Enum values: TYPE_UNSPECIFIED, TYPE_FULL_PRICE, TYPE_DAILY_RATE, TYPE_FIXED_RATE Enum values: TYPE_UNSPECIFIED, TYPE_FULL_PRICE, TYPE_DAILY_RATE, TYPE_FIXED_RATE --- ### CatalogChargeItem.Timing Type: object - value (integer): 数(負数の場合は前を表す。例: { "value": -1, "unit": "UNIT_MONTHLY" } => 先月) - unit (object): 単位 - monthlyOption (object): UNIT_MONTHLY指定時のオプション - **value**: integer — 数(負数の場合は前を表す。例: { "value": -1, "unit": "UNIT_MONTHLY" } => 先月) - **unit**: object — 単位 - **monthlyOption**: object — UNIT_MONTHLY指定時のオプション --- ### CatalogChargeItem.Timing.MonthlyOption - MONTHLY_OPTION_FIRST_DAY_OF_MONTH: alias MONTHLY_OPTION_DAY_1 Type: string Enum values: MONTHLY_OPTION_UNSPECIFIED, MONTHLY_OPTION_DAY_1, MONTHLY_OPTION_DAY_2, MONTHLY_OPTION_DAY_3, MONTHLY_OPTION_DAY_4, MONTHLY_OPTION_DAY_5, MONTHLY_OPTION_DAY_6, MONTHLY_OPTION_DAY_7, MONTHLY_OPTION_DAY_8, MONTHLY_OPTION_DAY_9, MONTHLY_OPTION_DAY_10, MONTHLY_OPTION_DAY_11, MONTHLY_OPTION_DAY_12, MONTHLY_OPTION_DAY_13, MONTHLY_OPTION_DAY_14, MONTHLY_OPTION_DAY_15, MONTHLY_OPTION_DAY_16, MONTHLY_OPTION_DAY_17, MONTHLY_OPTION_DAY_18, MONTHLY_OPTION_DAY_19, MONTHLY_OPTION_DAY_20, MONTHLY_OPTION_DAY_21, MONTHLY_OPTION_DAY_22, MONTHLY_OPTION_DAY_23, MONTHLY_OPTION_DAY_24, MONTHLY_OPTION_DAY_25, MONTHLY_OPTION_DAY_26, MONTHLY_OPTION_DAY_27, MONTHLY_OPTION_DAY_28, MONTHLY_OPTION_DAY_29, MONTHLY_OPTION_DAY_30, MONTHLY_OPTION_DAY_31, MONTHLY_OPTION_FIRST_DAY_OF_MONTH, MONTHLY_OPTION_LAST_DAY_OF_MONTH Enum values: MONTHLY_OPTION_UNSPECIFIED, MONTHLY_OPTION_DAY_1, MONTHLY_OPTION_DAY_2, MONTHLY_OPTION_DAY_3, MONTHLY_OPTION_DAY_4, MONTHLY_OPTION_DAY_5, MONTHLY_OPTION_DAY_6, MONTHLY_OPTION_DAY_7, MONTHLY_OPTION_DAY_8, MONTHLY_OPTION_DAY_9, MONTHLY_OPTION_DAY_10, MONTHLY_OPTION_DAY_11, MONTHLY_OPTION_DAY_12, MONTHLY_OPTION_DAY_13, MONTHLY_OPTION_DAY_14, MONTHLY_OPTION_DAY_15, MONTHLY_OPTION_DAY_16, MONTHLY_OPTION_DAY_17, MONTHLY_OPTION_DAY_18, MONTHLY_OPTION_DAY_19, MONTHLY_OPTION_DAY_20, MONTHLY_OPTION_DAY_21, MONTHLY_OPTION_DAY_22, MONTHLY_OPTION_DAY_23, MONTHLY_OPTION_DAY_24, MONTHLY_OPTION_DAY_25, MONTHLY_OPTION_DAY_26, MONTHLY_OPTION_DAY_27, MONTHLY_OPTION_DAY_28, MONTHLY_OPTION_DAY_29, MONTHLY_OPTION_DAY_30, MONTHLY_OPTION_DAY_31, MONTHLY_OPTION_FIRST_DAY_OF_MONTH, MONTHLY_OPTION_LAST_DAY_OF_MONTH --- ### CatalogChargeItem.Timing.Unit - UNIT_MONTHLY: 月 Type: string Enum values: UNIT_UNSPECIFIED, UNIT_MONTHLY Enum values: UNIT_UNSPECIFIED, UNIT_MONTHLY --- ### CatalogItem Type: object - id (string): カタログアイテムID - optionalId (string): カタログアイテム管理ID - name (string): カタログアイテム名 - description (string): カタログアイテム概要 - productId (string): プロダクトID - availabilityClosingDate (object): 利用締め日 - availabilityCycle (object): 利用周期(例: 1月毎) - status (object): ステータス - defaultContractTerm (object): 更新時に延長される期間(旧:契約周期 effective_cycle) - contractSelectRule (object): 契約での取り扱い - catalogChargeItems (array): カタログ課金項目 - autoRenewal (object): 自動更新設定 - **id**: string — カタログアイテムID - **optionalId**: string — カタログアイテム管理ID - **name**: string — カタログアイテム名 - **description**: string — カタログアイテム概要 - **productId**: string — プロダクトID - **availabilityClosingDate**: object — 利用締め日 - **availabilityCycle**: object — 利用周期(例: 1月毎) - **status**: object — ステータス - **defaultContractTerm**: object — 更新時に延長される期間(旧:契約周期 effective_cycle) - **contractSelectRule**: object — 契約での取り扱い - **catalogChargeItems**: array — カタログ課金項目 - **autoRenewal**: object — 自動更新設定 --- ### CatalogItem.Status Type: string Enum values: STATUS_UNSPECIFIED, STATUS_ON_SALE, STATUS_DISCONTINUED Enum values: STATUS_UNSPECIFIED, STATUS_ON_SALE, STATUS_DISCONTINUED --- ### ChangeMainItemRequest Type: object - contractId (string): 契約ID - contractOptionalId (string): 契約管理ID(契約IDの代わりに指定可) - mainItemId (string): メインアイテムID - item (object): 乗り換え先のアイテム - memo (string): 改定メモ - **contractId**: string — 契約ID - **contractOptionalId**: string — 契約管理ID(契約IDの代わりに指定可) - **mainItemId**: string — メインアイテムID - **item**: object — 乗り換え先のアイテム - **memo**: string — 改定メモ --- ### ChangeMainItemRequest.Item Type: object - catalogItemId (string): カタログアイテムID - catalogItemOptionalId (string): カタログアイテム管理ID(カタログアイテムIDの代わりに指定可) - effectiveStartDate (string): 改定の有効開始日(省略時はアイテム終了日の翌日になります(RFC 3339 format)) - endDate (string): 契約終了日(省略時はカタログの契約期間から算出(RFC 3339 format)) - defaultContractTerm (object): 基本契約期間(省略時はカタログの契約期間から適用) - chargeItems (array): 課金項目 - name (string): アイテム名。指定しなければカタログアイテムに従います。 - **catalogItemId**: string — カタログアイテムID - **catalogItemOptionalId**: string — カタログアイテム管理ID(カタログアイテムIDの代わりに指定可) - **effectiveStartDate**: string — 改定の有効開始日(省略時はアイテム終了日の翌日になります(RFC 3339 format)) - **endDate**: string — 契約終了日(省略時はカタログの契約期間から算出(RFC 3339 format)) - **defaultContractTerm**: object — 基本契約期間(省略時はカタログの契約期間から適用) - **chargeItems**: array — 課金項目 - **name**: string — アイテム名。指定しなければカタログアイテムに従います。 --- ### ChangeMainItemRequest.Item.Term Type: object - value (integer): 期間数 - unit (object): 単位 - **value**: integer — 期間数 - **unit**: object — 単位 --- ### ChangeMainItemRequest.Item.Term.Unit - UNIT_MONTHLY: 月 Type: string Enum values: UNIT_UNSPECIFIED, UNIT_MONTHLY Enum values: UNIT_UNSPECIFIED, UNIT_MONTHLY --- ### ChangeMainItemResponse Type: object - contract (object): 対象の契約 - amendment (object): 改定 - **contract**: object — 対象の契約 - **amendment**: object — 改定 --- ### ChangeMainItemResponse.Amendment Type: object - id (string): - **id**: string — --- ### ChangeMainItemResponse.Contract Type: object - id (string): - **id**: string — --- ### ChangeOptionItemRequest Type: object - contractId (string): 契約ID - contractOptionalId (string): 契約管理ID(契約IDの代わりに指定可) - optionItemId (string): 乗換対象のオプションアイテムID - effectiveStartDate (string): 改定の有効開始日(乗換日)(RFC 3339 format) - item (object): 乗換先のオプションアイテム - lastAvailabilityDailyRates (array): 乗り換え前のオプションの終了月日割設定 - memo (string): 改定メモ - **contractId**: string — 契約ID - **contractOptionalId**: string — 契約管理ID(契約IDの代わりに指定可) - **optionItemId**: string — 乗換対象のオプションアイテムID - **effectiveStartDate**: string — 改定の有効開始日(乗換日)(RFC 3339 format) - **item**: object — 乗換先のオプションアイテム - **lastAvailabilityDailyRates**: array — 乗り換え前のオプションの終了月日割設定 - **memo**: string — 改定メモ --- ### ChangeOptionItemRequest.ChargeItem Type: object - catalogChargeItemId (string): カタログ課金項目ID - optionalId (string): カタログ課金項目管理ID(半角英数字と_-のみ使用できます) - billAllAtOnce (boolean): 一括請求オプション。指定しなければカタログアイテムに従います - quantity (integer): 契約数。料金モデルが従量制の場合に使用できます - name (string): 課金項目名。指定しなければカタログアイテムに従います - price (integer): 単価。カタログの料金モデルが定額または従量制のみで使用できます。指定しなければカタログアイテムに従います - billingTiming (object): 請求タイミング - billingDueTiming (object): 支払期限タイミング - tiers (array): ティア（段階別価格設定）。ボリューム/段階制の料金モデルで使用します。priceとは排他的です - **catalogChargeItemId**: string — カタログ課金項目ID - **optionalId**: string — カタログ課金項目管理ID(半角英数字と_-のみ使用できます) - **billAllAtOnce**: boolean — 一括請求オプション。指定しなければカタログアイテムに従います - **quantity**: integer — 契約数。料金モデルが従量制の場合に使用できます - **name**: string — 課金項目名。指定しなければカタログアイテムに従います - **price**: integer — 単価。カタログの料金モデルが定額または従量制のみで使用できます。指定しなければカタログアイテムに従います - **billingTiming**: object — 請求タイミング - **billingDueTiming**: object — 支払期限タイミング - **tiers**: array — ティア（段階別価格設定）。ボリューム/段階制の料金モデルで使用します。priceとは排他的です --- ### ChangeOptionItemRequest.ChargeItem.Tier Type: object - upperLimit (string): ティアの上限値。省略時は上限なし（最後のティア） - kind (object): 料金計算式の種類 - unitPrice (string): 単価（KIND_PER_UNIT時に使用） - price (string): 定額価格（KIND_FLAT_FEE時に使用） - **upperLimit**: string — ティアの上限値。省略時は上限なし（最後のティア） - **kind**: object — 料金計算式の種類 - **unitPrice**: string — 単価（KIND_PER_UNIT時に使用） - **price**: string — 定額価格（KIND_FLAT_FEE時に使用） --- ### ChangeOptionItemRequest.ChargeItem.Tier.Kind - KIND_UNSPECIFIED: 未指定 - KIND_PER_UNIT: 従量制（単価×数量） - KIND_FLAT_FEE: 定額制 Type: string Enum values: KIND_UNSPECIFIED, KIND_PER_UNIT, KIND_FLAT_FEE Enum values: KIND_UNSPECIFIED, KIND_PER_UNIT, KIND_FLAT_FEE --- ### ChangeOptionItemRequest.ChargeItem.Timing Type: object - value (integer): 数(負数の場合は前を表す。例: { "value": -1, "unit": "UNIT_MONTHLY" } => 先月) - unit (object): 単位 - monthlyOption (object): UNIT_MONTHLY指定時のオプション - **value**: integer — 数(負数の場合は前を表す。例: { "value": -1, "unit": "UNIT_MONTHLY" } => 先月) - **unit**: object — 単位 - **monthlyOption**: object — UNIT_MONTHLY指定時のオプション --- ### ChangeOptionItemRequest.ChargeItem.Timing.MonthlyOption - MONTHLY_OPTION_FIRST_DAY_OF_MONTH: alias MONTHLY_OPTION_DAY_1 Type: string Enum values: MONTHLY_OPTION_UNSPECIFIED, MONTHLY_OPTION_DAY_1, MONTHLY_OPTION_DAY_2, MONTHLY_OPTION_DAY_3, MONTHLY_OPTION_DAY_4, MONTHLY_OPTION_DAY_5, MONTHLY_OPTION_DAY_6, MONTHLY_OPTION_DAY_7, MONTHLY_OPTION_DAY_8, MONTHLY_OPTION_DAY_9, MONTHLY_OPTION_DAY_10, MONTHLY_OPTION_DAY_11, MONTHLY_OPTION_DAY_12, MONTHLY_OPTION_DAY_13, MONTHLY_OPTION_DAY_14, MONTHLY_OPTION_DAY_15, MONTHLY_OPTION_DAY_16, MONTHLY_OPTION_DAY_17, MONTHLY_OPTION_DAY_18, MONTHLY_OPTION_DAY_19, MONTHLY_OPTION_DAY_20, MONTHLY_OPTION_DAY_21, MONTHLY_OPTION_DAY_22, MONTHLY_OPTION_DAY_23, MONTHLY_OPTION_DAY_24, MONTHLY_OPTION_DAY_25, MONTHLY_OPTION_DAY_26, MONTHLY_OPTION_DAY_27, MONTHLY_OPTION_DAY_28, MONTHLY_OPTION_DAY_29, MONTHLY_OPTION_DAY_30, MONTHLY_OPTION_DAY_31, MONTHLY_OPTION_FIRST_DAY_OF_MONTH, MONTHLY_OPTION_LAST_DAY_OF_MONTH Enum values: MONTHLY_OPTION_UNSPECIFIED, MONTHLY_OPTION_DAY_1, MONTHLY_OPTION_DAY_2, MONTHLY_OPTION_DAY_3, MONTHLY_OPTION_DAY_4, MONTHLY_OPTION_DAY_5, MONTHLY_OPTION_DAY_6, MONTHLY_OPTION_DAY_7, MONTHLY_OPTION_DAY_8, MONTHLY_OPTION_DAY_9, MONTHLY_OPTION_DAY_10, MONTHLY_OPTION_DAY_11, MONTHLY_OPTION_DAY_12, MONTHLY_OPTION_DAY_13, MONTHLY_OPTION_DAY_14, MONTHLY_OPTION_DAY_15, MONTHLY_OPTION_DAY_16, MONTHLY_OPTION_DAY_17, MONTHLY_OPTION_DAY_18, MONTHLY_OPTION_DAY_19, MONTHLY_OPTION_DAY_20, MONTHLY_OPTION_DAY_21, MONTHLY_OPTION_DAY_22, MONTHLY_OPTION_DAY_23, MONTHLY_OPTION_DAY_24, MONTHLY_OPTION_DAY_25, MONTHLY_OPTION_DAY_26, MONTHLY_OPTION_DAY_27, MONTHLY_OPTION_DAY_28, MONTHLY_OPTION_DAY_29, MONTHLY_OPTION_DAY_30, MONTHLY_OPTION_DAY_31, MONTHLY_OPTION_FIRST_DAY_OF_MONTH, MONTHLY_OPTION_LAST_DAY_OF_MONTH --- ### ChangeOptionItemRequest.ChargeItem.Timing.Unit - UNIT_DAILY: 日 - UNIT_MONTHLY: 月 Type: string Enum values: UNIT_UNSPECIFIED, UNIT_DAILY, UNIT_MONTHLY Enum values: UNIT_UNSPECIFIED, UNIT_DAILY, UNIT_MONTHLY --- ### ChangeOptionItemRequest.OptionItem Type: object - catalogItemId (string): カタログアイテムID - endDate (string): 契約終了日(省略時はカタログの契約期間から算出(RFC 3339 format)) - defaultContractTerm (object): 基本契約期間(省略時はカタログの契約期間から適用) - chargeItems (array): 課金項目 - name (string): アイテム名。指定しなければカタログアイテムに従います。 - **catalogItemId**: string — カタログアイテムID - **endDate**: string — 契約終了日(省略時はカタログの契約期間から算出(RFC 3339 format)) - **defaultContractTerm**: object — 基本契約期間(省略時はカタログの契約期間から適用) - **chargeItems**: array — 課金項目 - **name**: string — アイテム名。指定しなければカタログアイテムに従います。 --- ### ChangeOptionItemRequest.Term Type: object - value (integer): 期間数 - unit (object): 単位 - **value**: integer — 期間数 - **unit**: object — 単位 --- ### ChangeOptionItemRequest.Term.Unit - UNIT_MONTHLY: 月 Type: string Enum values: UNIT_UNSPECIFIED, UNIT_MONTHLY Enum values: UNIT_UNSPECIFIED, UNIT_MONTHLY --- ### ChangeOptionItemResponse Type: object - contract (object): 対象の契約 - amendment (object): 改定 - **contract**: object — 対象の契約 - **amendment**: object — 改定 --- ### ChangeOptionItemResponse.Amendment Type: object - id (string): - **id**: string — --- ### ChangeOptionItemResponse.Contract Type: object - id (string): - **id**: string — --- ### ChangeQuantityExpectedBillingRequest Type: object - id (string): 契約ID - optionalId (string): 契約管理ID(IDの代わりに指定可) - contractChargeItemId (string): 契約の課金項目ID（ContractChargeItemId） - effectiveStartDate (string): 有効開始日 (RFC3339) - quantity (integer): 新しい数量 - changeQuantityDailyRate (object): 契約数変更における日割り設定 - **id**: string — 契約ID - **optionalId**: string — 契約管理ID(IDの代わりに指定可) - **contractChargeItemId**: string — 契約の課金項目ID（ContractChargeItemId） - **effectiveStartDate**: string — 有効開始日 (RFC3339) - **quantity**: integer — 新しい数量 - **changeQuantityDailyRate**: object — 契約数変更における日割り設定 --- ### ChangeQuantityExpectedBillingResponse Type: object - expectedBilling (object): - **expectedBilling**: object — --- ### ChangeQuantityRequest Type: object - contractId (string): 契約ID - contractOptionalId (string): 契約管理ID(契約IDの代わりに指定可) - contractChargeItemId (string): 契約課金項目ID - effectiveStartDate (string): - quantity (integer): 変更後の契約数 - memo (string): 改定メモ - changeQuantityDailyRate (object): 契約数変更時の日割設定 - **contractId**: string — 契約ID - **contractOptionalId**: string — 契約管理ID(契約IDの代わりに指定可) - **contractChargeItemId**: string — 契約課金項目ID - **effectiveStartDate**: string — - **quantity**: integer — 変更後の契約数 - **memo**: string — 改定メモ - **changeQuantityDailyRate**: object — 契約数変更時の日割設定 --- ### ChangeQuantityRequest.DailyRate Type: object - type (object): - fixedRateValue (number): FIXED_RATE指定時の値 - **type**: object — - **fixedRateValue**: number — FIXED_RATE指定時の値 --- ### ChangeQuantityRequest.DailyRate.Type Type: string Enum values: TYPE_UNSPECIFIED, TYPE_FULL_PRICE, TYPE_DAILY_RATE, TYPE_FIXED_RATE Enum values: TYPE_UNSPECIFIED, TYPE_FULL_PRICE, TYPE_DAILY_RATE, TYPE_FIXED_RATE --- ### ChangeQuantityResponse Type: object - contract (object): 対象の契約 - amendment (object): 改定 - **contract**: object — 対象の契約 - **amendment**: object — 改定 --- ### ChangeQuantityResponse.Amendment Type: object - id (string): - **id**: string — --- ### ChangeQuantityResponse.Contract Type: object - id (string): - **id**: string — --- ### ChargeItemType - CHARGE_ITEM_TYPE_RECURRING: 定期課金 - CHARGE_ITEM_TYPE_ONE_TIME: 一回課金 - CHARGE_ITEM_TYPE_DISCOUNT: ディスカウント Type: string Enum values: CHARGE_ITEM_TYPE_UNSPECIFIED, CHARGE_ITEM_TYPE_RECURRING, CHARGE_ITEM_TYPE_ONE_TIME, CHARGE_ITEM_TYPE_DISCOUNT Enum values: CHARGE_ITEM_TYPE_UNSPECIFIED, CHARGE_ITEM_TYPE_RECURRING, CHARGE_ITEM_TYPE_ONE_TIME, CHARGE_ITEM_TYPE_DISCOUNT --- ### Clause.Status Type: object - eq (object): - **eq**: object — --- ### ClosingDate Type: string Enum values: CLOSING_DATE_UNSPECIFIED, CLOSING_DATE_LAST_DAY_OF_MONTH, CLOSING_DATE_ONE_DAY_BEFORE Enum values: CLOSING_DATE_UNSPECIFIED, CLOSING_DATE_LAST_DAY_OF_MONTH, CLOSING_DATE_ONE_DAY_BEFORE --- ### Contract.ChargeItem.Tier.FeeFormula Type: string Enum values: FEE_FORMULA_UNSPECIFIED, FEE_FORMULA_PER_UNIT, FEE_FORMULA_FLAT_FEE Enum values: FEE_FORMULA_UNSPECIFIED, FEE_FORMULA_PER_UNIT, FEE_FORMULA_FLAT_FEE --- ### Contract.ChargeItem.Tier.Kind Type: string Enum values: KIND_UNSPECIFIED, KIND_PER_UNIT, KIND_FLAT_FEE Enum values: KIND_UNSPECIFIED, KIND_PER_UNIT, KIND_FLAT_FEE --- ### Contract.Service Type: object - id (string): 契約サービスID - mainItem (object): メイン契約アイテム - optionItems (array): オプション契約アイテム（メインアイテムに紐づくオプション） - **id**: string — 契約サービスID - **mainItem**: object — メイン契約アイテム - **optionItems**: array — オプション契約アイテム（メインアイテムに紐づくオプション） --- ### ContractChargeItemType - CONTRACT_CHARGE_ITEM_TYPE_RECURRING: 定期課金 - CONTRACT_CHARGE_ITEM_TYPE_ONE_TIME: 一回課金 Type: string Enum values: CONTRACT_CHARGE_ITEM_TYPE_UNSPECIFIED, CONTRACT_CHARGE_ITEM_TYPE_RECURRING, CONTRACT_CHARGE_ITEM_TYPE_ONE_TIME Enum values: CONTRACT_CHARGE_ITEM_TYPE_UNSPECIFIED, CONTRACT_CHARGE_ITEM_TYPE_RECURRING, CONTRACT_CHARGE_ITEM_TYPE_ONE_TIME --- ### ContractEndDate Type: object - gte (string): - lte (string): - **gte**: string — - **lte**: string — --- ### ContractEndDateFilterClause Type: object - gte (string): - lte (string): - **gte**: string — - **lte**: string — --- ### ContractItemEndDate Type: object - gte (string): - lte (string): - **gte**: string — - **lte**: string — --- ### ContractItemEndDateFilterClause Type: object - gte (string): - lte (string): - **gte**: string — - **lte**: string — --- ### ContractOrder Type: object - field (object): - direction (object): - **field**: object — - **direction**: object — --- ### ContractOrder.Direction - DIRECTION_ASCENDING: 昇順 - DIRECTION_DESCENDING: 降順 Type: string Enum values: DIRECTION_UNSPECIFIED, DIRECTION_ASCENDING, DIRECTION_DESCENDING Enum values: DIRECTION_UNSPECIFIED, DIRECTION_ASCENDING, DIRECTION_DESCENDING --- ### ContractOrder.Field - FIELD_ID: 請求ID - FIELD_CONTRACT_END_DATE: 契約終了日 Type: string Enum values: FIELD_UNSPECIFIED, FIELD_ID, FIELD_CONTRACT_END_DATE Enum values: FIELD_UNSPECIFIED, FIELD_ID, FIELD_CONTRACT_END_DATE --- ### ContractSelectRule - CONTRACT_SELECT_RULE_UNSPECIFIED: 未指定 - CONTRACT_SELECT_RULE_MAIN_OR_OPTION: メインまたはオプション - CONTRACT_SELECT_RULE_ONLY_MAIN: メインのみ - CONTRACT_SELECT_RULE_ONLY_OPTION: オプションのみ Type: string Enum values: CONTRACT_SELECT_RULE_UNSPECIFIED, CONTRACT_SELECT_RULE_MAIN_OR_OPTION, CONTRACT_SELECT_RULE_ONLY_MAIN, CONTRACT_SELECT_RULE_ONLY_OPTION Enum values: CONTRACT_SELECT_RULE_UNSPECIFIED, CONTRACT_SELECT_RULE_MAIN_OR_OPTION, CONTRACT_SELECT_RULE_ONLY_MAIN, CONTRACT_SELECT_RULE_ONLY_OPTION --- ### ContractSortOrder Type: object - field (object): - direction (object): - **field**: object — - **direction**: object — --- ### ContractSortOrder.Direction - DIRECTION_ASCENDING: 昇順 - DIRECTION_DESCENDING: 降順 Type: string Enum values: DIRECTION_UNSPECIFIED, DIRECTION_ASCENDING, DIRECTION_DESCENDING Enum values: DIRECTION_UNSPECIFIED, DIRECTION_ASCENDING, DIRECTION_DESCENDING --- ### ContractSortOrder.Field - FIELD_ID: 契約ID - FIELD_CONTRACT_END_DATE: 契約終了日 Type: string Enum values: FIELD_UNSPECIFIED, FIELD_ID, FIELD_CONTRACT_END_DATE Enum values: FIELD_UNSPECIFIED, FIELD_ID, FIELD_CONTRACT_END_DATE --- ### CreateBillingsRequest Type: object - targetContracts (array): 対象契約のリスト - holdInvoiceCreation (boolean): 請求書作成を保留するかどうか - arbitraryBillingDate (string): 請求日（任意）。未指定の場合は契約の次回請求日を使用する - arbitraryBillingDueDate (string): 支払期限日（任意）。未指定の場合は契約の支払期限タイミングを使用する - **targetContracts**: array — 対象契約のリスト - **holdInvoiceCreation**: boolean — 請求書作成を保留するかどうか - **arbitraryBillingDate**: string — 請求日（任意）。未指定の場合は契約の次回請求日を使用する - **arbitraryBillingDueDate**: string — 支払期限日（任意）。未指定の場合は契約の支払期限タイミングを使用する --- ### CreateBillingsRequest.ContractIdentifier Type: object - id (string): 契約ID - optionalId (string): 契約管理ID(契約IDの代わりに指定可) - **id**: string — 契約ID - **optionalId**: string — 契約管理ID(契約IDの代わりに指定可) --- ### CreateBillingsResponse Type: object - ids (array): 請求ID - **ids**: array — 請求ID --- ### CreateContractRequest.CatalogItemIdentifier Type: object - catalogItemId (string): カタログアイテムID - catalogItemOptionalId (string): カタログアイテム管理ID(カタログアイテムIDの代わりに指定可) - **catalogItemId**: string — カタログアイテムID - **catalogItemOptionalId**: string — カタログアイテム管理ID(カタログアイテムIDの代わりに指定可) --- ### CreateContractRequest.ChargeItem.Pricing Type: object - price (integer): 単一価格（定額制または従量制のみ） - tiers (array): ティア（段階的価格設定） - **price**: integer — 単一価格（定額制または従量制のみ） - **tiers**: array — ティア（段階的価格設定） --- ### CreateContractRequest.ChargeItem.Tier Type: object - upperLimit (string): 上限値（最後のティアのみ省略可） - feeFormula (object): 料金計算式 - unitPrice (string): 単価。定額制の場合はこの値がそのまま料金となり、従量制の場合は数量との積算で料金が決まる - **upperLimit**: string — 上限値（最後のティアのみ省略可） - **feeFormula**: object — 料金計算式 - **unitPrice**: string — 単価。定額制の場合はこの値がそのまま料金となり、従量制の場合は数量との積算で料金が決まる --- ### CreateContractRequest.ChargeItem.Tier.FeeFormula - FEE_FORMULA_PER_UNIT: 従量 - FEE_FORMULA_FLAT_FEE: 定額 Type: string Enum values: FEE_FORMULA_UNSPECIFIED, FEE_FORMULA_PER_UNIT, FEE_FORMULA_FLAT_FEE Enum values: FEE_FORMULA_UNSPECIFIED, FEE_FORMULA_PER_UNIT, FEE_FORMULA_FLAT_FEE --- ### CreateContractRequest.ChargeItem.Timing Type: object - value (integer): 数(負数の場合は前を表す。例: { "value": -1, "unit": "UNIT_MONTHLY" } => 先月) - unit (object): 単位 - monthlyOption (object): UNIT_MONTHLY指定時のオプション - **value**: integer — 数(負数の場合は前を表す。例: { "value": -1, "unit": "UNIT_MONTHLY" } => 先月) - **unit**: object — 単位 - **monthlyOption**: object — UNIT_MONTHLY指定時のオプション --- ### CreateContractRequest.ChargeItem.Timing.MonthlyOption - MONTHLY_OPTION_FIRST_DAY_OF_MONTH: alias MONTHLY_OPTION_DAY_1 Type: string Enum values: MONTHLY_OPTION_UNSPECIFIED, MONTHLY_OPTION_DAY_1, MONTHLY_OPTION_DAY_2, MONTHLY_OPTION_DAY_3, MONTHLY_OPTION_DAY_4, MONTHLY_OPTION_DAY_5, MONTHLY_OPTION_DAY_6, MONTHLY_OPTION_DAY_7, MONTHLY_OPTION_DAY_8, MONTHLY_OPTION_DAY_9, MONTHLY_OPTION_DAY_10, MONTHLY_OPTION_DAY_11, MONTHLY_OPTION_DAY_12, MONTHLY_OPTION_DAY_13, MONTHLY_OPTION_DAY_14, MONTHLY_OPTION_DAY_15, MONTHLY_OPTION_DAY_16, MONTHLY_OPTION_DAY_17, MONTHLY_OPTION_DAY_18, MONTHLY_OPTION_DAY_19, MONTHLY_OPTION_DAY_20, MONTHLY_OPTION_DAY_21, MONTHLY_OPTION_DAY_22, MONTHLY_OPTION_DAY_23, MONTHLY_OPTION_DAY_24, MONTHLY_OPTION_DAY_25, MONTHLY_OPTION_DAY_26, MONTHLY_OPTION_DAY_27, MONTHLY_OPTION_DAY_28, MONTHLY_OPTION_DAY_29, MONTHLY_OPTION_DAY_30, MONTHLY_OPTION_DAY_31, MONTHLY_OPTION_FIRST_DAY_OF_MONTH, MONTHLY_OPTION_LAST_DAY_OF_MONTH Enum values: MONTHLY_OPTION_UNSPECIFIED, MONTHLY_OPTION_DAY_1, MONTHLY_OPTION_DAY_2, MONTHLY_OPTION_DAY_3, MONTHLY_OPTION_DAY_4, MONTHLY_OPTION_DAY_5, MONTHLY_OPTION_DAY_6, MONTHLY_OPTION_DAY_7, MONTHLY_OPTION_DAY_8, MONTHLY_OPTION_DAY_9, MONTHLY_OPTION_DAY_10, MONTHLY_OPTION_DAY_11, MONTHLY_OPTION_DAY_12, MONTHLY_OPTION_DAY_13, MONTHLY_OPTION_DAY_14, MONTHLY_OPTION_DAY_15, MONTHLY_OPTION_DAY_16, MONTHLY_OPTION_DAY_17, MONTHLY_OPTION_DAY_18, MONTHLY_OPTION_DAY_19, MONTHLY_OPTION_DAY_20, MONTHLY_OPTION_DAY_21, MONTHLY_OPTION_DAY_22, MONTHLY_OPTION_DAY_23, MONTHLY_OPTION_DAY_24, MONTHLY_OPTION_DAY_25, MONTHLY_OPTION_DAY_26, MONTHLY_OPTION_DAY_27, MONTHLY_OPTION_DAY_28, MONTHLY_OPTION_DAY_29, MONTHLY_OPTION_DAY_30, MONTHLY_OPTION_DAY_31, MONTHLY_OPTION_FIRST_DAY_OF_MONTH, MONTHLY_OPTION_LAST_DAY_OF_MONTH --- ### CreateContractRequest.ChargeItem.Timing.Unit - UNIT_DAILY: 日 - UNIT_MONTHLY: 月 Type: string Enum values: UNIT_UNSPECIFIED, UNIT_DAILY, UNIT_MONTHLY Enum values: UNIT_UNSPECIFIED, UNIT_DAILY, UNIT_MONTHLY --- ### CreateContractRequest.Customer Type: object - id (string): 顧客ID - optionalId (string): 顧客管理ID(顧客IDの代わりに指定可) - customerStaffId (string): 顧客担当者ID(請求先等の担当者として登録されます) - customerStaffOptionalId (string): 顧客担当者管理ID(顧客担当者IDの代わりに指定可) - **id**: string — 顧客ID - **optionalId**: string — 顧客管理ID(顧客IDの代わりに指定可) - **customerStaffId**: string — 顧客担当者ID(請求先等の担当者として登録されます) - **customerStaffOptionalId**: string — 顧客担当者管理ID(顧客担当者IDの代わりに指定可) --- ### CreateContractRequest.CustomerStaff Type: object - customerStaffId (string): 顧客担当者ID - customerStaffOptionalId (string): 顧客担当者管理ID(顧客担当者IDの代わりに指定可) - **customerStaffId**: string — 顧客担当者ID - **customerStaffOptionalId**: string — 顧客担当者管理ID(顧客担当者IDの代わりに指定可) --- ### CreateContractRequest.MainItem Type: object - catalogItemId (string): カタログアイテムID - catalogItemOptionalId (string): カタログアイテム管理ID(カタログアイテムIDの代わりに指定可) - itemStartDate (string): (DEPRECATED: start_date をお使いください) アイテム契約開始日(RFC 3339 format) - chargeItems (array): 課金項目パラメータ - optionItems (array): オプションとなるアイテム - startDate (string): 契約開始日(RFC 3339 format) - endDate (string): 契約終了日(省略時はカタログの契約期間から算出(RFC 3339 format)) - defaultContractTerm (object): 基本契約期間(省略時はカタログの契約期間から適用) - name (string): アイテム名。指定しなければカタログアイテムに従います。 - availabilityCycle (object): 利用周期(省略時はカタログの利用周期から適用) - **catalogItemId**: string — カタログアイテムID - **catalogItemOptionalId**: string — カタログアイテム管理ID(カタログアイテムIDの代わりに指定可) - **itemStartDate**: string — (DEPRECATED: start_date をお使いください) アイテム契約開始日(RFC 3339 format) - **chargeItems**: array — 課金項目パラメータ - **optionItems**: array — オプションとなるアイテム - **startDate**: string — 契約開始日(RFC 3339 format) - **endDate**: string — 契約終了日(省略時はカタログの契約期間から算出(RFC 3339 format)) - **defaultContractTerm**: object — 基本契約期間(省略時はカタログの契約期間から適用) - **name**: string — アイテム名。指定しなければカタログアイテムに従います。 - **availabilityCycle**: object — 利用周期(省略時はカタログの利用周期から適用) --- ### CreateContractRequest.OptionItem Type: object - catalogItemId (string): カタログアイテムID - catalogItemOptionalId (string): カタログアイテム管理ID(カタログアイテムIDの代わりに指定可) - chargeItems (array): 課金項目パラメータ - endDate (string): 契約終了日(省略時はカタログの契約期間から算出(RFC 3339 format)) - defaultContractTerm (object): 基本契約期間(省略時はカタログの契約期間から適用) - name (string): アイテム名。指定しなければカタログアイテムに従います。 - availabilityCycle (object): 利用周期(省略時はカタログの利用周期から適用) - **catalogItemId**: string — カタログアイテムID - **catalogItemOptionalId**: string — カタログアイテム管理ID(カタログアイテムIDの代わりに指定可) - **chargeItems**: array — 課金項目パラメータ - **endDate**: string — 契約終了日(省略時はカタログの契約期間から算出(RFC 3339 format)) - **defaultContractTerm**: object — 基本契約期間(省略時はカタログの契約期間から適用) - **name**: string — アイテム名。指定しなければカタログアイテムに従います。 - **availabilityCycle**: object — 利用周期(省略時はカタログの利用周期から適用) --- ### CreateContractRequest.Service Type: object - mainItem (object): メインとなるアイテム - optionItems (array): オプションとなるアイテム - **mainItem**: object — メインとなるアイテム - **optionItems**: array — オプションとなるアイテム --- ### CreateCustomerRequest Type: object - optionalId (string): 顧客管理ID - name (string): 顧客名 - salesRepresentative (object): - crmAccountId (string): 外部CRMサービスのアカウントID - **optionalId**: string — 顧客管理ID - **name**: string — 顧客名 - **salesRepresentative**: object — - **crmAccountId**: string — 外部CRMサービスのアカウントID --- ### CreateCustomerRequest.SalesRepresentative Type: object - firstName (string): 営業担当者の名 - lastName (string): 営業担当者の姓 - **firstName**: string — 営業担当者の名 - **lastName**: string — 営業担当者の姓 --- ### CreateCustomerResponse Type: object - customer (object): 顧客 - **customer**: object — 顧客 --- ### CreateCustomerStaffRequest Type: object - customerId (string): 顧客ID - customerOptionalId (string): 顧客管理ID(顧客IDの代わりに指定可) - optionalId (string): 顧客担当者管理ID - name (object): 顧客担当者名 - department (string): 部門 - title (string): 肩書 - phoneNumber (string): 電話番号 - emailAddress (string): メールアドレス - address (object): 住所 - crmStaffId (string): 外部CRMサービスの担当者ID - **customerId**: string — 顧客ID - **customerOptionalId**: string — 顧客管理ID(顧客IDの代わりに指定可) - **optionalId**: string — 顧客担当者管理ID - **name**: object — 顧客担当者名 - **department**: string — 部門 - **title**: string — 肩書 - **phoneNumber**: string — 電話番号 - **emailAddress**: string — メールアドレス - **address**: object — 住所 - **crmStaffId**: string — 外部CRMサービスの担当者ID --- ### CreateCustomerStaffRequest.Address Type: object - zipCode (string): 郵便番号 - country (object): 国 - prefecture (object): 都道府県 - city (string): 市区町村 - addressLines (array): [番地, 建物名・階数] - **zipCode**: string — 郵便番号 - **country**: object — 国 - **prefecture**: object — 都道府県 - **city**: string — 市区町村 - **addressLines**: array — [番地, 建物名・階数] --- ### CreateCustomerStaffRequest.Address.Country Type: string Enum values: COUNTRY_UNSPECIFIED, COUNTRY_JP Enum values: COUNTRY_UNSPECIFIED, COUNTRY_JP --- ### CreateCustomerStaffRequest.Address.Prefecture Type: string Enum values: PREFECTURE_UNSPECIFIED, PREFECTURE_HOKKAIDO, PREFECTURE_AOMORI, PREFECTURE_IWATE, PREFECTURE_MIYAGI, PREFECTURE_AKITA, PREFECTURE_YAMAGATA, PREFECTURE_FUKUSHIMA, PREFECTURE_IBARAKI, PREFECTURE_TOCHIGI, PREFECTURE_GUNMA, PREFECTURE_SAITAMA, PREFECTURE_CHIBA, PREFECTURE_TOKYO, PREFECTURE_KANAGAWA, PREFECTURE_NIIGATA, PREFECTURE_TOYAMA, PREFECTURE_ISHIKAWA, PREFECTURE_FUKUI, PREFECTURE_YAMANASHI, PREFECTURE_NAGANO, PREFECTURE_GIFU, PREFECTURE_SHIZUOKA, PREFECTURE_AICHI, PREFECTURE_MIE, PREFECTURE_SHIGA, PREFECTURE_KYOTO, PREFECTURE_OSAKA, PREFECTURE_HYOGO, PREFECTURE_NARA, PREFECTURE_WAKAYAMA, PREFECTURE_TOTTORI, PREFECTURE_SHIMANE, PREFECTURE_OKAYAMA, PREFECTURE_HIROSHIMA, PREFECTURE_YAMAGUCHI, PREFECTURE_TOKUSHIMA, PREFECTURE_KAGAWA, PREFECTURE_EHIME, PREFECTURE_KOCHI, PREFECTURE_FUKUOKA, PREFECTURE_SAGA, PREFECTURE_NAGASAKI, PREFECTURE_KUMAMOTO, PREFECTURE_OITA, PREFECTURE_MIYAZAKI, PREFECTURE_KAGOSHIMA, PREFECTURE_OKINAWA Enum values: PREFECTURE_UNSPECIFIED, PREFECTURE_HOKKAIDO, PREFECTURE_AOMORI, PREFECTURE_IWATE, PREFECTURE_MIYAGI, PREFECTURE_AKITA, PREFECTURE_YAMAGATA, PREFECTURE_FUKUSHIMA, PREFECTURE_IBARAKI, PREFECTURE_TOCHIGI, PREFECTURE_GUNMA, PREFECTURE_SAITAMA, PREFECTURE_CHIBA, PREFECTURE_TOKYO, PREFECTURE_KANAGAWA, PREFECTURE_NIIGATA, PREFECTURE_TOYAMA, PREFECTURE_ISHIKAWA, PREFECTURE_FUKUI, PREFECTURE_YAMANASHI, PREFECTURE_NAGANO, PREFECTURE_GIFU, PREFECTURE_SHIZUOKA, PREFECTURE_AICHI, PREFECTURE_MIE, PREFECTURE_SHIGA, PREFECTURE_KYOTO, PREFECTURE_OSAKA, PREFECTURE_HYOGO, PREFECTURE_NARA, PREFECTURE_WAKAYAMA, PREFECTURE_TOTTORI, PREFECTURE_SHIMANE, PREFECTURE_OKAYAMA, PREFECTURE_HIROSHIMA, PREFECTURE_YAMAGUCHI, PREFECTURE_TOKUSHIMA, PREFECTURE_KAGAWA, PREFECTURE_EHIME, PREFECTURE_KOCHI, PREFECTURE_FUKUOKA, PREFECTURE_SAGA, PREFECTURE_NAGASAKI, PREFECTURE_KUMAMOTO, PREFECTURE_OITA, PREFECTURE_MIYAZAKI, PREFECTURE_KAGOSHIMA, PREFECTURE_OKINAWA --- ### CreateCustomerStaffRequest.Name Type: object - firstName (string): 顧客担当者の名 - lastName (string): 顧客担当者の姓 - firstNameKana (string): 顧客担当者の名（ふりがな） - lastNameKana (string): 顧客担当者の姓（ふりがな） - **firstName**: string — 顧客担当者の名 - **lastName**: string — 顧客担当者の姓 - **firstNameKana**: string — 顧客担当者の名（ふりがな） - **lastNameKana**: string — 顧客担当者の姓（ふりがな） --- ### CreateCustomerStaffResponse Type: object - customerStaff (object): 顧客担当者 - **customerStaff**: object — 顧客担当者 --- ### CreateProductRequest Type: object - optionalId (string): プロダクト管理ID - name (string): プロダクト名 - description (string): プロダクト概要 - **optionalId**: string — プロダクト管理ID - **name**: string — プロダクト名 - **description**: string — プロダクト概要 --- ### CreateProductResponse Type: object - product (object): - **product**: object — --- ### CustomFieldMaster Type: object - id (string): カスタムフィールドマスターID - type (object): カスタムフィールドタイプ (DEPRECATED: field_type をお使いください) - name (string): カスタムフィールドマスタ名 - fieldType (object): カスタムフィールドタイプ - dataType (object): カスタムフィールドデータタイプ - **id**: string — カスタムフィールドマスターID - **type**: object — カスタムフィールドタイプ (DEPRECATED: field_type をお使いください) - **name**: string — カスタムフィールドマスタ名 - **fieldType**: object — カスタムフィールドタイプ - **dataType**: object — カスタムフィールドデータタイプ --- ### CustomFieldMaster.DataType Type: string Enum values: DATA_TYPE_UNSPECIFIED, DATA_TYPE_STRING, DATA_TYPE_DATE, DATA_TYPE_SELECT_LIST Enum values: DATA_TYPE_UNSPECIFIED, DATA_TYPE_STRING, DATA_TYPE_DATE, DATA_TYPE_SELECT_LIST --- ### CustomFieldMaster.FieldType Type: string Enum values: FIELD_TYPE_UNSPECIFIED, FIELD_TYPE_CUSTOMER, FIELD_TYPE_CONTRACT Enum values: FIELD_TYPE_UNSPECIFIED, FIELD_TYPE_CUSTOMER, FIELD_TYPE_CONTRACT --- ### CustomFieldUpdateError Type: object - resource (object): エラーが発生したリソースの識別子 - errorType (object): エラータイプ - message (string): エラーメッセージ - **resource**: object — エラーが発生したリソースの識別子 - **errorType**: object — エラータイプ - **message**: string — エラーメッセージ --- ### CustomFieldUpdateError.ErrorType Type: string Enum values: ERROR_TYPE_UNSPECIFIED, ERROR_TYPE_NOT_FOUND, ERROR_TYPE_VALIDATION_FAILED, ERROR_TYPE_STORE_FAILED Enum values: ERROR_TYPE_UNSPECIFIED, ERROR_TYPE_NOT_FOUND, ERROR_TYPE_VALIDATION_FAILED, ERROR_TYPE_STORE_FAILED --- ### CustomFieldUpdateSummary Type: object - totalCount (integer): 要求されたリソース数 - successCount (integer): 更新に成功したリソース数 - failedCount (integer): 更新に失敗したリソース数 - **totalCount**: integer — 要求されたリソース数 - **successCount**: integer — 更新に成功したリソース数 - **failedCount**: integer — 更新に失敗したリソース数 --- ### Customer.SalesRepresentative Type: object - firstName (string): 営業担当者の名 - lastName (string): 営業担当者の姓 - **firstName**: string — 営業担当者の名 - **lastName**: string — 営業担当者の姓 --- ### CustomerEqFilterClause Type: object - customerId (string): 顧客ID - customerOptionalId (string): 顧客管理ID（顧客IDの代わりに指定可） - **customerId**: string — 顧客ID - **customerOptionalId**: string — 顧客管理ID（顧客IDの代わりに指定可） --- ### CustomerIdentifier Type: object - customerId (string): 顧客ID - customerOptionalId (string): 顧客管理ID（顧客IDの代わりに指定可） - **customerId**: string — 顧客ID - **customerOptionalId**: string — 顧客管理ID（顧客IDの代わりに指定可） --- ### CustomerStaffIdentifier Type: object - customerStaffId (string): 顧客担当者ID - customerStaffOptionalId (string): 顧客担当者管理ID（顧客担当者IDの代わりに指定可） - **customerStaffId**: string — 顧客担当者ID - **customerStaffOptionalId**: string — 顧客担当者管理ID（顧客担当者IDの代わりに指定可） --- ### CustomizeOptionItemRequest Type: object - contractId (string): 契約ID - contractOptionalId (string): 契約管理ID(契約IDの代わりに指定可) - optionItemId (string): - effectiveStartDate (string): 改定の有効開始日 - chargeItems (array): 契約課金項目 - memo (string): 改定メモ - **contractId**: string — 契約ID - **contractOptionalId**: string — 契約管理ID(契約IDの代わりに指定可) - **optionItemId**: string — - **effectiveStartDate**: string — 改定の有効開始日 - **chargeItems**: array — 契約課金項目 - **memo**: string — 改定メモ --- ### CustomizeOptionItemRequest.ChargeItem Type: object - contractChargeItemId (string): 契約課金項目ID - billAllAtOnce (boolean): 一括請求オプション。指定しなければ編集前と同じ値となります - name (string): 請求書記載名。指定しなければ編集前と同じ値になります - price (integer): 単価。カタログの料金モデルが定額または従量制のみで使用できます。指定しなければ編集前と同じ値になります - **contractChargeItemId**: string — 契約課金項目ID - **billAllAtOnce**: boolean — 一括請求オプション。指定しなければ編集前と同じ値となります - **name**: string — 請求書記載名。指定しなければ編集前と同じ値になります - **price**: integer — 単価。カタログの料金モデルが定額または従量制のみで使用できます。指定しなければ編集前と同じ値になります --- ### CustomizeOptionItemResponse Type: object - contract (object): 対象の契約 - amendment (object): 改定 - **contract**: object — 対象の契約 - **amendment**: object — 改定 --- ### CustomizeOptionItemResponse.Amendment Type: object - id (string): - **id**: string — --- ### CustomizeOptionItemResponse.Contract Type: object - id (string): - **id**: string — --- ### DailyUsage Type: object - id (string): - **id**: string — --- ### DayOfMonth - DAY_OF_MONTH_FIRST: alias DAY_OF_MONTH_1 Type: string Enum values: DAY_OF_MONTH_UNSPECIFIED, DAY_OF_MONTH_1, DAY_OF_MONTH_2, DAY_OF_MONTH_3, DAY_OF_MONTH_4, DAY_OF_MONTH_5, DAY_OF_MONTH_6, DAY_OF_MONTH_7, DAY_OF_MONTH_8, DAY_OF_MONTH_9, DAY_OF_MONTH_10, DAY_OF_MONTH_11, DAY_OF_MONTH_12, DAY_OF_MONTH_13, DAY_OF_MONTH_14, DAY_OF_MONTH_15, DAY_OF_MONTH_16, DAY_OF_MONTH_17, DAY_OF_MONTH_18, DAY_OF_MONTH_19, DAY_OF_MONTH_20, DAY_OF_MONTH_21, DAY_OF_MONTH_22, DAY_OF_MONTH_23, DAY_OF_MONTH_24, DAY_OF_MONTH_25, DAY_OF_MONTH_26, DAY_OF_MONTH_27, DAY_OF_MONTH_28, DAY_OF_MONTH_29, DAY_OF_MONTH_30, DAY_OF_MONTH_31, DAY_OF_MONTH_FIRST, DAY_OF_MONTH_LAST Enum values: DAY_OF_MONTH_UNSPECIFIED, DAY_OF_MONTH_1, DAY_OF_MONTH_2, DAY_OF_MONTH_3, DAY_OF_MONTH_4, DAY_OF_MONTH_5, DAY_OF_MONTH_6, DAY_OF_MONTH_7, DAY_OF_MONTH_8, DAY_OF_MONTH_9, DAY_OF_MONTH_10, DAY_OF_MONTH_11, DAY_OF_MONTH_12, DAY_OF_MONTH_13, DAY_OF_MONTH_14, DAY_OF_MONTH_15, DAY_OF_MONTH_16, DAY_OF_MONTH_17, DAY_OF_MONTH_18, DAY_OF_MONTH_19, DAY_OF_MONTH_20, DAY_OF_MONTH_21, DAY_OF_MONTH_22, DAY_OF_MONTH_23, DAY_OF_MONTH_24, DAY_OF_MONTH_25, DAY_OF_MONTH_26, DAY_OF_MONTH_27, DAY_OF_MONTH_28, DAY_OF_MONTH_29, DAY_OF_MONTH_30, DAY_OF_MONTH_31, DAY_OF_MONTH_FIRST, DAY_OF_MONTH_LAST --- ### DefaultContractTerm Type: object - value (integer): 期間数 - unit (object): 単位 - **value**: integer — 期間数 - **unit**: object — 単位 --- ### DefaultContractTerm.Unit - UNIT_MONTHLY: 月 Type: string Enum values: UNIT_UNSPECIFIED, UNIT_MONTHLY Enum values: UNIT_UNSPECIFIED, UNIT_MONTHLY --- ### DeleteCustomerRequest Type: object - id (string): 顧客ID - optionalId (string): 顧客管理ID(顧客IDの代わりに指定可) - **id**: string — 顧客ID - **optionalId**: string — 顧客管理ID(顧客IDの代わりに指定可) --- ### DeleteCustomerResponse Type: object --- ### DeleteCustomerStaffRequest Type: object - id (string): 顧客担当者ID - optionalId (string): 顧客担当者管理ID(顧客担当者IDの代わりに指定可) - customerId (string): 顧客ID - customerOptionalId (string): 顧客管理ID(顧客IDの代わりに指定可) - **id**: string — 顧客担当者ID - **optionalId**: string — 顧客担当者管理ID(顧客担当者IDの代わりに指定可) - **customerId**: string — 顧客ID - **customerOptionalId**: string — 顧客管理ID(顧客IDの代わりに指定可) --- ### DeleteCustomerStaffResponse Type: object --- ### ExpectedBilling Type: object - items (array): 請求項目 - billingDate (string): 請求日(RFC 3339 format) - dueDate (string): 期限日(RFC 3339 format) - total (number): 合計(税込)。請求項目の料金の合計 - totalTaxAmount (number): 税額 - totalTaxExcluded (number): 合計(税抜)。請求項目の料金の合計 - **items**: array — 請求項目 - **billingDate**: string — 請求日(RFC 3339 format) - **dueDate**: string — 期限日(RFC 3339 format) - **total**: number — 合計(税込)。請求項目の料金の合計 - **totalTaxAmount**: number — 税額 - **totalTaxExcluded**: number — 合計(税抜)。請求項目の料金の合計 --- ### ExpectedBilling.Item Type: object - name (string): 請求項目名 - unitPrice (number): 単価 - quantity (string): 数量 - subtotal (number): 小計 - taxPercentage (integer): 税率 - startDate (string): 開始日(RFC 3339 format) - endDate (string): 終了日(RFC 3339 format) - **name**: string — 請求項目名 - **unitPrice**: number — 単価 - **quantity**: string — 数量 - **subtotal**: number — 小計 - **taxPercentage**: integer — 税率 - **startDate**: string — 開始日(RFC 3339 format) - **endDate**: string — 終了日(RFC 3339 format) --- ### Extensions Type: object - billingDestination (object): 請求先顧客 - **billingDestination**: object — 請求先顧客 --- ### FincodeCustomer Type: object - customerId (string): 顧客ID - fincodeCustomerId (string): fincode顧客ID - **customerId**: string — 顧客ID - **fincodeCustomerId**: string — fincode顧客ID --- ### FlatFeeOption Type: object - price (number): 料金 - **price**: number — 料金 --- ### GetBillingRequest Type: object - id (string): 請求ID - **id**: string — 請求ID --- ### GetBillingResponse Type: object - billing (object): 請求 - **billing**: object — 請求 --- ### GetCatalogItemRequest Type: object - id (string): カタログアイテムID - optionalId (string): カタログアイテム管理ID(カタログアイテムIDの代わりに指定可) - **id**: string — カタログアイテムID - **optionalId**: string — カタログアイテム管理ID(カタログアイテムIDの代わりに指定可) --- ### GetCatalogItemResponse Type: object - catalogItem (object): - **catalogItem**: object — --- ### GetCustomerRequest Type: object - id (string): 顧客ID - optionalId (string): 顧客管理ID(顧客IDの代わりに指定可) - crmAccountId (string): 外部CRMサービスのアカウントID(顧客IDの代わりに指定可) - **id**: string — 顧客ID - **optionalId**: string — 顧客管理ID(顧客IDの代わりに指定可) - **crmAccountId**: string — 外部CRMサービスのアカウントID(顧客IDの代わりに指定可) --- ### GetCustomerResponse Type: object - customer (object): - **customer**: object — --- ### GetCustomerStaffRequest Type: object - id (string): 顧客担当者ID - optionalId (string): 顧客担当者管理ID(顧客担当者IDの代わりに指定可) - crmStaffId (string): 外部CRMサービスの担当者ID(顧客担当者IDの代わりに指定可) - customerId (string): 顧客ID - customerOptionalId (string): 顧客管理ID(顧客IDの代わりに指定可) - **id**: string — 顧客担当者ID - **optionalId**: string — 顧客担当者管理ID(顧客担当者IDの代わりに指定可) - **crmStaffId**: string — 外部CRMサービスの担当者ID(顧客担当者IDの代わりに指定可) - **customerId**: string — 顧客ID - **customerOptionalId**: string — 顧客管理ID(顧客IDの代わりに指定可) --- ### GetCustomerStaffResponse Type: object - customerStaff (object): 顧客担当者 - **customerStaff**: object — 顧客担当者 --- ### GetLinkedCustomerRequest Type: object - customerId (string): 顧客ID - **customerId**: string — 顧客ID --- ### GetLinkedCustomerResponse Type: object - fincodeCustomer (object): fincode顧客連携情報（紐づいていない場合はnull） - **fincodeCustomer**: object — fincode顧客連携情報（紐づいていない場合はnull） --- ### GetPaymentMethodRequest Type: object - id (string): 決済方法ID - optionalId (string): 決済方法管理ID(決済方法IDの代わりに指定可) - **id**: string — 決済方法ID - **optionalId**: string — 決済方法管理ID(決済方法IDの代わりに指定可) --- ### GetPaymentMethodResponse Type: object - paymentMethod (object): - **paymentMethod**: object — --- ### GetProductRequest Type: object - id (string): プロダクトID - optionalId (string): プロダクト管理ID(プロダクトIDの代わりに指定可) - **id**: string — プロダクトID - **optionalId**: string — プロダクト管理ID(プロダクトIDの代わりに指定可) --- ### GetProductResponse Type: object - product (object): - **product**: object — --- ### GetResourceRequest Type: object - srn (object): リソースの識別子 - **srn**: object — リソースの識別子 --- ### GetResourceResponse Type: object - resource (object): リソース - **resource**: object — リソース --- ### GetUsageUnitRequest Type: object - id (string): 使用量単位ID - optionalId (string): 使用量単位管理ID(使用量単位IDの代わりに指定可) - **id**: string — 使用量単位ID - **optionalId**: string — 使用量単位管理ID(使用量単位IDの代わりに指定可) --- ### GetUsageUnitResponse Type: object - usageUnit (object): - **usageUnit**: object — --- ### IsDraftFilterClause Type: object - isDraft (boolean): 下書きフラグ(trueで下書き契約のみ、falseで通常契約のみ取得) - **isDraft**: boolean — 下書きフラグ(trueで下書き契約のみ、falseで通常契約のみ取得) --- ### Item.ChargeItem Type: object - catalogChargeItemId (string): - optionalId (string): 契約課金項目管理ID(半角英数字と_-のみ使用できます) - billAllAtOnce (boolean): 一括請求オプション。指定しなければカタログアイテムに従います - quantity (integer): 契約数。料金モデルが従量制の場合に使用できます - name (string): 課金項目名。指定しなければカタログアイテムに従います - price (integer): 単価。カタログの料金モデルが定額または従量制のみで使用できます。指定しなければカタログアイテムに従います - billingTiming (object): 請求タイミング - billingDueTiming (object): 支払期限タイミング - tiers (array): ティア（段階別価格設定）。ボリューム/段階制の料金モデルで使用します。priceとは排他的です - **catalogChargeItemId**: string — - **optionalId**: string — 契約課金項目管理ID(半角英数字と_-のみ使用できます) - **billAllAtOnce**: boolean — 一括請求オプション。指定しなければカタログアイテムに従います - **quantity**: integer — 契約数。料金モデルが従量制の場合に使用できます - **name**: string — 課金項目名。指定しなければカタログアイテムに従います - **price**: integer — 単価。カタログの料金モデルが定額または従量制のみで使用できます。指定しなければカタログアイテムに従います - **billingTiming**: object — 請求タイミング - **billingDueTiming**: object — 支払期限タイミング - **tiers**: array — ティア（段階別価格設定）。ボリューム/段階制の料金モデルで使用します。priceとは排他的です --- ### Item.ChargeItem.Tier Type: object - upperLimit (string): ティアの上限値。省略時は上限なし（最後のティア） - kind (object): 料金計算式の種類 - unitPrice (string): 単価（KIND_PER_UNIT時に使用） - price (string): 定額価格（KIND_FLAT_FEE時に使用） - **upperLimit**: string — ティアの上限値。省略時は上限なし（最後のティア） - **kind**: object — 料金計算式の種類 - **unitPrice**: string — 単価（KIND_PER_UNIT時に使用） - **price**: string — 定額価格（KIND_FLAT_FEE時に使用） --- ### Item.ChargeItem.Tier.Kind - KIND_UNSPECIFIED: 未指定 - KIND_PER_UNIT: 従量制（単価×数量） - KIND_FLAT_FEE: 定額制 Type: string Enum values: KIND_UNSPECIFIED, KIND_PER_UNIT, KIND_FLAT_FEE Enum values: KIND_UNSPECIFIED, KIND_PER_UNIT, KIND_FLAT_FEE --- ### Item.ChargeItem.Timing Type: object - value (integer): 数(負数の場合は前を表す。例: { "value": -1, "unit": "UNIT_MONTHLY" } => 先月) - unit (object): 単位 - monthlyOption (object): UNIT_MONTHLY指定時のオプション - **value**: integer — 数(負数の場合は前を表す。例: { "value": -1, "unit": "UNIT_MONTHLY" } => 先月) - **unit**: object — 単位 - **monthlyOption**: object — UNIT_MONTHLY指定時のオプション --- ### Item.ChargeItem.Timing.MonthlyOption - MONTHLY_OPTION_FIRST_DAY_OF_MONTH: alias MONTHLY_OPTION_DAY_1 Type: string Enum values: MONTHLY_OPTION_UNSPECIFIED, MONTHLY_OPTION_DAY_1, MONTHLY_OPTION_DAY_2, MONTHLY_OPTION_DAY_3, MONTHLY_OPTION_DAY_4, MONTHLY_OPTION_DAY_5, MONTHLY_OPTION_DAY_6, MONTHLY_OPTION_DAY_7, MONTHLY_OPTION_DAY_8, MONTHLY_OPTION_DAY_9, MONTHLY_OPTION_DAY_10, MONTHLY_OPTION_DAY_11, MONTHLY_OPTION_DAY_12, MONTHLY_OPTION_DAY_13, MONTHLY_OPTION_DAY_14, MONTHLY_OPTION_DAY_15, MONTHLY_OPTION_DAY_16, MONTHLY_OPTION_DAY_17, MONTHLY_OPTION_DAY_18, MONTHLY_OPTION_DAY_19, MONTHLY_OPTION_DAY_20, MONTHLY_OPTION_DAY_21, MONTHLY_OPTION_DAY_22, MONTHLY_OPTION_DAY_23, MONTHLY_OPTION_DAY_24, MONTHLY_OPTION_DAY_25, MONTHLY_OPTION_DAY_26, MONTHLY_OPTION_DAY_27, MONTHLY_OPTION_DAY_28, MONTHLY_OPTION_DAY_29, MONTHLY_OPTION_DAY_30, MONTHLY_OPTION_DAY_31, MONTHLY_OPTION_FIRST_DAY_OF_MONTH, MONTHLY_OPTION_LAST_DAY_OF_MONTH Enum values: MONTHLY_OPTION_UNSPECIFIED, MONTHLY_OPTION_DAY_1, MONTHLY_OPTION_DAY_2, MONTHLY_OPTION_DAY_3, MONTHLY_OPTION_DAY_4, MONTHLY_OPTION_DAY_5, MONTHLY_OPTION_DAY_6, MONTHLY_OPTION_DAY_7, MONTHLY_OPTION_DAY_8, MONTHLY_OPTION_DAY_9, MONTHLY_OPTION_DAY_10, MONTHLY_OPTION_DAY_11, MONTHLY_OPTION_DAY_12, MONTHLY_OPTION_DAY_13, MONTHLY_OPTION_DAY_14, MONTHLY_OPTION_DAY_15, MONTHLY_OPTION_DAY_16, MONTHLY_OPTION_DAY_17, MONTHLY_OPTION_DAY_18, MONTHLY_OPTION_DAY_19, MONTHLY_OPTION_DAY_20, MONTHLY_OPTION_DAY_21, MONTHLY_OPTION_DAY_22, MONTHLY_OPTION_DAY_23, MONTHLY_OPTION_DAY_24, MONTHLY_OPTION_DAY_25, MONTHLY_OPTION_DAY_26, MONTHLY_OPTION_DAY_27, MONTHLY_OPTION_DAY_28, MONTHLY_OPTION_DAY_29, MONTHLY_OPTION_DAY_30, MONTHLY_OPTION_DAY_31, MONTHLY_OPTION_FIRST_DAY_OF_MONTH, MONTHLY_OPTION_LAST_DAY_OF_MONTH --- ### Item.ChargeItem.Timing.Unit - UNIT_DAILY: 日 - UNIT_MONTHLY: 月 Type: string Enum values: UNIT_UNSPECIFIED, UNIT_DAILY, UNIT_MONTHLY Enum values: UNIT_UNSPECIFIED, UNIT_DAILY, UNIT_MONTHLY --- ### LinkCustomerRequest Type: object - customerId (string): 顧客ID - fincodeCustomerId (string): fincode顧客ID - **customerId**: string — 顧客ID - **fincodeCustomerId**: string — fincode顧客ID --- ### LinkCustomerResponse Type: object - fincodeCustomer (object): fincode顧客連携情報 - **fincodeCustomer**: object — fincode顧客連携情報 --- ### ListAmendmentsByContractOptionalIdRequest Type: object - contractOptionalId (string): 契約管理ID - pageToken (string): 一覧取得に使用するトークン - pageSize (integer): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - **contractOptionalId**: string — 契約管理ID - **pageToken**: string — 一覧取得に使用するトークン - **pageSize**: integer — 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] --- ### ListAmendmentsByContractOptionalIdResponse Type: object - amendments (array): 改定 - nextPageToken (string): 次の一覧取得に使用するトークン - **amendments**: array — 改定 - **nextPageToken**: string — 次の一覧取得に使用するトークン --- ### ListAmendmentsByContractRequest Type: object - id (string): 契約ID - optionalId (string): 契約管理ID(契約IDの代わりに指定可) - pageToken (string): 一覧取得に使用するトークン - pageSize (integer): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - **id**: string — 契約ID - **optionalId**: string — 契約管理ID(契約IDの代わりに指定可) - **pageToken**: string — 一覧取得に使用するトークン - **pageSize**: integer — 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] --- ### ListAmendmentsByContractResponse Type: object - amendments (array): 改定 - nextPageToken (string): 次の一覧取得に使用するトークン - **amendments**: array — 改定 - **nextPageToken**: string — 次の一覧取得に使用するトークン --- ### ListAmendmentsRequest Type: object - pageToken (string): 一覧取得に使用するトークン - pageSize (integer): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - orderBy (object): ソート条件 example: ``` { "orderBy": [ { "field": "FIELD_EXECUTE_DATE", "direction": "DIRECTION_DESCENDING" } ] } ``` - **pageToken**: string — 一覧取得に使用するトークン - **pageSize**: integer — 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - **orderBy**: object — ソート条件 example: ``` { "orderBy": [ { "field": "FIELD_EXECUTE_DATE", "direction": "DIRECTION_DESCENDING" } ] } ``` --- ### ListAmendmentsResponse Type: object - amendments (array): 改定 - nextPageToken (string): - **amendments**: array — 改定 - **nextPageToken**: string — --- ### ListBillingsByContractRequest Type: object - id (string): 契約ID - optionalId (string): 契約管理ID(契約IDの代わりに指定可) - pageToken (string): 一覧取得に使用するトークン - pageSize (integer): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - orderBy (object): ソート条件 example: ``` { "orderBy": [ { "field": "FIELD_BILLING_DATE", "direction": "DIRECTION_DESCENDING" } ] } ``` - **id**: string — 契約ID - **optionalId**: string — 契約管理ID(契約IDの代わりに指定可) - **pageToken**: string — 一覧取得に使用するトークン - **pageSize**: integer — 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - **orderBy**: object — ソート条件 example: ``` { "orderBy": [ { "field": "FIELD_BILLING_DATE", "direction": "DIRECTION_DESCENDING" } ] } ``` --- ### ListBillingsByContractResponse Type: object - billings (array): 請求 - nextPageToken (string): 次の一覧取得に使用するトークン - **billings**: array — 請求 - **nextPageToken**: string — 次の一覧取得に使用するトークン --- ### ListBillingsRequest Type: object - pageToken (string): 一覧取得に使用するトークン - pageSize (integer): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - **pageToken**: string — 一覧取得に使用するトークン - **pageSize**: integer — 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] --- ### ListBillingsResponse Type: object - billings (array): 請求 - nextPageToken (string): 次の一覧取得に使用するトークン - **billings**: array — 請求 - **nextPageToken**: string — 次の一覧取得に使用するトークン --- ### ListCatalogItemsRequest Type: object - pageToken (string): 一覧取得に使用するトークン - pageSize (integer): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - **pageToken**: string — 一覧取得に使用するトークン - **pageSize**: integer — 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] --- ### ListCatalogItemsResponse Type: object - catalogItems (array): カタログアイテム - nextPageToken (string): - **catalogItems**: array — カタログアイテム - **nextPageToken**: string — --- ### ListContractsAtDateRequest Type: object - filters (array): 契約のフィルタ条件 - sortOrder (object): ソート順 - offsetToken (string): オフセット情報を含むページングトークン。 - pageSize (integer): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - atPointInServiceTimeline (string): 契約サービスタイムラインのどの時点での契約を取得するかの指定。 - **filters**: array — 契約のフィルタ条件 - **sortOrder**: object — ソート順 - **offsetToken**: string — オフセット情報を含むページングトークン。 - **pageSize**: integer — 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - **atPointInServiceTimeline**: string — 契約サービスタイムラインのどの時点での契約を取得するかの指定。 --- ### ListContractsAtDateRequest.FilterClause Type: object - contractEndDate (object): - contractItemEndDate (object): - customerEq (object): - isDraft (object): 下書きフラグフィルタ(未指定時はfalse扱い＝通常契約のみ) - **contractEndDate**: object — - **contractItemEndDate**: object — - **customerEq**: object — - **isDraft**: object — 下書きフラグフィルタ(未指定時はfalse扱い＝通常契約のみ) --- ### ListContractsAtDateResponse Type: object - contracts (array): 一覧の終端に到達していない場合でも、この配列の長さが page_size に満たない場合があり得る。 特に、リクエストしたオフセットからすぐに取得できる契約が存在しない場合は空配列となるが、 next_offset_token が null でない限り、次のページに進むことでさらに結果が得られる可能性が残される。 - nextOffsetToken (string): contracts が一覧の終端に到達し、次のページが新たに結果を含むことが無いことが分かるとき、null が返却される。 - **contracts**: array — 一覧の終端に到達していない場合でも、この配列の長さが page_size に満たない場合があり得る。 特に、リクエストしたオフセットからすぐに取得できる契約が存在しない場合は空配列となるが、 next_offset_token が null でない限り、次のページに進むことでさらに結果が得られる可能性が残される。 - **nextOffsetToken**: string — contracts が一覧の終端に到達し、次のページが新たに結果を含むことが無いことが分かるとき、null が返却される。 --- ### ListContractsByCustomerRequest Type: object - customerId (string): 顧客ID - customerOptionalId (string): 顧客管理ID(顧客IDの代わりに指定可) - pageToken (string): 一覧取得に使用するトークン - pageSize (integer): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - **customerId**: string — 顧客ID - **customerOptionalId**: string — 顧客管理ID(顧客IDの代わりに指定可) - **pageToken**: string — 一覧取得に使用するトークン - **pageSize**: integer — 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] --- ### ListContractsByCustomerResponse Type: object - contracts (array): - nextPageToken (string): 次の一覧取得に使用するトークン - **contracts**: array — - **nextPageToken**: string — 次の一覧取得に使用するトークン --- ### ListContractsRequest.FilterClause Type: object - contractEndDate (object): - contractItemEndDate (object): - statusIn (object): NOTE: 必要なデータ移行が完了したため、PREVIEW 制限を解除している。 - customerEq (object): - isDraft (object): 下書きフラグフィルタ(未指定時はfalse扱い＝通常契約のみ) - **contractEndDate**: object — - **contractItemEndDate**: object — - **statusIn**: object — NOTE: 必要なデータ移行が完了したため、PREVIEW 制限を解除している。 - **customerEq**: object — - **isDraft**: object — 下書きフラグフィルタ(未指定時はfalse扱い＝通常契約のみ) --- ### ListCustomFieldMastersRequest Type: object - pageToken (string): 一覧取得に使用するトークン - pageSize (integer): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - **pageToken**: string — 一覧取得に使用するトークン - **pageSize**: integer — 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] --- ### ListCustomFieldMastersResponse Type: object - customFieldMasters (array): カスタムフィールドマスター - nextPageToken (string): - **customFieldMasters**: array — カスタムフィールドマスター - **nextPageToken**: string — --- ### ListCustomerStaffsRequest Type: object - customerId (string): 顧客ID - customerOptionalId (string): 顧客管理ID(顧客IDの代わりに指定可) - pageToken (string): 一覧取得に使用するトークン - pageSize (integer): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - **customerId**: string — 顧客ID - **customerOptionalId**: string — 顧客管理ID(顧客IDの代わりに指定可) - **pageToken**: string — 一覧取得に使用するトークン - **pageSize**: integer — 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] --- ### ListCustomerStaffsResponse Type: object - customerStaffs (array): - nextPageToken (string): 次の一覧取得に使用するトークン - **customerStaffs**: array — - **nextPageToken**: string — 次の一覧取得に使用するトークン --- ### ListCustomersRequest Type: object - pageToken (string): 一覧取得に使用するトークン - pageSize (integer): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - **pageToken**: string — 一覧取得に使用するトークン - **pageSize**: integer — 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] --- ### ListCustomersResponse Type: object - customers (array): - nextPageToken (string): 次の一覧取得に使用するトークン - **customers**: array — - **nextPageToken**: string — 次の一覧取得に使用するトークン --- ### ListExpectedBillingsByContractRequest Type: object - id (string): 契約ID - optionalId (string): 契約管理ID(IDの代わりに指定可) - pageToken (string): 一覧取得に使用するトークン - pageSize (integer): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - **id**: string — 契約ID - **optionalId**: string — 契約管理ID(IDの代わりに指定可) - **pageToken**: string — 一覧取得に使用するトークン - **pageSize**: integer — 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] --- ### ListExpectedBillingsByContractResponse Type: object - expectedBillings (array): 請求予定 - nextPageToken (string): 次の一覧取得に使用するトークン - **expectedBillings**: array — 請求予定 - **nextPageToken**: string — 次の一覧取得に使用するトークン --- ### ListPaymentMethodsRequest Type: object - pageToken (string): 一覧取得に使用するトークン [デフォルト: 10 / 最小: 1 / 最大: 100] - pageSize (integer): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - orderBy (object): ソート条件 example: ``` { "orderBy": [ { "field": "FIELD_ID", "direction": "DIRECTION_DESCENDING" } ] } ``` - **pageToken**: string — 一覧取得に使用するトークン [デフォルト: 10 / 最小: 1 / 最大: 100] - **pageSize**: integer — 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - **orderBy**: object — ソート条件 example: ``` { "orderBy": [ { "field": "FIELD_ID", "direction": "DIRECTION_DESCENDING" } ] } ``` --- ### ListPaymentMethodsResponse Type: object - paymentMethods (array): - nextPageToken (string): 次の一覧取得に使用するトークン - **paymentMethods**: array — - **nextPageToken**: string — 次の一覧取得に使用するトークン --- ### ListUsageUnitsRequest Type: object - pageToken (string): 一覧取得に使用するトークン - pageSize (integer): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - **pageToken**: string — 一覧取得に使用するトークン - **pageSize**: integer — 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] --- ### ListUsageUnitsResponse Type: object - usageUnits (array): - nextPageToken (string): 次の一覧取得に使用するトークン - **usageUnits**: array — - **nextPageToken**: string — 次の一覧取得に使用するトークン --- ### NullValue `NullValue` is a singleton enumeration to represent the null value for the `Value` type union. The JSON representation for `NullValue` is JSON `null`. - NULL_VALUE: Null value. Type: string Enum values: NULL_VALUE Enum values: NULL_VALUE --- ### Order Type: object - field (object): - direction (object): - **field**: object — - **direction**: object — --- ### Order.Direction - DIRECTION_ASCENDING: 昇順 - DIRECTION_DESCENDING: 降順 Type: string Enum values: DIRECTION_UNSPECIFIED, DIRECTION_ASCENDING, DIRECTION_DESCENDING Enum values: DIRECTION_UNSPECIFIED, DIRECTION_ASCENDING, DIRECTION_DESCENDING --- ### Order.Field - FIELD_ID: ID - FIELD_EXECUTE_DATE: 改定実行日 - FIELD_EFFECTIVE_START_DATE: 改定の有効開始日 Type: string Enum values: FIELD_UNSPECIFIED, FIELD_ID, FIELD_EXECUTE_DATE, FIELD_EFFECTIVE_START_DATE Enum values: FIELD_UNSPECIFIED, FIELD_ID, FIELD_EXECUTE_DATE, FIELD_EFFECTIVE_START_DATE --- ### PayPerUse Type: string Enum values: PAY_PER_USE_UNSPECIFIED, PAY_PER_USE_QUANTITY, PAY_PER_USE_USAGE Enum values: PAY_PER_USE_UNSPECIFIED, PAY_PER_USE_QUANTITY, PAY_PER_USE_USAGE --- ### PaymentMethod Type: object - id (string): 決済方法ID - optionalId (string): 決済方法管理ID（更新時、決済方法IDの代わりに指定可） - name (string): 決済方法名 - type (object): 決済方法種別 - **id**: string — 決済方法ID - **optionalId**: string — 決済方法管理ID（更新時、決済方法IDの代わりに指定可） - **name**: string — 決済方法名 - **type**: object — 決済方法種別 --- ### PaymentMethod.Type Type: string Enum values: TYPE_UNSPECIFIED, TYPE_CSV_DOWNLOAD, TYPE_SCALEBASE_PAYMENT, TYPE_MFCLOUD_INVOICE, TYPE_FREEE_INVOICE, TYPE_MAKELEAPS Enum values: TYPE_UNSPECIFIED, TYPE_CSV_DOWNLOAD, TYPE_SCALEBASE_PAYMENT, TYPE_MFCLOUD_INVOICE, TYPE_FREEE_INVOICE, TYPE_MAKELEAPS --- ### PaymentMethodIdentifier Type: object - paymentMethodId (string): 決済方法ID - paymentMethodOptionalId (string): 決済方法管理ID(決済方法IDの代わりに指定可) - **paymentMethodId**: string — 決済方法ID - **paymentMethodOptionalId**: string — 決済方法管理ID(決済方法IDの代わりに指定可) --- ### PaymentMethodOrder Type: object - field (object): - direction (object): - **field**: object — - **direction**: object — --- ### PaymentMethodOrder.Direction - DIRECTION_ASCENDING: 昇順 - DIRECTION_DESCENDING: 降順 Type: string Enum values: DIRECTION_UNSPECIFIED, DIRECTION_ASCENDING, DIRECTION_DESCENDING Enum values: DIRECTION_UNSPECIFIED, DIRECTION_ASCENDING, DIRECTION_DESCENDING --- ### PaymentMethodOrder.Field - FIELD_ID: 請求ID Type: string Enum values: FIELD_UNSPECIFIED, FIELD_ID Enum values: FIELD_UNSPECIFIED, FIELD_ID --- ### PaymentRecord Type: object - billingId (string): 請求ID - paidAt (string): 入金日 - **billingId**: string — 請求ID - **paidAt**: string — 入金日 --- ### PaymentRecordError Type: object - billingId (string): 請求ID - errorType (object): エラータイプ - message (string): エラーメッセージ - **billingId**: string — 請求ID - **errorType**: object — エラータイプ - **message**: string — エラーメッセージ --- ### PaymentRecordError.ErrorType Type: string Enum values: ERROR_TYPE_UNSPECIFIED, ERROR_TYPE_NOT_FOUND, ERROR_TYPE_INVALID_STATUS, ERROR_TYPE_INVALID_AMOUNT, ERROR_TYPE_STORE_FAILED Enum values: ERROR_TYPE_UNSPECIFIED, ERROR_TYPE_NOT_FOUND, ERROR_TYPE_INVALID_STATUS, ERROR_TYPE_INVALID_AMOUNT, ERROR_TYPE_STORE_FAILED --- ### PaymentSummary Type: object - totalCount (integer): 要求された請求数 - successCount (integer): 成功した請求数 - failedCount (integer): 失敗した請求数 - **totalCount**: integer — 要求された請求数 - **successCount**: integer — 成功した請求数 - **failedCount**: integer — 失敗した請求数 --- ### PerUnitOption Type: object - price (number): 単価 - payPerUse (object): 従量測定方式 - **price**: number — 単価 - **payPerUse**: object — 従量測定方式 --- ### PricingModel Type: object - type (object): - flatFeeOption (object): - perUnitOption (object): - volumeOption (object): - tieredOption (object): - **type**: object — - **flatFeeOption**: object — - **perUnitOption**: object — - **volumeOption**: object — - **tieredOption**: object — --- ### PricingModel.FeeFormula Type: string Enum values: FEE_FORMULA_UNSPECIFIED, FEE_FORMULA_FLAT_FEE, FEE_FORMULA_PER_UNIT Enum values: FEE_FORMULA_UNSPECIFIED, FEE_FORMULA_FLAT_FEE, FEE_FORMULA_PER_UNIT --- ### PricingModel.Tier Type: object - unitPrice (number): 単価 - feeFormula (object): 計算式 - upperLimit (number): 上限値(未指定時は上限なし) - **unitPrice**: number — 単価 - **feeFormula**: object — 計算式 - **upperLimit**: number — 上限値(未指定時は上限なし) --- ### PricingModel.Type Type: string Enum values: TYPE_UNSPECIFIED, TYPE_FLAT_FEE, TYPE_PER_UNIT, TYPE_VOLUME_PRICING, TYPE_TIERED_PRICING Enum values: TYPE_UNSPECIFIED, TYPE_FLAT_FEE, TYPE_PER_UNIT, TYPE_VOLUME_PRICING, TYPE_TIERED_PRICING --- ### Product Type: object - id (string): プロダクトID - optionalId (string): プロダクト管理ID - name (string): プロダクト名 - description (string): プロダクト概要 - **id**: string — プロダクトID - **optionalId**: string — プロダクト管理ID - **name**: string — プロダクト名 - **description**: string — プロダクト概要 --- ### RenewContractItemRequest Type: object - contractId (string): 契約ID - contractItemId (string): 契約アイテムID - memo (string): 改定メモ - **contractId**: string — 契約ID - **contractItemId**: string — 契約アイテムID - **memo**: string — 改定メモ --- ### RenewContractItemResponse Type: object - contract (object): 対象の契約 - amendment (object): 改定 - **contract**: object — 対象の契約 - **amendment**: object — 改定 --- ### RenewContractItemResponse.Amendment Type: object - id (string): - **id**: string — --- ### RenewContractItemResponse.Contract Type: object - id (string): - **id**: string — --- ### RenewalWithQuantityChangeExpectedBillingRequest Type: object - id (string): 契約ID - optionalId (string): 契約管理ID(IDの代わりに指定可) - contractChargeItemId (string): 契約の課金項目ID（ContractChargeItemId） - quantity (integer): 新しい数量 - changeQuantityDailyRate (object): 契約数変更における日割り設定 - **id**: string — 契約ID - **optionalId**: string — 契約管理ID(IDの代わりに指定可) - **contractChargeItemId**: string — 契約の課金項目ID（ContractChargeItemId） - **quantity**: integer — 新しい数量 - **changeQuantityDailyRate**: object — 契約数変更における日割り設定 --- ### RenewalWithQuantityChangeExpectedBillingResponse Type: object - expectedBilling (object): - **expectedBilling**: object — --- ### Resource Type: object - srn (object): - sra (object): - customFields (array): カスタムフィールド - **srn**: object — - **sra**: object — - **customFields**: array — カスタムフィールド --- ### Rounding Type: string Enum values: ROUNDING_UNSPECIFIED, ROUNDING_ROUND_UP, ROUNDING_ROUND_DOWN, ROUNDING_ROUND_HALF_UP Enum values: ROUNDING_UNSPECIFIED, ROUNDING_ROUND_UP, ROUNDING_ROUND_DOWN, ROUNDING_ROUND_HALF_UP --- ### SRA Type: object - optionalId (string): 管理ID - resourceType (object): - **optionalId**: string — 管理ID - **resourceType**: object — --- ### SRA.Type Type: string Enum values: TYPE_UNSPECIFIED, TYPE_CUSTOMER, TYPE_CONTRACT Enum values: TYPE_UNSPECIFIED, TYPE_CUSTOMER, TYPE_CONTRACT --- ### SRN Type: object - resourceId (string): リソースID - resourceType (object): - **resourceId**: string — リソースID - **resourceType**: object — --- ### SRN.Type Type: string Enum values: TYPE_UNSPECIFIED, TYPE_CUSTOMER, TYPE_CONTRACT, TYPE_CONTRACT_SERVICE, TYPE_CONTRACT_ITEM, TYPE_BILLING, TYPE_CATALOG_ITEM Enum values: TYPE_UNSPECIFIED, TYPE_CUSTOMER, TYPE_CONTRACT, TYPE_CONTRACT_SERVICE, TYPE_CONTRACT_ITEM, TYPE_BILLING, TYPE_CATALOG_ITEM --- ### SearchBillingsRequest Type: object - pageToken (string): 一覧取得に使用するトークン - pageSize (integer): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - query (string): template: :10:8: executing "" at <.EnumType>: can't evaluate field EnumType in type *descriptor.Field - filter (array): フィルター - orderBy (object): ソート条件 example: ``` { "orderBy": [ { "field": "FIELD_BILLING_DATE", "direction": "DIRECTION_DESCENDING" } ] } ``` - **pageToken**: string — 一覧取得に使用するトークン - **pageSize**: integer — 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - **query**: string — template: :10:8: executing "" at <.EnumType>: can't evaluate field EnumType in type *descriptor.Field - **filter**: array — フィルター - **orderBy**: object — ソート条件 example: ``` { "orderBy": [ { "field": "FIELD_BILLING_DATE", "direction": "DIRECTION_DESCENDING" } ] } ``` --- ### SearchBillingsRequest.Clause Type: object - status (object): - billingDate (object): - statuses (object): - **status**: object — - **billingDate**: object — - **statuses**: object — --- ### SearchBillingsResponse Type: object - billings (array): 請求 - nextPageToken (string): - **billings**: array — 請求 - **nextPageToken**: string — --- ### SearchContractsRequest Type: object - pageToken (string): 一覧取得に使用するトークン - pageSize (integer): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - filter (array): フィルター example: ``` { "contractEndDate": { "gte": "2025-01-23T00:00:00+09:00" }} { "contractItemEndDate": { "gte": "2025-01-31T15:00:00.000Z" }} ``` - orderBy (object): ソート条件 example: ``` { "orderBy": [ { "field": "FIELD_UPDATED_AT", "direction": "DIRECTION_DESCENDING" } ] } ``` - **pageToken**: string — 一覧取得に使用するトークン - **pageSize**: integer — 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - **filter**: array — フィルター example: ``` { "contractEndDate": { "gte": "2025-01-23T00:00:00+09:00" }} { "contractItemEndDate": { "gte": "2025-01-31T15:00:00.000Z" }} ``` - **orderBy**: object — ソート条件 example: ``` { "orderBy": [ { "field": "FIELD_UPDATED_AT", "direction": "DIRECTION_DESCENDING" } ] } ``` --- ### SearchContractsRequest.Clause Type: object - contractEndDate (object): - contractItemEndDate (object): - isDraft (boolean): 下書きフラグフィルタ(trueで下書き契約のみ、falseで通常契約のみ取得。未指定時はfalse扱い) - **contractEndDate**: object — - **contractItemEndDate**: object — - **isDraft**: boolean — 下書きフラグフィルタ(trueで下書き契約のみ、falseで通常契約のみ取得。未指定時はfalse扱い) --- ### SearchContractsResponse Type: object - contracts (array): 契約 - nextPageToken (string): 次の一覧取得に使用するトークン - **contracts**: array — 契約 - **nextPageToken**: string — 次の一覧取得に使用するトークン --- ### Service.MainItem Type: object - catalogItemIdentifier (object): カタログアイテム識別子 - startDate (string): 契約開始日(RFC 3339 format) - endDate (string): 契約終了日(省略時は更新時に延長される期間から算出(RFC 3339 format)) - defaultContractTerm (object): 更新時に延長される期間(省略時はカタログから適用されます) - name (string): アイテム名（省略時はカタログから適用されます） - chargeItems (array): 課金項目パラメータ - availabilityCycle (object): 利用周期(省略時はカタログの利用周期から適用されます) - autoRenewal (object): 自動更新設定(省略時はカタログの自動更新設定が継承されます) - **catalogItemIdentifier**: object — カタログアイテム識別子 - **startDate**: string — 契約開始日(RFC 3339 format) - **endDate**: string — 契約終了日(省略時は更新時に延長される期間から算出(RFC 3339 format)) - **defaultContractTerm**: object — 更新時に延長される期間(省略時はカタログから適用されます) - **name**: string — アイテム名（省略時はカタログから適用されます） - **chargeItems**: array — 課金項目パラメータ - **availabilityCycle**: object — 利用周期(省略時はカタログの利用周期から適用されます) - **autoRenewal**: object — 自動更新設定(省略時はカタログの自動更新設定が継承されます) --- ### Service.OptionItem Type: object - catalogItemIdentifier (object): カタログアイテム識別子 - startDate (string): 契約開始日(RFC 3339 format) - endDate (string): 契約終了日(省略時は更新時に延長される期間から算出(RFC 3339 format)) - defaultContractTerm (object): 更新時に延長される期間(省略時はカタログから適用されます) - name (string): アイテム名（省略時はカタログから適用されます） - chargeItems (array): 課金項目パラメータ - availabilityCycle (object): 利用周期(省略時はカタログの利用周期から適用されます) - autoRenewal (object): 自動更新設定(省略時はカタログの自動更新設定が継承されます) - **catalogItemIdentifier**: object — カタログアイテム識別子 - **startDate**: string — 契約開始日(RFC 3339 format) - **endDate**: string — 契約終了日(省略時は更新時に延長される期間から算出(RFC 3339 format)) - **defaultContractTerm**: object — 更新時に延長される期間(省略時はカタログから適用されます) - **name**: string — アイテム名（省略時はカタログから適用されます） - **chargeItems**: array — 課金項目パラメータ - **availabilityCycle**: object — 利用周期(省略時はカタログの利用周期から適用されます) - **autoRenewal**: object — 自動更新設定(省略時はカタログの自動更新設定が継承されます) --- ### ServingStatus - SERVICE_UNKNOWN: Used only by the Watch method. Type: string Enum values: UNKNOWN, SERVING, NOT_SERVING, SERVICE_UNKNOWN Enum values: UNKNOWN, SERVING, NOT_SERVING, SERVICE_UNKNOWN --- ### Status.Status Type: string Enum values: 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 Enum values: 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 --- ### Statuses Type: object - in (array): - **in**: array — --- ### TieredOption Type: object - payPerUse (object): 従量測定方式 - tiers (array): - **payPerUse**: object — 従量測定方式 - **tiers**: array — --- ### UnlinkCustomerRequest Type: object - customerId (string): 顧客ID - **customerId**: string — 顧客ID --- ### UnlinkCustomerResponse Type: object --- ### UpdateCustomerResponse Type: object - customer (object): 顧客 - **customer**: object — 顧客 --- ### UpdateCustomerStaffResponse Type: object - customerStaff (object): 顧客担当者 - **customerStaff**: object — 顧客担当者 --- ### UpdatePaymentMethodRequest Type: object - contractIdentifier (object): 契約識別子 - paymentMethodIdentifier (object): 決済方法識別子 - **contractIdentifier**: object — 契約識別子 - **paymentMethodIdentifier**: object — 決済方法識別子 --- ### UpdatePaymentMethodRequest.ContractIdentifier Type: object - contractId (string): 契約ID - contractOptionalId (string): 契約管理ID(契約IDの代わりに指定可) - **contractId**: string — 契約ID - **contractOptionalId**: string — 契約管理ID(契約IDの代わりに指定可) --- ### UpdatePaymentMethodResponse Type: object - contract (object): 更新された契約 - **contract**: object — 更新された契約 --- ### UpdateResourceResponse Type: object - resource (object): リソース - **resource**: object — リソース --- ### UpdateSummary Type: object - totalCount (integer): 要求された請求数 - successCount (integer): 更新に成功した請求数 - failedCount (integer): 更新に失敗した請求数 - **totalCount**: integer — 要求された請求数 - **successCount**: integer — 更新に成功した請求数 - **failedCount**: integer — 更新に失敗した請求数 --- ### UpsertDailyUsageByContractAndUsageUnitRequest Type: object - contractOptionalId (string): 契約管理ID - usageUnitOptionalId (string): 使用量単位管理ID - targetDate (string): 対象日(RFC 3339 format) - quantity (number): 計測された値 - **contractOptionalId**: string — 契約管理ID - **usageUnitOptionalId**: string — 使用量単位管理ID - **targetDate**: string — 対象日(RFC 3339 format) - **quantity**: number — 計測された値 --- ### UpsertDailyUsageByContractAndUsageUnitResponse Type: object - usage (object): - **usage**: object — --- ### UpsertDailyUsageByOptionalIdRequest Type: object - contractOptionalId (string): 契約管理ID - usageUnitOptionalId (string): 使用量単位管理ID - targetDate (string): 対象日(RFC 3339 format) - quantity (number): 計測された値 - **contractOptionalId**: string — 契約管理ID - **usageUnitOptionalId**: string — 使用量単位管理ID - **targetDate**: string — 対象日(RFC 3339 format) - **quantity**: number — 計測された値 --- ### UpsertDailyUsageByOptionalIdResponse Type: object - usage (object): - **usage**: object — --- ### UpsertDailyUsageRequest Type: object - contractChargeItemId (string): 契約課金項目ID - customerId (string): 顧客ID - customerOptionalId (string): 顧客管理ID(顧客IDの代わりに指定可) - usageUnitId (string): 使用量単位ID - usageUnitOptionalId (string): 使用量単位管理ID(使用量単位IDの代わりに指定可) - targetDate (string): 対象日(RFC 3339 format) - quantity (number): 計測された値 - **contractChargeItemId**: string — 契約課金項目ID - **customerId**: string — 顧客ID - **customerOptionalId**: string — 顧客管理ID(顧客IDの代わりに指定可) - **usageUnitId**: string — 使用量単位ID - **usageUnitOptionalId**: string — 使用量単位管理ID(使用量単位IDの代わりに指定可) - **targetDate**: string — 対象日(RFC 3339 format) - **quantity**: number — 計測された値 --- ### UpsertDailyUsageResponse Type: object - usage (object): - **usage**: object — --- ### VolumeOption Type: object - payPerUse (object): 従量測定方式 - tiers (array): - **payPerUse**: object — 従量測定方式 - **tiers**: array — --- ### public.v1.Billing Type: object - id (string): 請求ID - invoiceNumber (string): 請求書番号 - total (string): 請求金額 - tax (string): 税額 - status (object): ステータス - paymentMethodId (string): 決済方法ID - billingDate (string): 請求日(RFC 3339 format) - billingDueDate (string): 支払期限日(RFC 3339 format) - billingIssueDate (string): 請求生成日(RFC 3339 format) - billingItems (array): 請求アイテム - billingCustomerStaffs (array): 請求先の顧客顧客担当者 - **id**: string — 請求ID - **invoiceNumber**: string — 請求書番号 - **total**: string — 請求金額 - **tax**: string — 税額 - **status**: object — ステータス - **paymentMethodId**: string — 決済方法ID - **billingDate**: string — 請求日(RFC 3339 format) - **billingDueDate**: string — 支払期限日(RFC 3339 format) - **billingIssueDate**: string — 請求生成日(RFC 3339 format) - **billingItems**: array — 請求アイテム - **billingCustomerStaffs**: array — 請求先の顧客顧客担当者 --- ### public.v1.Billing.Status Type: string Enum values: 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 Enum values: 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 --- ### public.v1.CheckResponse Type: object - status (object): ステータス - metadata (object): (メタデータ) - **status**: object — ステータス - **metadata**: object — (メタデータ) --- ### public.v1.GetProviderRequest Type: object --- ### public.v1.GetProviderResponse Type: object - provider (object): プロバイダー - **provider**: object — プロバイダー --- ### public.v1.Provider Type: object - id (string): プロバイダーID - name (string): 企業名 - representativeName (object): 代表氏名 - phoneNumber (string): 電話番号 - emailAddress (string): メールアドレス - address (object): 住所 - **id**: string — プロバイダーID - **name**: string — 企業名 - **representativeName**: object — 代表氏名 - **phoneNumber**: string — 電話番号 - **emailAddress**: string — メールアドレス - **address**: object — 住所 --- ### public.v1.Provider.Address Type: object - zipCode (string): 郵便番号 - country (object): 国 - prefecture (object): 都道府県 - city (string): 市区町村 - addressLines (array): [番地, 建物名・階数] - **zipCode**: string — 郵便番号 - **country**: object — 国 - **prefecture**: object — 都道府県 - **city**: string — 市区町村 - **addressLines**: array — [番地, 建物名・階数] --- ### public.v1.Provider.Address.Country Type: string Enum values: COUNTRY_UNSPECIFIED, COUNTRY_JP Enum values: COUNTRY_UNSPECIFIED, COUNTRY_JP --- ### public.v1.Provider.Address.Prefecture Type: string Enum values: PREFECTURE_UNSPECIFIED, PREFECTURE_HOKKAIDO, PREFECTURE_AOMORI, PREFECTURE_IWATE, PREFECTURE_MIYAGI, PREFECTURE_AKITA, PREFECTURE_YAMAGATA, PREFECTURE_FUKUSHIMA, PREFECTURE_IBARAKI, PREFECTURE_TOCHIGI, PREFECTURE_GUNMA, PREFECTURE_SAITAMA, PREFECTURE_CHIBA, PREFECTURE_TOKYO, PREFECTURE_KANAGAWA, PREFECTURE_NIIGATA, PREFECTURE_TOYAMA, PREFECTURE_ISHIKAWA, PREFECTURE_FUKUI, PREFECTURE_YAMANASHI, PREFECTURE_NAGANO, PREFECTURE_GIFU, PREFECTURE_SHIZUOKA, PREFECTURE_AICHI, PREFECTURE_MIE, PREFECTURE_SHIGA, PREFECTURE_KYOTO, PREFECTURE_OSAKA, PREFECTURE_HYOGO, PREFECTURE_NARA, PREFECTURE_WAKAYAMA, PREFECTURE_TOTTORI, PREFECTURE_SHIMANE, PREFECTURE_OKAYAMA, PREFECTURE_HIROSHIMA, PREFECTURE_YAMAGUCHI, PREFECTURE_TOKUSHIMA, PREFECTURE_KAGAWA, PREFECTURE_EHIME, PREFECTURE_KOCHI, PREFECTURE_FUKUOKA, PREFECTURE_SAGA, PREFECTURE_NAGASAKI, PREFECTURE_KUMAMOTO, PREFECTURE_OITA, PREFECTURE_MIYAZAKI, PREFECTURE_KAGOSHIMA, PREFECTURE_OKINAWA Enum values: PREFECTURE_UNSPECIFIED, PREFECTURE_HOKKAIDO, PREFECTURE_AOMORI, PREFECTURE_IWATE, PREFECTURE_MIYAGI, PREFECTURE_AKITA, PREFECTURE_YAMAGATA, PREFECTURE_FUKUSHIMA, PREFECTURE_IBARAKI, PREFECTURE_TOCHIGI, PREFECTURE_GUNMA, PREFECTURE_SAITAMA, PREFECTURE_CHIBA, PREFECTURE_TOKYO, PREFECTURE_KANAGAWA, PREFECTURE_NIIGATA, PREFECTURE_TOYAMA, PREFECTURE_ISHIKAWA, PREFECTURE_FUKUI, PREFECTURE_YAMANASHI, PREFECTURE_NAGANO, PREFECTURE_GIFU, PREFECTURE_SHIZUOKA, PREFECTURE_AICHI, PREFECTURE_MIE, PREFECTURE_SHIGA, PREFECTURE_KYOTO, PREFECTURE_OSAKA, PREFECTURE_HYOGO, PREFECTURE_NARA, PREFECTURE_WAKAYAMA, PREFECTURE_TOTTORI, PREFECTURE_SHIMANE, PREFECTURE_OKAYAMA, PREFECTURE_HIROSHIMA, PREFECTURE_YAMAGUCHI, PREFECTURE_TOKUSHIMA, PREFECTURE_KAGAWA, PREFECTURE_EHIME, PREFECTURE_KOCHI, PREFECTURE_FUKUOKA, PREFECTURE_SAGA, PREFECTURE_NAGASAKI, PREFECTURE_KUMAMOTO, PREFECTURE_OITA, PREFECTURE_MIYAZAKI, PREFECTURE_KAGOSHIMA, PREFECTURE_OKINAWA --- ### public.v1.Provider.Name Type: object - firstName (string): 名 - lastName (string): 姓 - **firstName**: string — 名 - **lastName**: string — 姓 --- ### rpc.Status Type: object - code (integer): - message (string): - details (array): - **code**: integer — - **message**: string — - **details**: array — --- ### v1.Amendment Type: object - id (string): 改定ID - amendmentType (object): 改定タイプ - contractId (string): 契約ID - version (integer): バージョン - executeDate (string): 改定実行日(RFC 3339 format) - effectiveStartDate (string): 改定の有効開始日(RFC 3339 format) - memo (string): 改定メモ - targetContractItemId (string): 対象の課金項目ID - **id**: string — 改定ID - **amendmentType**: object — 改定タイプ - **contractId**: string — 契約ID - **version**: integer — バージョン - **executeDate**: string — 改定実行日(RFC 3339 format) - **effectiveStartDate**: string — 改定の有効開始日(RFC 3339 format) - **memo**: string — 改定メモ - **targetContractItemId**: string — 対象の課金項目ID --- ### v1.CatalogChargeItem Type: object - id (string): カタログ課金項目ID - name (string): 課金項目名 - billAllAtOnce (boolean): 一括請求オプション - unitPrice (string): 単価 - chargeItemType (object): 課金項目タイプ - pricingModelType (object): 料金モデルタイプ - pricingModel (object): 料金モデルの詳細 - billingTiming (object): 請求タイミング(ex: 翌々月 初日) - billingDueTiming (object): 支払期限タイミング - billingCycle (object): 請求周期 - scale (integer): 端数処理の精度 - rounding (object): 端数処理の方法 - startDailyRate (object): 開始月日割設定 - endDailyRate (object): 終了月日割設定 - usageUnitId (string): 使用量単位ID（従量課金の場合に指定） - estimateItemName (string): 見積書記載名 - **id**: string — カタログ課金項目ID - **name**: string — 課金項目名 - **billAllAtOnce**: boolean — 一括請求オプション - **unitPrice**: string — 単価 - **chargeItemType**: object — 課金項目タイプ - **pricingModelType**: object — 料金モデルタイプ - **pricingModel**: object — 料金モデルの詳細 - **billingTiming**: object — 請求タイミング(ex: 翌々月 初日) - **billingDueTiming**: object — 支払期限タイミング - **billingCycle**: object — 請求周期 - **scale**: integer — 端数処理の精度 - **rounding**: object — 端数処理の方法 - **startDailyRate**: object — 開始月日割設定 - **endDailyRate**: object — 終了月日割設定 - **usageUnitId**: string — 使用量単位ID（従量課金の場合に指定） - **estimateItemName**: string — 見積書記載名 --- ### v1.ConfirmDraftContractRequest Type: object - contractId (string): 契約ID - **contractId**: string — 契約ID --- ### v1.ConfirmDraftContractResponse Type: object - contract (object): 契約 - **contract**: object — 契約 --- ### v1.Contract Type: object - id (string): 契約ID - optionalId (string): 契約管理ID - mainItems (array): メイン契約アイテム - customFields (array): 契約カスタムフィールド - version (integer): 契約バージョン - customerId (string): 契約顧客ID - paymentMethodId (string): 決済手段ID - billingCustomerStaffIds (array): 請求担当者ID（配列の先頭が主請求担当者） - shippingCustomerStaffIds (array): 納入先担当者ID（配列の先頭が主納入先担当者） - isDraft (boolean): 下書きフラグ - **id**: string — 契約ID - **optionalId**: string — 契約管理ID - **mainItems**: array — メイン契約アイテム - **customFields**: array — 契約カスタムフィールド - **version**: integer — 契約バージョン - **customerId**: string — 契約顧客ID - **paymentMethodId**: string — 決済手段ID - **billingCustomerStaffIds**: array — 請求担当者ID（配列の先頭が主請求担当者） - **shippingCustomerStaffIds**: array — 納入先担当者ID（配列の先頭が主納入先担当者） - **isDraft**: boolean — 下書きフラグ --- ### v1.Contract.ChargeItem Type: object - id (string): 契約課金項目ID - billAllAtOnce (boolean): 一括請求オプション(定期課金の契約課金項目の場合のみ返却されます。使用量ベース定期課金では常にfalse) - name (string): 契約課金項目名 - quantity (string): 契約数。すべての料金モデルで使用できます。定額制の場合は1に正規化されます - usageUnitId (string): (DEPRECATED: usage_unit.id をお使いください) 使用量単位ID(使用量ベースの課金項目の場合のみ返却されます) - usageUnit (object): 使用量単位(使用量ベースの課金項目の場合のみ返却されます) - pricingModelType (string): 料金計算モデル NOTE: StringValue だと空文字とのマッピングに問題があるため optional string を使用しています - tiers (array): ティア - billingCycle (object): 請求周期 - **id**: string — 契約課金項目ID - **billAllAtOnce**: boolean — 一括請求オプション(定期課金の契約課金項目の場合のみ返却されます。使用量ベース定期課金では常にfalse) - **name**: string — 契約課金項目名 - **quantity**: string — 契約数。すべての料金モデルで使用できます。定額制の場合は1に正規化されます - **usageUnitId**: string — (DEPRECATED: usage_unit.id をお使いください) 使用量単位ID(使用量ベースの課金項目の場合のみ返却されます) - **usageUnit**: object — 使用量単位(使用量ベースの課金項目の場合のみ返却されます) - **pricingModelType**: string — 料金計算モデル NOTE: StringValue だと空文字とのマッピングに問題があるため optional string を使用しています - **tiers**: array — ティア - **billingCycle**: object — 請求周期 --- ### v1.Contract.ChargeItem.Tier Type: object - upperLimit (string): - kind (object): - unitPrice (string): - price (string): - **upperLimit**: string — - **kind**: object — - **unitPrice**: string — - **price**: string — --- ### v1.Contract.ChargeItem.UsageUnit Type: object - id (string): 使用量単位ID - optionalId (string): 使用量単位管理ID - **id**: string — 使用量単位ID - **optionalId**: string — 使用量単位管理ID --- ### v1.Contract.CustomField Type: object - masterId (string): カスタムフィールドマスターID - value (string): カスタムフィールド値 - **masterId**: string — カスタムフィールドマスターID - **value**: string — カスタムフィールド値 --- ### v1.Contract.Item Type: object - id (string): 契約アイテムID - chargeItems (array): 契約課金項目 - optionItems (array): オプション契約アイテム（自身がオプションアイテムの場合は空） - status (object): 契約アイテムステータス - startDate (string): 契約開始日(RFC 3339 format) - endDate (string): 契約終了日(RFC 3339 format) - defaultContractTerm (object): 基本契約期間 - name (string): アイテム名 - availabilityCycle (object): 利用周期 - **id**: string — 契約アイテムID - **chargeItems**: array — 契約課金項目 - **optionItems**: array — オプション契約アイテム（自身がオプションアイテムの場合は空） - **status**: object — 契約アイテムステータス - **startDate**: string — 契約開始日(RFC 3339 format) - **endDate**: string — 契約終了日(RFC 3339 format) - **defaultContractTerm**: object — 基本契約期間 - **name**: string — アイテム名 - **availabilityCycle**: object — 利用周期 --- ### v1.Contract.Item.Status Type: string Enum values: STATUS_UNSPECIFIED, STATUS_WAITING_ACTIVATION, STATUS_ACTIVE, STATUS_WAITING_CANCELLATION, STATUS_CANCELED, STATUS_WAITING_COMPLETION, STATUS_COMPLETED, STATUS_INVALIDATED Enum values: STATUS_UNSPECIFIED, STATUS_WAITING_ACTIVATION, STATUS_ACTIVE, STATUS_WAITING_CANCELLATION, STATUS_CANCELED, STATUS_WAITING_COMPLETION, STATUS_COMPLETED, STATUS_INVALIDATED --- ### v1.Contract.Item.Term Type: object - value (integer): 期間数 - unit (object): 単位 - **value**: integer — 期間数 - **unit**: object — 単位 --- ### v1.Contract.Item.Term.Unit - UNIT_MONTHLY: 月 Type: string Enum values: UNIT_UNSPECIFIED, UNIT_MONTHLY Enum values: UNIT_UNSPECIFIED, UNIT_MONTHLY --- ### v1.CreateContractRequest Type: object - optionalId (string): 契約管理ID - customer (object): 顧客 - mainItems (array): メインとなるアイテム - billingCustomerStaffs (array): 請求担当者（配列の先頭が主請求担当者、優先順位: 1. billingCustomerStaffs -> 2. extensions.billingDestination -> 3. customer.customerStaff） - shippingCustomerStaffs (array): 納入先担当者（配列の先頭が主納入先担当者） - paymentMethodId (string): 決済手段ID(指定しない場合はデフォルトの決済手段が適用されます) - paymentMethodOptionalId (string): 決済手段管理ID(決済手段IDの代わりに指定可) - extensions (object): 拡張機能: 請求先の指定など契約作成をサポートする機能を提供します。 - isDraft (boolean): 下書きフラグ(trueの場合、契約は下書き状態で作成され、請求生成が抑制されます) - **optionalId**: string — 契約管理ID - **customer**: object — 顧客 - **mainItems**: array — メインとなるアイテム - **billingCustomerStaffs**: array — 請求担当者（配列の先頭が主請求担当者、優先順位: 1. billingCustomerStaffs -> 2. extensions.billingDestination -> 3. customer.customerStaff） - **shippingCustomerStaffs**: array — 納入先担当者（配列の先頭が主納入先担当者） - **paymentMethodId**: string — 決済手段ID(指定しない場合はデフォルトの決済手段が適用されます) - **paymentMethodOptionalId**: string — 決済手段管理ID(決済手段IDの代わりに指定可) - **extensions**: object — 拡張機能: 請求先の指定など契約作成をサポートする機能を提供します。 - **isDraft**: boolean — 下書きフラグ(trueの場合、契約は下書き状態で作成され、請求生成が抑制されます) --- ### v1.CreateContractRequest.ChargeItem Type: object - catalogChargeItemId (string): カタログ課金項目ID - billAllAtOnce (boolean): 一括請求オプション。指定しなければカタログアイテムに従います - quantity (integer): 契約数。すべての料金モデルで使用できます。定額制の場合は1に正規化されます - chargeItemName (string): (DEPRECATED: name をお使いください) 課金項目名 - price (integer): 単価。カタログの料金モデルが定額または従量制のみで使用できます。指定しなければカタログアイテムに従います - billingTiming (object): 請求タイミング - billingDueTiming (object): 支払期限タイミング - name (string): 課金項目名。指定しなければカタログアイテムに従います - tiers (array): Volume/Tiered pricing tiers; conflicts with price - billingCycle (object): 請求周期(省略時はカタログの請求周期から適用) - **catalogChargeItemId**: string — カタログ課金項目ID - **billAllAtOnce**: boolean — 一括請求オプション。指定しなければカタログアイテムに従います - **quantity**: integer — 契約数。すべての料金モデルで使用できます。定額制の場合は1に正規化されます - **chargeItemName**: string — (DEPRECATED: name をお使いください) 課金項目名 - **price**: integer — 単価。カタログの料金モデルが定額または従量制のみで使用できます。指定しなければカタログアイテムに従います - **billingTiming**: object — 請求タイミング - **billingDueTiming**: object — 支払期限タイミング - **name**: string — 課金項目名。指定しなければカタログアイテムに従います - **tiers**: array — Volume/Tiered pricing tiers; conflicts with price - **billingCycle**: object — 請求周期(省略時はカタログの請求周期から適用) --- ### v1.CreateContractRequest.Term Type: object - value (integer): 期間数 - unit (object): 単位 - **value**: integer — 期間数 - **unit**: object — 単位 --- ### v1.CreateContractRequest.Term.Unit - UNIT_MONTHLY: 月 Type: string Enum values: UNIT_UNSPECIFIED, UNIT_MONTHLY Enum values: UNIT_UNSPECIFIED, UNIT_MONTHLY --- ### v1.CreateContractResponse Type: object - contract (object): 契約 - **contract**: object — 契約 --- ### v1.CustomField Type: object - masterId (string): カスタムフィールドマスターID - string (string): テキスト型の値 - date (string): 日付型の値(RFC 3339 format) - selectList (string): 選択リスト型の値 - **masterId**: string — カスタムフィールドマスターID - **string**: string — テキスト型の値 - **date**: string — 日付型の値(RFC 3339 format) - **selectList**: string — 選択リスト型の値 --- ### v1.Customer Type: object - id (string): 顧客ID - optionalId (string): 顧客管理ID（更新時、顧客IDの代わりに指定可） - name (string): 顧客名（更新可） - salesRepresentative (object): 営業担当者 - crmAccountId (string): 外部CRMサービスのアカウントID - **id**: string — 顧客ID - **optionalId**: string — 顧客管理ID（更新時、顧客IDの代わりに指定可） - **name**: string — 顧客名（更新可） - **salesRepresentative**: object — 営業担当者 - **crmAccountId**: string — 外部CRMサービスのアカウントID --- ### v1.CustomerStaff Type: object - id (string): 顧客担当者ID - customerId (string): 顧客ID - optionalId (string): 顧客担当者管理ID（更新時、顧客担当者IDの代わりに指定可） - name (object): 顧客担当者名（更新可） - department (string): 部門（更新可） - title (string): 肩書（更新可） - phoneNumber (string): 電話番号（更新可） - emailAddress (string): メールアドレス（更新可） - address (object): 住所（更新可） - isDeleted (boolean): 削除済みかどうか - crmStaffId (string): 外部CRMサービスの担当者ID - **id**: string — 顧客担当者ID - **customerId**: string — 顧客ID - **optionalId**: string — 顧客担当者管理ID（更新時、顧客担当者IDの代わりに指定可） - **name**: object — 顧客担当者名（更新可） - **department**: string — 部門（更新可） - **title**: string — 肩書（更新可） - **phoneNumber**: string — 電話番号（更新可） - **emailAddress**: string — メールアドレス（更新可） - **address**: object — 住所（更新可） - **isDeleted**: boolean — 削除済みかどうか - **crmStaffId**: string — 外部CRMサービスの担当者ID --- ### v1.CustomerStaff.Address Type: object - zipCode (string): 郵便番号（更新可） - country (object): 国（更新可） - prefecture (object): 都道府県（更新可） - city (string): 市区郡（更新可） - addressLines (array): 町名・番地（更新可） - **zipCode**: string — 郵便番号（更新可） - **country**: object — 国（更新可） - **prefecture**: object — 都道府県（更新可） - **city**: string — 市区郡（更新可） - **addressLines**: array — 町名・番地（更新可） --- ### v1.CustomerStaff.Address.Country Type: string Enum values: COUNTRY_UNSPECIFIED, COUNTRY_JP Enum values: COUNTRY_UNSPECIFIED, COUNTRY_JP --- ### v1.CustomerStaff.Address.Prefecture Type: string Enum values: PREFECTURE_UNSPECIFIED, PREFECTURE_HOKKAIDO, PREFECTURE_AOMORI, PREFECTURE_IWATE, PREFECTURE_MIYAGI, PREFECTURE_AKITA, PREFECTURE_YAMAGATA, PREFECTURE_FUKUSHIMA, PREFECTURE_IBARAKI, PREFECTURE_TOCHIGI, PREFECTURE_GUNMA, PREFECTURE_SAITAMA, PREFECTURE_CHIBA, PREFECTURE_TOKYO, PREFECTURE_KANAGAWA, PREFECTURE_NIIGATA, PREFECTURE_TOYAMA, PREFECTURE_ISHIKAWA, PREFECTURE_FUKUI, PREFECTURE_YAMANASHI, PREFECTURE_NAGANO, PREFECTURE_GIFU, PREFECTURE_SHIZUOKA, PREFECTURE_AICHI, PREFECTURE_MIE, PREFECTURE_SHIGA, PREFECTURE_KYOTO, PREFECTURE_OSAKA, PREFECTURE_HYOGO, PREFECTURE_NARA, PREFECTURE_WAKAYAMA, PREFECTURE_TOTTORI, PREFECTURE_SHIMANE, PREFECTURE_OKAYAMA, PREFECTURE_HIROSHIMA, PREFECTURE_YAMAGUCHI, PREFECTURE_TOKUSHIMA, PREFECTURE_KAGAWA, PREFECTURE_EHIME, PREFECTURE_KOCHI, PREFECTURE_FUKUOKA, PREFECTURE_SAGA, PREFECTURE_NAGASAKI, PREFECTURE_KUMAMOTO, PREFECTURE_OITA, PREFECTURE_MIYAZAKI, PREFECTURE_KAGOSHIMA, PREFECTURE_OKINAWA Enum values: PREFECTURE_UNSPECIFIED, PREFECTURE_HOKKAIDO, PREFECTURE_AOMORI, PREFECTURE_IWATE, PREFECTURE_MIYAGI, PREFECTURE_AKITA, PREFECTURE_YAMAGATA, PREFECTURE_FUKUSHIMA, PREFECTURE_IBARAKI, PREFECTURE_TOCHIGI, PREFECTURE_GUNMA, PREFECTURE_SAITAMA, PREFECTURE_CHIBA, PREFECTURE_TOKYO, PREFECTURE_KANAGAWA, PREFECTURE_NIIGATA, PREFECTURE_TOYAMA, PREFECTURE_ISHIKAWA, PREFECTURE_FUKUI, PREFECTURE_YAMANASHI, PREFECTURE_NAGANO, PREFECTURE_GIFU, PREFECTURE_SHIZUOKA, PREFECTURE_AICHI, PREFECTURE_MIE, PREFECTURE_SHIGA, PREFECTURE_KYOTO, PREFECTURE_OSAKA, PREFECTURE_HYOGO, PREFECTURE_NARA, PREFECTURE_WAKAYAMA, PREFECTURE_TOTTORI, PREFECTURE_SHIMANE, PREFECTURE_OKAYAMA, PREFECTURE_HIROSHIMA, PREFECTURE_YAMAGUCHI, PREFECTURE_TOKUSHIMA, PREFECTURE_KAGAWA, PREFECTURE_EHIME, PREFECTURE_KOCHI, PREFECTURE_FUKUOKA, PREFECTURE_SAGA, PREFECTURE_NAGASAKI, PREFECTURE_KUMAMOTO, PREFECTURE_OITA, PREFECTURE_MIYAZAKI, PREFECTURE_KAGOSHIMA, PREFECTURE_OKINAWA --- ### v1.CustomerStaff.Name Type: object - firstName (string): 顧客担当者の名（更新可） - lastName (string): 顧客担当者の姓（更新可） - firstNameKana (string): 顧客担当者の名（ふりがな）（更新可） - lastNameKana (string): 顧客担当者の姓（ふりがな）（更新可） - **firstName**: string — 顧客担当者の名（更新可） - **lastName**: string — 顧客担当者の姓（更新可） - **firstNameKana**: string — 顧客担当者の名（ふりがな）（更新可） - **lastNameKana**: string — 顧客担当者の姓（ふりがな）（更新可） --- ### v1.DailyRate Type: object - type (object): - fixedRateValue (number): FIXED_RATE指定時の値 - **type**: object — - **fixedRateValue**: number — FIXED_RATE指定時の値 --- ### v1.DailyRate.Type Type: string Enum values: TYPE_UNSPECIFIED, TYPE_FULL_PRICE, TYPE_DAILY_RATE, TYPE_FIXED_RATE Enum values: TYPE_UNSPECIFIED, TYPE_FULL_PRICE, TYPE_DAILY_RATE, TYPE_FIXED_RATE --- ### v1.GetContractByOptionalIdRequest Type: object - optionalId (string): 契約管理ID - version (integer): 契約バージョン。指定がなければ最新バージョンの契約が返却される - **optionalId**: string — 契約管理ID - **version**: integer — 契約バージョン。指定がなければ最新バージョンの契約が返却される --- ### v1.GetContractByOptionalIdResponse Type: object - contract (object): 契約 - **contract**: object — 契約 --- ### v1.GetContractRequest Type: object - id (string): 契約ID - version (integer): 契約バージョン。指定がなければ最新バージョンの契約が返却される - **id**: string — 契約ID - **version**: integer — 契約バージョン。指定がなければ最新バージョンの契約が返却される --- ### v1.GetContractResponse Type: object - contract (object): 契約 - **contract**: object — 契約 --- ### v1.LastAvailabilityDailyRate Type: object - contractChargeItemId (string): - lastAvailabilityDailyRate (object): - **contractChargeItemId**: string — - **lastAvailabilityDailyRate**: object — --- ### v1.ListContractsRequest Type: object - pageToken (string): 一覧取得に使用するトークン - pageSize (integer): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - **pageToken**: string — 一覧取得に使用するトークン - **pageSize**: integer — 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] --- ### v1.ListContractsResponse Type: object - contracts (array): 契約 - nextPageToken (string): 次の一覧取得に使用するトークン - **contracts**: array — 契約 - **nextPageToken**: string — 次の一覧取得に使用するトークン --- ### v1.PricingModelType - PRICING_MODEL_TYPE_FLAT_FEE: 定額 - PRICING_MODEL_TYPE_PER_UNIT: 従量 - PRICING_MODEL_TYPE_VOLUME: 選択式 - PRICING_MODEL_TYPE_TIERED: 積上式 Type: string Enum values: PRICING_MODEL_TYPE_UNSPECIFIED, PRICING_MODEL_TYPE_FLAT_FEE, PRICING_MODEL_TYPE_PER_UNIT, PRICING_MODEL_TYPE_VOLUME, PRICING_MODEL_TYPE_TIERED Enum values: PRICING_MODEL_TYPE_UNSPECIFIED, PRICING_MODEL_TYPE_FLAT_FEE, PRICING_MODEL_TYPE_PER_UNIT, PRICING_MODEL_TYPE_VOLUME, PRICING_MODEL_TYPE_TIERED --- ### v1.UsageUnit Type: object - id (string): - optionalId (string): - name (string): - description (string): - **id**: string — - **optionalId**: string — - **name**: string — - **description**: string — --- ### v2.ConfirmDraftContractRequest Type: object - contractId (string): 契約ID - **contractId**: string — 契約ID --- ### v2.ConfirmDraftContractResponse Type: object - contract (object): 契約 - **contract**: object — 契約 --- ### v2.Contract Type: object - id (string): 契約ID - optionalId (string): 契約管理ID - services (array): 契約サービス(複数のメイン・オプションアイテムをサービス単位でグルーピング) - customFields (array): 契約カスタムフィールド - customerId (string): 契約顧客ID - paymentMethodId (string): 決済方法ID - billingCustomerStaffIds (array): 請求担当者ID（配列の先頭が主請求担当者） - shippingCustomerStaffIds (array): 納入先担当者ID（配列の先頭が主納入先担当者） - isDraft (boolean): 下書きフラグ - **id**: string — 契約ID - **optionalId**: string — 契約管理ID - **services**: array — 契約サービス(複数のメイン・オプションアイテムをサービス単位でグルーピング) - **customFields**: array — 契約カスタムフィールド - **customerId**: string — 契約顧客ID - **paymentMethodId**: string — 決済方法ID - **billingCustomerStaffIds**: array — 請求担当者ID（配列の先頭が主請求担当者） - **shippingCustomerStaffIds**: array — 納入先担当者ID（配列の先頭が主納入先担当者） - **isDraft**: boolean — 下書きフラグ --- ### v2.Contract.ChargeItem Type: object - id (string): 契約課金項目ID - billAllAtOnce (boolean): 一括請求オプション(定期課金の契約課金項目の場合のみ返却されます。使用量ベース定期課金では常にfalse) - name (string): 契約課金項目名 - quantity (string): 契約数。すべての料金モデルで使用できます。定額制の場合は1に正規化されます - usageUnit (object): 使用量単位(使用量ベースの課金項目の場合のみ返却されます) - pricingModelType (string): 料金計算モデル - tiers (array): ティア - catalogChargeItemId (string): カタログ課金項目ID - contractChargeItemType (object): 契約課金項目タイプ - billingTiming (object): 請求タイミング - billingDueTiming (object): 支払期限タイミング - calculatedPrice (string): 計算済み金額(契約数ベースの課金項目のみ。使用量ベースの場合は0) - billingCycle (object): 請求周期 - optionalId (string): 契約課金項目管理ID - **id**: string — 契約課金項目ID - **billAllAtOnce**: boolean — 一括請求オプション(定期課金の契約課金項目の場合のみ返却されます。使用量ベース定期課金では常にfalse) - **name**: string — 契約課金項目名 - **quantity**: string — 契約数。すべての料金モデルで使用できます。定額制の場合は1に正規化されます - **usageUnit**: object — 使用量単位(使用量ベースの課金項目の場合のみ返却されます) - **pricingModelType**: string — 料金計算モデル - **tiers**: array — ティア - **catalogChargeItemId**: string — カタログ課金項目ID - **contractChargeItemType**: object — 契約課金項目タイプ - **billingTiming**: object — 請求タイミング - **billingDueTiming**: object — 支払期限タイミング - **calculatedPrice**: string — 計算済み金額(契約数ベースの課金項目のみ。使用量ベースの場合は0) - **billingCycle**: object — 請求周期 - **optionalId**: string — 契約課金項目管理ID --- ### v2.Contract.ChargeItem.Tier Type: object - upperLimit (string): 上限値（最後のティアのみ省略可） - feeFormula (object): 料金計算式 - unitPrice (string): 単価。定額制の場合はこの値がそのまま料金となり、従量制の場合は数量との積算で料金が決まる - **upperLimit**: string — 上限値（最後のティアのみ省略可） - **feeFormula**: object — 料金計算式 - **unitPrice**: string — 単価。定額制の場合はこの値がそのまま料金となり、従量制の場合は数量との積算で料金が決まる --- ### v2.Contract.ChargeItem.UsageUnit Type: object - id (string): 使用量単位ID - optionalId (string): 使用量単位管理ID - **id**: string — 使用量単位ID - **optionalId**: string — 使用量単位管理ID --- ### v2.Contract.CustomField Type: object - masterId (string): カスタムフィールドマスターID - value (string): カスタムフィールド値 - **masterId**: string — カスタムフィールドマスターID - **value**: string — カスタムフィールド値 --- ### v2.Contract.Item Type: object - id (string): 契約アイテムID - chargeItems (array): 契約課金項目 - status (object): 「日付指定」で契約を取得した場合以外では、`STATUS_UNSPECIFIED` 以外の値が入ることが保証される。 - startDate (string): 契約開始日(RFC 3339 format) - endDate (string): 契約終了日(RFC 3339 format) - defaultContractTerm (object): 基本契約期間 - name (string): アイテム名 - catalogItemId (string): カタログアイテムID - availabilityCycle (object): 利用周期 - **id**: string — 契約アイテムID - **chargeItems**: array — 契約課金項目 - **status**: object — 「日付指定」で契約を取得した場合以外では、`STATUS_UNSPECIFIED` 以外の値が入ることが保証される。 - **startDate**: string — 契約開始日(RFC 3339 format) - **endDate**: string — 契約終了日(RFC 3339 format) - **defaultContractTerm**: object — 基本契約期間 - **name**: string — アイテム名 - **catalogItemId**: string — カタログアイテムID - **availabilityCycle**: object — 利用周期 --- ### v2.Contract.Item.Status - STATUS_WAITING_ACTIVATION: 有効化待ち - STATUS_ACTIVE: 有効 - STATUS_WAITING_CANCELLATION: 解約待ち - STATUS_CANCELED: 途中解約 - STATUS_WAITING_COMPLETION: 終了待ち - STATUS_COMPLETED: 終了 - STATUS_INVALIDATED: 無効 Type: string Enum values: STATUS_UNSPECIFIED, STATUS_WAITING_ACTIVATION, STATUS_ACTIVE, STATUS_WAITING_CANCELLATION, STATUS_CANCELED, STATUS_WAITING_COMPLETION, STATUS_COMPLETED, STATUS_INVALIDATED Enum values: STATUS_UNSPECIFIED, STATUS_WAITING_ACTIVATION, STATUS_ACTIVE, STATUS_WAITING_CANCELLATION, STATUS_CANCELED, STATUS_WAITING_COMPLETION, STATUS_COMPLETED, STATUS_INVALIDATED --- ### v2.Contract.Item.Term Type: object - value (integer): 期間数 - unit (object): 単位 - **value**: integer — 期間数 - **unit**: object — 単位 --- ### v2.Contract.Item.Term.Unit - UNIT_MONTHLY: 月 Type: string Enum values: UNIT_UNSPECIFIED, UNIT_MONTHLY Enum values: UNIT_UNSPECIFIED, UNIT_MONTHLY --- ### v2.CreateContractRequest Type: object - optionalId (string): 契約管理ID - customer (object): 顧客識別子 - services (array): 契約サービス(複数のメイン・オプションアイテムをサービス単位でグルーピング、最低1件必須) - billingCustomerStaffs (array): 請求先担当者識別子（配列の先頭が請求先主担当、最低1件必須） - shippingCustomerStaffs (array): 納入先担当者識別子（配列の先頭が納入先主担当） - paymentMethodId (string): 決済方法ID（省略時はデフォルトの決済方法が適用されます） - paymentMethodOptionalId (string): 決済方法管理ID（決済方法IDの代わりに指定可） - isDraft (boolean): 下書きフラグ(trueの場合、契約は下書き状態で作成され、請求生成が抑制されます) - **optionalId**: string — 契約管理ID - **customer**: object — 顧客識別子 - **services**: array — 契約サービス(複数のメイン・オプションアイテムをサービス単位でグルーピング、最低1件必須) - **billingCustomerStaffs**: array — 請求先担当者識別子（配列の先頭が請求先主担当、最低1件必須） - **shippingCustomerStaffs**: array — 納入先担当者識別子（配列の先頭が納入先主担当） - **paymentMethodId**: string — 決済方法ID（省略時はデフォルトの決済方法が適用されます） - **paymentMethodOptionalId**: string — 決済方法管理ID（決済方法IDの代わりに指定可） - **isDraft**: boolean — 下書きフラグ(trueの場合、契約は下書き状態で作成され、請求生成が抑制されます) --- ### v2.CreateContractRequest.ChargeItem Type: object - catalogChargeItemId (string): カタログ課金項目ID - name (string): 請求書記載名(省略時はカタログから適用されます) - quantity (integer): 契約数（定額料金の場合は1に固定されます） - billAllAtOnce (boolean): 一括請求オプション(省略時はカタログから適用されます) - optionalId (string): 課金項目管理ID - pricing (object): 料金設定(省略時はカタログから適用されます) - billingTiming (object): 請求タイミング(省略時はカタログから適用されます) - billingDueTiming (object): 支払期限タイミング(省略時はカタログから適用されます) - billingCycle (object): 請求周期(省略時はカタログの請求周期から適用されます) - **catalogChargeItemId**: string — カタログ課金項目ID - **name**: string — 請求書記載名(省略時はカタログから適用されます) - **quantity**: integer — 契約数（定額料金の場合は1に固定されます） - **billAllAtOnce**: boolean — 一括請求オプション(省略時はカタログから適用されます) - **optionalId**: string — 課金項目管理ID - **pricing**: object — 料金設定(省略時はカタログから適用されます) - **billingTiming**: object — 請求タイミング(省略時はカタログから適用されます) - **billingDueTiming**: object — 支払期限タイミング(省略時はカタログから適用されます) - **billingCycle**: object — 請求周期(省略時はカタログの請求周期から適用されます) --- ### v2.CreateContractRequest.Term Type: object - value (integer): 期間数 - unit (object): 単位 - **value**: integer — 期間数 - **unit**: object — 単位 --- ### v2.CreateContractRequest.Term.Unit - UNIT_MONTHLY: 月 Type: string Enum values: UNIT_UNSPECIFIED, UNIT_MONTHLY Enum values: UNIT_UNSPECIFIED, UNIT_MONTHLY --- ### v2.CreateContractResponse Type: object - contract (object): 契約 - **contract**: object — 契約 --- ### v2.DailyRate Type: object - type (object): - fixedRateValue (number): FIXED_RATE指定時の値 - **type**: object — - **fixedRateValue**: number — FIXED_RATE指定時の値 --- ### v2.DailyRate.Type Type: string Enum values: TYPE_UNSPECIFIED, TYPE_FULL_PRICE, TYPE_DAILY_RATE, TYPE_FIXED_RATE Enum values: TYPE_UNSPECIFIED, TYPE_FULL_PRICE, TYPE_DAILY_RATE, TYPE_FIXED_RATE --- ### v2.GetContractByOptionalIdRequest Type: object - optionalId (string): 契約管理ID - atPointInServiceTimeline (string): 契約サービスタイムラインのどの時点での契約を取得するかの指定。 指定しない場合は、契約サービスタイムラインの最も未来の時点での契約の状態が返却される。 - **optionalId**: string — 契約管理ID - **atPointInServiceTimeline**: string — 契約サービスタイムラインのどの時点での契約を取得するかの指定。 指定しない場合は、契約サービスタイムラインの最も未来の時点での契約の状態が返却される。 --- ### v2.GetContractByOptionalIdResponse Type: object - contract (object): `at_point_in_service_timeline`をリクエストに含まなかった場合、 返却される契約アイテムのステータスには`STATUS_UNSPECIFIED` 以外の値が入ることが保証される。 - **contract**: object — `at_point_in_service_timeline`をリクエストに含まなかった場合、 返却される契約アイテムのステータスには`STATUS_UNSPECIFIED` 以外の値が入ることが保証される。 --- ### v2.GetContractRequest Type: object - id (string): 契約ID - atPointInServiceTimeline (string): 契約サービスタイムラインのどの時点での契約を取得するかの指定。 指定しない場合は、契約サービスタイムラインの最も未来の時点での契約の状態が返却される。 - **id**: string — 契約ID - **atPointInServiceTimeline**: string — 契約サービスタイムラインのどの時点での契約を取得するかの指定。 指定しない場合は、契約サービスタイムラインの最も未来の時点での契約の状態が返却される。 --- ### v2.GetContractResponse Type: object - contract (object): `at_point_in_service_timeline`をリクエストに含まなかった場合、 返却される契約アイテムのステータスには`STATUS_UNSPECIFIED` 以外の値が入ることが保証される。 - **contract**: object — `at_point_in_service_timeline`をリクエストに含まなかった場合、 返却される契約アイテムのステータスには`STATUS_UNSPECIFIED` 以外の値が入ることが保証される。 --- ### v2.LastAvailabilityDailyRate Type: object - contractChargeItemId (string): - lastAvailabilityDailyRate (object): - **contractChargeItemId**: string — - **lastAvailabilityDailyRate**: object — --- ### v2.ListContractsRequest Type: object - filters (array): 契約のフィルタ条件 - sortOrder (object): ソート順 - offsetToken (string): オフセット情報を含むページングトークン。 - pageSize (integer): 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] - **filters**: array — 契約のフィルタ条件 - **sortOrder**: object — ソート順 - **offsetToken**: string — オフセット情報を含むページングトークン。 - **pageSize**: integer — 一覧取得する最大数 [デフォルト: 10 / 最小: 1 / 最大: 100] --- ### v2.ListContractsResponse Type: object - contracts (array): 返却される契約アイテムのステータスには`STATUS_UNSPECIFIED` 以外の値が入ることが保証される。 - nextOffsetToken (string): contracts が一覧の終端に到達し、次のページが新たに結果を含むことが無いことが分かるとき、null が返却される。 - **contracts**: array — 返却される契約アイテムのステータスには`STATUS_UNSPECIFIED` 以外の値が入ることが保証される。 - **nextOffsetToken**: string — contracts が一覧の終端に到達し、次のページが新たに結果を含むことが無いことが分かるとき、null が返却される。 --- ### v2.Timing Type: object - value (integer): 数(負数の場合は前を表す。例: { "value": -1, "unit": "UNIT_MONTHLY" } => 先月) - unit (object): 単位 - dayOfMonth (object): UNIT_MONTHLY指定時の日 - **value**: integer — 数(負数の場合は前を表す。例: { "value": -1, "unit": "UNIT_MONTHLY" } => 先月) - **unit**: object — 単位 - **dayOfMonth**: object — UNIT_MONTHLY指定時の日 --- ### v2.Timing.Unit - UNIT_DAILY: 日 - UNIT_MONTHLY: 月 Type: string Enum values: UNIT_UNSPECIFIED, UNIT_DAILY, UNIT_MONTHLY Enum values: UNIT_UNSPECIFIED, UNIT_DAILY, UNIT_MONTHLY