機械翻訳について

ジャンプ先

• リクエスト
• レスポンス
• 例

対象レベルの取得

get

/crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}

リクエスト

パス・パラメータ

• CoveredLevelPuid(required): string
  対象レベルの公開一意識別子。
• SubscriptionProductPuid(required): string
  サブスクリプション製品の公開一意識別子。

問合せパラメータ

• dependency: string
  このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
  
  フォーマット: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
• fields: string
  このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
  
  フォーマット : ?fields=Attribute1,Attribute2
  
  子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
• links: string
  このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
  
  例:
  self,canonical
  
• onlyData: boolean
  リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

サポートされるメディア・タイプ

• application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

• Metadata-Context(required):
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : subscriptionProducts-coveredLevels-item-response

タイプ: object

ソースを表示

• Address: string
  タイトル: Address

  パーティ・サイトの住所。
• AssetGroupId: integer (int64)
  アセット・グループの一意の識別子。
• AssetGroupName: string
  タイトル: Asset Group Name

  アセット・グループの名前。
• AssetGroupNumber: string
  タイトル: Asset Group Number

  アセット・グループの代替識別子。
• AssetId: integer (int64)
  アセットの一意の識別子。
• AssetName: string
  タイトル: Covered Level Asset Name

  アセットの名前。
• AssetSerialNumber: string
  タイトル: Covered Asset Serial Number

  アセットのシリアル番号。
• billLines: array Bill Lines
  タイトル: Bill Lines

  請求明細リソースは、請求期間、請求日:自、請求日:至、金額、定型フラグ、請求書テキスト、使用数量、使用フラグなど、サブスクリプション請求明細詳細の表示、作成、更新および削除に使用されます。
• CalculatedCreditAmount: number
  タイトル: Calculated Credit Amount

  対象レベルの計算済貸方金額。
• CancelDescription: string
  タイトル: Cancellation Description

  最大長: 2000

  対象レベルに関連付けられた取消摘要。
• CanceledAmount: number
  取り消された金額。
• CanceledDate: 文字列(日付)
  タイトル: Canceled Date

  対象レベルが取り消された日付。
• CancelReason: string
  タイトル: Cancellation Reason

  最大長: 30

  対象レベルを取り消す事由。
• charges: array Charges
  タイトル: Charges

  手数料リソースは、手数料名、手数料定義、価格タイプ、価格周期性および階層フラグなどのサブスクリプション手数料詳細の表示、作成、更新および削除に使用されます。
• ClosedAmount: number
  対象レベルがクローズされた金額。
• ClosedDate: 文字列(日付)
  タイトル: Covered Level Close Date

  対象レベルがクローズされた日付。
• CloseDescription: string
  タイトル: Covered Level Close Description

  最大長: 2000

  対象レベルに関連付けられたクローズ摘要。
• CloseReason: string
  タイトル: Covered Level Close Reason

  最大長: 30

  対象レベルがクローズされた事由です。
• CorpCurrencyCode: string
  最大長: 15

  対象レベルに関連付けられた企業通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。
• CoveredLevelId: integer (int64)
  対象レベルの一意の識別子。
• CoveredLevelName: string
  タイトル: Covered Level Name

  最大長: 300

  対象レベルの名前。
• CoveredLevelParentPuid: string
  対象レベルの親の代替一意識別子。
• CoveredLevelPuid: string
  最大長: 120

  対象レベルの公開一意識別子。
• CoveredLevlName: string
  タイトル: Covered Level Name

  対象レベルの名前。
• CoveredLevlNumber: string
  タイトル: Covered Level Number

  対象レベルの代替識別子。
• CreatedBy: string
  読取り専用: true

  最大長: 64

  対象レベルを作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  対象レベルが作成された日付。
• CreditedAmount: number
  貸方記入された金額。
• CurcyConvRateType: string
  最大長: 30

  対象レベルに関連付けられた通貨換算レート・タイプ。 この属性は、CRM拡張フレームワークで使用されます。 受け入れられる値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。
• CurrencyCode: string
  最大長: 15

  対象レベルに関連付けられた通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
• CustomerAccountId: integer (int64)
  顧客アカウントの一意の識別子。
• CustomerName: string
  タイトル: Customer Account

  顧客の名前。
• CustomerNumber: string
  タイトル: Customer Account Number

  顧客の代替一意識別子。
• Description: string
  タイトル: Covered Level Description

  対象レベルの簡単な説明。
• Duration: integer
  対象レベルの期間。
• EndDate: 文字列(日付)
  タイトル: Covered Level End Date

  対象レベルが終了する日付。
• ExplodeAssetHierarchy: string
  アセスメント階層を他の階層にコピーする必要があるかどうかを示します。
• GenerateBillingSchedule: string
  請求スケジュールが生成されるかどうかを示します。
• HierarchyTotal: number
  階層の合計対象レベル。
• InventoryItemId: integer (int64)
  在庫品目の一意の識別子。
• InvoicedAmount: number
  請求書が作成された金額。
• InvoiceText: string
  最大長: 2000

  請求書に含まれるテキスト。
• ItemUnitOfMeasure: string
  最大長: 15

  対象レベルの品目の測定に使用される単位。
• LastUpdateDate: string (date-time)
  読取り専用: true

  対象レベルが最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  対象レベルを最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  対象レベルを最後に更新したユーザーのログイン詳細。
• LineNumber: string
  タイトル: Number

  最大長: 300

  行番号
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• OverrideCreditAmount: number
  タイトル: Override Credit Amount

  対象レベルの貸方金額の上書き。
• ParentCoveredAssetId: integer (int64)
  親対象アセットの一意の識別子。
• ParentCoveredLevelId: integer (int64)
  親対象レベルの一意の識別子。
• PartyId: integer (int64)
  パーティの一意識別子
• PartyName: string
  タイトル: Party Name

  パーティの名前。
• PartyNumber: string
  タイトル: Party Number

  パーティの代替識別子。
• PartySite: string
  タイトル: Party Site Number

  パーティ・サイトの名前。
• PartySiteId: integer (int64)
  パーティ・サイトの一意の識別子。
• Period: string
  最大長: 80

  対象レベルの期間。
• PriceAsOf: 文字列(日付)
  特定の日付時点での価格。
• PriceListId: integer (int64)
  価格リストの一意の識別子。
• PriceUnitOfMeasure: string
  最大長: 30

  価格を示すために使用される単位。
• PriceUnitOfMeasureName: string
  タイトル: Pricing UOM

  単位の表示名。
• PricingError: string
  最大長: 1000

  価格設定のエラー(ある場合)。
• ProductGroupId: integer (int64)
  製品グループの一意の識別子。
• ProductGroupName: string
  タイトル: Product Group Name

  製品グループの名前。
• ProductGroupNumber: string
  タイトル: Product Group Number

  製品グループの代替識別子。
• ProductName: string
  タイトル: Product Name

  対象レベルに関連付けられた製品の名前。
• PutOnHoldFlag: boolean
  対象レベルが保留されているかどうかを示します。
• 数量: number
  タイトル: Quantity

  デフォルト値: 1

  対象レベルの数量。
• relationships: array Relationships
  タイトル: Relationships

  関係リソースは、関係タイプ、ソース・サブスクリプション製品PUID、ターゲット・サブスクリプション製品PUIDなど、サブスクリプション製品関係の詳細を表示、作成、更新および削除するために使用されます。
• RemoveHoldFlag: boolean
  対象レベルの保留を削除する必要があるかどうかを示します。
• RenewalType: string
  タイトル: Renewal Type

  最大長: 30

  対象レベル更改のタイプ。
• RenewedDate: 文字列(日付)
  対象レベルが更改された日付。
• RepriceFlag: boolean
  サブスクリプション対象レベルを再価格設定する必要があるかどうかを示します。 'true'として渡された場合、サブスクリプションの対象レベルとその子対象レベルは価格再設定されます。
• ReturnCreditMethod: string
  タイトル: Close Credit Method

  最大長: 230

  クレジットを返すメソッド。
• RollupTotal: number
  対象レベルの積上合計。
• SerialNumber: string
  タイトル: Covered Asset Serial Number

  読取り専用: true

  最大長: 80

  対象レベルのシリアル番号。
• SourceKey: string
  最大長: 120

  対象レベルのソース・キー。
• SourceLineKey: string
  最大長: 120

  対象レベルのソース明細キー。
• SourceLineNumber: string
  最大長: 120

  対象レベルのソース明細番号。
• SourceNumber: string
  最大長: 120

  対象レベルのソース番号。
• SourceSystem: string
  最大長: 30

  対象レベルのソース・システム。
• StartDate: 文字列(日付)
  タイトル: Covered Level Start Date

  対象レベルが開始する日付。
• Status: string
  タイトル: Covered Level Status

  最大長: 30

  対象レベルのステータス。
• StatusName: string
  タイトル: Status

  対象レベルのステータスの意味。
• SubscriptionId: integer (int64)
  サブスクリプションの一意の識別子。
• SubscriptionProductId: integer (int64)
  サブスクリプション製品の一意の識別子。
• SuppressedCreditAmount: number
  抑制されたクレジット金額。
• SuspendCreditMethod: string
  最大長: 30

  クレジット・メソッドを休止する必要があるかどうかを示します。
• SuspendedDate: 文字列(日付)
  タイトル: Covered Level Suspend Date

  対象レベルが休止された日付。
• SuspendReason: string
  タイトル: Covered Level Suspend Reason

  最大長: 30

  対象レベルのクレジット・メソッドの一時停止の事由。
• TaxAmount: number
  トランザクションに課せられた税額です。
• TaxError: string
  最大長: 4000

  計算金額の税金エラー(ある場合)。
• TotalContractValue: number
  タイトル: Covered Level Contract Value

  対象レベルに関連付けられた合計契約値。
• Type: string
  タイトル: Type

  最大長: 30

  対象レベルのタイプ。
• TypeName: string
  タイトル: Covered Level Type

  対象レベルのタイプの名前。
• UnitPrice: number
  タイトル: Unit Price

  対象レベルの単価。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the covered level was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeName":{
            "title":"Covered Level Type",
            "type":"string",
            "description":"The name of the type of the covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CalculatedCreditAmount":{
            "title":"Calculated Credit Amount",
            "type":"number",
            "description":"The calculated credit amount of the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductName":{
            "title":"Product Name",
            "type":"string",
            "description":"The name of the product associated with the covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "Address":{
            "title":"Address",
            "type":"string",
            "description":"The address of the party site.",
            "nullable":true,
            "x-queryable":false
        },
        "ParentCoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the parent covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Party Name",
            "type":"string",
            "description":"The name of the party.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CancelDescription":{
            "title":"Cancellation Description",
            "maxLength":2000,
            "type":"string",
            "description":"The cancellation description associated with a covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type associated with the covered level. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductGroupName":{
            "title":"Product Group Name",
            "type":"string",
            "description":"The name of the product group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "RollupTotal":{
            "type":"number",
            "description":"The rollup total of covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "SuspendCreditMethod":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the credit method has to be suspended.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Covered Level Start Date",
            "type":"string",
            "description":"The date when the covered level starts.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the covered level. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentCoveredAssetId":{
            "type":"integer",
            "description":"The unique identifier of the parent covered asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "relationships":{
            "title":"Relationships",
            "type":"array",
            "description":"The relationships resource is used to view, create, update, and delete the subscription product relationships details, such as relationship type, source subscription product PUID, and target subscription product PUID.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-relationships-item-response"
            }
        },
        "TaxAmount":{
            "type":"number",
            "description":"The tax amount levied on the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source key of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CloseReason":{
            "title":"Covered Level Close Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason why the covered level was closed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CustomerNumber":{
            "title":"Customer Account Number",
            "type":"string",
            "description":"The alternate unique identifier of the customer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CoveredLevelParentPuid":{
            "type":"string",
            "description":"The alternate unique identifier of the covered level parent.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The source number of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "PartySiteId":{
            "type":"integer",
            "description":"The unique identifier of the party site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CanceledDate":{
            "title":"Canceled Date",
            "type":"string",
            "description":"The date when the covered level was canceled.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ExplodeAssetHierarchy":{
            "type":"string",
            "description":"Indicates if the assest hierarchy should be copied to other hierarchies.",
            "nullable":true,
            "x-queryable":false
        },
        "AssetGroupId":{
            "type":"integer",
            "description":"The unique identifier of the asset group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code associated with the covered level. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemUnitOfMeasure":{
            "maxLength":15,
            "type":"string",
            "description":"The unit of measure used to measure the items in the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the covered level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Covered Level Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the covered level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CoveredLevelName":{
            "title":"Covered Level Name",
            "maxLength":300,
            "type":"string",
            "description":"The name of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "AssetGroupNumber":{
            "title":"Asset Group Number",
            "type":"string",
            "description":"The alternate identifier of an asset group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The unique identifier of the inventory item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreditedAmount":{
            "type":"number",
            "description":"The amount that was credited.",
            "nullable":true,
            "x-queryable":true
        },
        "Period":{
            "maxLength":80,
            "type":"string",
            "description":"The period of the covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Duration":{
            "type":"integer",
            "description":"The duration of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "StatusName":{
            "title":"Status",
            "type":"string",
            "description":"The meaning of the status of the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "RenewalType":{
            "title":"Renewal Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the covered level renewal.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssetName":{
            "title":"Covered Level Asset Name",
            "type":"string",
            "description":"The name of the asset.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AssetSerialNumber":{
            "title":"Covered Asset Serial Number",
            "type":"string",
            "description":"The serial number of the asset.",
            "nullable":true,
            "x-queryable":true
        },
        "charges":{
            "title":"Charges",
            "type":"array",
            "description":"The charges resource is used to view, create, update, and delete the subscription charge details, such as charge name, charge definition, price type, price periodicity, and tiered flag.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-item-response"
            }
        },
        "CancelReason":{
            "title":"Cancellation Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason for cancelling the covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SuppressedCreditAmount":{
            "type":"number",
            "description":"The credit amount that was suppressed.",
            "nullable":true,
            "x-queryable":true
        },
        "SerialNumber":{
            "title":"Covered Asset Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"The serial number of the covered level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceUnitOfMeasureName":{
            "title":"Pricing UOM",
            "type":"string",
            "description":"The display name of the unit of measure.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PriceListId":{
            "type":"integer",
            "description":"The unique identifier of the price list.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReturnCreditMethod":{
            "title":"Close Credit Method",
            "maxLength":230,
            "type":"string",
            "description":"The method used to return the credit.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AssetId":{
            "type":"integer",
            "description":"The unique identifier of the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InvoicedAmount":{
            "type":"number",
            "description":"The amount for which the invoice was created.",
            "nullable":true,
            "x-queryable":true
        },
        "SuspendedDate":{
            "title":"Covered Level Suspend Date",
            "type":"string",
            "description":"The date when the covered level was suspended.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "SourceLineNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The source line number of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CoveredLevlNumber":{
            "title":"Covered Level Number",
            "type":"string",
            "description":"The alternate identifier of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "ProductGroupNumber":{
            "title":"Product Group Number",
            "type":"string",
            "description":"The alternate identifier of a product group.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the covered level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetGroupName":{
            "title":"Asset Group Name",
            "type":"string",
            "description":"The name of the asset group.",
            "nullable":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Covered Level Description",
            "type":"string",
            "description":"A brief description of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CanceledAmount":{
            "type":"number",
            "description":"The amount that was canceled.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceAsOf":{
            "type":"string",
            "description":"The price as of a certain date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Number",
            "maxLength":300,
            "type":"string",
            "description":"The line number",
            "nullable":true,
            "x-queryable":false
        },
        "PartySite":{
            "title":"Party Site Number",
            "type":"string",
            "description":"The name of the party site.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "InvoiceText":{
            "maxLength":2000,
            "type":"string",
            "description":"The text included in the invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CoveredLevelPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the covered level.",
            "nullable":false,
            "x-queryable":true
        },
        "CustomerAccountId":{
            "type":"integer",
            "description":"The unique identifier of the customer account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaxError":{
            "maxLength":4000,
            "type":"string",
            "description":"The tax error, if any, in the calculated amount.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerName":{
            "title":"Customer Account",
            "type":"string",
            "description":"The name of the customer.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceLineKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source line key of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "ProductGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RepriceFlag":{
            "type":"boolean",
            "description":"Indicates whether the subscription covered level should be repriced or not. If passed as 'true', the subscription covered level and its child covered levels will be repriced.",
            "nullable":true,
            "x-queryable":false
        },
        "billLines":{
            "title":"Bill Lines",
            "type":"array",
            "description":"The bill lines resource is used to view, create, update, and delete the subscription bill line details, such as charge period, date bill from, date billed to, amount, recurring flag, invoice text, usage quantity, and usage flags.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-billLines-item-response"
            }
        },
        "RenewedDate":{
            "type":"string",
            "description":"The date when the covered level was renewed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TotalContractValue":{
            "title":"Covered Level Contract Value",
            "type":"number",
            "description":"The total contract value associated with the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "SuspendReason":{
            "title":"Covered Level Suspend Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason for suspending the credit method for the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of the covered level.",
            "nullable":false,
            "default":1,
            "x-queryable":true
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the covered level.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PriceUnitOfMeasure":{
            "maxLength":30,
            "type":"string",
            "description":"The unit of measure used to indicate the price.",
            "nullable":true,
            "x-queryable":true
        },
        "HierarchyTotal":{
            "type":"number",
            "description":"The total covered level of the hierarchy.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"Covered Level End Date",
            "type":"string",
            "description":"The date when the covered level ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ClosedAmount":{
            "type":"number",
            "description":"The amount at which the covered level was closed.",
            "nullable":true,
            "x-queryable":true
        },
        "CoveredLevlName":{
            "title":"Covered Level Name",
            "type":"string",
            "description":"The name of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "OverrideCreditAmount":{
            "title":"Override Credit Amount",
            "type":"number",
            "description":"The override credit amount of the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "Type":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the covered level.",
            "nullable":false,
            "x-queryable":true
        },
        "PutOnHoldFlag":{
            "type":"boolean",
            "description":"Indicates if the covered level has been put on hold.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyNumber":{
            "title":"Party Number",
            "type":"string",
            "description":"The alternate identifier of the party.",
            "nullable":true,
            "x-queryable":false
        },
        "UnitPrice":{
            "title":"Unit Price",
            "type":"number",
            "description":"The unit price of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "GenerateBillingSchedule":{
            "type":"string",
            "description":"Indicates whether the billing schedule is to be generated.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RemoveHoldFlag":{
            "type":"boolean",
            "description":"Indicates if the hold on the covered level has to be removed.",
            "nullable":true,
            "x-queryable":false
        },
        "ClosedDate":{
            "title":"Covered Level Close Date",
            "type":"string",
            "description":"The date when the covered level was closed.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "PricingError":{
            "maxLength":1000,
            "type":"string",
            "description":"The error in the pricing, if any.",
            "nullable":true,
            "x-queryable":true
        },
        "CloseDescription":{
            "title":"Covered Level Close Description",
            "maxLength":2000,
            "type":"string",
            "description":"The close description associated with a covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "maxLength":30,
            "type":"string",
            "description":"The source system of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the covered level was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : 請求明細

タイプ: array

タイトル: Bill Lines

請求明細リソースは、請求期間、請求日:自、請求日:至、金額、定型フラグ、請求書テキスト、使用数量、使用フラグなど、サブスクリプション請求明細詳細の表示、作成、更新および削除に使用されます。

ソースを表示

• Array of: object subscriptionProducts-coveredLevels-billLines-item-response

{
    "title":"Bill Lines",
    "type":"array",
    "description":"The bill lines resource is used to view, create, update, and delete the subscription bill line details, such as charge period, date bill from, date billed to, amount, recurring flag, invoice text, usage quantity, and usage flags.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-billLines-item-response"
    }
}

ネストされたスキーマ : 手数料

タイプ: array

タイトル: Charges

手数料リソースは、手数料名、手数料定義、価格タイプ、価格周期性および階層フラグなどのサブスクリプション手数料詳細の表示、作成、更新および削除に使用されます。

ソースを表示

• Array of: object subscriptionProducts-coveredLevels-charges-item-response

{
    "title":"Charges",
    "type":"array",
    "description":"The charges resource is used to view, create, update, and delete the subscription charge details, such as charge name, charge definition, price type, price periodicity, and tiered flag.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : 関係

タイプ: array

タイトル: Relationships

関係リソースは、関係タイプ、ソース・サブスクリプション製品PUID、ターゲット・サブスクリプション製品PUIDなど、サブスクリプション製品関係の詳細を表示、作成、更新および削除するために使用されます。

ソースを表示

• Array of: object subscriptionProducts-coveredLevels-relationships-item-response

{
    "title":"Relationships",
    "type":"array",
    "description":"The relationships resource is used to view, create, update, and delete the subscription product relationships details, such as relationship type, source subscription product PUID, and target subscription product PUID.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-relationships-item-response"
    }
}

ネストされたスキーマ : subscriptionProducts-coveredLevels-billLines-item-response

タイプ: object

ソースを表示

• 金額: number
  タイトル: Amount

  請求が生成される金額。
• billAdjustments: array Bill Adjustments
  タイトル: Bill Adjustments

  請求修正リソースは、調整名、調整値、調整タイプ、事由および有効性などのサブスクリプション請求修正詳細を表示、作成、更新および削除するために使用されます。
• BillingPeriod: number
  タイトル: Sequence

  請求が生成される期間。
• BillLineId: integer (int64)
  請求明細の一意の識別子。
• BillLinePuid: string
  最大長: 120

  請求明細の公開一意識別子。
• BusinessUnitId: integer
  請求明細に関連付けられているビジネス・ユニットのID。
• ChargeDefinition: string
  最大長: 30

  手数料の目的を示す定義。
• ChargeId: integer (int64)
  手数料の一意の識別子。
• ChargeName: string
  タイトル: Charge Name

  最大長: 120

  請求明細に関連付けられた手数料の名前。
• ChargePeriod: number
  タイトル: Period

  請求された使用期間。
• ChargePeriodFactor: number
  請求明細に関連付けられた変更期間ファクタ。
• ChargePuid: string
  読取り専用: true

  手数料の公開一意識別子。
• CoveredLevelId: integer (int64)
  対象レベルの一意の識別子。
• CreatedBy: string
  読取り専用: true

  最大長: 64

  請求明細を作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  請求明細が作成された日付。
• CreditMemoAmount: number
  クレジット・メモの金額。
• CreditMemoFlag: string
  請求明細に関連付けられたクレジット・メモがあるかどうかを示します。
• CreditMemoReason: string
  クレジット・メモを上げる事由。
• CreditMemoReasonCode: string
  最大長: 30

  クレジット・メモ事由コードのコード。
• CustomerTrxTypeSequenceId: integer (int64)
  顧客取引タイプ連番ID
• DateBilledFrom: 文字列(日付)
  タイトル: Bill-from Date

  請求が生成された日付。
• DateBilledTo: 文字列(日付)
  タイトル: Bill-to Date

  請求が生成される最終日。
• DateToInterface: 文字列(日付)
  タイトル: Interface Date

  請求明細のインタフェース日。
• InterfacedFlag: boolean
  タイトル: Interfaced

  最大長: 1

  デフォルト値: false

  請求明細がインタフェースされているかどうかを示します。
• InvoiceBillLineId: integer (int64)
  請求書請求明細の一意の識別子。
• InvoiceDate: 文字列(日付)
  請求書が提起された日付。
• InvoiceText: string
  タイトル: Invoice Text

  最大長: 240

  請求明細請求書のテキスト。
• LastUpdateDate: string (date-time)
  読取り専用: true

  請求明細が最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  請求明細を最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  請求明細を最後に更新したユーザーのログイン詳細。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ListPrice: number
  請求明細に関連付けられた製品の定価。
• MilestoneEventId: integer (int64)
  請求明細に関連付けられたマイルストン・イベントのID。
• MilestoneEventName: string
  請求明細に関連付けられたマイルストン・イベントの名前。
• NewCreditMemoPUID: string
  新規クレジット・メモの一意の公開識別子。
• PricedQuantity: number
  請求明細が請求された数量。
• PricingError: string
  最大長: 1000

  価格設定のエラー(ある場合)。
• RecurringFlag: boolean
  最大長: 1

  明細が固定処理かどうかを示します。
• RevenueLineId: integer (int64)
  収益明細の一意の識別子。
• SentDate: 文字列(日付)
  タイトル: Sent Date

  請求書情報が売掛管理に送信される日付。
• SubscriptionId: integer (int64)
  サブスクリプションの一意の識別子。
• SubscriptionProductId: integer (int64)
  サブスクリプション製品の一意の識別子。
• TransactionAmount: number
  タイトル: Invoice Amount

  トランザクションが発生した金額。
• TransactionClass: string
  タイトル: Transaction Class

  最大長: 30

  トランザクションのクラス。
• TransactionClassMeaning: string
  タイトル: Class

  トランザクション区分参照の意味。
• TransactionDate: 文字列(日付)
  タイトル: Invoice Date

  トランザクションが発生した日付。
• TransactionNumber: string
  タイトル: Invoice Number

  最大長: 30

  トランザクションの番号。
• TransactionTax: number
  タイトル: Tax

  トランザクションに課せられた税金です。
• TransactionTypeName: string
  サブスクリプション請求明細のトランザクション・タイプ名。
• TruedUpYn: string
  最大長: 3

  請求明細に調整期間があるかどうかを示します。
• TrxId: integer (int64)
  ARトランザクションID。
• TrxLineId: integer (int64)
  ARトランザクション明細ID。
• UsageAcquiredFlag: boolean
  最大長: 1

  使用状況が取得されたかどうかを示します。
• UsageCaptureDate: 文字列(日付)
  使用状況が取得された日付。
• UsageChargeType: string
  タイトル: Usage Charge Type

  最大長: 30

  使用手数料のタイプ。
• UsageChargeTypeName: string
  使用手数料タイプの名前。
• UsageFlag: boolean
  最大長: 1

  明細が使用明細かどうかを示します。
• UsagePricedFlag: boolean
  最大長: 1

  使用明細が価格設定されているかどうかを示します。
• UsageQuantity: number
  タイトル: Usage Quantity

  使用量の数量。

{
    "type":"object",
    "properties":{
        "TrxId":{
            "type":"integer",
            "description":"The AR transaction ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the billing line was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionTypeName":{
            "type":"string",
            "description":"The transaction type name of the subscription bill line.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargePuid":{
            "type":"string",
            "description":"The public unique identifier of the charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeDefinition":{
            "maxLength":30,
            "type":"string",
            "description":"The definition that indicates the purpose of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "SentDate":{
            "title":"Sent Date",
            "type":"string",
            "description":"The date invoice information is sent to receivables.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "UsagePricedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the usage line has been priced or not.",
            "nullable":true,
            "x-queryable":true
        },
        "ListPrice":{
            "type":"number",
            "description":"The list price of the product associated with the bill line.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionTax":{
            "title":"Tax",
            "type":"number",
            "description":"The tax levied on the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "RevenueLineId":{
            "type":"integer",
            "description":"The unique identifier of the revenue line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreditMemoReason":{
            "type":"string",
            "description":"The reason to raise the credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillLinePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the bill line.",
            "nullable":false,
            "x-queryable":true
        },
        "UsageFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the line is a usage line or not.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the billing line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UsageChargeTypeName":{
            "type":"string",
            "description":"The name of the usage charge type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "billAdjustments":{
            "title":"Bill Adjustments",
            "type":"array",
            "description":"The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details, such as adjustment name, adjustment value, adjustment type, reason, and effectivity.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-billLines-billAdjustments-item-response"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the billing line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillingPeriod":{
            "title":"Sequence",
            "type":"number",
            "description":"The period for which the bill is generated.",
            "nullable":false,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"The ID of the business unit associated with the bill line.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeName":{
            "title":"Charge Name",
            "maxLength":120,
            "type":"string",
            "description":"The name of the charge associated with the bill line.",
            "nullable":true,
            "x-queryable":true
        },
        "MilestoneEventId":{
            "type":"integer",
            "description":"The ID of the milestone event associated with the bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TrxLineId":{
            "type":"integer",
            "description":"The AR transaction line ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UsageCaptureDate":{
            "type":"string",
            "description":"The date when the usage was captured.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the billing line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditMemoFlag":{
            "type":"string",
            "description":"Indicates if there is a credit memo associated with the bill line.",
            "nullable":true,
            "x-queryable":false
        },
        "DateToInterface":{
            "title":"Interface Date",
            "type":"string",
            "description":"The date to interface for the bill line.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "UsageChargeType":{
            "title":"Usage Charge Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of usage charge.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionNumber":{
            "title":"Invoice Number",
            "maxLength":30,
            "type":"string",
            "description":"The number of the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "NewCreditMemoPUID":{
            "type":"string",
            "description":"The unique public identifier of the new credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargePeriodFactor":{
            "type":"number",
            "description":"The change period factor associated with the bill line.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerTrxTypeSequenceId":{
            "type":"integer",
            "description":"Customer Transaction Type Sequence Id",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TruedUpYn":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates if the bill line has a trueup period.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditMemoReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code of the credit memo reason code.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceText":{
            "title":"Invoice Text",
            "maxLength":240,
            "type":"string",
            "description":"The text in the bill line invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditMemoAmount":{
            "type":"number",
            "description":"The amount for the credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionClass":{
            "title":"Transaction Class",
            "maxLength":30,
            "type":"string",
            "description":"The class of the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceDate":{
            "type":"string",
            "description":"The date when the invoice was raised.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ChargePeriod":{
            "title":"Period",
            "type":"number",
            "description":"The usage period that was charged.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionDate":{
            "title":"Invoice Date",
            "type":"string",
            "description":"The date when the transaction occurred.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceBillLineId":{
            "type":"integer",
            "description":"The unique identifier of the invoice bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UsageAcquiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the usage has been acquired or not.",
            "nullable":true,
            "x-queryable":true
        },
        "InterfacedFlag":{
            "title":"Interfaced",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the bill line is interfaced or not.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount for which the bill is generated.",
            "nullable":true,
            "x-queryable":true
        },
        "DateBilledTo":{
            "title":"Bill-to Date",
            "type":"string",
            "description":"The date up to which the bill is generated.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "UsageQuantity":{
            "title":"Usage Quantity",
            "type":"number",
            "description":"The quantity of the usage.",
            "nullable":true,
            "x-queryable":true
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PricedQuantity":{
            "type":"number",
            "description":"The quantity for which the bill line was charged.",
            "nullable":true,
            "x-queryable":true
        },
        "MilestoneEventName":{
            "type":"string",
            "description":"The name of the milestone event associated with the bill line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TransactionAmount":{
            "title":"Invoice Amount",
            "type":"number",
            "description":"The amount for which the transaction occurred.",
            "nullable":true,
            "x-queryable":true
        },
        "RecurringFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the line is recurring or not.",
            "nullable":false,
            "x-queryable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The unique identifier of the bill line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DateBilledFrom":{
            "title":"Bill-from Date",
            "type":"string",
            "description":"The date from which the bill was generated.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionClassMeaning":{
            "title":"Class",
            "type":"string",
            "description":"The meaning of transaction class lookup.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PricingError":{
            "maxLength":1000,
            "type":"string",
            "description":"The error in pricing, if any.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the billing line was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : 請求修正

タイプ: array

タイトル: Bill Adjustments

請求修正リソースは、調整名、調整値、調整タイプ、事由および有効性などのサブスクリプション請求修正詳細を表示、作成、更新および削除するために使用されます。

ソースを表示

• Array of: object subscriptionProducts-coveredLevels-billLines-billAdjustments-item-response

{
    "title":"Bill Adjustments",
    "type":"array",
    "description":"The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details, such as adjustment name, adjustment value, adjustment type, reason, and effectivity.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-billLines-billAdjustments-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : subscriptionProducts-coveredLevels-billLines-billAdjustments-item-response

タイプ: object

ソースを表示

• AdjustmentBasis: string
  タイトル: Basis

  最大長: 30

  請求が調整される基準。
• AdjustmentName: string
  タイトル: Adjustment

  最大長: 120

  請求修正の名前。
• AdjustmentReasonCode: string
  最大長: 30

  調整事由のコード。
• AdjustmentType: string
  タイトル: Type

  最大長: 30

  請求修正のタイプ。
• AdjustmentValue: number
  タイトル: Value

  請求の調整に使用する値。
• AutoAdjustmentFlag: boolean
  最大長: 3

  調整が自動かどうかを示します。
• BasisEnableFlag: boolean
  基準が請求修正に対して有効になっているかどうかを示します。
• BillAdjustmentId: integer (int64)
  請求修正の一意の識別子。
• BillAdjustmentPuid: string
  最大長: 120

  請求修正の公開一意識別子。
• BillLineId: integer (int64)
  請求明細の一意の識別子。
• ChargeAdjustmentId: integer (int64)
  手数料修正の一意の識別子です。
• CreatedBy: string
  読取り専用: true

  最大長: 64

  請求修正を作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  請求修正が作成された日付。
• CurrencyCode: string
  請求修正に使用される現在のコード。
• Effectivity: string
  最大長: 30

  請求修正の有効性。
• LastUpdateDate: string (date-time)
  読取り専用: true

  請求修正が最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  請求修正を最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  請求修正を最後に更新したユーザーのログイン詳細。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• NumberOfPeriods: number
  期間数
• PeriodFrom: number
  請求が調整された期間。
• PeriodUntil: number
  請求が調整されるまでの期間。
• Reason: string
  タイトル: Reason Details

  最大長: 120

  請求が調整された事由です。
• SequenceNumber: number
  タイトル: Sequence

  請求修正のシーケンス番号。
• SubscriptionId: integer (int64)
  サブスクリプションの一意の識別子。
• SubscriptionProductId: integer (int64)
  サブスクリプション製品の一意の識別子。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the bill adjustment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the adjustment is automatic or not.",
            "nullable":false,
            "x-queryable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis on which the bill is adjusted.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Reason":{
            "title":"Reason Details",
            "maxLength":120,
            "type":"string",
            "description":"The reason why the bill is adjusted.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "type":"string",
            "description":"The current code used for the bill adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"number",
            "description":"The sequence number of the bill adjustment.",
            "nullable":false,
            "x-queryable":true
        },
        "NumberOfPeriods":{
            "type":"number",
            "description":"The number of periods",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the bill adjustment.",
            "nullable":false,
            "x-queryable":true
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until which the bill is adjusted.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from which the bill was adjusted.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the bill adjustment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillAdjustmentId":{
            "type":"integer",
            "description":"The unique identifier of the bill adjustment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the bill adjustment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The unique identifier of the charge adjustment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdjustmentReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code of the adjustment reason.",
            "nullable":true,
            "x-queryable":true
        },
        "Effectivity":{
            "maxLength":30,
            "type":"string",
            "description":"The effectivity of the bill adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the bill adjustment.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The value by which the bill is adjusted.",
            "nullable":false,
            "x-queryable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The unique identifier of the bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdjustmentName":{
            "title":"Adjustment",
            "maxLength":120,
            "type":"string",
            "description":"The name of the bill adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "BasisEnableFlag":{
            "type":"boolean",
            "description":"Indicates if the base has been enabled for the bill adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the bill adjustment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the bill adjustment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

• href: string
  タイトル: hyperlink reference

  関連リソースへのURI。
• kind: string
  タイトル: kind

  許可された値: [ "collection", "item", "describe", "other" ]

  関連リソースの種類。
• name: string
  タイトル: name

  関連リソースへのリンクの名前。
• properties: object properties
• rel: string
  タイトル: relation

  許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  リソース・インスタンスとの関係の名前。 例: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

• changeIndicator: string
  リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

ネストされたスキーマ : subscriptionProducts-coveredLevels-charges-item-response

タイプ: object

ソースを表示

• adjustments: array Adjustments
  タイトル: Adjustments

  調整リソースは、調整名、調整タイプ、調整値、調整事由および有効性などのサブスクリプション手数料調整詳細の表示、作成、更新および削除に使用されます。
• AggregationMethod: string
  最大長: 30

  手数料に使用される集計メソッド。
• 手当: number
  タイトル: Allowance

  手数料の引当金部分。
• AssetMeterYn: boolean
  最大長: 1

  アセット・メーターかどうかを示すフラグ。
• BillLineId: integer (int64)
  請求明細の一意の識別子。
• BlockSize: number
  タイトル: Block Size

  料金のブロック・サイズ。
• ChargeDefinition: string
  タイトル: Charge Name

  最大長: 30

  手数料の目的を示す定義。
• ChargeDefinitionName: string
  手数料定義の名前。
• ChargeId: integer (int64)
  手数料の一意の識別子。
• chargeMilestoneEvents: array Charge Milestone Events
  タイトル: Charge Milestone Events

  手数料マイルストン・イベント・リソースは、サブスクリプションの手数料に関連付けられたマイルストン・イベントを表示、作成、更新および削除するために使用されます。
• ChargeName: string
  タイトル: Charge Name

  最大長: 120

  手数料の名前。
• ChargePuid: string
  最大長: 120

  手数料の公開一意識別子。
• chargeTiers: array Charge Tiers
  タイトル: Charge Tiers

  手数料階層リソースは、階層:自、階層:至、定価など、サブスクリプション手数料階層の詳細を表示、作成、更新および削除するために使用されます。
• CoveredLevelId: integer (int64)
  対象レベルの一意の識別子。
• CreatedBy: string
  読取り専用: true

  最大長: 64

  手数料を作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  手数料が作成された日付。
• EnableProration: string
  最大長: 1

  按分が使用可能かどうかを示します。
• EstimatedAmount: number
  タイトル: Estimated Amount

  手数料の見積金額。
• EstimatedMethodName: string
  タイトル: Estimation Method

  金額の見積に使用するメソッド。
• EstimatedQuantity: number
  タイトル: Estimated Quantity

  手数料の見積数量。
• EstimationMethod: string
  タイトル: Estimation Method

  最大長: 30

  金額の見積に使用するメソッド。
• ExternalKey: string
  最大長: 120

  手数料の測定に使用される外部キー。
• ExternalParentKey: string
  最大長: 120

  外部親キー。
• InitialMeterReadingId: integer (int64)
  初期メーター読取り識別子値。
• InvoicingRuleId: integer (int64)
  請求書ルールのID。
• InvoicingRuleName: string
  タイトル: Invoicing Rule

  請求書ルールの名前。
• LastUpdateDate: string (date-time)
  読取り専用: true

  手数料が最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  手数料を最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  料金を最後に更新したユーザーのログイン詳細。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• MeterDefinitionId: integer (int64)
  手数料に関連付けられたメーター定義の一意の識別子。
• MeterId: integer (int64)
  手数料に関連付けられたメーターの一意の識別子。
• MilestoneBillingFlag: boolean
  請求がマイルストン・イベントの影響を受けるかどうかを示します。
• MilestoneRevenueFlag: boolean
  収益がマイルストン・イベントの影響を受けるかどうかを示します。
• MilestoneTemplateId: integer (int64)
  手数料に関連付けられたマイルストン・イベントのID。
• MilestoneTemplateName: string
  最大長: 120

  手数料に関連付けられたマイルストン・テンプレートの名前。
• MinimumAmount: number
  タイトル: Minimum Amount

  請求される最小金額。
• MinimumQuantity: number
  タイトル: Minimum Quantity

  許可される最小数量。
• PeriodicBillingFlag: string
  最大長: 1

  定期請求が許可されているかどうかを示します。
• PeriodicRevenueFlag: string
  タイトル: Enable Periodic Revenue Recognition

  最大長: 1

  単発手数料の定期収益認識を示します。
• PrePaymentNumber: integer (int64)
  タイトル: Prepayment Number

  手数料の前払金番号。
• PricePeriodicity: string
  タイトル: Periodicity

  最大長: 30

  手数料の価格周期。 課金を適用する必要がある頻度を示します。
• PricePeriodicityName: string
  価格周期の名前。
• PriceType: string
  最大長: 30

  手数料に関連付けられた価格タイプ。
• QuotedTcv: number
  料金の見積TCV。
• RollupFlag: boolean
  最大長: 1

  手数料を積み上げる必要があるかどうかを示します。
• SequenceNumber: 整数(int32)
  手数料の連番。
• SubscriptionId: integer (int64)
  サブスクリプションの一意の識別子。
• SubscriptionProductId: integer (int64)
  サブスクリプション製品の一意の識別子。
• TieredFlag: boolean
  最大長: 3

  手数料に階層があるかどうかを示します。
• TierType: string
  タイトル: Tier Type

  最大長: 30

  手数料階層のタイプです。
• TrueUpPeriod: string
  タイトル: True Up Period

  最大長: 30

  デフォルト値: ORA_OSS_USAGE_BILLING_PERIOD

  調整期間の識別子。
• TrueUpPeriodName: string
  タイトル: True Up Period

  調整期間の名前。
• UnitListPrice: number
  タイトル: List Price

  ユニット・リストの価格。
• UsagePriceLockFlag: boolean
  最大長: 3

  使用価格がロックされているかどうかを示します。

{
    "type":"object",
    "properties":{
        "AggregationMethod":{
            "maxLength":30,
            "type":"string",
            "description":"The aggregation method used for the charges.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the charge was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "chargeMilestoneEvents":{
            "title":"Charge Milestone Events",
            "type":"array",
            "description":"The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-chargeMilestoneEvents-item-response"
            }
        },
        "adjustments":{
            "title":"Adjustments",
            "type":"array",
            "description":"The adjustments resource is used to view, create, update, and delete the subscription charge adjustment details, such as adjustment name, adjustment type, adjustment value, adjustment reason, and effectivity.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-adjustments-item-response"
            }
        },
        "ChargeDefinition":{
            "title":"Charge Name",
            "maxLength":30,
            "type":"string",
            "description":"The definition that indicates the purpose of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetMeterYn":{
            "maxLength":1,
            "type":"boolean",
            "description":"The flag whether it is an asset meter or not.",
            "nullable":true,
            "x-queryable":true
        },
        "EstimatedAmount":{
            "title":"Estimated Amount",
            "type":"number",
            "description":"The estimated amount of the charges.",
            "nullable":true,
            "x-queryable":true
        },
        "PricePeriodicityName":{
            "type":"string",
            "description":"The name of the price periodicity.",
            "nullable":true,
            "x-queryable":true
        },
        "PrePaymentNumber":{
            "title":"Prepayment Number",
            "type":"integer",
            "description":"The prepayment number for the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "MeterDefinitionId":{
            "type":"integer",
            "description":"The unique identifier of the meter definition associated with the charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EstimationMethod":{
            "title":"Estimation Method",
            "maxLength":30,
            "type":"string",
            "description":"The method used to estimate the amount.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodicBillingFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether periodic billing is allowed or not.",
            "nullable":true,
            "x-queryable":true
        },
        "MilestoneBillingFlag":{
            "type":"boolean",
            "description":"Indicates whether the billing is impacted by milestone events or not.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "ExternalParentKey":{
            "maxLength":120,
            "type":"string",
            "description":"The external parent key.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The price of the unit list.",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number for the charge.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "InitialMeterReadingId":{
            "type":"integer",
            "description":"The initial meter reading identifier value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the charge.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedQuantity":{
            "title":"Estimated Quantity",
            "type":"number",
            "description":"The estimated quantity for the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the charge.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeName":{
            "title":"Charge Name",
            "maxLength":120,
            "type":"string",
            "description":"The name of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "QuotedTcv":{
            "type":"number",
            "description":"The quoted TCV of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "TieredFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the charge has tiers.",
            "nullable":true,
            "x-queryable":true
        },
        "UsagePriceLockFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the usage price is locked or not.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodicRevenueFlag":{
            "title":"Enable Periodic Revenue Recognition",
            "maxLength":1,
            "type":"string",
            "description":"Indicates the periodic revenue recognition of one-time charges.",
            "nullable":true,
            "x-queryable":true
        },
        "MilestoneRevenueFlag":{
            "type":"boolean",
            "description":"Indicates whether the revenue is impacted by milestone events or not.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "chargeTiers":{
            "title":"Charge Tiers",
            "type":"array",
            "description":"The charge tiers resource is used to view, create, update, and delete the subscription charge tier details, such as tier from, tier to, and list price.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-chargeTiers-item-response"
            }
        },
        "MinimumAmount":{
            "title":"Minimum Amount",
            "type":"number",
            "description":"The minimum amount to be charged.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceType":{
            "maxLength":30,
            "type":"string",
            "description":"The price type associated with the charge.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the charge needs to be rolled up.",
            "nullable":true,
            "x-queryable":true
        },
        "TierType":{
            "title":"Tier Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the charge tier.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InvoicingRuleName":{
            "title":"Invoicing Rule",
            "type":"string",
            "description":"The name of the invoice rule.",
            "nullable":true,
            "x-queryable":false
        },
        "MeterId":{
            "type":"integer",
            "description":"The unique identifier of the meter associated with the charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeDefinitionName":{
            "type":"string",
            "description":"The name of the charge definition.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnableProration":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether proration is enabled or not.",
            "nullable":true,
            "x-queryable":true
        },
        "TrueUpPeriodName":{
            "title":"True Up Period",
            "type":"string",
            "description":"The name of the trueup period.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExternalKey":{
            "maxLength":120,
            "type":"string",
            "description":"The external key used to measure the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "Allowance":{
            "title":"Allowance",
            "type":"number",
            "description":"The allowance part of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoicingRuleId":{
            "type":"integer",
            "description":"The ID of the invoice rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MilestoneTemplateName":{
            "maxLength":120,
            "type":"string",
            "description":"The name of the milestone template associated with a charge.",
            "nullable":true,
            "x-queryable":false
        },
        "MilestoneTemplateId":{
            "type":"integer",
            "description":"The ID of the milestone event associated with a charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MinimumQuantity":{
            "title":"Minimum Quantity",
            "type":"number",
            "description":"The minimum quantity that is allowed.",
            "nullable":true,
            "x-queryable":true
        },
        "EstimatedMethodName":{
            "title":"Estimation Method",
            "type":"string",
            "description":"The method used to estimate the amount.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PricePeriodicity":{
            "title":"Periodicity",
            "maxLength":30,
            "type":"string",
            "description":"The price periodicity for the charge. Indicates the frequency when the charge has to be applied.",
            "nullable":true,
            "x-queryable":true
        },
        "TrueUpPeriod":{
            "title":"True Up Period",
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the trueup period.",
            "nullable":true,
            "default":"ORA_OSS_USAGE_BILLING_PERIOD",
            "x-queryable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The unique identifier of the bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BlockSize":{
            "title":"Block Size",
            "type":"number",
            "description":"The block size of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the charge was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : 調整

タイプ: array

タイトル: Adjustments

調整リソースは、調整名、調整タイプ、調整値、調整事由および有効性などのサブスクリプション手数料調整詳細の表示、作成、更新および削除に使用されます。

ソースを表示

• Array of: object subscriptionProducts-coveredLevels-charges-adjustments-item-response

{
    "title":"Adjustments",
    "type":"array",
    "description":"The adjustments resource is used to view, create, update, and delete the subscription charge adjustment details, such as adjustment name, adjustment type, adjustment value, adjustment reason, and effectivity.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-adjustments-item-response"
    }
}

ネストされたスキーマ : 手数料マイルストン・イベント

タイプ: array

タイトル: Charge Milestone Events

手数料マイルストン・イベント・リソースは、サブスクリプションの手数料に関連付けられたマイルストン・イベントを表示、作成、更新および削除するために使用されます。

ソースを表示

• Array of: object subscriptionProducts-coveredLevels-charges-chargeMilestoneEvents-item-response

{
    "title":"Charge Milestone Events",
    "type":"array",
    "description":"The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-chargeMilestoneEvents-item-response"
    }
}

ネストされたスキーマ : 手数料階層

タイプ: array

タイトル: Charge Tiers

手数料階層リソースは、階層:自、階層:至、定価など、サブスクリプション手数料階層の詳細を表示、作成、更新および削除するために使用されます。

ソースを表示

• Array of: object subscriptionProducts-coveredLevels-charges-chargeTiers-item-response

{
    "title":"Charge Tiers",
    "type":"array",
    "description":"The charge tiers resource is used to view, create, update, and delete the subscription charge tier details, such as tier from, tier to, and list price.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-chargeTiers-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : subscriptionProducts-coveredLevels-charges-adjustments-item-response

タイプ: object

ソースを表示

• AdjustmentBasis: string
  タイトル: Basis

  最大長: 30

  調整の基準。
• AdjustmentName: string
  タイトル: Adjustment

  最大長: 120

  調整の名前。
• AdjustmentReasonCode: string
  タイトル: Reason

  最大長: 30

  調整事由のコード。
• AdjustmentReasonMeaning: string
  タイトル: Reason

  換算済修正事由。
• AdjustmentType: string
  タイトル: Type

  最大長: 30

  調整のタイプ。
• AdjustmentValue: number
  タイトル: Value

  調整の値。
• AutoAdjustmentFlag: boolean
  最大長: 3

  調整が自動かどうかを示します。
• ChargeAdjustmentId: integer (int64)
  手数料修正の一意の識別子です。
• ChargeAdjustmentPuid: string
  最大長: 120

  手数料修正の公開一意識別子。
• ChargeId: integer (int64)
  手数料の一意の識別子。
• CreatedBy: string
  読取り専用: true

  最大長: 64

  調整を作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  調整が作成された日付。
• Effectivity: string
  タイトル: Effectivity

  最大長: 30

  調整の有効性
• LastUpdateDate: string (date-time)
  読取り専用: true

  調整が最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  調整を最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  調整を最後に更新したユーザーのログイン詳細。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• NumberOfPeriods: number
  期間数
• ObjectVersionNumber: 整数(int32)
  オプティミスティック・ロックの実装に使用される数。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
• PeriodFrom: number
  調整が開始された期間。
• PeriodUntil: number
  調整が開始されるまでの期間。
• Reason: string
  タイトル: Reason Description

  最大長: 120

  修正の理由
• SequenceNumber: 整数(int32)
  タイトル: Sequence

  調整の連番。
• SubscriptionId: integer (int64)
  サブスクリプションの一意の識別子。
• SubscriptionProductId: integer (int64)
  サブスクリプション製品の一意の識別子。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the adjustment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the adjustment is automatic or not.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis of the adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Reason":{
            "title":"Reason Description",
            "maxLength":120,
            "type":"string",
            "description":"The reason for the adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence number of the adjustment.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "NumberOfPeriods":{
            "type":"number",
            "description":"The number of periods",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until which the adjustment is initiated.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from which the adjustment was initiated.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the adjustment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the adjustment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the charge adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The unique identifier of the charge adjustment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdjustmentReasonCode":{
            "title":"Reason",
            "maxLength":30,
            "type":"string",
            "description":"The code of the adjustment reason.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Effectivity":{
            "title":"Effectivity",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment effectivity",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The value of the adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdjustmentReasonMeaning":{
            "title":"Reason",
            "type":"string",
            "description":"The translated adjustment reason.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AdjustmentName":{
            "title":"Adjustment",
            "maxLength":120,
            "type":"string",
            "description":"The name of the adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the adjustment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the adjustment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : subscriptionProducts-coveredLevels-charges-chargeMilestoneEvents-item-response

タイプ: object

ソースを表示

• BillingOffset: number
  マイルストン・イベントに関連付けられた請求オフセット。
• BillLineId: integer (int64)
  マイルストン・イベントに関連付けられた請求明細ID。
• ChargeId: integer (int64)
  マイルストン・イベントが関連付けられている手数料ID。
• ChargePuid: string
  最大長: 120

  デフォルト値: Charges.ChargePuid

  マイルストン・イベントが関連付けられている手数料のPUID。
• CompletionDate: 文字列(日付)
  マイルストン・イベントの完了日。
• CreatedBy: string
  読取り専用: true

  最大長: 64

  マイルストン・イベントを作成したユーザーのログイン。
• CreationDate: string (date-time)
  読取り専用: true

  マイルストン・イベントが作成された日付。
• EventId: integer (int64)
  マイルストン・イベントのID。
• EventSource: string
  最大長: 30

  マイルストン・イベントのソース。
• EventSourceReference: string
  最大長: 120

  マイルストン・イベントのソース参照。
• EventType: string
  最大長: 30

  マイルストン・イベントのタイプ。
• ExpectedCompletionDate: 文字列(日付)
  マイルストン・イベントの予定完了日。
• LastUpdateDate: string (date-time)
  読取り専用: true

  マイルストン・イベントが最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  マイルストン・イベントを最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  マイルストン・イベントを最後に更新したログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• MilestoneComment: string
  最大長: 300

  マイルストン・イベント・コメント。
• MilestoneName: string
  最大長: 30

  マイルストン・イベントの名前。
• MilestonePuid: string
  最大長: 120

  マイルストン・イベントPUID。
• ObjectVersionNumber: 整数(int32)
  マイルストン・イベントのオブジェクト・バージョン番号。
• パーセント: number
  マイルストン・イベントに関連付けられたパーセント。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who updated the milestone event the last.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date on which the milestone event was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillingOffset":{
            "type":"number",
            "description":"The billing offset associated with a milestone event.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the charge to which the milestone event is associated.",
            "nullable":true,
            "default":"Charges.ChargePuid",
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The login of the user who created the milestone event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpectedCompletionDate":{
            "type":"string",
            "description":"The expected completion date of a milestone event.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EventType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the milestone event.",
            "nullable":false,
            "x-queryable":true
        },
        "Percentage":{
            "type":"number",
            "description":"The percentage associated with a milestone event.",
            "nullable":false,
            "x-hints":{
                "precision":5,
                "scale":2
            },
            "x-queryable":true
        },
        "MilestoneName":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the milestone event.",
            "nullable":false,
            "x-queryable":true
        },
        "MilestoneComment":{
            "maxLength":300,
            "type":"string",
            "description":"The milestone event comment.",
            "nullable":true,
            "x-queryable":true
        },
        "MilestonePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The milestone event PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "EventSource":{
            "maxLength":30,
            "type":"string",
            "description":"The source of the milestone event.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the milestone event.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "EventId":{
            "type":"integer",
            "description":"The ID of the milestone event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EventSourceReference":{
            "maxLength":120,
            "type":"string",
            "description":"The source reference of the milestone event.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BillLineId":{
            "type":"integer",
            "description":"The bill line ID associated with the milestone event.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID with which the milestone event is associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CompletionDate":{
            "type":"string",
            "description":"The completion date of the milestone event.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BillingOffset"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date of which the milestone event was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login which updated the milestone event the last.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : subscriptionProducts-coveredLevels-charges-chargeTiers-item-response

タイプ: object

ソースを表示

• AdditionalNumberFive: number
  タイトル: Additional Number Five

  手数料階層の追加番号(ある場合)。
• AdditionalNumberFour: number
  タイトル: Additional Number Four

  手数料階層の追加番号(ある場合)。
• AdditionalNumberOne: number
  タイトル: Additional Number One

  手数料階層の追加番号(ある場合)。
• AdditionalNumberSix: number
  タイトル: Additional Number Six

  手数料階層の追加番号(ある場合)。
• AdditionalNumberThree: number
  タイトル: Additional Number Three

  手数料階層の追加番号(ある場合)。
• AdditionalNumberTwo: number
  タイトル: Additional Number Two

  手数料階層の追加番号(ある場合)。
• AdditionalTextOne: string
  タイトル: Additional Text One

  最大長: 4000

  手数料階層の追加テキスト(ある場合)。
• AdditionalTextTwo: string
  タイトル: Additional Text Two

  最大長: 4000

  手数料階層の追加テキスト(ある場合)。
• AdditionalTimestampOne: string (date-time)
  タイトル: Additional Time-stamp One

  課金階層の追加タイムスタンプ(ある場合)。
• AdditionalTimestampThree: string (date-time)
  タイトル: Additional Time-stamp Three

  課金階層の追加タイムスタンプ(ある場合)。
• AdditionalTimestampTwo: string (date-time)
  タイトル: Additional Time-stamp Two

  課金階層の追加タイムスタンプ(ある場合)。
• AddtionalTextThree: string
  タイトル: Additional Text Three

  最大長: 4000

  手数料階層の追加テキスト(ある場合)。
• BlockSize: number
  タイトル: Block Size

  ブロック・サイズ
• ChargeId: integer (int64)
  手数料の一意の識別子。
• ChargeTierId: integer (int64)
  手数料階層の一意の識別子。
• ChargeTierPuid: string
  最大長: 120

  手数料階層の公開一意識別子。
• CreatedBy: string
  読取り専用: true

  最大長: 64

  手数料階層を作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  課金階層が作成された日付。
• LastUpdateDate: string (date-time)
  読取り専用: true

  課金階層が最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  手数料階層を最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  課金階層を最後に更新したユーザーのログイン詳細。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ListPrice: number
  タイトル: List Price

  定価
• PriceFormat: string
  タイトル: Price Format

  最大長: 30

  価格の表示書式。
• SequenceNumber: number
  連番
• SubscriptionId: integer (int64)
  サブスクリプションの一意の識別子。
• SubscriptionProductId: integer (int64)
  サブスクリプション製品の一意の識別子。
• TierFrom: number
  タイトル: Tier From

  階層:自
• TierTo: number
  タイトル: Tier To

  階層:至

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the charge tier was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalTimestampTwo":{
            "title":"Additional Time-stamp Two",
            "type":"string",
            "description":"Additional timestamp, if any, for the charge tier.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeTierPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the charge tier.",
            "nullable":false,
            "x-queryable":true
        },
        "AdditionalNumberThree":{
            "title":"Additional Number Three",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true,
            "x-queryable":true
        },
        "ListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The list price",
            "nullable":false,
            "x-queryable":true
        },
        "AdditionalNumberFive":{
            "title":"Additional Number Five",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TierTo":{
            "title":"Tier To",
            "type":"number",
            "description":"The tier to",
            "nullable":true,
            "x-queryable":true
        },
        "AddtionalTextThree":{
            "title":"Additional Text Three",
            "maxLength":4000,
            "type":"string",
            "description":"Additional text, if any, for the charge tier.",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"number",
            "description":"The sequence number",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TierFrom":{
            "title":"Tier From",
            "type":"number",
            "description":"The tier from",
            "nullable":false,
            "x-queryable":true
        },
        "AdditionalNumberTwo":{
            "title":"Additional Number Two",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the charge tier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeTierId":{
            "type":"integer",
            "description":"The unique identifier of the charge tier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the charge tier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalNumberFour":{
            "title":"Additional Number Four",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalTimestampOne":{
            "title":"Additional Time-stamp One",
            "type":"string",
            "description":"Additional timestamp, if any, for the charge tier.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PriceFormat":{
            "title":"Price Format",
            "maxLength":30,
            "type":"string",
            "description":"The display format of the price.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdditionalTextOne":{
            "title":"Additional Text One",
            "maxLength":4000,
            "type":"string",
            "description":"Additional text, if any, for the charge tier.",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalNumberSix":{
            "title":"Additional Number Six",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalNumberOne":{
            "title":"Additional Number One",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalTextTwo":{
            "title":"Additional Text Two",
            "maxLength":4000,
            "type":"string",
            "description":"Additional text, if any, for the charge tier.",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalTimestampThree":{
            "title":"Additional Time-stamp Three",
            "type":"string",
            "description":"Additional timestamp, if any, for the charge tier.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BlockSize":{
            "title":"Block Size",
            "type":"number",
            "description":"The block size",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the charge tier was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the charge tier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : subscriptionProducts-coveredLevels-relationships-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  読取り専用: true

  最大長: 64

  関係を作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  関係が作成された日付。
• LastUpdateDate: string (date-time)
  読取り専用: true

  関係が最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  関係を最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  関係を最後に更新したユーザーのログイン詳細。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ObjectVersionNumber: 整数(int32)
  読取り専用: true

  オプティミスティック・ロックの実装に使用される数。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
• OperationLinksPuid: string
  最大長: 120

  操作リンクの公開一意識別子。
• RelationshipTypeCode: string
  最大長: 30

  関係のタイプを示すコード。
• SourceAssetKey: string
  最大長: 120

  ソース・アセット・キー
• SourceProdAssociationId: integer (int64)
  ソース製品関連の一意の識別子。
• SourceProdAssociationPuid: string
  最大長: 120

  ソース製品関連の公開一意識別子。
• SourceProductPuid: string
  最大長: 120

  ソース製品の公開一意識別子。
• SourceRootAssetKey: string
  最大長: 120

  ソース・ルート・アセット・キー
• TargetProdAssociationId: integer (int64)
  ターゲット製品関連の一意の識別子。
• TargetProdAssociationPuid: string
  最大長: 120

  ターゲット製品関連の公開一意識別子。
• TargetProductPuid: string
  最大長: 120

  ターゲット製品の公開一意識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the relationship was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceProdAssociationId":{
            "type":"integer",
            "description":"The unique identifier of the source product association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TargetProdAssociationId":{
            "type":"integer",
            "description":"The unique identifier of the target product association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceAssetKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source asset key",
            "nullable":true,
            "x-queryable":true
        },
        "SourceProductPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the source product.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "OperationLinksPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the operation links.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceRootAssetKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source root asset key",
            "nullable":true,
            "x-queryable":true
        },
        "SourceProdAssociationPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the source product association.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetProductPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the target product.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetProdAssociationPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the target product association.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the relationship was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

リンク

billLines

操作: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines

パラメータ:

• CoveredLevelPuid: $request.path.CoveredLevelPuid
• SubscriptionProductPuid: $request.path.SubscriptionProductPuid

請求明細ビュー・オブジェクト

手数料

操作: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges

パラメータ:

• CoveredLevelPuid: $request.path.CoveredLevelPuid
• SubscriptionProductPuid: $request.path.SubscriptionProductPuid

サブスクリプション手数料ビュー・オブジェクト

関係

操作: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/relationships

パラメータ:

• CoveredLevelPuid: $request.path.CoveredLevelPuid
• SubscriptionProductPuid: $request.path.SubscriptionProductPuid

関係ビュー・オブジェクト

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、対象レベルを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionProducts/CDRM_4016-PRDT-2013/child/coveredLevels/GP-5678-PRDT-7-PASS-1

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
      "CoveredLevelId": 300100192686410,
      "CoveredLevelPuid": "GP-5678-PRDT-7-PASS-1",
      "SubscriptionProductId": 300100181994505,
      "SubscriptionId": 300100181994494,
      "LineNumber": "1",
      "InventoryItemId": 300100118490672,
      "AssetId": 300100118585763,
      "AssetName": "zOKC_Auto_Asset1",
      "AssetSerialNumber": null,
      "ProductName": "ZOKC_Item_001",
      "Description": "Item",
      "Type": "ORA_ASSET",
      "TypeName": "Asset",
      "Quantity": 1,
      "ItemUnitOfMeasure": "Ea",
      "TotalContractValue": 12361.29,
      "GenerateBillingSchedule": null,
      "EndDate": "2020-05-29",
      "StartDate": "2020-01-01",
      "Duration": 150,
      "Period": "DY",
      "Status": "ORA_DRAFT",
      "StatusName": "Draft",
      "PriceAsOf": "2020-01-01",
      "PriceUnitOfMeasure": "0zE",
      "PriceUnitOfMeasureName": "YEAR",
      "PriceListId": null,
      "PricingError": null,
      "TaxAmount": null,
      "InvoiceText": "[$Product Name]: [$Charge Name] [$Bill from Date]-[$Bill to Date]",
      "CancelReason": null,
      "CanceledDate": null,
      "CanceledAmount": null,
      "ClosedDate": null,
      "CloseReason": null,
      "ClosedAmount": null,
      "ReturnCreditMethod": null,
      "SuppressedCreditAmount": null,
      "InvoicedAmount": null,
      "CreditedAmount": null,
      "RenewedDate": null,
      "RenewalType": null,
      "TaxError": null,
      "CreatedBy": "SALES_ADMIN",
      "CreationDate": "2019-08-20T06:55:15+00:00",
      "LastUpdatedBy": "SALES_ADMIN",
      "LastUpdateDate": "2019-08-20T06:55:15.130+00:00",
      "LastUpdateLogin": "9062D47DF31EDAF6E0533EFDF40A2696",
      "CurrencyCode": null,
      "CorpCurrencyCode": null,
      "CurcyConvRateType": null,
      "PutOnHoldFlag": null,
      "RemoveHoldFlag": null,
      "links":
	...
}

「トップに戻る」