Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

サブスクリプション製品の作成

post

/crmRestApi/resources/11.13.18.05/subscriptionProducts

リクエスト

ヘッダー・パラメータ

Metadata-Context:

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

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
Upsert-Mode:

次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

application/json

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

AccountingRuleId(required): integer (int64)

タイトル: Accounting Rule

会計基準の一意の識別子。
AccountingRuleName: string

タイトル: Accounting Rule

会計基準の名前。
AlignBillingFrom: 文字列(日付)

タイトル: Align Billing From

請求連携の日付:自。
AmendCreditMethod: string

タイトル: Amendment Credit Method

最大長: 30

クレジットの修正に使用するメソッド。
AmendCreditMethodName: string

クレジットの修正メソッドの名称。
AmendDescription: string

タイトル: Amendment Description

最大長: 300

修正されたクレジットの簡単な説明。
AmendEffectiveDate: 文字列(日付)

タイトル: Amendment Effective Date

修正された貸方が有効になる日付。
AmendReason: string

タイトル: Amendment Reason

最大長: 30

クレジットが修正された理由。
AmendReasonName: string

修正事由の名前。
associatedAsset: array Associated Assets

タイトル: Associated Assets

関連付けられたアセット・リソースは、サブスクリプション・タイプのサブスクリプション製品にリンクされたアセットの表示、作成、更新および削除に使用されます。
AutoExtendFlag: boolean

製品を自動延長する必要があるかどうかを示します。
BillingDateCode: string

タイトル: Billing Date Code

最大長: 30

請求日を示すコード。
BillingDateName: string

請求日の名前。
BillingFrequency(required): string

タイトル: Billing Frequency

最大長: 30

請求頻度。
BillingFrequencyName: string

タイトル: Billing Frequency

請求頻度の名前。
BillingOffsetDays: integer (int64)

タイトル: Billing Offset Days

請求オフセット日数。
billLines: array Bill Lines

タイトル: Bill Lines

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

タイトル: Bill on Day

製品の請求日。
BillToAccountDescription: string

請求先アカウントの簡単な説明。
BillToAccountId(required): integer (int64)

タイトル: Billing Account

請求先アカウントの一意の識別子。
BillToAccountNumber: string

タイトル: Billing Account

請求先アカウントのアカウント番号。
BillToAddress: string

タイトル: Bill-to Address

請求先住所。
BillToContactId: integer (int64)

タイトル: Bill-to Contact

サブスクリプション製品の請求先担当者ID。
BillToContactName: string

タイトル: Bill-to Contact

サブスクリプション製品の請求先担当者名。
BillToContactNumber: string

サブスクリプション製品の請求先担当者番号。
BillToPartyId: integer (int64)

タイトル: Bill-to Customer

サブスクリプション製品の請求先顧客ID。
BillToPartyName: string

タイトル: Bill-to Customer

サブスクリプション製品の請求先顧客名。
BillToPartyNumber: string

サブスクリプション製品の請求先顧客番号。
BillToSiteNumber: string

タイトル: Bill-to Site Number

サブスクリプション製品の請求先サイト番号。
BillToSiteUseId(required): integer (int64)

タイトル: Bill-to Site

請求先サイト使用の一意の識別子。
CalculatedCreditAmount: number

タイトル: Calculated Credit Amount

サブスクリプション製品の計算済クレジット金額。
CancelDescription: string

タイトル: Cancellation Description

最大長: 2000

サブスクリプション製品の取消事由摘要。
CanceledAmount: number

タイトル: Canceled Amount

取り消されたトランザクション金額。
CanceledDate: 文字列(日付)

タイトル: Product Canceled Date

製品が取り消された日付。
CancelReason: string

タイトル: Cancellation Reason

最大長: 30

製品が取り消された理由。
charges: array Charges

タイトル: Charges

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

解約予測トレンド。
ChurnProbability: number

タイトル: Churn Probability

製品に関連付けられた流動の可能性。
CloseCreditMethod: string

タイトル: Close Credit Method

最大長: 30

クレジットのクローズに使用するメソッド。
ClosedAmount: number

タイトル: Closed Amount

トランザクションがクローズされた金額。
ClosedDate: 文字列(日付)

タイトル: Product Close Date

製品がクローズされた日付。
CloseDescription: string

タイトル: Close Description

最大長: 2000

サブスクリプション製品のクローズ事由摘要。
CloseReason: string

タイトル: Product Close Reason

最大長: 30

製品がクローズされた理由。
CorpCurrencyCode: string

最大長: 15

製品に関連付けられている企業通貨コード。この属性は、CRM拡張フレームワークで使用されます。受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。
CoverageName: string

タイトル: Template Name

製品に関連付けられている補償内容の名前。
CoverageScheduleId: integer (int64)

スケジュール済カバレッジ
coveredLevels: array Covered Levels

タイトル: Covered Levels

対象レベル・リソースは、サブスクリプションID、サブスクリプション製品ID、対象アセットおよびその関連詳細など、サブスクリプション対象レベル詳細の作成、表示、更新または削除に使用されます。
creditCards: array Credit Cards

タイトル: Credit Cards

クレジット・カード・リソースは、サブスクリプションに関連付けられているクレジット・カードを表示、作成および更新するために使用されます。
CreditedAmount: number

タイトル: Credited Amount

アカウントに貸方記入された金額。
CurcyConvRateType: string

最大長: 30

製品に関連付けられている通貨換算レート・タイプ。この属性は、CRM拡張フレームワークで使用されます。受け入れられる値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。
Currency(required): string

最大長: 15

サブスクリプション製品に関連付けられた通貨。
CustomerTrxTypeSequenceId: integer (int64)

サブスクリプション製品の顧客トランザクション・タイプ連番ID。
DefaultRevenueAction: string

最大長: 30

修正中に使用されるサブスクリプション製品の収益管理ルール。
DefinitionOrganizationId(required): integer (int64)

品目マスター組織の一意の識別子。
Description: string

タイトル: Product Description

サブスクリプション製品の簡単な説明。
DisplaySequence: number

タイトル: Display Sequence

サブスクリプション製品の表示順序。
DocumentTypeId: integer (int64)

タイトル: Document Type

デフォルト値: 10

Oracle Revenue Management Cloudのソース文書タイプのTheuUnique識別子。
DropOneTimeChargeFlag: boolean

タイトル: Don't copy one-time charges

最大長: 1

製品の変更時に単発料金を削除する必要があるかどうかを示します。
Duration: integer

タイトル: Duration

製品期間
EarlyTerminationPenalty: string

タイトル: Early Termination Penalty

最大長: 30

早期終了ペナルティ。
EarlyTerminationPenaltyName: string

早期終了ペナルティの名前。
EnablePricingTermsFlag: boolean

タイトル: Enable pricing term

最大長: 1

価格設定条件が使用可能かどうかを示します。
EnableProrateByDay: boolean

タイトル: Prorate by day

最大長: 1

日別按分が使用可能かどうかを示します。
EnableUpfrontBillingFlag: boolean

タイトル: Bill immediately

最大長: 1

請求が事前完了したかどうかを示します。
EndDate: 文字列(日付)

タイトル: Product End Date

サブスクリプションが終了する日付。
EstimatedTax: number

タイトル: Estimated Tax

製品の見積税。
ExemptCertificateNumber: string

タイトル: Tax Exemption Certificate Number

最大長: 80

免税証明書の番号。
ExemptReason: string

タイトル: Exemption Reason

最大長: 30

免税の事由です。
ExternalAssetKey: string

最大長: 120

外部アセット・キー
ExternalParentAssetKey: string

最大長: 120

外部親アセット・キー
ExternalPriceListId: string

最大長: 120

外部価格表の一意の識別子。
ExternalRootAssetKey: string

最大長: 120

外部ルート・アセット・キー
flexFields: array Descriptive Flexfields

タイトル: Descriptive Flexfields

付加フレックスフィールド・リソースは、付加フレックスフィールドの表示、作成、更新および削除に使用されます。
GenerateBillFullPeriodFlag: boolean

タイトル: Generate billing schedule for full period

最大長: 1

全期間請求の生成フラグ
GenerateBillingSchedule: string

タイトル: Generate billing schedule for full period

最大長: 80

請求スケジュールが生成されるかどうかを示します。
GracePeriod: integer (int64)

タイトル: Grace Period in Days

猶予期間
InterfaceOffsetDays: 整数(int32)

インタフェースを相殺する必要がある日数。
InventoryItemId(required): integer (int64)

在庫品目の一意の識別子。
InvoicedAmount: number

タイトル: Invoiced Amount

請求書で指定された金額。
InvoiceText: string

タイトル: Invoice Text

最大長: 2000

請求請求書のテキスト。
InvoicingRuleId(required): integer (int64)

タイトル: Invoicing Rule

請求ルールの一意の識別子です。
InvoicingRuleName: string

タイトル: Invoicing Rule

請求ルールの名前。
ItemUnitOfMeasure: string

タイトル: Pricing UOM Code

最大長: 15

品目の測定に使用される単位。
LineNumber(required): string

タイトル: Product Line Number

最大長: 300

製品の明細番号。
MonthlyRecurringRevenue: number

タイトル: MRR

製品に関連付けられた月次経常売上。
NextBillStartDate: 文字列(日付)

次回請求開始日
NextPricingDate: 文字列(日付)

次の価格設定が発生する日付。
OrderFulfillLineId: integer (int64)

サブスクリプション製品に関連付けられた販売オーダー履行明細のID。
OrderFulfillLineNumber: 整数(int32)

サブスクリプション製品に関連付けられている販売オーダー履行明細の番号。
OutputTaxClassification: string

最大長: 50

仮受税金の計算時に使用する税分類です。
OverrideCreditAmount: number

タイトル: Override Credit Amount

サブスクリプション製品のクレジット金額の上書き。
PaymentMethod: string

タイトル: Payment Method Code

最大長: 30

支払方法の一意の識別子。
PaymentMethodName: string

タイトル: Payment Method

支払方法の名前。
PaymentTermsId: integer (int64)

タイトル: Payment Terms

支払条件の一意の識別子。
PaymentTermsName: string

タイトル: Payment Terms

支払条件の名前。
PenaltyChargeName: string

ペナルティ手数料名。
PenaltyValue: number

タイトル: Penalty Value

ペナルティ値。
PendingActivationFlag: boolean

タイトル: Pending activation

最大長: 1

サブスクリプション製品のアクティブ化が待ち状態かどうかを示します。
Period: string

タイトル: Period

製品がサブスクライブされている期間。
PONumber: string

タイトル: PO Number

最大長: 50

購買オーダーの番号。
PrePaymentNumber: integer (int64)

タイトル: Prepayment Number

前払金番号。
PriceAdjustmentBasis: string

タイトル: Price Adjustment Basis

最大長: 30

価格が調整される基準。
PriceAdjustmentPercent: number

タイトル: Price Adjustment Value

価格修正パーセント。
PriceAdjustmentType: string

タイトル: Price Adjustment Type

最大長: 30

価格調整のタイプ。
PriceAsOf: 文字列(日付)

タイトル: Price as of Date

特定の日付時点での製品の価格。
PriceListId: integer (int64)

価格リストの一意の識別子。
PriceListName: string

最大長: 120

価格リストの名前。
PriceTransactionOn: 文字列(日付)

価格トランザクションが発生した日付。
PricingError: string

最大長: 2000

製品に関連する価格設定エラー。
PricingTermsAdjustmentPCT: number

タイトル: Pricing Term Adjustment Percentage

価格設定条件の調整。
PricingTermsDuration: number

タイトル: Pricing Term Duration

価格設定条件の継続期間。
PricingTermsPeriod: string

タイトル: Pricing Term

最大長: 15

価格設定条件が継続する期間。
PricingTermsPricingMethod: string

タイトル: Pricing Method

最大長: 30

製品価格設定の条件を設定するために使用するメソッド。
PricingTermsStartDate: 文字列(日付)

タイトル: Starting On

価格設定条件が開始する日付。
ProductChangeReason: string

タイトル: Change Reason

最大長: 300

製品変更の事由。
ProductChangeSchedule: string

タイトル: Apply Change

最大長: 30

製品変更スケジュールは、更新、ANNIVERSARYまたはSPECIFIC_DATEに適用されます。
ProductChangeScheduleFrom: 文字列(日付)

タイトル: Product Change Schedule Effective Date

製品変更スケジュールが適用可能な開始日。
ProductFiscClassification: string

最大長: 30

製品会計分類。
ProductName: string

タイトル: Product Name

最大長: 300

製品の名前。
数量: number

タイトル: Quantity

製品の数量。
RatePlanDocument: 文字列(バイト)

レート・プランを表すJSON。
RatePlanDocumentId: integer (int64)

レート・プラン文書の識別子。
RatePlanId: integer (int64)

レート・プランの一意の識別子。
RatePlanName: string

タイトル: Rate Plan

レート・プランの名前。
RatePlanNumber: string

レート・プランの番号。
RelatedInventoryItemId: integer (int64)

タイトル: Related Inventory Item ID

置換サブスクリプション製品に関連付けられたアイテムの一意の識別子。
RelatedProductDescription: string

タイトル: Description

置換サブスクリプション製品の説明。
RelatedProductName: string

タイトル: Product Name

最大長: 300

置換サブスクリプション製品の名前。
relationships: array Relationships

タイトル: Relationships

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

タイトル: Renewal Duration

自動更改または手動更改による更改時に使用されるサブスクリプション製品レベルの更改期間上書き。
RenewalDurationPeriod: string

タイトル: Renewal Period

最大長: 30

自動または手動更改による更改時に使用される、サブスクリプション製品レベルの更改期間上書きのコードです。
RenewalDurationPeriodName: string

タイトル: Renewal Period

自動更改または手動更改による更改時に使用されるサブスクリプション製品レベルの更改期間上書きの名前。
RenewalPaymentMethod: string

タイトル: Product Renewal Payment Method

最大長: 30

サブスクリプション製品で使用される更改支払方法の内部コード。
RenewalPaymentMethodName: string

タイトル: Renewal Payment Method

更改済サブスクリプション製品の支払メソッド。支払方法は、購買オーダー、電信、クレジット・カードのいずれかです。
RenewalPoNumber: string

タイトル: Product Renewal PO Number

最大長: 50

更改済サブスクリプション製品の購買オーダー番号。
RenewalType: string

タイトル: Product Renewal Type

最大長: 30

サブスクリプション更改のタイプ。
RenewalWireNumber: string

タイトル: Product Renewal Wire Number

最大長: 30

更改済サブスクリプション製品の支払に使用される電子送金を識別する電信番号。
RenewedDate: 文字列(日付)

タイトル: Renewed On

製品が更改された日付。
RenewPerpetuallyFlag: boolean

タイトル: Renew forever

最大長: 1

サブスクリプション製品を永久に更新する必要があるかどうかを示します。
RepriceFlag: boolean

サブスクリプション製品の価格を再設定する必要があるかどうかを示します。 'true'として渡された場合、サブスクリプション製品および関連する対象レベルの価格が再設定されます。
RequestedRatePlanId: integer (int64)

リクエストされたレート・プランの一意の識別子。
RequestedRatePlanNumber: string

リクエストされたレート・プランの代替一意識別子。
ResumeDate: 文字列(日付)

製品を再開する日付。
ResumeDuration: integer

製品を再開するまでの期間。
ResumePeriod: string

製品が再開されるまでの期間。
salesCredits: array Sales Credits

タイトル: Sales Credits

サブスクリプションまたはサブスクリプション製品に定義されている販売実績を表示、作成、更新および削除するための販売実績リソースです。
SalesOrderId: integer (int64)

サブスクリプション製品に関連付けられている販売オーダーのID。
SalesOrderNumber: string

最大長: 200

サブスクリプション製品に関連付けられた販売オーダーの番号。
SalesProductType: string

タイトル: Type

最大長: 30

販売製品のタイプ。
serviceResources: array Service Resources

タイトル: Service Resources

サービス・リソース・リソースは、サブスクリプション製品のサービス識別子を表示、作成、更新および削除するために使用されます。
ShipToAccountDescription: string

サブスクリプション製品の出荷先アカウント摘要。
ShipToAccountId: integer (int64)

タイトル: Ship-to Account

サブスクリプション製品の出荷先アカウントID。
ShipToAccountNumber: string

タイトル: Ship-to Account

サブスクリプション製品の出荷先アカウント番号。
ShipToContactId: integer (int64)

タイトル: Ship-to Contact

サブスクリプション製品の出荷先担当者ID。
ShipToContactName: string

タイトル: Ship-to Contact

サブスクリプション製品の出荷先担当者名。
ShipToContactNumber: string

サブスクリプション製品の出荷先担当者番号。
ShipToPartyId: integer (int64)

タイトル: Ship-to Party

出荷先パーティの一意の識別子。
ShipToPartyName: string

タイトル: Ship-to Party

出荷先パーティの名前。
ShipToPartyNumber: string

タイトル: Ship-to Party Number

サブスクリプション製品の出荷先パーティ番号。
ShipToPartySiteId: integer (int64)

タイトル: Ship-to Site

出荷先パーティ・サイトの一意の識別子。
ShipToPartySiteName: string

タイトル: Ship-to Site

出荷先パーティ・サイトの名前。
ShipToPartySiteNumber: string

タイトル: Ship-to Site Number

サブスクリプション製品の出荷先パーティ・サイト番号。
SourceKey: string

最大長: 120

ソース・システム内の製品の識別子。
SourceLineKey: string

最大長: 120

ソース明細キー
SourceLineNumber: string

最大長: 120

ソース明細番号
SourceNumber: string

最大長: 120

ソース・システム内の製品の代替識別子。
SourceSystem: string

最大長: 30

ソース・システム内の製品の参照。
StartDate(required): 文字列(日付)

タイトル: Product Start Date

サブスクリプションが開始する日付。
Status: string

タイトル: Status

最大長: 30

デフォルト値: DRAFT

サブスクリプション製品のステータス。
SubscriptionId(required): integer (int64)

サブスクリプションの一意の識別子。
SubscriptionNumber: string

タイトル: Subscription Number

最大長: 120

デフォルト値: Subscriptions.SubscriptionNumber

製品のサブスクリプション番号。
SubscriptionProductId: integer (int64)

サブスクリプション製品の一意の識別子。
SubscriptionProductPuid(required): string

タイトル: Subscription Product Number

最大長: 120

サブスクリプション製品の公開一意識別子。
SummarizedBillingFlag: boolean

タイトル: Summarized billing

最大長: 1

請求が要約されるかどうかを示します。
SuspendCreditMethod: string

タイトル: Suspend Credit Method

最大長: 30

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

タイトル: Suspend Date

製品が一時停止された日付。
SuspendReason: string

タイトル: Suspend Reason

最大長: 30

製品を一時停止する理由。
TaxError: string

最大長: 2000

計算金額の税金エラー(ある場合)。
TaxExemptionHandling: string

最大長: 30

免税処理。
TaxExemptionHandlingName: string

免税処理名。
TotalContractValue: number

タイトル: Product Contract Value

契約合計の値。
TransactionTypeName(required): string

タイトル: Transaction Type

最大長: 30

トランザクション・タイプの名前。
UnitPrice: number

単位の価格。
UsageInvoiceLayoutTemplate: string

タイトル: Usage Events Invoice Template

最大長: 200

使用請求書のレイアウト・テンプレート。
WarehouseId: integer (int64)

タイトル: Warehouse

サブスクリプション製品に関連付けられた倉庫ID。
WareHouseName: string

タイトル: Warehouse

サブスクリプション製品のウェアハウス名。
WireNumber: string

タイトル: Wire Number

最大長: 30

電信番号。

{
    "required":[
        "AccountingRuleId",
        "BillToAccountId",
        "BillToSiteUseId",
        "BillingFrequency",
        "Currency",
        "DefinitionOrganizationId",
        "InventoryItemId",
        "InvoicingRuleId",
        "LineNumber",
        "StartDate",
        "SubscriptionId",
        "SubscriptionProductPuid",
        "TransactionTypeName"
    ],
    "type":"object",
    "properties":{
        "PONumber":{
            "title":"PO Number",
            "maxLength":50,
            "type":"string",
            "description":"The number of the purchase order.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PaymentMethod"
                ]
            }
        },
        "CalculatedCreditAmount":{
            "title":"Calculated Credit Amount",
            "type":"number",
            "description":"The calculated credit amount of the subscription product.",
            "nullable":true
        },
        "NextPricingDate":{
            "type":"string",
            "description":"The date when the next pricing will occur.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToPartyId":{
            "title":"Ship-to Party",
            "type":"integer",
            "description":"The unique identifier of the ship-to party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CurcyConvRateType":{
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type associated with the product. 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":false
        },
        "EarlyTerminationPenalty":{
            "title":"Early Termination Penalty",
            "maxLength":30,
            "type":"string",
            "description":"The early termination penalty.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CancelDescription":{
            "title":"Cancellation Description",
            "maxLength":2000,
            "type":"string",
            "description":"The cancellation reason description of the subscription product.",
            "nullable":true
        },
        "ResumeDate":{
            "type":"string",
            "description":"The date when the product should be resumed.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ResumePeriod":{
            "type":"string",
            "description":"The period of time after which the product will resume.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChurnPredictionTrend":{
            "type":"integer",
            "description":"The churn prediction trend.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            }
        },
        "ProductChangeScheduleFrom":{
            "title":"Product Change Schedule Effective Date",
            "type":"string",
            "description":"The date from which the product change schedule is  applicable.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "PrePaymentNumber":{
            "title":"Prepayment Number",
            "type":"integer",
            "description":"The prepayment number.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "ChurnProbability":{
            "title":"Churn Probability",
            "type":"number",
            "description":"The probability of churn associated with the product.",
            "nullable":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-relationships-item-post-request"
            }
        },
        "SourceKey":{
            "maxLength":120,
            "type":"string",
            "description":"The identifier of the product in the source system.",
            "nullable":true,
            "x-queryable":false
        },
        "CloseReason":{
            "title":"Product Close Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason why the product was closed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Currency":{
            "maxLength":15,
            "type":"string",
            "description":"The currency associated with the subscription product.",
            "nullable":false,
            "x-queryable":false
        },
        "SummarizedBillingFlag":{
            "title":"Summarized billing",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the billing is to be summarized.",
            "nullable":true
        },
        "BillToPartyId":{
            "title":"Bill-to Customer",
            "type":"integer",
            "description":"The bill-to customer ID of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SourceNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate identifier of the product in the source system.",
            "nullable":true,
            "x-queryable":false
        },
        "PricingTermsPeriod":{
            "title":"Pricing Term",
            "maxLength":15,
            "type":"string",
            "description":"The period for which the pricing terms last.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CanceledDate":{
            "title":"Product Canceled Date",
            "type":"string",
            "description":"The date when the product was canceled.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "WareHouseName":{
            "title":"Warehouse",
            "type":"string",
            "description":"The warehouse name of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PriceAdjustmentPercent":{
            "title":"Price Adjustment Value",
            "type":"number",
            "description":"The price adjustment percent.",
            "nullable":true,
            "x-queryable":false
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the subscription product.",
            "nullable":false,
            "default":"DRAFT"
        },
        "AlignBillingFrom":{
            "title":"Align Billing From",
            "type":"string",
            "description":"The from date of the billing alignment.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "BillingFrequency":{
            "title":"Billing Frequency",
            "maxLength":30,
            "type":"string",
            "description":"The billing frequency.",
            "nullable":false,
            "x-queryable":false
        },
        "SubscriptionProductPuid":{
            "title":"Subscription Product Number",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the subscription product.",
            "nullable":false
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The unique identifier of the inventory item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CreditedAmount":{
            "title":"Credited Amount",
            "type":"number",
            "description":"The amount credited to a account.",
            "nullable":true,
            "x-queryable":false
        },
        "PaymentTermsId":{
            "title":"Payment Terms",
            "type":"integer",
            "description":"The unique identifier of the payment terms.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PaymentTermsName":{
            "title":"Payment Terms",
            "type":"string",
            "description":"The name of the payment terms.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RenewalPaymentMethodName":{
            "title":"Renewal Payment Method",
            "type":"string",
            "description":"The method of payment for renewed subscription product. The payment method could be a purchase order, wire, or credit card.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RenewalDurationPeriodName":{
            "title":"Renewal Period",
            "type":"string",
            "description":"The name of the subscription product level renewal duration period override that will be used while renewing through automatic or manual renewal.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AmendDescription":{
            "title":"Amendment Description",
            "maxLength":300,
            "type":"string",
            "description":"A brief description of the amended credit.",
            "nullable":true,
            "x-queryable":false
        },
        "EstimatedTax":{
            "title":"Estimated Tax",
            "type":"number",
            "description":"The estimated tax on the product.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewalPaymentMethod":{
            "title":"Product Renewal Payment Method",
            "maxLength":30,
            "type":"string",
            "description":"The internal code for the renewal payment method used in the subscription product.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewPerpetuallyFlag":{
            "title":"Renew forever",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the subscription product should be renewed forever.",
            "nullable":true
        },
        "SalesOrderNumber":{
            "maxLength":200,
            "type":"string",
            "description":"The number of the sales order associated with the subscription product.",
            "nullable":true
        },
        "BillToPartyName":{
            "title":"Bill-to Customer",
            "type":"string",
            "description":"The bill-to customer name of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false
            }
        },
        "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-charges-item-post-request"
            }
        },
        "PricingTermsPricingMethod":{
            "title":"Pricing Method",
            "maxLength":30,
            "type":"string",
            "description":"The method used to set the terms of the product pricing.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ShipToPartySiteName":{
            "title":"Ship-to Site",
            "type":"string",
            "description":"The name of the ship-to party site.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "serviceResources":{
            "title":"Service Resources",
            "type":"array",
            "description":"The service resources resouce is used to view, create, update, and delete the service identifier for a subscription product.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-serviceResources-item-post-request"
            }
        },
        "PriceListId":{
            "type":"integer",
            "description":"The unique identifier of the price list.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AutoExtendFlag":{
            "type":"boolean",
            "description":"Indicates if the product should be auto extended.",
            "nullable":true,
            "x-queryable":false
        },
        "GracePeriod":{
            "title":"Grace Period in Days",
            "type":"integer",
            "description":"The grace period.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AmendReasonName":{
            "type":"string",
            "description":"The name of the amend reason.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InvoicedAmount":{
            "title":"Invoiced Amount",
            "type":"number",
            "description":"The amount specified in the invoice.",
            "nullable":true,
            "x-queryable":false
        },
        "SuspendedDate":{
            "title":"Suspend Date",
            "type":"string",
            "description":"The date when the product was suspended.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "OutputTaxClassification":{
            "maxLength":50,
            "type":"string",
            "description":"The tax classification to use when calculating the output tax.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewalDuration":{
            "title":"Renewal Duration",
            "type":"integer",
            "description":"The subscription product level renewal duration override that will be used while renewing through automatic or manual renewal.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MonthlyRecurringRevenue":{
            "title":"MRR",
            "type":"number",
            "description":"The monthly recurring revenue associated with the product.",
            "nullable":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Product Description",
            "type":"string",
            "description":"A brief description of the subscription product.",
            "nullable":true,
            "x-queryable":false
        },
        "RelatedProductDescription":{
            "title":"Description",
            "type":"string",
            "description":"The description of the replacement subscription product.",
            "nullable":true,
            "x-queryable":false
        },
        "CanceledAmount":{
            "title":"Canceled Amount",
            "type":"number",
            "description":"The transaction amount that was canceled.",
            "nullable":true,
            "x-queryable":false
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"number",
            "description":"The display sequence of the subscription product.",
            "nullable":true,
            "x-queryable":false
        },
        "InvoicingRuleName":{
            "title":"Invoicing Rule",
            "type":"string",
            "description":"The name of the invoicing rule.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CustomerTrxTypeSequenceId":{
            "type":"integer",
            "description":"The customer transaction type sequence ID of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DefaultRevenueAction":{
            "maxLength":30,
            "type":"string",
            "description":"The revenue management rule of the subscription product used during the amendment.",
            "nullable":true,
            "x-queryable":false
        },
        "LineNumber":{
            "title":"Product Line Number",
            "maxLength":300,
            "type":"string",
            "description":"The line number of the product.",
            "nullable":false
        },
        "BillToPartyNumber":{
            "type":"string",
            "description":"The bill-to customer number of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PaymentMethodName":{
            "title":"Payment Method",
            "type":"string",
            "description":"The name of the payment method.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExternalAssetKey":{
            "maxLength":120,
            "type":"string",
            "description":"The external asset key",
            "nullable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ExternalPriceListId":{
            "maxLength":120,
            "type":"string",
            "description":"The unique identifier of the external price list.",
            "nullable":true
        },
        "UsageInvoiceLayoutTemplate":{
            "title":"Usage Events Invoice Template",
            "maxLength":200,
            "type":"string",
            "description":"The layout template of the usage invoice.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "OrderFulfillLineNumber":{
            "type":"integer",
            "description":"The number of the sales order fulfillment line associated with the subscription product.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "flexFields":{
            "title":"Descriptive Flexfields",
            "type":"array",
            "description":"The descriptive flexfields resource is used to view, create, update, and delete a descriptive flexfield.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-flexFields-item-post-request"
            },
            "x-cardinality":"1"
        },
        "EarlyTerminationPenaltyName":{
            "type":"string",
            "description":"The name of the early termination penalty.",
            "nullable":true
        },
        "BillingDateCode":{
            "title":"Billing Date Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the billing date.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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-billLines-item-post-request"
            }
        },
        "PendingActivationFlag":{
            "title":"Pending activation",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the activation of the subscription product is pending or not.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToContactName":{
            "title":"Ship-to Contact",
            "type":"string",
            "description":"The ship-to contact name of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false
            }
        },
        "TotalContractValue":{
            "title":"Product Contract Value",
            "type":"number",
            "description":"The value of the total contract.",
            "nullable":true
        },
        "SuspendReason":{
            "title":"Suspend Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason to suspend the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DropOneTimeChargeFlag":{
            "title":"Don't copy one-time charges",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether one time charges have to be removed when the product is changed.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalParentAssetKey":{
            "maxLength":120,
            "type":"string",
            "description":"The external parent asset key",
            "nullable":true
        },
        "coveredLevels":{
            "title":"Covered Levels",
            "type":"array",
            "description":"The covered levels resource is used to create, view, update, or delete the subscription covered levels details, such as subscription ID, subscription product ID, covered asset and its associated details.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-item-post-request"
            }
        },
        "CloseCreditMethod":{
            "title":"Close Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"The method used to close the credit.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PricingTermsDuration":{
            "title":"Pricing Term Duration",
            "type":"number",
            "description":"The duration for which the pricing terms last.",
            "nullable":true,
            "x-queryable":false
        },
        "WarehouseId":{
            "title":"Warehouse",
            "type":"integer",
            "description":"The warehouse ID associated with the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EndDate":{
            "title":"Product End Date",
            "type":"string",
            "description":"The date when the subscriptions ends.",
            "format":"date",
            "nullable":true
        },
        "DocumentTypeId":{
            "title":"Document Type",
            "type":"integer",
            "description":"TheuUnique identifier of a source document type in Oracle Revenue Management Cloud.",
            "format":"int64",
            "nullable":true,
            "default":10,
            "x-hints":{
                "precision":18
            }
        },
        "ClosedAmount":{
            "title":"Closed Amount",
            "type":"number",
            "description":"The amount at which the transaction was closed.",
            "nullable":true,
            "x-queryable":false
        },
        "RelatedProductName":{
            "title":"Product Name",
            "maxLength":300,
            "type":"string",
            "description":"The name of the replacement subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "BillToSiteNumber":{
            "title":"Bill-to Site Number",
            "type":"string",
            "description":"The bill-to site number of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "OverrideCreditAmount":{
            "title":"Override Credit Amount",
            "type":"number",
            "description":"The override credit amount of the subscription product.",
            "nullable":true
        },
        "ShipToPartySiteId":{
            "title":"Ship-to Site",
            "type":"integer",
            "description":"The unique identifier of the ship-to party site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "UnitPrice":{
            "type":"number",
            "description":"The price of the unit.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalRootAssetKey":{
            "maxLength":120,
            "type":"string",
            "description":"The external root asset key",
            "nullable":true
        },
        "ResumeDuration":{
            "type":"integer",
            "description":"The duration after which the the product should be resumed.",
            "nullable":true,
            "x-queryable":false
        },
        "ProductFiscClassification":{
            "maxLength":30,
            "type":"string",
            "description":"The product fiscal classification.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceTransactionOn":{
            "type":"string",
            "description":"The date when the price transaction occurred.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "GenerateBillingSchedule":{
            "title":"Generate billing schedule for full period",
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the billing schedule is to be generated or not.",
            "nullable":true,
            "x-queryable":false
        },
        "AccountingRuleId":{
            "title":"Accounting Rule",
            "type":"integer",
            "description":"The unique identifier of the accounting rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BillToAccountId":{
            "title":"Billing Account",
            "type":"integer",
            "description":"The unique identifier of the bill-to account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PenaltyValue":{
            "title":"Penalty Value",
            "type":"number",
            "description":"The penalty value.",
            "nullable":true,
            "x-queryable":false
        },
        "RatePlanName":{
            "title":"Rate Plan",
            "type":"string",
            "description":"The name of the rate plan.",
            "nullable":true,
            "x-queryable":false
        },
        "ClosedDate":{
            "title":"Product Close Date",
            "type":"string",
            "description":"The date when the product was closed.",
            "format":"date",
            "nullable":true
        },
        "SourceSystem":{
            "maxLength":30,
            "type":"string",
            "description":"The reference of the product in the source system.",
            "nullable":true,
            "x-queryable":false
        },
        "ProductChangeReason":{
            "title":"Change Reason",
            "maxLength":300,
            "type":"string",
            "description":"The reason for the product change.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CloseDescription":{
            "title":"Close Description",
            "maxLength":2000,
            "type":"string",
            "description":"The close reason description of the subscription product.",
            "nullable":true
        },
        "TransactionTypeName":{
            "title":"Transaction Type",
            "maxLength":30,
            "type":"string",
            "description":"The name of the transaction type.",
            "nullable":false,
            "x-queryable":false
        },
        "AmendReason":{
            "title":"Amendment Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason why the credit was amended.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillingOffsetDays":{
            "title":"Billing Offset Days",
            "type":"integer",
            "description":"The billing offset days.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ProductName":{
            "title":"Product Name",
            "maxLength":300,
            "type":"string",
            "description":"The name of the product.",
            "nullable":true,
            "x-hints":{
                "controlType":"input_text_lov"
            }
        },
        "TaxExemptionHandlingName":{
            "type":"string",
            "description":"The tax exemption handling name.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillToAccountDescription":{
            "type":"string",
            "description":"A brief description of the bill-to account.",
            "nullable":true,
            "x-queryable":false
        },
        "BillToAccountNumber":{
            "title":"Billing Account",
            "type":"string",
            "description":"The account number of the bill-to account.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "BillingDateName":{
            "type":"string",
            "description":"The name of the billing date.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PenaltyChargeName":{
            "type":"string",
            "description":"The penalty charge name.",
            "nullable":true
        },
        "TaxExemptionHandling":{
            "maxLength":30,
            "type":"string",
            "description":"The tax exemption handling.",
            "nullable":true,
            "x-queryable":false
        },
        "SuspendCreditMethod":{
            "title":"Suspend Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the credit method has to be suspended.",
            "nullable":true,
            "x-queryable":false
        },
        "StartDate":{
            "title":"Product Start Date",
            "type":"string",
            "description":"The date when the subscriptions starts.",
            "format":"date",
            "nullable":false
        },
        "BillToAddress":{
            "title":"Bill-to Address",
            "type":"string",
            "description":"The bill-to address.",
            "nullable":true,
            "x-queryable":false
        },
        "ExemptReason":{
            "title":"Exemption Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason for the tax exemption.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToAccountDescription":{
            "type":"string",
            "description":"The ship-to account description of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PricingTermsStartDate":{
            "title":"Starting On",
            "type":"string",
            "description":"The date when the pricing terms starts.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "PriceAdjustmentBasis":{
            "title":"Price Adjustment Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis on the which the price is adjusted.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RelatedInventoryItemId":{
            "title":"Related Inventory Item ID",
            "type":"integer",
            "description":"The unique identifier of the item associated to the replacement subscription product.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RatePlanDocumentId":{
            "type":"integer",
            "description":"The identifier of the rate plan document.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RequestedRatePlanNumber":{
            "type":"string",
            "description":"The alternate unique identifier of the requested rate plan.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false
            }
        },
        "CorpCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code associated with the product. 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":false
        },
        "ShipToAccountNumber":{
            "title":"Ship-to Account",
            "type":"string",
            "description":"The ship-to account number of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false
            }
        },
        "ItemUnitOfMeasure":{
            "title":"Pricing UOM Code",
            "maxLength":15,
            "type":"string",
            "description":"The unit of measure used to measure the items.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EnableProrateByDay":{
            "title":"Prorate by day",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether proration by day is enabled or not.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToContactId":{
            "title":"Ship-to Contact",
            "type":"integer",
            "description":"The ship-to contact ID of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CoverageScheduleId":{
            "type":"integer",
            "description":"Coverage Scheduled",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BillToSiteUseId":{
            "title":"Bill-to Site",
            "type":"integer",
            "description":"The unique identifier of the bill-to site use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Period":{
            "title":"Period",
            "type":"string",
            "description":"The period for which the product has been subscribed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Duration":{
            "title":"Duration",
            "type":"integer",
            "description":"Product Duration",
            "nullable":true,
            "x-queryable":false
        },
        "RequestedRatePlanId":{
            "type":"integer",
            "description":"The unique identifier of the requested rate plan.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RenewalType":{
            "title":"Product Renewal Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of subscription renewal.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillOnDay":{
            "title":"Bill on Day",
            "type":"number",
            "description":"The day on which the product should be billed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "WireNumber":{
            "title":"Wire Number",
            "maxLength":30,
            "type":"string",
            "description":"The wire number.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PaymentMethod"
                ]
            }
        },
        "RatePlanId":{
            "type":"integer",
            "description":"The unique identifier of the rate plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CancelReason":{
            "title":"Cancellation Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason why the product was canceled.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceAdjustmentType":{
            "title":"Price Adjustment Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the price adjustment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "creditCards":{
            "title":"Credit Cards",
            "type":"array",
            "description":"The credit cards resource is used to view, create, and update the credit cards associated with a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-creditCards-item-post-request"
            }
        },
        "GenerateBillFullPeriodFlag":{
            "title":"Generate billing schedule for full period",
            "maxLength":1,
            "type":"boolean",
            "description":"Generate Bill Full Period Flag",
            "nullable":true,
            "x-queryable":false
        },
        "BillToContactNumber":{
            "type":"string",
            "description":"The bill-to contact number of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PaymentMethod":{
            "title":"Payment Method Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the payment method.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewalPoNumber":{
            "title":"Product Renewal PO Number",
            "maxLength":50,
            "type":"string",
            "description":"The purchase order number of the renewed subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "RenewalPaymentMethod"
                ]
            }
        },
        "SourceLineNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The source line number",
            "nullable":true,
            "x-queryable":false
        },
        "DefinitionOrganizationId":{
            "type":"integer",
            "description":"The unique identifier of the item master organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SalesProductType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the sales product.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AmendCreditMethod":{
            "title":"Amendment Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"The method used to amend the credit.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RenewalDurationPeriod":{
            "title":"Renewal Period",
            "maxLength":30,
            "type":"string",
            "description":"The code of the subscription product level renewal duration period override that will be used while renewing through automatic or manual renewal.",
            "nullable":true
        },
        "PriceAsOf":{
            "title":"Price as of Date",
            "type":"string",
            "description":"The price of the product as of a certain date.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "CoverageName":{
            "title":"Template Name",
            "type":"string",
            "description":"The name of the coverage associated with the product.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "RatePlanNumber":{
            "type":"string",
            "description":"The number of the rate plan.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ShipToContactNumber":{
            "type":"string",
            "description":"The ship-to contact number of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ShipToPartyName":{
            "title":"Ship-to Party",
            "type":"string",
            "description":"The name of the ship-to party.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ProductChangeSchedule":{
            "title":"Apply Change",
            "maxLength":30,
            "type":"string",
            "description":"The product change schedule is applicable on RENEWAL, ANNIVERSARY or SPECIFIC_DATE.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToAccountId":{
            "title":"Ship-to Account",
            "type":"integer",
            "description":"The ship-to account ID of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AccountingRuleName":{
            "title":"Accounting Rule",
            "type":"string",
            "description":"The name of the accounting rule.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InvoiceText":{
            "title":"Invoice Text",
            "maxLength":2000,
            "type":"string",
            "description":"The text in the billing invoice.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AmendCreditMethodName":{
            "type":"string",
            "description":"The name of the method used to amend the credit .",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "NextBillStartDate":{
            "type":"string",
            "description":"Next Bill Start Date",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "SalesOrderId":{
            "type":"integer",
            "description":"The ID of the sales order associated with the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AmendEffectiveDate":{
            "title":"Amendment Effective Date",
            "type":"string",
            "description":"The date when the amended credit becomes effective.",
            "format":"date",
            "nullable":true
        },
        "OrderFulfillLineId":{
            "type":"integer",
            "description":"The ID of the sales order fulfillment line associated with the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PricingTermsAdjustmentPCT":{
            "title":"Pricing Term Adjustment Percentage",
            "type":"number",
            "description":"The adjustment in the pricing terms.",
            "nullable":true,
            "x-queryable":false
        },
        "TaxError":{
            "maxLength":2000,
            "type":"string",
            "description":"The tax error, if any, in the calculated amount.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceListName":{
            "maxLength":120,
            "type":"string",
            "description":"The name of the price list.",
            "nullable":true,
            "x-queryable":false
        },
        "InterfaceOffsetDays":{
            "type":"integer",
            "description":"The number of days that the interface needs to be offset for.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":5
            }
        },
        "SourceLineKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source line key",
            "nullable":true,
            "x-queryable":false
        },
        "EnableUpfrontBillingFlag":{
            "title":"Bill immediately",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether billing is done upfront or not.",
            "nullable":true,
            "x-queryable":false
        },
        "InvoicingRuleId":{
            "title":"Invoicing Rule",
            "type":"integer",
            "description":"The unique identifier of the invoicing rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RepriceFlag":{
            "type":"boolean",
            "description":"Indicates whether the subscription product should be repriced or not. If passed as 'true', the subscription product and its associated covered levels will be repriced.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":120,
            "type":"string",
            "description":"The subscription number of the product.",
            "nullable":false,
            "default":"Subscriptions.SubscriptionNumber"
        },
        "RenewedDate":{
            "title":"Renewed On",
            "type":"string",
            "description":"The date when the product was renewed.",
            "format":"date",
            "nullable":true
        },
        "ShipToPartyNumber":{
            "title":"Ship-to Party Number",
            "type":"string",
            "description":"The ship-to party number of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of the product.",
            "nullable":true,
            "x-queryable":false
        },
        "BillingFrequencyName":{
            "title":"Billing Frequency",
            "type":"string",
            "description":"The name of the billing frequency.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExemptCertificateNumber":{
            "title":"Tax Exemption Certificate Number",
            "maxLength":80,
            "type":"string",
            "description":"The number of the exempt certificate.",
            "nullable":true,
            "x-queryable":false
        },
        "BillToContactId":{
            "title":"Bill-to Contact",
            "type":"integer",
            "description":"The bill-to contact ID of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ShipToPartySiteNumber":{
            "title":"Ship-to Site Number",
            "type":"string",
            "description":"The ship-to party site number of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "salesCredits":{
            "title":"Sales Credits",
            "type":"array",
            "description":"The sales credits resource to view, create, update, and delete the sales credits defined for a subscription or a subscription product.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-salesCredits-item-post-request"
            }
        },
        "EnablePricingTermsFlag":{
            "title":"Enable pricing term",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the pricing terms are enabled or not.",
            "nullable":true
        },
        "BillToContactName":{
            "title":"Bill-to Contact",
            "type":"string",
            "description":"The bill-to contact name of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false
            }
        },
        "RenewalWireNumber":{
            "title":"Product Renewal Wire Number",
            "maxLength":30,
            "type":"string",
            "description":"The wire number that identifies the electronic funds transfer used to pay for a renewed subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "RenewalPaymentMethod"
                ]
            }
        },
        "associatedAsset":{
            "title":"Associated Assets",
            "type":"array",
            "description":"The associated assets resource is used to view, create, update, and delete the assets linked to a subscription product of subscription type.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-associatedAsset-item-post-request"
            }
        },
        "RatePlanDocument":{
            "type":"string",
            "description":"The JSON representing the rate plan.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PricingError":{
            "maxLength":2000,
            "type":"string",
            "description":"The pricing error associated with the product.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

ネストされたスキーマ : 関連アセット

タイプ: array

タイトル: Associated Assets

関連付けられたアセット・リソースは、サブスクリプション・タイプのサブスクリプション製品にリンクされたアセットの表示、作成、更新および削除に使用されます。

ソースを表示

Array of: object subscriptionProducts-associatedAsset-item-post-request

{
    "title":"Associated Assets",
    "type":"array",
    "description":"The associated assets resource is used to view, create, update, and delete the assets linked to a subscription product of subscription type.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-associatedAsset-item-post-request"
    }
}

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

タイプ: array

タイトル: Bill Lines

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

ソースを表示

Array of: object subscriptionProducts-billLines-item-post-request

{
    "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-billLines-item-post-request"
    }
}

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

タイプ: array

タイトル: Charges

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

ソースを表示

Array of: object subscriptionProducts-charges-item-post-request

{
    "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-charges-item-post-request"
    }
}

ネストされたスキーマ : 対象レベル

タイプ: array

タイトル: Covered Levels

対象レベル・リソースは、サブスクリプションID、サブスクリプション製品ID、対象アセットおよびその関連詳細など、サブスクリプション対象レベル詳細の作成、表示、更新または削除に使用されます。

ソースを表示

Array of: object subscriptionProducts-coveredLevels-item-post-request

{
    "title":"Covered Levels",
    "type":"array",
    "description":"The covered levels resource is used to create, view, update, or delete the subscription covered levels details, such as subscription ID, subscription product ID, covered asset and its associated details.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-item-post-request"
    }
}

ネストされたスキーマ : クレジット・カード情報

タイプ: array

タイトル: Credit Cards

クレジット・カード・リソースは、サブスクリプションに関連付けられているクレジット・カードを表示、作成および更新するために使用されます。

ソースを表示

Array of: object subscriptionProducts-creditCards-item-post-request

{
    "title":"Credit Cards",
    "type":"array",
    "description":"The credit cards resource is used to view, create, and update the credit cards associated with a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-creditCards-item-post-request"
    }
}

ネストされたスキーマ : 付加フレックスフィールド

タイプ: array

タイトル: Descriptive Flexfields

付加フレックスフィールド・リソースは、付加フレックスフィールドの表示、作成、更新および削除に使用されます。

ソースを表示

Array of: object subscriptionProducts-flexFields-item-post-request

{
    "title":"Descriptive Flexfields",
    "type":"array",
    "description":"The descriptive flexfields resource is used to view, create, update, and delete a descriptive flexfield.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-flexFields-item-post-request"
    },
    "x-cardinality":"1"
}

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

タイプ: array

タイトル: Relationships

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

ソースを表示

Array of: object schema

{
    "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-relationships-item-post-request"
    }
}

ネストされたスキーマ : 販売実績

タイプ: array

タイトル: Sales Credits

サブスクリプションまたはサブスクリプション製品に定義されている販売実績を表示、作成、更新および削除するための販売実績リソースです。

ソースを表示

Array of: object schema

{
    "title":"Sales Credits",
    "type":"array",
    "description":"The sales credits resource to view, create, update, and delete the sales credits defined for a subscription or a subscription product.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-salesCredits-item-post-request"
    }
}

ネストされたスキーマ : サービス・リソース

タイプ: array

タイトル: Service Resources

サービス・リソース・リソースは、サブスクリプション製品のサービス識別子を表示、作成、更新および削除するために使用されます。

ソースを表示

Array of: object subscriptionProducts-serviceResources-item-post-request

{
    "title":"Service Resources",
    "type":"array",
    "description":"The service resources resouce is used to view, create, update, and delete the service identifier for a subscription product.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-serviceResources-item-post-request"
    }
}

ネストされたスキーマ : subscriptionProducts-associatedAsset-item-post-request

タイプ: object

ソースを表示

AssetId: integer (int64)

アセットの一意の識別子。
AssetName: string

タイトル: Asset Name

アセットの名前。
AssetSerialNumber: string

タイトル: Asset Serial Number

アセットのシリアル番号。
AssociatedAssetId: integer (int64)

関連付けられたアセットの一意の識別子。
AssociatedAssetPuid: string

最大長: 120

関連付けられたアセットのPUID。
CorpCurrencyCode: string

最大長: 15

企業通貨コード。
CurcyConvRateType: string

最大長: 30

通貨換算レート・タイプ。有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
CurrencyCode: string

最大長: 15

USDやINRなどの通貨コード。
InventoryItemId: integer

在庫品目の一意の識別子。
LineNumber: integer (int64)

タイトル: Number

関連付けられたアセットのライン番号。
ProductName: string

タイトル: Product Name

製品の名前。
数量: number

タイトル: Quantity

関連アセットの数量。
SourceKey: string

最大長: 120

関連付けられたアセットのソース・キー。
SourceLineKey: string

最大長: 120

関連付けられたアセットのソース明細キー。
SourceLineNumber: string

最大長: 120

関連付けられたアセットのソース明細番号。
SourceNumber: string

最大長: 120

関連付けられたアセットのソース番号。
SourceSystem: string

最大長: 30

関連付けられたアセットのソース・システム。
SubscriptionId: integer (int64)

サブスクリプションの一意の識別子。
SubscriptionProductId: integer (int64)

サブサープション製品の一意の識別子。
UnitOfMeasure: string

タイトル: UOM

関連付けられたアセットの計量単位。
UnitOfMeasureCode: string

タイトル: UOM

関連付けられたアセットの単位コード。

{
    "type":"object",
    "properties":{
        "UnitOfMeasureCode":{
            "title":"UOM",
            "type":"string",
            "description":"The unit of measure code of the associated asset.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "AssetId"
                ]
            }
        },
        "AssociatedAssetId":{
            "type":"integer",
            "description":"The unique identifier of the associated asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ProductName":{
            "title":"Product Name",
            "type":"string",
            "description":"The name of the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "AssetId"
                ]
            }
        },
        "UnitOfMeasure":{
            "title":"UOM",
            "type":"string",
            "description":"The unit of measure of the associated asset.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "UnitOfMeasureCode"
                ]
            }
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The unique identifier of the inventory item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of the associated asset.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "AssetId"
                ]
            }
        },
        "CurcyConvRateType":{
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true
        },
        "LineNumber":{
            "title":"Number",
            "type":"integer",
            "description":"The line number of the associated asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            }
        },
        "AssetName":{
            "title":"Asset Name",
            "type":"string",
            "description":"The name of the asset.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false,
                "dependencies":[
                    "AssetId"
                ]
            }
        },
        "AssetSerialNumber":{
            "title":"Asset Serial Number",
            "type":"string",
            "description":"The serial number of the asset.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "AssetId"
                ]
            }
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code such as USD or INR.",
            "nullable":true
        },
        "SourceKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source key of the associated asset.",
            "nullable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "SubscriptionProductId"
                ]
            }
        },
        "SourceNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The source number of the associated asset.",
            "nullable":true
        },
        "AssociatedAssetPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the associated asset.",
            "nullable":false
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscurption product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AssetId":{
            "type":"integer",
            "description":"The unique identifier of the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SourceLineKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source line key of the associated asset.",
            "nullable":true
        },
        "SourceLineNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The source line number of the associated asset.",
            "nullable":true
        },
        "SourceSystem":{
            "maxLength":30,
            "type":"string",
            "description":"The source system of the associated asset.",
            "nullable":true
        },
        "CorpCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code.",
            "nullable":true
        }
    }
}

ネストされたスキーマ : subscriptionProducts-billLines-item-post-request

タイプ: object

ソースを表示

金額: number

タイトル: Amount

請求が生成される金額。
billAdjustments: array Bill Adjustments

タイトル: Bill Adjustments

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

タイトル: Sequence

請求が生成される期間。
BillLineId: integer (int64)

請求明細の一意の識別子。
BillLinePuid(required): string

最大長: 120

請求明細の公開一意識別子。
BusinessUnitId: integer

請求明細に関連付けられているビジネス・ユニットのID。
ChargeDefinition: string

最大長: 30

手数料の目的を示す定義。
ChargeId: integer (int64)

手数料の一意の識別子。
ChargeName: string

タイトル: Charge Name

最大長: 120

請求明細に関連付けられた手数料の名前。
ChargePeriod: number

タイトル: Period

請求された使用期間。
ChargePeriodFactor: number

請求明細に関連付けられた変更期間ファクタ。
CoveredLevelId: integer (int64)

対象レベルの一意の識別子。
CreditMemoAmount: number

クレジット・メモの金額。
CreditMemoFlag: string

請求明細に関連付けられたクレジット・メモがあるかどうかを示します。
CreditMemoReason: string

クレジット・メモを上げる事由。
CreditMemoReasonCode: string

最大長: 30

クレジット・メモ事由コードのコード。
CustomerTrxTypeSequenceId: integer (int64)

顧客取引タイプ連番ID
DateBilledFrom(required): 文字列(日付)

タイトル: Bill-from Date

請求が生成された日付。
DateBilledTo(required): 文字列(日付)

タイトル: Bill-to Date

請求が生成される最終日。
DateToInterface(required): 文字列(日付)

タイトル: Interface Date

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

タイトル: Interfaced

最大長: 1

デフォルト値: false

請求明細がインタフェースされているかどうかを示します。
InvoiceBillLineId: integer (int64)

請求書請求明細の一意の識別子。
InvoiceDate: 文字列(日付)

請求書が提起された日付。
InvoiceText: string

タイトル: Invoice Text

最大長: 240

請求明細請求書のテキスト。
ListPrice: number

請求明細に関連付けられた製品の定価。
MilestoneEventId: integer (int64)

請求明細に関連付けられたマイルストン・イベントのID。
MilestoneEventName: string

請求明細に関連付けられたマイルストン・イベントの名前。
NewCreditMemoPUID: string

新規クレジット・メモの一意の公開識別子。
PricedQuantity: number

請求明細が請求された数量。
PricingError: string

最大長: 1000

価格設定のエラー(ある場合)。
RecurringFlag(required): 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

使用量の数量。

{
    "required":[
        "BillLinePuid",
        "BillingPeriod",
        "DateBilledFrom",
        "DateBilledTo",
        "DateToInterface",
        "RecurringFlag"
    ],
    "type":"object",
    "properties":{
        "TrxId":{
            "type":"integer",
            "description":"The AR transaction ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TransactionTypeName":{
            "type":"string",
            "description":"The transaction type name of the subscription bill line.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeDefinition":{
            "maxLength":30,
            "type":"string",
            "description":"The definition that indicates the purpose of the charge.",
            "nullable":true
        },
        "SentDate":{
            "title":"Sent Date",
            "type":"string",
            "description":"The date invoice information is sent to receivables.",
            "format":"date",
            "nullable":true
        },
        "UsagePricedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the usage line has been priced or not.",
            "nullable":true
        },
        "ListPrice":{
            "type":"number",
            "description":"The list price of the product associated with the bill line.",
            "nullable":true
        },
        "TransactionTax":{
            "title":"Tax",
            "type":"number",
            "description":"The tax levied on the transaction.",
            "nullable":true
        },
        "RevenueLineId":{
            "type":"integer",
            "description":"The unique identifier of the revenue line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CreditMemoReason":{
            "type":"string",
            "description":"The reason to raise the credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BillLinePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the bill line.",
            "nullable":false
        },
        "UsageFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the line is a usage line or not.",
            "nullable":true
        },
        "UsageChargeTypeName":{
            "type":"string",
            "description":"The name of the usage charge type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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-billLines-billAdjustments-item-post-request"
            }
        },
        "BillingPeriod":{
            "title":"Sequence",
            "type":"number",
            "description":"The period for which the bill is generated.",
            "nullable":false
        },
        "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
        },
        "MilestoneEventId":{
            "type":"integer",
            "description":"The ID of the milestone event associated with the bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TrxLineId":{
            "type":"integer",
            "description":"The AR transaction line ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "UsageCaptureDate":{
            "type":"string",
            "description":"The date when the usage was captured.",
            "format":"date",
            "nullable":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
        },
        "UsageChargeType":{
            "title":"Usage Charge Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of usage charge.",
            "nullable":true
        },
        "TransactionNumber":{
            "title":"Invoice Number",
            "maxLength":30,
            "type":"string",
            "description":"The number of the transaction.",
            "nullable":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
        },
        "CustomerTrxTypeSequenceId":{
            "type":"integer",
            "description":"Customer Transaction Type Sequence Id",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TruedUpYn":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates if the bill line has a trueup period.",
            "nullable":true
        },
        "CreditMemoReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code of the credit memo reason code.",
            "nullable":true
        },
        "InvoiceText":{
            "title":"Invoice Text",
            "maxLength":240,
            "type":"string",
            "description":"The text in the bill line invoice.",
            "nullable":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
            }
        },
        "TransactionClass":{
            "title":"Transaction Class",
            "maxLength":30,
            "type":"string",
            "description":"The class of the transaction.",
            "nullable":true
        },
        "InvoiceDate":{
            "type":"string",
            "description":"The date when the invoice was raised.",
            "format":"date",
            "nullable":true
        },
        "ChargePeriod":{
            "title":"Period",
            "type":"number",
            "description":"The usage period that was charged.",
            "nullable":true
        },
        "TransactionDate":{
            "title":"Invoice Date",
            "type":"string",
            "description":"The date when the transaction occurred.",
            "format":"date",
            "nullable":true
        },
        "InvoiceBillLineId":{
            "type":"integer",
            "description":"The unique identifier of the invoice bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "UsageAcquiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the usage has been acquired or not.",
            "nullable":true
        },
        "InterfacedFlag":{
            "title":"Interfaced",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the bill line is interfaced or not.",
            "nullable":false,
            "default":false
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount for which the bill is generated.",
            "nullable":true
        },
        "DateBilledTo":{
            "title":"Bill-to Date",
            "type":"string",
            "description":"The date up to which the bill is generated.",
            "format":"date",
            "nullable":false
        },
        "UsageQuantity":{
            "title":"Usage Quantity",
            "type":"number",
            "description":"The quantity of the usage.",
            "nullable":true
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PricedQuantity":{
            "type":"number",
            "description":"The quantity for which the bill line was charged.",
            "nullable":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
        },
        "RecurringFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the line is recurring or not.",
            "nullable":false
        },
        "BillLineId":{
            "type":"integer",
            "description":"The unique identifier of the bill line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DateBilledFrom":{
            "title":"Bill-from Date",
            "type":"string",
            "description":"The date from which the bill was generated.",
            "format":"date",
            "nullable":false
        },
        "TransactionClassMeaning":{
            "title":"Class",
            "type":"string",
            "description":"The meaning of transaction class lookup.",
            "nullable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PricingError":{
            "maxLength":1000,
            "type":"string",
            "description":"The error in pricing, if any.",
            "nullable":true
        }
    }
}

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

タイプ: array

タイトル: Bill Adjustments

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

ソースを表示

Array of: object schema

{
    "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-billLines-billAdjustments-item-post-request"
    }
}

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

タイプ: 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)

手数料修正の一意の識別子です。
CurrencyCode: string

請求修正に使用される現在のコード。
Effectivity: string

最大長: 30

請求修正の有効性。
NumberOfPeriods: number

期間数
PeriodFrom: number

請求が調整された期間。
PeriodUntil: number

請求が調整されるまでの期間。
Reason: string

タイトル: Reason Details

最大長: 120

請求が調整された事由です。
SequenceNumber: number

タイトル: Sequence

請求修正のシーケンス番号。
SubscriptionId: integer (int64)

サブスクリプションの一意の識別子。
SubscriptionProductId: integer (int64)

サブスクリプション製品の一意の識別子。

{
    "type":"object",
    "properties":{
        "BillAdjustmentId":{
            "type":"integer",
            "description":"The unique identifier of the bill adjustment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the adjustment is automatic or not.",
            "nullable":false
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis on which the bill is adjusted.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The unique identifier of the charge adjustment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AdjustmentReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code of the adjustment reason.",
            "nullable":true
        },
        "Effectivity":{
            "maxLength":30,
            "type":"string",
            "description":"The effectivity of the bill adjustment.",
            "nullable":true
        },
        "Reason":{
            "title":"Reason Details",
            "maxLength":120,
            "type":"string",
            "description":"The reason why the bill is adjusted.",
            "nullable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the bill adjustment.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CurrencyCode":{
            "type":"string",
            "description":"The current code used for the bill adjustment.",
            "nullable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The value by which the bill is adjusted.",
            "nullable":false
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"number",
            "description":"The sequence number of the bill adjustment.",
            "nullable":false
        },
        "NumberOfPeriods":{
            "type":"number",
            "description":"The number of periods",
            "nullable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The unique identifier of the bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BillAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the bill adjustment.",
            "nullable":false
        },
        "AdjustmentName":{
            "title":"Adjustment",
            "maxLength":120,
            "type":"string",
            "description":"The name of the bill adjustment.",
            "nullable":true
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until which the bill is adjusted.",
            "nullable":true
        },
        "BasisEnableFlag":{
            "type":"boolean",
            "description":"Indicates if the base has been enabled for the bill adjustment.",
            "nullable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from which the bill was adjusted.",
            "nullable":true
        }
    }
}

ネストされたスキーマ : subscriptionProducts-charges-item-post-request

タイプ: 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)

対象レベルの一意の識別子。
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

請求書ルールの名前。
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(required): 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

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

{
    "required":[
        "PriceType"
    ],
    "type":"object",
    "properties":{
        "AggregationMethod":{
            "maxLength":30,
            "type":"string",
            "description":"The aggregation method used for the charges.",
            "nullable":true
        },
        "ChargePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the charge.",
            "nullable":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-charges-chargeMilestoneEvents-item-post-request"
            }
        },
        "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-charges-adjustments-item-post-request"
            }
        },
        "ChargeDefinition":{
            "title":"Charge Name",
            "maxLength":30,
            "type":"string",
            "description":"The definition that indicates the purpose of the charge.",
            "nullable":true
        },
        "AssetMeterYn":{
            "maxLength":1,
            "type":"boolean",
            "description":"The flag whether it is an asset meter or not.",
            "nullable":true
        },
        "EstimatedAmount":{
            "title":"Estimated Amount",
            "type":"number",
            "description":"The estimated amount of the charges.",
            "nullable":true
        },
        "PricePeriodicityName":{
            "type":"string",
            "description":"The name of the price periodicity.",
            "nullable":true
        },
        "PrePaymentNumber":{
            "title":"Prepayment Number",
            "type":"integer",
            "description":"The prepayment number for the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "MeterDefinitionId":{
            "type":"integer",
            "description":"The unique identifier of the meter definition associated with the charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EstimationMethod":{
            "title":"Estimation Method",
            "maxLength":30,
            "type":"string",
            "description":"The method used to estimate the amount.",
            "nullable":true
        },
        "PeriodicBillingFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether periodic billing is allowed or not.",
            "nullable":true
        },
        "MilestoneBillingFlag":{
            "type":"boolean",
            "description":"Indicates whether the billing is impacted by milestone events or not.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "ExternalParentKey":{
            "maxLength":120,
            "type":"string",
            "description":"The external parent key.",
            "nullable":true
        },
        "UnitListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The price of the unit list.",
            "nullable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number for the charge.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "InitialMeterReadingId":{
            "type":"integer",
            "description":"The initial meter reading identifier value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EstimatedQuantity":{
            "title":"Estimated Quantity",
            "type":"number",
            "description":"The estimated quantity for the charge.",
            "nullable":true
        },
        "ChargeName":{
            "title":"Charge Name",
            "maxLength":120,
            "type":"string",
            "description":"The name of the charge.",
            "nullable":true
        },
        "QuotedTcv":{
            "type":"number",
            "description":"The quoted TCV of the charge.",
            "nullable":true
        },
        "TieredFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the charge has tiers.",
            "nullable":true
        },
        "UsagePriceLockFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the usage price is locked or not.",
            "nullable":true
        },
        "PeriodicRevenueFlag":{
            "title":"Enable Periodic Revenue Recognition",
            "maxLength":1,
            "type":"string",
            "description":"Indicates the periodic revenue recognition of one-time charges.",
            "nullable":true
        },
        "MilestoneRevenueFlag":{
            "type":"boolean",
            "description":"Indicates whether the revenue is impacted by milestone events or not.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "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-charges-chargeTiers-item-post-request"
            }
        },
        "MinimumAmount":{
            "title":"Minimum Amount",
            "type":"number",
            "description":"The minimum amount to be charged.",
            "nullable":true
        },
        "PriceType":{
            "maxLength":30,
            "type":"string",
            "description":"The price type associated with the charge.",
            "nullable":false
        },
        "RollupFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the charge needs to be rolled up.",
            "nullable":true
        },
        "TierType":{
            "title":"Tier Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the charge tier.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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
            }
        },
        "ChargeDefinitionName":{
            "type":"string",
            "description":"The name of the charge definition.",
            "nullable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EnableProration":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether proration is enabled or not.",
            "nullable":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
        },
        "Allowance":{
            "title":"Allowance",
            "type":"number",
            "description":"The allowance part of the charge.",
            "nullable":true
        },
        "InvoicingRuleId":{
            "type":"integer",
            "description":"The ID of the invoice rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "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
            }
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "MinimumQuantity":{
            "title":"Minimum Quantity",
            "type":"number",
            "description":"The minimum quantity that is allowed.",
            "nullable":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
        },
        "TrueUpPeriod":{
            "title":"True Up Period",
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the trueup period.",
            "nullable":true,
            "default":"ORA_OSS_USAGE_BILLING_PERIOD"
        },
        "BillLineId":{
            "type":"integer",
            "description":"The unique identifier of the bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BlockSize":{
            "title":"Block Size",
            "type":"number",
            "description":"The block size of the charge.",
            "nullable":true
        }
    }
}

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

タイプ: array

タイトル: Adjustments

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

ソースを表示

Array of: object schema

{
    "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-charges-adjustments-item-post-request"
    }
}

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

タイプ: array

タイトル: Charge Milestone Events

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

ソースを表示

Array of: object subscriptionProducts-charges-chargeMilestoneEvents-item-post-request

{
    "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-charges-chargeMilestoneEvents-item-post-request"
    }
}

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

タイプ: array

タイトル: Charge Tiers

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

ソースを表示

Array of: object subscriptionProducts-charges-chargeTiers-item-post-request

{
    "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-charges-chargeTiers-item-post-request"
    }
}

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

タイプ: 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)

手数料の一意の識別子。
Effectivity: string

タイトル: Effectivity

最大長: 30

調整の有効性
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":{
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the adjustment is automatic or not.",
            "nullable":true
        },
        "ChargeAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the charge adjustment.",
            "nullable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis of the adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The unique identifier of the charge adjustment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AdjustmentReasonCode":{
            "title":"Reason",
            "maxLength":30,
            "type":"string",
            "description":"The code of the adjustment reason.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Effectivity":{
            "title":"Effectivity",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment effectivity",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Reason":{
            "title":"Reason Description",
            "maxLength":120,
            "type":"string",
            "description":"The reason for the adjustment.",
            "nullable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The value of the adjustment.",
            "nullable":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
            }
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence number of the adjustment.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "NumberOfPeriods":{
            "type":"number",
            "description":"The number of periods",
            "nullable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until which the adjustment is initiated.",
            "nullable":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
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from which the adjustment was initiated.",
            "nullable":true
        }
    }
}

ネストされたスキーマ : subscriptionProducts-charges-chargeMilestoneEvents-item-post-request

タイプ: object

ソースを表示

BillingOffset: number

マイルストン・イベントに関連付けられた請求オフセット。
BillLineId: integer (int64)

マイルストン・イベントに関連付けられた請求明細ID。
ChargeId: integer (int64)

マイルストン・イベントが関連付けられている手数料ID。
ChargePuid: string

最大長: 120

デフォルト値: Charges.ChargePuid

マイルストン・イベントが関連付けられている手数料のPUID。
CompletionDate: 文字列(日付)

マイルストン・イベントの完了日。
EventId: integer (int64)

マイルストン・イベントのID。
EventSource: string

最大長: 30

マイルストン・イベントのソース。
EventSourceReference: string

最大長: 120

マイルストン・イベントのソース参照。
EventType: string

最大長: 30

マイルストン・イベントのタイプ。
ExpectedCompletionDate: 文字列(日付)

マイルストン・イベントの予定完了日。
MilestoneComment: string

最大長: 300

マイルストン・イベント・コメント。
MilestoneName: string

最大長: 30

マイルストン・イベントの名前。
MilestonePuid: string

最大長: 120

マイルストン・イベントPUID。
ObjectVersionNumber: 整数(int32)

マイルストン・イベントのオブジェクト・バージョン番号。
パーセント: number

マイルストン・イベントに関連付けられたパーセント。

{
    "type":"object",
    "properties":{
        "BillingOffset":{
            "type":"number",
            "description":"The billing offset associated with a milestone event.",
            "nullable":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
        },
        "ExpectedCompletionDate":{
            "type":"string",
            "description":"The expected completion date of a milestone event.",
            "format":"date",
            "nullable":true
        },
        "EventType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the milestone event.",
            "nullable":false
        },
        "Percentage":{
            "type":"number",
            "description":"The percentage associated with a milestone event.",
            "nullable":false,
            "x-hints":{
                "precision":5,
                "scale":2
            }
        },
        "MilestoneName":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the milestone event.",
            "nullable":false
        },
        "MilestoneComment":{
            "maxLength":300,
            "type":"string",
            "description":"The milestone event comment.",
            "nullable":true
        },
        "MilestonePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The milestone event PUID.",
            "nullable":true
        },
        "EventSource":{
            "maxLength":30,
            "type":"string",
            "description":"The source of the milestone event.",
            "nullable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the milestone event.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "EventId":{
            "type":"integer",
            "description":"The ID of the milestone event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EventSourceReference":{
            "maxLength":120,
            "type":"string",
            "description":"The source reference of the milestone event.",
            "nullable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The bill line ID associated with the milestone event.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID with which the milestone event is associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CompletionDate":{
            "type":"string",
            "description":"The completion date of the milestone event.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BillingOffset"
                ]
            }
        }
    }
}

ネストされたスキーマ : subscriptionProducts-charges-chargeTiers-item-post-request

タイプ: 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

手数料階層の公開一意識別子。
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":{
        "ChargeTierId":{
            "type":"integer",
            "description":"The unique identifier of the charge tier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AdditionalTimestampTwo":{
            "title":"Additional Time-stamp Two",
            "type":"string",
            "description":"Additional timestamp, if any, for the charge tier.",
            "format":"date-time",
            "nullable":true
        },
        "AdditionalNumberFour":{
            "title":"Additional Number Four",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true
        },
        "ChargeTierPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the charge tier.",
            "nullable":false
        },
        "AdditionalNumberThree":{
            "title":"Additional Number Three",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true
        },
        "AdditionalTimestampOne":{
            "title":"Additional Time-stamp One",
            "type":"string",
            "description":"Additional timestamp, if any, for the charge tier.",
            "format":"date-time",
            "nullable":true
        },
        "ListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The list price",
            "nullable":false
        },
        "PriceFormat":{
            "title":"Price Format",
            "maxLength":30,
            "type":"string",
            "description":"The display format of the price.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AdditionalTextOne":{
            "title":"Additional Text One",
            "maxLength":4000,
            "type":"string",
            "description":"Additional text, if any, for the charge tier.",
            "nullable":true
        },
        "AdditionalNumberFive":{
            "title":"Additional Number Five",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true
        },
        "AdditionalNumberSix":{
            "title":"Additional Number Six",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TierTo":{
            "title":"Tier To",
            "type":"number",
            "description":"The tier to",
            "nullable":true
        },
        "AddtionalTextThree":{
            "title":"Additional Text Three",
            "maxLength":4000,
            "type":"string",
            "description":"Additional text, if any, for the charge tier.",
            "nullable":true
        },
        "AdditionalNumberOne":{
            "title":"Additional Number One",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true
        },
        "SequenceNumber":{
            "type":"number",
            "description":"The sequence number",
            "nullable":false
        },
        "AdditionalTextTwo":{
            "title":"Additional Text Two",
            "maxLength":4000,
            "type":"string",
            "description":"Additional text, if any, for the charge tier.",
            "nullable":true
        },
        "AdditionalTimestampThree":{
            "title":"Additional Time-stamp Three",
            "type":"string",
            "description":"Additional timestamp, if any, for the charge tier.",
            "format":"date-time",
            "nullable":true
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BlockSize":{
            "title":"Block Size",
            "type":"number",
            "description":"The block size",
            "nullable":true
        },
        "TierFrom":{
            "title":"Tier From",
            "type":"number",
            "description":"The tier from",
            "nullable":false
        },
        "AdditionalNumberTwo":{
            "title":"Additional Number Two",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true
        }
    }
}

ネストされたスキーマ : subscriptionProducts-coveredLevels-item-post-request

タイプ: 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(required): string

最大長: 120

対象レベルの公開一意識別子。
CoveredLevlName: string

タイトル: Covered Level Name

対象レベルの名前。
CoveredLevlNumber: string

タイトル: Covered Level Number

対象レベルの代替識別子。
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

対象レベルの品目の測定に使用される単位。
LineNumber: string

タイトル: Number

最大長: 300

行番号
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

対象レベルの積上合計。
SourceKey: string

最大長: 120

対象レベルのソース・キー。
SourceLineKey: string

最大長: 120

対象レベルのソース明細キー。
SourceLineNumber: string

最大長: 120

対象レベルのソース明細番号。
SourceNumber: string

最大長: 120

対象レベルのソース番号。
SourceSystem: string

最大長: 30

対象レベルのソース・システム。
StartDate(required): 文字列(日付)

タイトル: Covered Level Start Date

対象レベルが開始する日付。
Status: string

タイトル: Covered Level Status

最大長: 30

対象レベルのステータス。
StatusName: string

タイトル: Status

対象レベルのステータスの意味。
SubscriptionId(required): integer (int64)

サブスクリプションの一意の識別子。
SubscriptionProductId(required): 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(required): string

タイトル: Type

最大長: 30

対象レベルのタイプ。
TypeName: string

タイトル: Covered Level Type

対象レベルのタイプの名前。
UnitPrice: number

タイトル: Unit Price

対象レベルの単価。

{
    "required":[
        "CoveredLevelPuid",
        "StartDate",
        "SubscriptionId",
        "SubscriptionProductId",
        "Type"
    ],
    "type":"object",
    "properties":{
        "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
        },
        "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
            }
        },
        "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
        },
        "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
        },
        "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
        },
        "SuspendCreditMethod":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the credit method has to be suspended.",
            "nullable":true
        },
        "StartDate":{
            "title":"Covered Level Start Date",
            "type":"string",
            "description":"The date when the covered level starts.",
            "format":"date",
            "nullable":false
        },
        "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
        },
        "ParentCoveredAssetId":{
            "type":"integer",
            "description":"The unique identifier of the parent covered asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "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-post-request"
            }
        },
        "TaxAmount":{
            "type":"number",
            "description":"The tax amount levied on the transaction.",
            "nullable":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
            }
        },
        "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
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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
        },
        "ItemUnitOfMeasure":{
            "maxLength":15,
            "type":"string",
            "description":"The unit of measure used to measure the items in the covered level.",
            "nullable":true
        },
        "Status":{
            "title":"Covered Level Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the covered level.",
            "nullable":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
            }
        },
        "CreditedAmount":{
            "type":"number",
            "description":"The amount that was credited.",
            "nullable":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
        },
        "RenewalType":{
            "title":"Renewal Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the covered level renewal.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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
        },
        "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-post-request"
            }
        },
        "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
        },
        "PriceUnitOfMeasureName":{
            "title":"Pricing UOM",
            "type":"string",
            "description":"The display name of the unit of measure.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PriceListId":{
            "type":"integer",
            "description":"The unique identifier of the price list.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "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
            }
        },
        "InvoicedAmount":{
            "type":"number",
            "description":"The amount for which the invoice was created.",
            "nullable":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
        },
        "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
        },
        "PriceAsOf":{
            "type":"string",
            "description":"The price as of a certain date.",
            "format":"date",
            "nullable":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
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CoveredLevelPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the covered level.",
            "nullable":false
        },
        "CustomerAccountId":{
            "type":"integer",
            "description":"The unique identifier of the customer account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaxError":{
            "maxLength":4000,
            "type":"string",
            "description":"The tax error, if any, in the calculated amount.",
            "nullable":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
            }
        },
        "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-post-request"
            }
        },
        "RenewedDate":{
            "type":"string",
            "description":"The date when the covered level was renewed.",
            "format":"date",
            "nullable":true
        },
        "TotalContractValue":{
            "title":"Covered Level Contract Value",
            "type":"number",
            "description":"The total contract value associated with the covered level.",
            "nullable":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
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the covered level.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PriceUnitOfMeasure":{
            "maxLength":30,
            "type":"string",
            "description":"The unit of measure used to indicate the price.",
            "nullable":true
        },
        "HierarchyTotal":{
            "type":"number",
            "description":"The total covered level of the hierarchy.",
            "nullable":true
        },
        "EndDate":{
            "title":"Covered Level End Date",
            "type":"string",
            "description":"The date when the covered level ends.",
            "format":"date",
            "nullable":true
        },
        "ClosedAmount":{
            "type":"number",
            "description":"The amount at which the covered level was closed.",
            "nullable":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
        },
        "Type":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the covered level.",
            "nullable":false
        },
        "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
            }
        },
        "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
        },
        "CloseDescription":{
            "title":"Covered Level Close Description",
            "maxLength":2000,
            "type":"string",
            "description":"The close description associated with a covered level.",
            "nullable":true
        },
        "SourceSystem":{
            "maxLength":30,
            "type":"string",
            "description":"The source system of the covered level.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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

タイプ: array

タイトル: Bill Lines

ソースを表示

Array of: object subscriptionProducts-coveredLevels-billLines-item-post-request

{
    "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-post-request"
    }
}

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

タイプ: array

タイトル: Charges

ソースを表示

Array of: object subscriptionProducts-coveredLevels-charges-item-post-request

{
    "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-post-request"
    }
}

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

タイプ: array

タイトル: Relationships

ソースを表示

Array of: object schema

{
    "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-post-request"
    }
}

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

タイプ: object

ソースを表示

金額: number

タイトル: Amount

請求が生成される金額。
billAdjustments: array Bill Adjustments

タイトル: Bill Adjustments

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

タイトル: Sequence

請求が生成される期間。
BillLineId: integer (int64)

請求明細の一意の識別子。
BillLinePuid(required): string

最大長: 120

請求明細の公開一意識別子。
BusinessUnitId: integer

請求明細に関連付けられているビジネス・ユニットのID。
ChargeDefinition: string

最大長: 30

手数料の目的を示す定義。
ChargeId: integer (int64)

手数料の一意の識別子。
ChargeName: string

タイトル: Charge Name

最大長: 120

請求明細に関連付けられた手数料の名前。
ChargePeriod: number

タイトル: Period

請求された使用期間。
ChargePeriodFactor: number

請求明細に関連付けられた変更期間ファクタ。
CoveredLevelId: integer (int64)

対象レベルの一意の識別子。
CreditMemoAmount: number

クレジット・メモの金額。
CreditMemoFlag: string

請求明細に関連付けられたクレジット・メモがあるかどうかを示します。
CreditMemoReason: string

クレジット・メモを上げる事由。
CreditMemoReasonCode: string

最大長: 30

クレジット・メモ事由コードのコード。
CustomerTrxTypeSequenceId: integer (int64)

顧客取引タイプ連番ID
DateBilledFrom(required): 文字列(日付)

タイトル: Bill-from Date

請求が生成された日付。
DateBilledTo(required): 文字列(日付)

タイトル: Bill-to Date

請求が生成される最終日。
DateToInterface(required): 文字列(日付)

タイトル: Interface Date

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

タイトル: Interfaced

最大長: 1

デフォルト値: false

請求明細がインタフェースされているかどうかを示します。
InvoiceBillLineId: integer (int64)

請求書請求明細の一意の識別子。
InvoiceDate: 文字列(日付)

請求書が提起された日付。
InvoiceText: string

タイトル: Invoice Text

最大長: 240

請求明細請求書のテキスト。
ListPrice: number

請求明細に関連付けられた製品の定価。
MilestoneEventId: integer (int64)

請求明細に関連付けられたマイルストン・イベントのID。
MilestoneEventName: string

請求明細に関連付けられたマイルストン・イベントの名前。
NewCreditMemoPUID: string

新規クレジット・メモの一意の公開識別子。
PricedQuantity: number

請求明細が請求された数量。
PricingError: string

最大長: 1000

価格設定のエラー(ある場合)。
RecurringFlag(required): 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

使用量の数量。

{
    "required":[
        "BillLinePuid",
        "BillingPeriod",
        "DateBilledFrom",
        "DateBilledTo",
        "DateToInterface",
        "RecurringFlag"
    ],
    "type":"object",
    "properties":{
        "TrxId":{
            "type":"integer",
            "description":"The AR transaction ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TransactionTypeName":{
            "type":"string",
            "description":"The transaction type name of the subscription bill line.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeDefinition":{
            "maxLength":30,
            "type":"string",
            "description":"The definition that indicates the purpose of the charge.",
            "nullable":true
        },
        "SentDate":{
            "title":"Sent Date",
            "type":"string",
            "description":"The date invoice information is sent to receivables.",
            "format":"date",
            "nullable":true
        },
        "UsagePricedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the usage line has been priced or not.",
            "nullable":true
        },
        "ListPrice":{
            "type":"number",
            "description":"The list price of the product associated with the bill line.",
            "nullable":true
        },
        "TransactionTax":{
            "title":"Tax",
            "type":"number",
            "description":"The tax levied on the transaction.",
            "nullable":true
        },
        "RevenueLineId":{
            "type":"integer",
            "description":"The unique identifier of the revenue line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CreditMemoReason":{
            "type":"string",
            "description":"The reason to raise the credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BillLinePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the bill line.",
            "nullable":false
        },
        "UsageFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the line is a usage line or not.",
            "nullable":true
        },
        "UsageChargeTypeName":{
            "type":"string",
            "description":"The name of the usage charge type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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-post-request"
            }
        },
        "BillingPeriod":{
            "title":"Sequence",
            "type":"number",
            "description":"The period for which the bill is generated.",
            "nullable":false
        },
        "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
        },
        "MilestoneEventId":{
            "type":"integer",
            "description":"The ID of the milestone event associated with the bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TrxLineId":{
            "type":"integer",
            "description":"The AR transaction line ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "UsageCaptureDate":{
            "type":"string",
            "description":"The date when the usage was captured.",
            "format":"date",
            "nullable":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
        },
        "UsageChargeType":{
            "title":"Usage Charge Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of usage charge.",
            "nullable":true
        },
        "TransactionNumber":{
            "title":"Invoice Number",
            "maxLength":30,
            "type":"string",
            "description":"The number of the transaction.",
            "nullable":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
        },
        "CustomerTrxTypeSequenceId":{
            "type":"integer",
            "description":"Customer Transaction Type Sequence Id",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TruedUpYn":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates if the bill line has a trueup period.",
            "nullable":true
        },
        "CreditMemoReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code of the credit memo reason code.",
            "nullable":true
        },
        "InvoiceText":{
            "title":"Invoice Text",
            "maxLength":240,
            "type":"string",
            "description":"The text in the bill line invoice.",
            "nullable":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
            }
        },
        "TransactionClass":{
            "title":"Transaction Class",
            "maxLength":30,
            "type":"string",
            "description":"The class of the transaction.",
            "nullable":true
        },
        "InvoiceDate":{
            "type":"string",
            "description":"The date when the invoice was raised.",
            "format":"date",
            "nullable":true
        },
        "ChargePeriod":{
            "title":"Period",
            "type":"number",
            "description":"The usage period that was charged.",
            "nullable":true
        },
        "TransactionDate":{
            "title":"Invoice Date",
            "type":"string",
            "description":"The date when the transaction occurred.",
            "format":"date",
            "nullable":true
        },
        "InvoiceBillLineId":{
            "type":"integer",
            "description":"The unique identifier of the invoice bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "UsageAcquiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the usage has been acquired or not.",
            "nullable":true
        },
        "InterfacedFlag":{
            "title":"Interfaced",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the bill line is interfaced or not.",
            "nullable":false,
            "default":false
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount for which the bill is generated.",
            "nullable":true
        },
        "DateBilledTo":{
            "title":"Bill-to Date",
            "type":"string",
            "description":"The date up to which the bill is generated.",
            "format":"date",
            "nullable":false
        },
        "UsageQuantity":{
            "title":"Usage Quantity",
            "type":"number",
            "description":"The quantity of the usage.",
            "nullable":true
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PricedQuantity":{
            "type":"number",
            "description":"The quantity for which the bill line was charged.",
            "nullable":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
        },
        "RecurringFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the line is recurring or not.",
            "nullable":false
        },
        "BillLineId":{
            "type":"integer",
            "description":"The unique identifier of the bill line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DateBilledFrom":{
            "title":"Bill-from Date",
            "type":"string",
            "description":"The date from which the bill was generated.",
            "format":"date",
            "nullable":false
        },
        "TransactionClassMeaning":{
            "title":"Class",
            "type":"string",
            "description":"The meaning of transaction class lookup.",
            "nullable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PricingError":{
            "maxLength":1000,
            "type":"string",
            "description":"The error in pricing, if any.",
            "nullable":true
        }
    }
}

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

タイプ: array

タイトル: Bill Adjustments

ソースを表示

Array of: object subscriptionProducts-coveredLevels-billLines-billAdjustments-item-post-request

{
    "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-post-request"
    }
}

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

タイプ: 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)

手数料修正の一意の識別子です。
CurrencyCode: string

請求修正に使用される現在のコード。
Effectivity: string

最大長: 30

請求修正の有効性。
NumberOfPeriods: number

期間数
PeriodFrom: number

請求が調整された期間。
PeriodUntil: number

請求が調整されるまでの期間。
Reason: string

タイトル: Reason Details

最大長: 120

請求が調整された事由です。
SequenceNumber: number

タイトル: Sequence

請求修正のシーケンス番号。
SubscriptionId: integer (int64)

サブスクリプションの一意の識別子。
SubscriptionProductId: integer (int64)

サブスクリプション製品の一意の識別子。

{
    "type":"object",
    "properties":{
        "BillAdjustmentId":{
            "type":"integer",
            "description":"The unique identifier of the bill adjustment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the adjustment is automatic or not.",
            "nullable":false
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis on which the bill is adjusted.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The unique identifier of the charge adjustment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AdjustmentReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code of the adjustment reason.",
            "nullable":true
        },
        "Effectivity":{
            "maxLength":30,
            "type":"string",
            "description":"The effectivity of the bill adjustment.",
            "nullable":true
        },
        "Reason":{
            "title":"Reason Details",
            "maxLength":120,
            "type":"string",
            "description":"The reason why the bill is adjusted.",
            "nullable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the bill adjustment.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CurrencyCode":{
            "type":"string",
            "description":"The current code used for the bill adjustment.",
            "nullable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The value by which the bill is adjusted.",
            "nullable":false
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"number",
            "description":"The sequence number of the bill adjustment.",
            "nullable":false
        },
        "NumberOfPeriods":{
            "type":"number",
            "description":"The number of periods",
            "nullable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The unique identifier of the bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BillAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the bill adjustment.",
            "nullable":false
        },
        "AdjustmentName":{
            "title":"Adjustment",
            "maxLength":120,
            "type":"string",
            "description":"The name of the bill adjustment.",
            "nullable":true
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until which the bill is adjusted.",
            "nullable":true
        },
        "BasisEnableFlag":{
            "type":"boolean",
            "description":"Indicates if the base has been enabled for the bill adjustment.",
            "nullable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from which the bill was adjusted.",
            "nullable":true
        }
    }
}

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

タイプ: 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)

対象レベルの一意の識別子。
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

請求書ルールの名前。
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(required): 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

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

{
    "required":[
        "PriceType"
    ],
    "type":"object",
    "properties":{
        "AggregationMethod":{
            "maxLength":30,
            "type":"string",
            "description":"The aggregation method used for the charges.",
            "nullable":true
        },
        "ChargePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the charge.",
            "nullable":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-post-request"
            }
        },
        "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-post-request"
            }
        },
        "ChargeDefinition":{
            "title":"Charge Name",
            "maxLength":30,
            "type":"string",
            "description":"The definition that indicates the purpose of the charge.",
            "nullable":true
        },
        "AssetMeterYn":{
            "maxLength":1,
            "type":"boolean",
            "description":"The flag whether it is an asset meter or not.",
            "nullable":true
        },
        "EstimatedAmount":{
            "title":"Estimated Amount",
            "type":"number",
            "description":"The estimated amount of the charges.",
            "nullable":true
        },
        "PricePeriodicityName":{
            "type":"string",
            "description":"The name of the price periodicity.",
            "nullable":true
        },
        "PrePaymentNumber":{
            "title":"Prepayment Number",
            "type":"integer",
            "description":"The prepayment number for the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "MeterDefinitionId":{
            "type":"integer",
            "description":"The unique identifier of the meter definition associated with the charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EstimationMethod":{
            "title":"Estimation Method",
            "maxLength":30,
            "type":"string",
            "description":"The method used to estimate the amount.",
            "nullable":true
        },
        "PeriodicBillingFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether periodic billing is allowed or not.",
            "nullable":true
        },
        "MilestoneBillingFlag":{
            "type":"boolean",
            "description":"Indicates whether the billing is impacted by milestone events or not.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "ExternalParentKey":{
            "maxLength":120,
            "type":"string",
            "description":"The external parent key.",
            "nullable":true
        },
        "UnitListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The price of the unit list.",
            "nullable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number for the charge.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "InitialMeterReadingId":{
            "type":"integer",
            "description":"The initial meter reading identifier value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EstimatedQuantity":{
            "title":"Estimated Quantity",
            "type":"number",
            "description":"The estimated quantity for the charge.",
            "nullable":true
        },
        "ChargeName":{
            "title":"Charge Name",
            "maxLength":120,
            "type":"string",
            "description":"The name of the charge.",
            "nullable":true
        },
        "QuotedTcv":{
            "type":"number",
            "description":"The quoted TCV of the charge.",
            "nullable":true
        },
        "TieredFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the charge has tiers.",
            "nullable":true
        },
        "UsagePriceLockFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the usage price is locked or not.",
            "nullable":true
        },
        "PeriodicRevenueFlag":{
            "title":"Enable Periodic Revenue Recognition",
            "maxLength":1,
            "type":"string",
            "description":"Indicates the periodic revenue recognition of one-time charges.",
            "nullable":true
        },
        "MilestoneRevenueFlag":{
            "type":"boolean",
            "description":"Indicates whether the revenue is impacted by milestone events or not.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "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-post-request"
            }
        },
        "MinimumAmount":{
            "title":"Minimum Amount",
            "type":"number",
            "description":"The minimum amount to be charged.",
            "nullable":true
        },
        "PriceType":{
            "maxLength":30,
            "type":"string",
            "description":"The price type associated with the charge.",
            "nullable":false
        },
        "RollupFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the charge needs to be rolled up.",
            "nullable":true
        },
        "TierType":{
            "title":"Tier Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the charge tier.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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
            }
        },
        "ChargeDefinitionName":{
            "type":"string",
            "description":"The name of the charge definition.",
            "nullable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EnableProration":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether proration is enabled or not.",
            "nullable":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
        },
        "Allowance":{
            "title":"Allowance",
            "type":"number",
            "description":"The allowance part of the charge.",
            "nullable":true
        },
        "InvoicingRuleId":{
            "type":"integer",
            "description":"The ID of the invoice rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "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
            }
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "MinimumQuantity":{
            "title":"Minimum Quantity",
            "type":"number",
            "description":"The minimum quantity that is allowed.",
            "nullable":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
        },
        "TrueUpPeriod":{
            "title":"True Up Period",
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the trueup period.",
            "nullable":true,
            "default":"ORA_OSS_USAGE_BILLING_PERIOD"
        },
        "BillLineId":{
            "type":"integer",
            "description":"The unique identifier of the bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BlockSize":{
            "title":"Block Size",
            "type":"number",
            "description":"The block size of the charge.",
            "nullable":true
        }
    }
}

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

タイプ: array

タイトル: Adjustments

ソースを表示

Array of: object subscriptionProducts-coveredLevels-charges-adjustments-item-post-request

{
    "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-post-request"
    }
}

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

タイプ: array

タイトル: Charge Milestone Events

ソースを表示

Array of: object subscriptionProducts-coveredLevels-charges-chargeMilestoneEvents-item-post-request

{
    "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-post-request"
    }
}

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

タイプ: array

タイトル: Charge Tiers

ソースを表示

Array of: object subscriptionProducts-coveredLevels-charges-chargeTiers-item-post-request

{
    "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-post-request"
    }
}

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

タイプ: 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)

手数料の一意の識別子。
Effectivity: string

タイトル: Effectivity

最大長: 30

調整の有効性
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":{
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the adjustment is automatic or not.",
            "nullable":true
        },
        "ChargeAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the charge adjustment.",
            "nullable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis of the adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The unique identifier of the charge adjustment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AdjustmentReasonCode":{
            "title":"Reason",
            "maxLength":30,
            "type":"string",
            "description":"The code of the adjustment reason.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Effectivity":{
            "title":"Effectivity",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment effectivity",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Reason":{
            "title":"Reason Description",
            "maxLength":120,
            "type":"string",
            "description":"The reason for the adjustment.",
            "nullable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The value of the adjustment.",
            "nullable":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
            }
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence number of the adjustment.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "NumberOfPeriods":{
            "type":"number",
            "description":"The number of periods",
            "nullable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until which the adjustment is initiated.",
            "nullable":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
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from which the adjustment was initiated.",
            "nullable":true
        }
    }
}

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

タイプ: object

ソースを表示

BillingOffset: number

マイルストン・イベントに関連付けられた請求オフセット。
BillLineId: integer (int64)

マイルストン・イベントに関連付けられた請求明細ID。
ChargeId: integer (int64)

マイルストン・イベントが関連付けられている手数料ID。
ChargePuid: string

最大長: 120

デフォルト値: Charges.ChargePuid

マイルストン・イベントが関連付けられている手数料のPUID。
CompletionDate: 文字列(日付)

マイルストン・イベントの完了日。
EventId: integer (int64)

マイルストン・イベントのID。
EventSource: string

最大長: 30

マイルストン・イベントのソース。
EventSourceReference: string

最大長: 120

マイルストン・イベントのソース参照。
EventType: string

最大長: 30

マイルストン・イベントのタイプ。
ExpectedCompletionDate: 文字列(日付)

マイルストン・イベントの予定完了日。
MilestoneComment: string

最大長: 300

マイルストン・イベント・コメント。
MilestoneName: string

最大長: 30

マイルストン・イベントの名前。
MilestonePuid: string

最大長: 120

マイルストン・イベントPUID。
ObjectVersionNumber: 整数(int32)

マイルストン・イベントのオブジェクト・バージョン番号。
パーセント: number

マイルストン・イベントに関連付けられたパーセント。

{
    "type":"object",
    "properties":{
        "BillingOffset":{
            "type":"number",
            "description":"The billing offset associated with a milestone event.",
            "nullable":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
        },
        "ExpectedCompletionDate":{
            "type":"string",
            "description":"The expected completion date of a milestone event.",
            "format":"date",
            "nullable":true
        },
        "EventType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the milestone event.",
            "nullable":false
        },
        "Percentage":{
            "type":"number",
            "description":"The percentage associated with a milestone event.",
            "nullable":false,
            "x-hints":{
                "precision":5,
                "scale":2
            }
        },
        "MilestoneName":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the milestone event.",
            "nullable":false
        },
        "MilestoneComment":{
            "maxLength":300,
            "type":"string",
            "description":"The milestone event comment.",
            "nullable":true
        },
        "MilestonePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The milestone event PUID.",
            "nullable":true
        },
        "EventSource":{
            "maxLength":30,
            "type":"string",
            "description":"The source of the milestone event.",
            "nullable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the milestone event.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "EventId":{
            "type":"integer",
            "description":"The ID of the milestone event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EventSourceReference":{
            "maxLength":120,
            "type":"string",
            "description":"The source reference of the milestone event.",
            "nullable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The bill line ID associated with the milestone event.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID with which the milestone event is associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CompletionDate":{
            "type":"string",
            "description":"The completion date of the milestone event.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BillingOffset"
                ]
            }
        }
    }
}

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

タイプ: 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

手数料階層の公開一意識別子。
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":{
        "ChargeTierId":{
            "type":"integer",
            "description":"The unique identifier of the charge tier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AdditionalTimestampTwo":{
            "title":"Additional Time-stamp Two",
            "type":"string",
            "description":"Additional timestamp, if any, for the charge tier.",
            "format":"date-time",
            "nullable":true
        },
        "AdditionalNumberFour":{
            "title":"Additional Number Four",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true
        },
        "ChargeTierPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the charge tier.",
            "nullable":false
        },
        "AdditionalNumberThree":{
            "title":"Additional Number Three",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true
        },
        "AdditionalTimestampOne":{
            "title":"Additional Time-stamp One",
            "type":"string",
            "description":"Additional timestamp, if any, for the charge tier.",
            "format":"date-time",
            "nullable":true
        },
        "ListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The list price",
            "nullable":false
        },
        "PriceFormat":{
            "title":"Price Format",
            "maxLength":30,
            "type":"string",
            "description":"The display format of the price.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AdditionalTextOne":{
            "title":"Additional Text One",
            "maxLength":4000,
            "type":"string",
            "description":"Additional text, if any, for the charge tier.",
            "nullable":true
        },
        "AdditionalNumberFive":{
            "title":"Additional Number Five",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true
        },
        "AdditionalNumberSix":{
            "title":"Additional Number Six",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TierTo":{
            "title":"Tier To",
            "type":"number",
            "description":"The tier to",
            "nullable":true
        },
        "AddtionalTextThree":{
            "title":"Additional Text Three",
            "maxLength":4000,
            "type":"string",
            "description":"Additional text, if any, for the charge tier.",
            "nullable":true
        },
        "AdditionalNumberOne":{
            "title":"Additional Number One",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true
        },
        "SequenceNumber":{
            "type":"number",
            "description":"The sequence number",
            "nullable":false
        },
        "AdditionalTextTwo":{
            "title":"Additional Text Two",
            "maxLength":4000,
            "type":"string",
            "description":"Additional text, if any, for the charge tier.",
            "nullable":true
        },
        "AdditionalTimestampThree":{
            "title":"Additional Time-stamp Three",
            "type":"string",
            "description":"Additional timestamp, if any, for the charge tier.",
            "format":"date-time",
            "nullable":true
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BlockSize":{
            "title":"Block Size",
            "type":"number",
            "description":"The block size",
            "nullable":true
        },
        "TierFrom":{
            "title":"Tier From",
            "type":"number",
            "description":"The tier from",
            "nullable":false
        },
        "AdditionalNumberTwo":{
            "title":"Additional Number Two",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true
        }
    }
}

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

タイプ: object

ソースを表示

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":{
        "RelationshipTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the relationship.",
            "nullable":false
        },
        "OperationLinksPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the operation links.",
            "nullable":true
        },
        "SourceProdAssociationId":{
            "type":"integer",
            "description":"The unique identifier of the source product association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TargetProdAssociationId":{
            "type":"integer",
            "description":"The unique identifier of the target product association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SourceAssetKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source asset key",
            "nullable":true
        },
        "SourceProductPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the source product.",
            "nullable":true
        },
        "SourceRootAssetKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source root asset key",
            "nullable":true
        },
        "SourceProdAssociationPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the source product association.",
            "nullable":true
        },
        "TargetProductPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the target product.",
            "nullable":true
        },
        "TargetProdAssociationPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the target product association.",
            "nullable":true
        }
    }
}

ネストされたスキーマ : subscriptionProducts-creditCards-item-post-request

タイプ: object

ソースを表示

AddToBillingAccountFlag: boolean

パーティを請求アカウントとして追加できるかどうかを示します。
AuthorizedAmount: number

トランザクションが承認された金額。
AuthRequestId: string

カード承認リクエスト識別子。
CardHolderName: string

タイトル: Cardholder Name

クレジット・カード所有者の名前。
CreditCardId: integer (int64)

クレジット・カードの一意の識別子。
CreditCardPuid: string

最大長: 120

クレジット・カードの公開一意識別子。
ExpirationDate: 文字列(日付)

処理に使用されるクレジット・カード有効期限。
FirstName: string

クレジット・カード所有者の名。
InstrAssignmentId: integer (int64)

タイトル: Number

手段割当の一意の識別子。
IssuerCode: string

クレジット・カード発行会社。
LastName: string

クレジット・カード所有者の姓。
MaskedNumber: string

マスクされたクレジット・カード番号。
Notes: string

タイトル: Notes

最大長: 300

クレジット・カードに関連付けられているノート(ある場合)。
PaymentSystemOrderNumber: string

クレジット・カード支払のオーダー番号。
RenewalCreditCardFlag: boolean

最大長: 1

クレジット・カードが更改支払方法として使用されるかどうかを示します。
SubscriptionId: integer (int64)

サブスクリプションの一意の識別子。
SubscriptionProductId: integer (int64)

サブスクリプション製品の公開一意識別子。
TokenNumber: string

処理に使用されるクレジット・カード・トークン番号。
VoiceAuthCode: string

クレジット・カード音声承認情報。

{
    "type":"object",
    "properties":{
        "InstrAssignmentId":{
            "title":"Number",
            "type":"integer",
            "description":"The unique identifier of the instrument assignment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "CreditCardPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the credit card.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "FirstName":{
            "type":"string",
            "description":"The first name of the credit card holder.",
            "nullable":true,
            "x-queryable":false
        },
        "MaskedNumber":{
            "type":"string",
            "description":"The masked credit card number.",
            "nullable":true,
            "x-queryable":false
        },
        "IssuerCode":{
            "type":"string",
            "description":"The credit card issuing company.",
            "nullable":true,
            "x-queryable":false
        },
        "PaymentSystemOrderNumber":{
            "type":"string",
            "description":"The order number for the credit card payment.",
            "nullable":true,
            "x-queryable":false
        },
        "CardHolderName":{
            "title":"Cardholder Name",
            "type":"string",
            "description":"The name of the credit card holder.",
            "nullable":true
        },
        "AddToBillingAccountFlag":{
            "type":"boolean",
            "description":"Indicates whether the party can be added as a billing account.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "precision":18
            }
        },
        "ExpirationDate":{
            "type":"string",
            "description":"The credit card expiration date used for processing.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "VoiceAuthCode":{
            "type":"string",
            "description":"The credit card voice authorization information.",
            "nullable":true,
            "x-queryable":false
        },
        "AuthRequestId":{
            "type":"string",
            "description":"The card authorization request identifier.",
            "nullable":true,
            "x-queryable":false
        },
        "AuthorizedAmount":{
            "type":"number",
            "description":"The amount the transaction was authorized for.",
            "nullable":true,
            "x-queryable":false
        },
        "LastName":{
            "type":"string",
            "description":"The last name of the credit card holder.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The public unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "precision":18
            }
        },
        "RenewalCreditCardFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the credit card is used as Renewal Payment Method.",
            "nullable":true
        },
        "TokenNumber":{
            "type":"string",
            "description":"The credit card token number used for processing.",
            "nullable":true,
            "x-queryable":false
        },
        "CreditCardId":{
            "type":"integer",
            "description":"The unique identifier of the credit card.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "precision":18,
                "SUPPORTS_RANGE_PAGING":"true"
            }
        },
        "Notes":{
            "title":"Notes",
            "maxLength":300,
            "type":"string",
            "description":"The notes, if any, associated with the credit card.",
            "nullable":true
        }
    }
}

ネストされたスキーマ : subscriptionProducts-flexFields-item-post-request

タイプ: object

ソースを表示

__FLEX_Context: string

タイトル: Context Segment

最大長: 30

ユーザー付加フレックスフィールドの構造定義です。
__FLEX_Context_DisplayValue: string

タイトル: Context Segment

ユーザー付加フレックスフィールドの体系定義の表示名です。
SubscriptionProductId: integer (int64)

サブスクリプション製品の一意の識別子。

{
    "type":"object",
    "properties":{
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"The display name for structure definition of the user descriptive flexfield.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"The structure definition of the user descriptive flexfield.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

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

タイプ: object

ソースを表示

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":{
        "RelationshipTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the relationship.",
            "nullable":false
        },
        "OperationLinksPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the operation links.",
            "nullable":true
        },
        "SourceProdAssociationId":{
            "type":"integer",
            "description":"The unique identifier of the source product association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TargetProdAssociationId":{
            "type":"integer",
            "description":"The unique identifier of the target product association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SourceAssetKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source asset key",
            "nullable":true
        },
        "SourceProductPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the source product.",
            "nullable":true
        },
        "SourceRootAssetKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source root asset key",
            "nullable":true
        },
        "SourceProdAssociationPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the source product association.",
            "nullable":true
        },
        "TargetProductPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the target product.",
            "nullable":true
        },
        "TargetProdAssociationPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the target product association.",
            "nullable":true
        }
    }
}

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

タイプ: object

ソースを表示

EndDate: 文字列(日付)

販売実績が終了した日付。
パーセント: number

パーセント
SalesCreditId: integer (int64)

販売実績の一意の識別子。
SalesCreditPuid: string

最大長: 120

販売実績の公開一意識別子。
SalesCreditType: string

販売実績のタイプ。
SalesCreditTypeId: integer (int64)

販売実績のタイプの一意の識別子。
SalesPerson: string

営業担当の名前。
SalesPersonNumber: string

タイトル: Salesperson Number

営業担当の代替識別子。
SalesrepId: integer (int64)

営業担当の一意の識別子。
StartDate: 文字列(日付)

販売実績が開始した日付。
SubscriptionId: integer (int64)

サブスクリプションの一意の識別子。
SubscriptionProductId: integer (int64)

サブスクリプション製品の一意の識別子。

{
    "type":"object",
    "properties":{
        "Percentage":{
            "type":"number",
            "description":"The percentage",
            "nullable":false,
            "x-hints":{
                "precision":5,
                "scale":2
            }
        },
        "SalesPerson":{
            "type":"string",
            "description":"The name of the sales person.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "SalesCreditTypeId":{
            "type":"integer",
            "description":"The unique identifier of the type of the sales credit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "SalesrepId":{
            "type":"integer",
            "description":"The unique identifier of the sales representative.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SalesPersonNumber":{
            "title":"Salesperson Number",
            "type":"string",
            "description":"The alternate identifier of a salesperson.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "sortable":false
            }
        },
        "SalesCreditType":{
            "type":"string",
            "description":"The type of the sales credit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EndDate":{
            "type":"string",
            "description":"The date when the sales credit was ends.",
            "format":"date",
            "nullable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The date when the sales credit started.",
            "format":"date",
            "nullable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SalesCreditPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the sales credit.",
            "nullable":false
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SalesCreditId":{
            "type":"integer",
            "description":"The unique identifier of the sales credit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

ネストされたスキーマ : subscriptionProducts-serviceResources-item-post-request

タイプ: object

ソースを表示

EnabledFlag: boolean

タイトル: Enable Service Resource

最大長: 1

デフォルト値: true

サービス・リソースが有効かどうかを示します。
EndDate: 文字列(日付)

タイトル: End Date

サービス・リソースの終了日。
ServiceId: string

タイトル: Service Identifier

最大長: 120

サービスの一意の識別子。
ServiceResourceId: integer (int64)

サービス・リソースの一意の識別子。
ServiceResourcePuid: string

最大長: 120

サービス・リソースのPUID。
StartDate: 文字列(日付)

タイトル: Start Date

サービス・リソースの開始日。
SubscriptionId: integer (int64)

サブスクリプションの一意の識別子。
SubscriptionProductId: integer (int64)

サブスクリプション製品の一意の識別子。

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the service resource.",
            "format":"date",
            "nullable":true
        },
        "ServiceResourcePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the service resource.",
            "nullable":false
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ServiceResourceId":{
            "type":"integer",
            "description":"The unique identifier of the service resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EnabledFlag":{
            "title":"Enable Service Resource",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the service resource is enabled or not.",
            "nullable":true,
            "default":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the service resource.",
            "format":"date",
            "nullable":true
        },
        "ServiceId":{
            "title":"Service Identifier",
            "maxLength":120,
            "type":"string",
            "description":"The unique identifier of the service.",
            "nullable":false
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

タイプ: object

ソースを表示

AccountingRuleId: integer (int64)

タイトル: Accounting Rule

会計基準の一意の識別子。
AccountingRuleName: string

タイトル: Accounting Rule

会計基準の名前。
AlignBillingFrom: 文字列(日付)

タイトル: Align Billing From

請求連携の日付:自。
AmendCreditMethod: string

タイトル: Amendment Credit Method

最大長: 30

クレジットの修正に使用するメソッド。
AmendCreditMethodName: string

クレジットの修正メソッドの名称。
AmendDescription: string

タイトル: Amendment Description

最大長: 300

修正されたクレジットの簡単な説明。
AmendEffectiveDate: 文字列(日付)

タイトル: Amendment Effective Date

修正された貸方が有効になる日付。
AmendReason: string

タイトル: Amendment Reason

最大長: 30

クレジットが修正された理由。
AmendReasonName: string

修正事由の名前。
associatedAsset: array Associated Assets

タイトル: Associated Assets

関連付けられたアセット・リソースは、サブスクリプション・タイプのサブスクリプション製品にリンクされたアセットの表示、作成、更新および削除に使用されます。
AutoExtendFlag: boolean

製品を自動延長する必要があるかどうかを示します。
BillingDateCode: string

タイトル: Billing Date Code

最大長: 30

請求日を示すコード。
BillingDateName: string

請求日の名前。
BillingFrequency: string

タイトル: Billing Frequency

最大長: 30

請求頻度。
BillingFrequencyName: string

タイトル: Billing Frequency

請求頻度の名前。
BillingOffsetDays: integer (int64)

タイトル: Billing Offset Days

請求オフセット日数。
billLines: array Bill Lines

タイトル: Bill Lines

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

タイトル: Bill on Day

製品の請求日。
BillToAccountDescription: string

請求先アカウントの簡単な説明。
BillToAccountId: integer (int64)

タイトル: Billing Account

請求先アカウントの一意の識別子。
BillToAccountNumber: string

タイトル: Billing Account

請求先アカウントのアカウント番号。
BillToAddress: string

タイトル: Bill-to Address

請求先住所。
BillToContactId: integer (int64)

タイトル: Bill-to Contact

サブスクリプション製品の請求先担当者ID。
BillToContactName: string

タイトル: Bill-to Contact

サブスクリプション製品の請求先担当者名。
BillToContactNumber: string

サブスクリプション製品の請求先担当者番号。
BillToPartyId: integer (int64)

タイトル: Bill-to Customer

サブスクリプション製品の請求先顧客ID。
BillToPartyName: string

タイトル: Bill-to Customer

サブスクリプション製品の請求先顧客名。
BillToPartyNumber: string

サブスクリプション製品の請求先顧客番号。
BillToSiteNumber: string

タイトル: Bill-to Site Number

サブスクリプション製品の請求先サイト番号。
BillToSiteUseId: integer (int64)

タイトル: Bill-to Site

請求先サイト使用の一意の識別子。
CalculatedCreditAmount: number

タイトル: Calculated Credit Amount

サブスクリプション製品の計算済クレジット金額。
CancelDescription: string

タイトル: Cancellation Description

最大長: 2000

サブスクリプション製品の取消事由摘要。
CanceledAmount: number

タイトル: Canceled Amount

取り消されたトランザクション金額。
CanceledDate: 文字列(日付)

タイトル: Product Canceled Date

製品が取り消された日付。
CancelReason: string

タイトル: Cancellation Reason

最大長: 30

製品が取り消された理由。
charges: array Charges

タイトル: Charges

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

解約予測トレンド。
ChurnProbability: number

タイトル: Churn Probability

製品に関連付けられた流動の可能性。
CloseCreditMethod: string

タイトル: Close Credit Method

最大長: 30

クレジットのクローズに使用するメソッド。
ClosedAmount: number

タイトル: Closed Amount

トランザクションがクローズされた金額。
ClosedDate: 文字列(日付)

タイトル: Product Close Date

製品がクローズされた日付。
CloseDescription: string

タイトル: Close Description

最大長: 2000

サブスクリプション製品のクローズ事由摘要。
CloseReason: string

タイトル: Product Close Reason

最大長: 30

製品がクローズされた理由。
CorpCurrencyCode: string

最大長: 15

製品に関連付けられている企業通貨コード。この属性は、CRM拡張フレームワークで使用されます。受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。
CoverageName: string

タイトル: Template Name

製品に関連付けられている補償内容の名前。
CoverageScheduleId: integer (int64)

スケジュール済カバレッジ
coveredLevels: array Covered Levels

タイトル: Covered Levels

対象レベル・リソースは、サブスクリプションID、サブスクリプション製品ID、対象アセットおよびその関連詳細など、サブスクリプション対象レベル詳細の作成、表示、更新または削除に使用されます。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

サブスクリプション製品を作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

サブスクリプションが作成された日付。
creditCards: array Credit Cards

タイトル: Credit Cards

クレジット・カード・リソースは、サブスクリプションに関連付けられているクレジット・カードを表示、作成および更新するために使用されます。
CreditedAmount: number

タイトル: Credited Amount

アカウントに貸方記入された金額。
CurcyConvRateType: string

最大長: 30

製品に関連付けられている通貨換算レート・タイプ。この属性は、CRM拡張フレームワークで使用されます。受け入れられる値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。
Currency: string

最大長: 15

サブスクリプション製品に関連付けられた通貨。
CustomerTrxTypeSequenceId: integer (int64)

サブスクリプション製品の顧客トランザクション・タイプ連番ID。
DefaultRevenueAction: string

最大長: 30

修正中に使用されるサブスクリプション製品の収益管理ルール。
DefinitionOrganizationId: integer (int64)

品目マスター組織の一意の識別子。
Description: string

タイトル: Product Description

サブスクリプション製品の簡単な説明。
DisplaySequence: number

タイトル: Display Sequence

サブスクリプション製品の表示順序。
DocumentTypeId: integer (int64)

タイトル: Document Type

デフォルト値: 10

Oracle Revenue Management Cloudのソース文書タイプのTheuUnique識別子。
DropOneTimeChargeFlag: boolean

タイトル: Don't copy one-time charges

最大長: 1

製品の変更時に単発料金を削除する必要があるかどうかを示します。
Duration: integer

タイトル: Duration

製品期間
EarlyTerminationFee: number

タイトル: Early Termination Fee

読取り専用: true

早期退職金。
EarlyTerminationPenalty: string

タイトル: Early Termination Penalty

最大長: 30

早期終了ペナルティ。
EarlyTerminationPenaltyName: string

早期終了ペナルティの名前。
EnablePricingTermsFlag: boolean

タイトル: Enable pricing term

最大長: 1

価格設定条件が使用可能かどうかを示します。
EnableProrateByDay: boolean

タイトル: Prorate by day

最大長: 1

日別按分が使用可能かどうかを示します。
EnableUpfrontBillingFlag: boolean

タイトル: Bill immediately

最大長: 1

請求が事前完了したかどうかを示します。
EndDate: 文字列(日付)

タイトル: Product End Date

サブスクリプションが終了する日付。
EstimatedTax: number

タイトル: Estimated Tax

製品の見積税。
ExemptCertificateNumber: string

タイトル: Tax Exemption Certificate Number

最大長: 80

免税証明書の番号。
ExemptReason: string

タイトル: Exemption Reason

最大長: 30

免税の事由です。
ExternalAssetKey: string

最大長: 120

外部アセット・キー
ExternalParentAssetKey: string

最大長: 120

外部親アセット・キー
ExternalPriceListId: string

最大長: 120

外部価格表の一意の識別子。
ExternalRootAssetKey: string

最大長: 120

外部ルート・アセット・キー
flexFields: array Descriptive Flexfields

タイトル: Descriptive Flexfields

付加フレックスフィールド・リソースは、付加フレックスフィールドの表示、作成、更新および削除に使用されます。
GenerateBillFullPeriodFlag: boolean

タイトル: Generate billing schedule for full period

最大長: 1

全期間請求の生成フラグ
GenerateBillingSchedule: string

タイトル: Generate billing schedule for full period

最大長: 80

請求スケジュールが生成されるかどうかを示します。
GracePeriod: integer (int64)

タイトル: Grace Period in Days

猶予期間
InterfaceOffsetDays: 整数(int32)

インタフェースを相殺する必要がある日数。
InventoryItemId: integer (int64)

在庫品目の一意の識別子。
InvoicedAmount: number

タイトル: Invoiced Amount

請求書で指定された金額。
InvoiceText: string

タイトル: Invoice Text

最大長: 2000

請求請求書のテキスト。
InvoicingRuleId: integer (int64)

タイトル: Invoicing Rule

請求ルールの一意の識別子です。
InvoicingRuleName: string

タイトル: Invoicing Rule

請求ルールの名前。
ItemUnitOfMeasure: string

タイトル: Pricing UOM Code

最大長: 15

品目の測定に使用される単位。
LastUpdateDate: string (date-time)

タイトル: Line Last Update Date

読取り専用: true

サブスクリプションが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

サブスクリプション製品を最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

サブスクリプション製品を最後に更新したユーザーのログイン詳細。
LineNumber: string

タイトル: Product Line Number

最大長: 300

製品の明細番号。
links: array Links

タイトル: Links

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

タイトル: MRR

製品に関連付けられた月次経常売上。
NextBillStartDate: 文字列(日付)

次回請求開始日
NextPricingDate: 文字列(日付)

次の価格設定が発生する日付。
OrderFulfillLineId: integer (int64)

サブスクリプション製品に関連付けられた販売オーダー履行明細のID。
OrderFulfillLineNumber: 整数(int32)

サブスクリプション製品に関連付けられている販売オーダー履行明細の番号。
OutputTaxClassification: string

最大長: 50

仮受税金の計算時に使用する税分類です。
OverrideCreditAmount: number

タイトル: Override Credit Amount

サブスクリプション製品のクレジット金額の上書き。
PaymentMethod: string

タイトル: Payment Method Code

最大長: 30

支払方法の一意の識別子。
PaymentMethodName: string

タイトル: Payment Method

支払方法の名前。
PaymentTermsId: integer (int64)

タイトル: Payment Terms

支払条件の一意の識別子。
PaymentTermsName: string

タイトル: Payment Terms

支払条件の名前。
PenaltyChargeName: string

ペナルティ手数料名。
PenaltyValue: number

タイトル: Penalty Value

ペナルティ値。
PendingActivationFlag: boolean

タイトル: Pending activation

最大長: 1

サブスクリプション製品のアクティブ化が待ち状態かどうかを示します。
Period: string

タイトル: Period

製品がサブスクライブされている期間。
PONumber: string

タイトル: PO Number

最大長: 50

購買オーダーの番号。
PrePaymentNumber: integer (int64)

タイトル: Prepayment Number

前払金番号。
PriceAdjustmentBasis: string

タイトル: Price Adjustment Basis

最大長: 30

価格が調整される基準。
PriceAdjustmentPercent: number

タイトル: Price Adjustment Value

価格修正パーセント。
PriceAdjustmentType: string

タイトル: Price Adjustment Type

最大長: 30

価格調整のタイプ。
PriceAsOf: 文字列(日付)

タイトル: Price as of Date

特定の日付時点での製品の価格。
PriceListId: integer (int64)

価格リストの一意の識別子。
PriceListName: string

最大長: 120

価格リストの名前。
PriceTransactionOn: 文字列(日付)

価格トランザクションが発生した日付。
PricingError: string

最大長: 2000

製品に関連する価格設定エラー。
PricingTermsAdjustmentPCT: number

タイトル: Pricing Term Adjustment Percentage

価格設定条件の調整。
PricingTermsDuration: number

タイトル: Pricing Term Duration

価格設定条件の継続期間。
PricingTermsPeriod: string

タイトル: Pricing Term

最大長: 15

価格設定条件が継続する期間。
PricingTermsPricingMethod: string

タイトル: Pricing Method

最大長: 30

製品価格設定の条件を設定するために使用するメソッド。
PricingTermsStartDate: 文字列(日付)

タイトル: Starting On

価格設定条件が開始する日付。
PrimaryPartyId: integer (int64)

読取り専用: true

サブスクリプション製品のプライマリ・パーティID。
ProductChangeReason: string

タイトル: Change Reason

最大長: 300

製品変更の事由。
ProductChangeSchedule: string

タイトル: Apply Change

最大長: 30

製品変更スケジュールは、更新、ANNIVERSARYまたはSPECIFIC_DATEに適用されます。
ProductChangeScheduleFrom: 文字列(日付)

タイトル: Product Change Schedule Effective Date

製品変更スケジュールが適用可能な開始日。
ProductFiscClassification: string

最大長: 30

製品会計分類。
ProductName: string

タイトル: Product Name

最大長: 300

製品の名前。
数量: number

タイトル: Quantity

製品の数量。
RatePlanDocument: 文字列(バイト)

レート・プランを表すJSON。
RatePlanDocumentId: integer (int64)

レート・プラン文書の識別子。
RatePlanId: integer (int64)

レート・プランの一意の識別子。
RatePlanName: string

タイトル: Rate Plan

レート・プランの名前。
RatePlanNumber: string

レート・プランの番号。
RelatedInventoryItemId: integer (int64)

タイトル: Related Inventory Item ID

置換サブスクリプション製品に関連付けられたアイテムの一意の識別子。
RelatedProductDescription: string

タイトル: Description

置換サブスクリプション製品の説明。
RelatedProductName: string

タイトル: Product Name

最大長: 300

置換サブスクリプション製品の名前。
relationships: array Relationships

タイトル: Relationships

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

タイトル: Renewal Duration

自動更改または手動更改による更改時に使用されるサブスクリプション製品レベルの更改期間上書き。
RenewalDurationPeriod: string

タイトル: Renewal Period

最大長: 30

自動または手動更改による更改時に使用される、サブスクリプション製品レベルの更改期間上書きのコードです。
RenewalDurationPeriodName: string

タイトル: Renewal Period

自動更改または手動更改による更改時に使用されるサブスクリプション製品レベルの更改期間上書きの名前。
RenewalPaymentMethod: string

タイトル: Product Renewal Payment Method

最大長: 30

サブスクリプション製品で使用される更改支払方法の内部コード。
RenewalPaymentMethodName: string

タイトル: Renewal Payment Method

更改済サブスクリプション製品の支払メソッド。支払方法は、購買オーダー、電信、クレジット・カードのいずれかです。
RenewalPoNumber: string

タイトル: Product Renewal PO Number

最大長: 50

更改済サブスクリプション製品の購買オーダー番号。
RenewalType: string

タイトル: Product Renewal Type

最大長: 30

サブスクリプション更改のタイプ。
RenewalWireNumber: string

タイトル: Product Renewal Wire Number

最大長: 30

更改済サブスクリプション製品の支払に使用される電子送金を識別する電信番号。
RenewedDate: 文字列(日付)

タイトル: Renewed On

製品が更改された日付。
RenewPerpetuallyFlag: boolean

タイトル: Renew forever

最大長: 1

サブスクリプション製品を永久に更新する必要があるかどうかを示します。
RepriceFlag: boolean

サブスクリプション製品の価格を再設定する必要があるかどうかを示します。 'true'として渡された場合、サブスクリプション製品および関連する対象レベルの価格が再設定されます。
RequestedRatePlanId: integer (int64)

リクエストされたレート・プランの一意の識別子。
RequestedRatePlanNumber: string

リクエストされたレート・プランの代替一意識別子。
ResumeDate: 文字列(日付)

製品を再開する日付。
ResumeDuration: integer

製品を再開するまでの期間。
ResumePeriod: string

製品が再開されるまでの期間。
salesCredits: array Sales Credits

タイトル: Sales Credits

サブスクリプションまたはサブスクリプション製品に定義されている販売実績を表示、作成、更新および削除するための販売実績リソースです。
SalesOrderId: integer (int64)

サブスクリプション製品に関連付けられている販売オーダーのID。
SalesOrderNumber: string

最大長: 200

サブスクリプション製品に関連付けられた販売オーダーの番号。
SalesProductType: string

タイトル: Type

最大長: 30

販売製品のタイプ。
serviceResources: array Service Resources

タイトル: Service Resources

サービス・リソース・リソースは、サブスクリプション製品のサービス識別子を表示、作成、更新および削除するために使用されます。
ShipToAccountDescription: string

サブスクリプション製品の出荷先アカウント摘要。
ShipToAccountId: integer (int64)

タイトル: Ship-to Account

サブスクリプション製品の出荷先アカウントID。
ShipToAccountNumber: string

タイトル: Ship-to Account

サブスクリプション製品の出荷先アカウント番号。
ShipToContactId: integer (int64)

タイトル: Ship-to Contact

サブスクリプション製品の出荷先担当者ID。
ShipToContactName: string

タイトル: Ship-to Contact

サブスクリプション製品の出荷先担当者名。
ShipToContactNumber: string

サブスクリプション製品の出荷先担当者番号。
ShipToContactPartyId: integer

読取り専用: true

サブスクリプション製品の出荷先担当者パーティID。
ShipToPartyId: integer (int64)

タイトル: Ship-to Party

出荷先パーティの一意の識別子。
ShipToPartyName: string

タイトル: Ship-to Party

出荷先パーティの名前。
ShipToPartyNumber: string

タイトル: Ship-to Party Number

サブスクリプション製品の出荷先パーティ番号。
ShipToPartySiteId: integer (int64)

タイトル: Ship-to Site

出荷先パーティ・サイトの一意の識別子。
ShipToPartySiteName: string

タイトル: Ship-to Site

出荷先パーティ・サイトの名前。
ShipToPartySiteNumber: string

タイトル: Ship-to Site Number

サブスクリプション製品の出荷先パーティ・サイト番号。
SourceKey: string

最大長: 120

ソース・システム内の製品の識別子。
SourceLineKey: string

最大長: 120

ソース明細キー
SourceLineNumber: string

最大長: 120

ソース明細番号
SourceNumber: string

最大長: 120

ソース・システム内の製品の代替識別子。
SourceSystem: string

最大長: 30

ソース・システム内の製品の参照。
StartDate: 文字列(日付)

タイトル: Product Start Date

サブスクリプションが開始する日付。
Status: string

タイトル: Status

最大長: 30

デフォルト値: DRAFT

サブスクリプション製品のステータス。
StatusMeaning: string

タイトル: Product Status

読取り専用: true

最大長: 80

製品ステータスの意味。
SubscriptionId: integer (int64)

サブスクリプションの一意の識別子。
SubscriptionNumber: string

タイトル: Subscription Number

最大長: 120

デフォルト値: Subscriptions.SubscriptionNumber

製品のサブスクリプション番号。
SubscriptionProductId: integer (int64)

サブスクリプション製品の一意の識別子。
SubscriptionProductPuid: string

タイトル: Subscription Product Number

最大長: 120

サブスクリプション製品の公開一意識別子。
SummarizedBillingFlag: boolean

タイトル: Summarized billing

最大長: 1

請求が要約されるかどうかを示します。
SuspendCreditMethod: string

タイトル: Suspend Credit Method

最大長: 30

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

タイトル: Suspend Date

製品が一時停止された日付。
SuspendReason: string

タイトル: Suspend Reason

最大長: 30

製品を一時停止する理由。
TaxClassificationMeaning: string

読取り専用: true

税分類の意味。
TaxError: string

最大長: 2000

計算金額の税金エラー(ある場合)。
TaxExemptionHandling: string

最大長: 30

免税処理。
TaxExemptionHandlingName: string

免税処理名。
TotalContractValue: number

タイトル: Product Contract Value

契約合計の値。
TransactionTypeName: string

タイトル: Transaction Type

最大長: 30

トランザクション・タイプの名前。
UnitPrice: number

単位の価格。
UsageInvoiceLayoutTemplate: string

タイトル: Usage Events Invoice Template

最大長: 200

使用請求書のレイアウト・テンプレート。
WarehouseId: integer (int64)

タイトル: Warehouse

サブスクリプション製品に関連付けられた倉庫ID。
WareHouseName: string

タイトル: Warehouse

サブスクリプション製品のウェアハウス名。
WireNumber: string

タイトル: Wire Number

最大長: 30

電信番号。

{
    "type":"object",
    "properties":{
        "CalculatedCreditAmount":{
            "title":"Calculated Credit Amount",
            "type":"number",
            "description":"The calculated credit amount of the subscription product.",
            "nullable":true,
            "x-queryable":true
        },
        "NextPricingDate":{
            "type":"string",
            "description":"The date when the next pricing will occur.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "CurcyConvRateType":{
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type associated with the product. 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":false
        },
        "EarlyTerminationPenalty":{
            "title":"Early Termination Penalty",
            "maxLength":30,
            "type":"string",
            "description":"The early termination penalty.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CancelDescription":{
            "title":"Cancellation Description",
            "maxLength":2000,
            "type":"string",
            "description":"The cancellation reason description of the subscription product.",
            "nullable":true,
            "x-queryable":true
        },
        "ResumeDate":{
            "type":"string",
            "description":"The date when the product should be resumed.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ChurnProbability":{
            "title":"Churn Probability",
            "type":"number",
            "description":"The probability of churn associated with the product.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceKey":{
            "maxLength":120,
            "type":"string",
            "description":"The identifier of the product in the source system.",
            "nullable":true,
            "x-queryable":false
        },
        "Currency":{
            "maxLength":15,
            "type":"string",
            "description":"The currency associated with the subscription product.",
            "nullable":false,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the subscription product.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the subscription product.",
            "nullable":false,
            "default":"DRAFT",
            "x-queryable":true
        },
        "AlignBillingFrom":{
            "title":"Align Billing From",
            "type":"string",
            "description":"The from date of the billing alignment.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription product.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SubscriptionProductPuid":{
            "title":"Subscription Product Number",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the subscription product.",
            "nullable":false,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The unique identifier of the inventory item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreditedAmount":{
            "title":"Credited Amount",
            "type":"number",
            "description":"The amount credited to a account.",
            "nullable":true,
            "x-queryable":false
        },
        "PaymentTermsId":{
            "title":"Payment Terms",
            "type":"integer",
            "description":"The unique identifier of the payment terms.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PaymentTermsName":{
            "title":"Payment Terms",
            "type":"string",
            "description":"The name of the payment terms.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AmendDescription":{
            "title":"Amendment Description",
            "maxLength":300,
            "type":"string",
            "description":"A brief description of the amended credit.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewalPaymentMethod":{
            "title":"Product Renewal Payment Method",
            "maxLength":30,
            "type":"string",
            "description":"The internal code for the renewal payment method used in the subscription product.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewPerpetuallyFlag":{
            "title":"Renew forever",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the subscription product should be renewed forever.",
            "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-charges-item-response"
            }
        },
        "ShipToPartySiteName":{
            "title":"Ship-to Site",
            "type":"string",
            "description":"The name of the ship-to party site.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PriceListId":{
            "type":"integer",
            "description":"The unique identifier of the price list.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AutoExtendFlag":{
            "type":"boolean",
            "description":"Indicates if the product should be auto extended.",
            "nullable":true,
            "x-queryable":false
        },
        "GracePeriod":{
            "title":"Grace Period in Days",
            "type":"integer",
            "description":"The grace period.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AmendReasonName":{
            "type":"string",
            "description":"The name of the amend reason.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the subscription product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OutputTaxClassification":{
            "maxLength":50,
            "type":"string",
            "description":"The tax classification to use when calculating the output tax.",
            "nullable":true,
            "x-queryable":false
        },
        "MonthlyRecurringRevenue":{
            "title":"MRR",
            "type":"number",
            "description":"The monthly recurring revenue associated with the product.",
            "nullable":true,
            "x-queryable":false
        },
        "CanceledAmount":{
            "title":"Canceled Amount",
            "type":"number",
            "description":"The transaction amount that was canceled.",
            "nullable":true,
            "x-queryable":false
        },
        "DefaultRevenueAction":{
            "maxLength":30,
            "type":"string",
            "description":"The revenue management rule of the subscription product used during the amendment.",
            "nullable":true,
            "x-queryable":false
        },
        "UsageInvoiceLayoutTemplate":{
            "title":"Usage Events Invoice Template",
            "maxLength":200,
            "type":"string",
            "description":"The layout template of the usage invoice.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "TaxClassificationMeaning":{
            "type":"string",
            "description":"The meaning of the tax classification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrderFulfillLineNumber":{
            "type":"integer",
            "description":"The number of the sales order fulfillment line associated with the subscription product.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "BillingDateCode":{
            "title":"Billing Date Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the billing date.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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-billLines-item-response"
            }
        },
        "PendingActivationFlag":{
            "title":"Pending activation",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the activation of the subscription product is pending or not.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalParentAssetKey":{
            "maxLength":120,
            "type":"string",
            "description":"The external parent asset key",
            "nullable":true,
            "x-queryable":true
        },
        "PricingTermsDuration":{
            "title":"Pricing Term Duration",
            "type":"number",
            "description":"The duration for which the pricing terms last.",
            "nullable":true,
            "x-queryable":false
        },
        "WarehouseId":{
            "title":"Warehouse",
            "type":"integer",
            "description":"The warehouse ID associated with the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"Product End Date",
            "type":"string",
            "description":"The date when the subscriptions ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentTypeId":{
            "title":"Document Type",
            "type":"integer",
            "description":"TheuUnique identifier of a source document type in Oracle Revenue Management Cloud.",
            "format":"int64",
            "nullable":true,
            "default":10,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClosedAmount":{
            "title":"Closed Amount",
            "type":"number",
            "description":"The amount at which the transaction was closed.",
            "nullable":true,
            "x-queryable":false
        },
        "RelatedProductName":{
            "title":"Product Name",
            "maxLength":300,
            "type":"string",
            "description":"The name of the replacement subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "OverrideCreditAmount":{
            "title":"Override Credit Amount",
            "type":"number",
            "description":"The override credit amount of the subscription product.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitPrice":{
            "type":"number",
            "description":"The price of the unit.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalRootAssetKey":{
            "maxLength":120,
            "type":"string",
            "description":"The external root asset key",
            "nullable":true,
            "x-queryable":true
        },
        "ResumeDuration":{
            "type":"integer",
            "description":"The duration after which the the product should be resumed.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceTransactionOn":{
            "type":"string",
            "description":"The date when the price transaction occurred.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "GenerateBillingSchedule":{
            "title":"Generate billing schedule for full period",
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the billing schedule is to be generated or not.",
            "nullable":true,
            "x-queryable":false
        },
        "CloseDescription":{
            "title":"Close Description",
            "maxLength":2000,
            "type":"string",
            "description":"The close reason description of the subscription product.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Line Last Update Date",
            "type":"string",
            "description":"The date when the subscription was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AmendReason":{
            "title":"Amendment Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason why the credit was amended.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillingOffsetDays":{
            "title":"Billing Offset Days",
            "type":"integer",
            "description":"The billing offset days.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TaxExemptionHandlingName":{
            "type":"string",
            "description":"The tax exemption handling name.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillToAccountNumber":{
            "title":"Billing Account",
            "type":"string",
            "description":"The account number of the bill-to account.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "BillingDateName":{
            "type":"string",
            "description":"The name of the billing date.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PenaltyChargeName":{
            "type":"string",
            "description":"The penalty charge name.",
            "nullable":true,
            "x-queryable":true
        },
        "TaxExemptionHandling":{
            "maxLength":30,
            "type":"string",
            "description":"The tax exemption handling.",
            "nullable":true,
            "x-queryable":false
        },
        "RelatedInventoryItemId":{
            "title":"Related Inventory Item ID",
            "type":"integer",
            "description":"The unique identifier of the item associated to the replacement subscription product.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RatePlanDocumentId":{
            "type":"integer",
            "description":"The identifier of the rate plan document.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShipToAccountNumber":{
            "title":"Ship-to Account",
            "type":"string",
            "description":"The ship-to account number of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false
            }
        },
        "ShipToContactId":{
            "title":"Ship-to Contact",
            "type":"integer",
            "description":"The ship-to contact ID of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Duration":{
            "title":"Duration",
            "type":"integer",
            "description":"Product Duration",
            "nullable":true,
            "x-queryable":false
        },
        "RequestedRatePlanId":{
            "type":"integer",
            "description":"The unique identifier of the requested rate plan.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RenewalType":{
            "title":"Product Renewal Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of subscription renewal.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PriceAdjustmentType":{
            "title":"Price Adjustment Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the price adjustment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EarlyTerminationFee":{
            "title":"Early Termination Fee",
            "type":"number",
            "description":"The early termination fee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RenewalPoNumber":{
            "title":"Product Renewal PO Number",
            "maxLength":50,
            "type":"string",
            "description":"The purchase order number of the renewed subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "RenewalPaymentMethod"
                ]
            }
        },
        "SourceLineNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The source line number",
            "nullable":true,
            "x-queryable":false
        },
        "SalesProductType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the sales product.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PriceAsOf":{
            "title":"Price as of Date",
            "type":"string",
            "description":"The price of the product as of a certain date.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "CoverageName":{
            "title":"Template Name",
            "type":"string",
            "description":"The name of the coverage associated with the product.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ShipToContactPartyId":{
            "type":"integer",
            "description":"The ship-to contact party ID of the subscription product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PrimaryPartyId":{
            "type":"integer",
            "description":"The primary party ID of the subscription product.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RatePlanNumber":{
            "type":"string",
            "description":"The number of the rate plan.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ShipToContactNumber":{
            "type":"string",
            "description":"The ship-to contact number of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ProductChangeSchedule":{
            "title":"Apply Change",
            "maxLength":30,
            "type":"string",
            "description":"The product change schedule is applicable on RENEWAL, ANNIVERSARY or SPECIFIC_DATE.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToAccountId":{
            "title":"Ship-to Account",
            "type":"integer",
            "description":"The ship-to account ID of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccountingRuleName":{
            "title":"Accounting Rule",
            "type":"string",
            "description":"The name of the accounting rule.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SalesOrderId":{
            "type":"integer",
            "description":"The ID of the sales order associated with the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PricingTermsAdjustmentPCT":{
            "title":"Pricing Term Adjustment Percentage",
            "type":"number",
            "description":"The adjustment in the pricing terms.",
            "nullable":true,
            "x-queryable":false
        },
        "TaxError":{
            "maxLength":2000,
            "type":"string",
            "description":"The tax error, if any, in the calculated amount.",
            "nullable":true,
            "x-queryable":false
        },
        "InterfaceOffsetDays":{
            "type":"integer",
            "description":"The number of days that the interface needs to be offset for.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "SourceLineKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source line key",
            "nullable":true,
            "x-queryable":false
        },
        "EnableUpfrontBillingFlag":{
            "title":"Bill immediately",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether billing is done upfront or not.",
            "nullable":true,
            "x-queryable":false
        },
        "RepriceFlag":{
            "type":"boolean",
            "description":"Indicates whether the subscription product should be repriced or not. If passed as 'true', the subscription product and its associated covered levels will be repriced.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":120,
            "type":"string",
            "description":"The subscription number of the product.",
            "nullable":false,
            "default":"Subscriptions.SubscriptionNumber",
            "x-queryable":true
        },
        "ShipToPartyNumber":{
            "title":"Ship-to Party Number",
            "type":"string",
            "description":"The ship-to party number of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ExemptCertificateNumber":{
            "title":"Tax Exemption Certificate Number",
            "maxLength":80,
            "type":"string",
            "description":"The number of the exempt certificate.",
            "nullable":true,
            "x-queryable":false
        },
        "BillToContactId":{
            "title":"Bill-to Contact",
            "type":"integer",
            "description":"The bill-to contact ID of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShipToPartySiteNumber":{
            "title":"Ship-to Site Number",
            "type":"string",
            "description":"The ship-to party site number of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "StatusMeaning":{
            "title":"Product Status",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the product status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnablePricingTermsFlag":{
            "title":"Enable pricing term",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the pricing terms are enabled or not.",
            "nullable":true,
            "x-queryable":true
        },
        "RenewalWireNumber":{
            "title":"Product Renewal Wire Number",
            "maxLength":30,
            "type":"string",
            "description":"The wire number that identifies the electronic funds transfer used to pay for a renewed subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "RenewalPaymentMethod"
                ]
            }
        },
        "associatedAsset":{
            "title":"Associated Assets",
            "type":"array",
            "description":"The associated assets resource is used to view, create, update, and delete the assets linked to a subscription product of subscription type.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-associatedAsset-item-response"
            }
        },
        "PONumber":{
            "title":"PO Number",
            "maxLength":50,
            "type":"string",
            "description":"The number of the purchase order.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PaymentMethod"
                ]
            }
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ShipToPartyId":{
            "title":"Ship-to Party",
            "type":"integer",
            "description":"The unique identifier of the ship-to party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResumePeriod":{
            "type":"string",
            "description":"The period of time after which the product will resume.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChurnPredictionTrend":{
            "type":"integer",
            "description":"The churn prediction trend.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "ProductChangeScheduleFrom":{
            "title":"Product Change Schedule Effective Date",
            "type":"string",
            "description":"The date from which the product change schedule is  applicable.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "PrePaymentNumber":{
            "title":"Prepayment Number",
            "type":"integer",
            "description":"The prepayment number.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "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-relationships-item-response"
            }
        },
        "CloseReason":{
            "title":"Product Close Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason why the product was closed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SummarizedBillingFlag":{
            "title":"Summarized billing",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the billing is to be summarized.",
            "nullable":true,
            "x-queryable":true
        },
        "BillToPartyId":{
            "title":"Bill-to Customer",
            "type":"integer",
            "description":"The bill-to customer ID of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate identifier of the product in the source system.",
            "nullable":true,
            "x-queryable":false
        },
        "PricingTermsPeriod":{
            "title":"Pricing Term",
            "maxLength":15,
            "type":"string",
            "description":"The period for which the pricing terms last.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CanceledDate":{
            "title":"Product Canceled Date",
            "type":"string",
            "description":"The date when the product was canceled.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "WareHouseName":{
            "title":"Warehouse",
            "type":"string",
            "description":"The warehouse name of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PriceAdjustmentPercent":{
            "title":"Price Adjustment Value",
            "type":"number",
            "description":"The price adjustment percent.",
            "nullable":true,
            "x-queryable":false
        },
        "BillingFrequency":{
            "title":"Billing Frequency",
            "maxLength":30,
            "type":"string",
            "description":"The billing frequency.",
            "nullable":false,
            "x-queryable":false
        },
        "RenewalPaymentMethodName":{
            "title":"Renewal Payment Method",
            "type":"string",
            "description":"The method of payment for renewed subscription product. The payment method could be a purchase order, wire, or credit card.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RenewalDurationPeriodName":{
            "title":"Renewal Period",
            "type":"string",
            "description":"The name of the subscription product level renewal duration period override that will be used while renewing through automatic or manual renewal.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EstimatedTax":{
            "title":"Estimated Tax",
            "type":"number",
            "description":"The estimated tax on the product.",
            "nullable":true,
            "x-queryable":false
        },
        "SalesOrderNumber":{
            "maxLength":200,
            "type":"string",
            "description":"The number of the sales order associated with the subscription product.",
            "nullable":true,
            "x-queryable":true
        },
        "BillToPartyName":{
            "title":"Bill-to Customer",
            "type":"string",
            "description":"The bill-to customer name of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false
            }
        },
        "PricingTermsPricingMethod":{
            "title":"Pricing Method",
            "maxLength":30,
            "type":"string",
            "description":"The method used to set the terms of the product pricing.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "serviceResources":{
            "title":"Service Resources",
            "type":"array",
            "description":"The service resources resouce is used to view, create, update, and delete the service identifier for a subscription product.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-serviceResources-item-response"
            }
        },
        "InvoicedAmount":{
            "title":"Invoiced Amount",
            "type":"number",
            "description":"The amount specified in the invoice.",
            "nullable":true,
            "x-queryable":false
        },
        "SuspendedDate":{
            "title":"Suspend Date",
            "type":"string",
            "description":"The date when the product was suspended.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "RenewalDuration":{
            "title":"Renewal Duration",
            "type":"integer",
            "description":"The subscription product level renewal duration override that will be used while renewing through automatic or manual renewal.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Description":{
            "title":"Product Description",
            "type":"string",
            "description":"A brief description of the subscription product.",
            "nullable":true,
            "x-queryable":false
        },
        "RelatedProductDescription":{
            "title":"Description",
            "type":"string",
            "description":"The description of the replacement subscription product.",
            "nullable":true,
            "x-queryable":false
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"number",
            "description":"The display sequence of the subscription product.",
            "nullable":true,
            "x-queryable":false
        },
        "InvoicingRuleName":{
            "title":"Invoicing Rule",
            "type":"string",
            "description":"The name of the invoicing rule.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CustomerTrxTypeSequenceId":{
            "type":"integer",
            "description":"The customer transaction type sequence ID of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Product Line Number",
            "maxLength":300,
            "type":"string",
            "description":"The line number of the product.",
            "nullable":false,
            "x-queryable":true
        },
        "BillToPartyNumber":{
            "type":"string",
            "description":"The bill-to customer number of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PaymentMethodName":{
            "title":"Payment Method",
            "type":"string",
            "description":"The name of the payment method.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExternalAssetKey":{
            "maxLength":120,
            "type":"string",
            "description":"The external asset key",
            "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
        },
        "ExternalPriceListId":{
            "maxLength":120,
            "type":"string",
            "description":"The unique identifier of the external price list.",
            "nullable":true,
            "x-queryable":true
        },
        "flexFields":{
            "title":"Descriptive Flexfields",
            "type":"array",
            "description":"The descriptive flexfields resource is used to view, create, update, and delete a descriptive flexfield.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-flexFields-item-response"
            },
            "x-cardinality":"1"
        },
        "EarlyTerminationPenaltyName":{
            "type":"string",
            "description":"The name of the early termination penalty.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipToContactName":{
            "title":"Ship-to Contact",
            "type":"string",
            "description":"The ship-to contact name of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false
            }
        },
        "TotalContractValue":{
            "title":"Product Contract Value",
            "type":"number",
            "description":"The value of the total contract.",
            "nullable":true,
            "x-queryable":true
        },
        "SuspendReason":{
            "title":"Suspend Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason to suspend the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DropOneTimeChargeFlag":{
            "title":"Don't copy one-time charges",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether one time charges have to be removed when the product is changed.",
            "nullable":true,
            "x-queryable":false
        },
        "coveredLevels":{
            "title":"Covered Levels",
            "type":"array",
            "description":"The covered levels resource is used to create, view, update, or delete the subscription covered levels details, such as subscription ID, subscription product ID, covered asset and its associated details.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-item-response"
            }
        },
        "CloseCreditMethod":{
            "title":"Close Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"The method used to close the credit.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillToSiteNumber":{
            "title":"Bill-to Site Number",
            "type":"string",
            "description":"The bill-to site number of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ShipToPartySiteId":{
            "title":"Ship-to Site",
            "type":"integer",
            "description":"The unique identifier of the ship-to party site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductFiscClassification":{
            "maxLength":30,
            "type":"string",
            "description":"The product fiscal classification.",
            "nullable":true,
            "x-queryable":false
        },
        "AccountingRuleId":{
            "title":"Accounting Rule",
            "type":"integer",
            "description":"The unique identifier of the accounting rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillToAccountId":{
            "title":"Billing Account",
            "type":"integer",
            "description":"The unique identifier of the bill-to account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PenaltyValue":{
            "title":"Penalty Value",
            "type":"number",
            "description":"The penalty value.",
            "nullable":true,
            "x-queryable":false
        },
        "RatePlanName":{
            "title":"Rate Plan",
            "type":"string",
            "description":"The name of the rate plan.",
            "nullable":true,
            "x-queryable":false
        },
        "ClosedDate":{
            "title":"Product Close Date",
            "type":"string",
            "description":"The date when the product was closed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "maxLength":30,
            "type":"string",
            "description":"The reference of the product in the source system.",
            "nullable":true,
            "x-queryable":false
        },
        "ProductChangeReason":{
            "title":"Change Reason",
            "maxLength":300,
            "type":"string",
            "description":"The reason for the product change.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TransactionTypeName":{
            "title":"Transaction Type",
            "maxLength":30,
            "type":"string",
            "description":"The name of the transaction type.",
            "nullable":false,
            "x-queryable":false
        },
        "ProductName":{
            "title":"Product Name",
            "maxLength":300,
            "type":"string",
            "description":"The name of the product.",
            "nullable":true,
            "x-hints":{
                "controlType":"input_text_lov"
            },
            "x-queryable":true
        },
        "BillToAccountDescription":{
            "type":"string",
            "description":"A brief description of the bill-to account.",
            "nullable":true,
            "x-queryable":false
        },
        "SuspendCreditMethod":{
            "title":"Suspend Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the credit method has to be suspended.",
            "nullable":true,
            "x-queryable":false
        },
        "StartDate":{
            "title":"Product Start Date",
            "type":"string",
            "description":"The date when the subscriptions starts.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "BillToAddress":{
            "title":"Bill-to Address",
            "type":"string",
            "description":"The bill-to address.",
            "nullable":true,
            "x-queryable":false
        },
        "ExemptReason":{
            "title":"Exemption Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason for the tax exemption.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToAccountDescription":{
            "type":"string",
            "description":"The ship-to account description of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PricingTermsStartDate":{
            "title":"Starting On",
            "type":"string",
            "description":"The date when the pricing terms starts.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "PriceAdjustmentBasis":{
            "title":"Price Adjustment Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis on the which the price is adjusted.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RequestedRatePlanNumber":{
            "type":"string",
            "description":"The alternate unique identifier of the requested rate plan.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CorpCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code associated with the product. 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":false
        },
        "ItemUnitOfMeasure":{
            "title":"Pricing UOM Code",
            "maxLength":15,
            "type":"string",
            "description":"The unit of measure used to measure the items.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EnableProrateByDay":{
            "title":"Prorate by day",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether proration by day is enabled or not.",
            "nullable":true,
            "x-queryable":false
        },
        "CoverageScheduleId":{
            "type":"integer",
            "description":"Coverage Scheduled",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillToSiteUseId":{
            "title":"Bill-to Site",
            "type":"integer",
            "description":"The unique identifier of the bill-to site use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Period":{
            "title":"Period",
            "type":"string",
            "description":"The period for which the product has been subscribed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillOnDay":{
            "title":"Bill on Day",
            "type":"number",
            "description":"The day on which the product should be billed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "WireNumber":{
            "title":"Wire Number",
            "maxLength":30,
            "type":"string",
            "description":"The wire number.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PaymentMethod"
                ]
            }
        },
        "RatePlanId":{
            "type":"integer",
            "description":"The unique identifier of the rate plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CancelReason":{
            "title":"Cancellation Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason why the product was canceled.",
            "nullable":true,
            "x-queryable":false
        },
        "creditCards":{
            "title":"Credit Cards",
            "type":"array",
            "description":"The credit cards resource is used to view, create, and update the credit cards associated with a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-creditCards-item-response"
            }
        },
        "GenerateBillFullPeriodFlag":{
            "title":"Generate billing schedule for full period",
            "maxLength":1,
            "type":"boolean",
            "description":"Generate Bill Full Period Flag",
            "nullable":true,
            "x-queryable":false
        },
        "BillToContactNumber":{
            "type":"string",
            "description":"The bill-to contact number of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PaymentMethod":{
            "title":"Payment Method Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the payment method.",
            "nullable":true,
            "x-queryable":false
        },
        "DefinitionOrganizationId":{
            "type":"integer",
            "description":"The unique identifier of the item master organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AmendCreditMethod":{
            "title":"Amendment Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"The method used to amend the credit.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RenewalDurationPeriod":{
            "title":"Renewal Period",
            "maxLength":30,
            "type":"string",
            "description":"The code of the subscription product level renewal duration period override that will be used while renewing through automatic or manual renewal.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipToPartyName":{
            "title":"Ship-to Party",
            "type":"string",
            "description":"The name of the ship-to party.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "InvoiceText":{
            "title":"Invoice Text",
            "maxLength":2000,
            "type":"string",
            "description":"The text in the billing invoice.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AmendCreditMethodName":{
            "type":"string",
            "description":"The name of the method used to amend the credit .",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "NextBillStartDate":{
            "type":"string",
            "description":"Next Bill Start Date",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "AmendEffectiveDate":{
            "title":"Amendment Effective Date",
            "type":"string",
            "description":"The date when the amended credit becomes effective.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "OrderFulfillLineId":{
            "type":"integer",
            "description":"The ID of the sales order fulfillment line associated with the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PriceListName":{
            "maxLength":120,
            "type":"string",
            "description":"The name of the price list.",
            "nullable":true,
            "x-queryable":false
        },
        "InvoicingRuleId":{
            "title":"Invoicing Rule",
            "type":"integer",
            "description":"The unique identifier of the invoicing rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RenewedDate":{
            "title":"Renewed On",
            "type":"string",
            "description":"The date when the product was renewed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of the product.",
            "nullable":true,
            "x-queryable":false
        },
        "BillingFrequencyName":{
            "title":"Billing Frequency",
            "type":"string",
            "description":"The name of the billing frequency.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "salesCredits":{
            "title":"Sales Credits",
            "type":"array",
            "description":"The sales credits resource to view, create, update, and delete the sales credits defined for a subscription or a subscription product.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-salesCredits-item-response"
            }
        },
        "BillToContactName":{
            "title":"Bill-to Contact",
            "type":"string",
            "description":"The bill-to contact name of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false
            }
        },
        "RatePlanDocument":{
            "type":"string",
            "description":"The JSON representing the rate plan.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PricingError":{
            "maxLength":2000,
            "type":"string",
            "description":"The pricing error associated with the product.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

ネストされたスキーマ : 関連アセット

タイプ: array

タイトル: Associated Assets

ソースを表示

Array of: object subscriptionProducts-associatedAsset-item-response

{
    "title":"Associated Assets",
    "type":"array",
    "description":"The associated assets resource is used to view, create, update, and delete the assets linked to a subscription product of subscription type.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-associatedAsset-item-response"
    }
}

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

タイプ: array

タイトル: Bill Lines

ソースを表示

Array of: object subscriptionProducts-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-billLines-item-response"
    }
}

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

タイプ: array

タイトル: Charges

ソースを表示

Array of: object subscriptionProducts-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-charges-item-response"
    }
}

ネストされたスキーマ : 対象レベル

タイプ: array

タイトル: Covered Levels

ソースを表示

Array of: object subscriptionProducts-coveredLevels-item-response

{
    "title":"Covered Levels",
    "type":"array",
    "description":"The covered levels resource is used to create, view, update, or delete the subscription covered levels details, such as subscription ID, subscription product ID, covered asset and its associated details.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-item-response"
    }
}

ネストされたスキーマ : クレジット・カード情報

タイプ: array

タイトル: Credit Cards

ソースを表示

Array of: object subscriptionProducts-creditCards-item-response

{
    "title":"Credit Cards",
    "type":"array",
    "description":"The credit cards resource is used to view, create, and update the credit cards associated with a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-creditCards-item-response"
    }
}

ネストされたスキーマ : 付加フレックスフィールド

タイプ: array

タイトル: Descriptive Flexfields

付加フレックスフィールド・リソースは、付加フレックスフィールドの表示、作成、更新および削除に使用されます。

ソースを表示

Array of: object subscriptionProducts-flexFields-item-response

{
    "title":"Descriptive Flexfields",
    "type":"array",
    "description":"The descriptive flexfields resource is used to view, create, update, and delete a descriptive flexfield.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-flexFields-item-response"
    },
    "x-cardinality":"1"
}

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

タイプ: 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

ソースを表示

Array of: object subscriptionProducts-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-relationships-item-response"
    }
}

ネストされたスキーマ : 販売実績

タイプ: array

タイトル: Sales Credits

サブスクリプションまたはサブスクリプション製品に定義されている販売実績を表示、作成、更新および削除するための販売実績リソースです。

ソースを表示

Array of: object subscriptionProducts-salesCredits-item-response

{
    "title":"Sales Credits",
    "type":"array",
    "description":"The sales credits resource to view, create, update, and delete the sales credits defined for a subscription or a subscription product.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-salesCredits-item-response"
    }
}

ネストされたスキーマ : サービス・リソース

タイプ: array

タイトル: Service Resources

サービス・リソース・リソースは、サブスクリプション製品のサービス識別子を表示、作成、更新および削除するために使用されます。

ソースを表示

Array of: object subscriptionProducts-serviceResources-item-response

{
    "title":"Service Resources",
    "type":"array",
    "description":"The service resources resouce is used to view, create, update, and delete the service identifier for a subscription product.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-serviceResources-item-response"
    }
}

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

タイプ: object

ソースを表示

AssetId: integer (int64)

アセットの一意の識別子。
AssetName: string

タイトル: Asset Name

アセットの名前。
AssetSerialNumber: string

タイトル: Asset Serial Number

アセットのシリアル番号。
AssociatedAssetId: integer (int64)

関連付けられたアセットの一意の識別子。
AssociatedAssetPuid: string

最大長: 120

関連付けられたアセットのPUID。
CorpCurrencyCode: string

最大長: 15

企業通貨コード。
CreatedBy: string

読取り専用: true

最大長: 64

関連付けられたアセットを作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

関連アセットが作成された日付。
CurcyConvRateType: string

最大長: 30

通貨換算レート・タイプ。有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
CurrencyCode: string

最大長: 15

USDやINRなどの通貨コード。
InventoryItemId: integer

在庫品目の一意の識別子。
LastUpdateDate: string (date-time)

読取り専用: true

関連付けられたアセットが最後に更新された日付。
LastUpdatedBy: string

読取り専用: true

最大長: 64

関連付けられたアセットを最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

関連付けられたアセットを最後に更新したユーザーのログイン。
LineNumber: integer (int64)

タイトル: Number

関連付けられたアセットのライン番号。
links: array Links

タイトル: Links

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

タイトル: Product Name

製品の名前。
数量: number

タイトル: Quantity

関連アセットの数量。
SourceKey: string

最大長: 120

関連付けられたアセットのソース・キー。
SourceLineKey: string

最大長: 120

関連付けられたアセットのソース明細キー。
SourceLineNumber: string

最大長: 120

関連付けられたアセットのソース明細番号。
SourceNumber: string

最大長: 120

関連付けられたアセットのソース番号。
SourceSystem: string

最大長: 30

関連付けられたアセットのソース・システム。
SubscriptionId: integer (int64)

サブスクリプションの一意の識別子。
SubscriptionProductId: integer (int64)

サブサープション製品の一意の識別子。
UnitOfMeasure: string

タイトル: UOM

関連付けられたアセットの計量単位。
UnitOfMeasureCode: string

タイトル: UOM

関連付けられたアセットの単位コード。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the associated asset was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasureCode":{
            "title":"UOM",
            "type":"string",
            "description":"The unit of measure code of the associated asset.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "AssetId"
                ]
            }
        },
        "ProductName":{
            "title":"Product Name",
            "type":"string",
            "description":"The name of the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "AssetId"
                ]
            }
        },
        "CurcyConvRateType":{
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Number",
            "type":"integer",
            "description":"The line number of the associated asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code such as USD or INR.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source key of the associated asset.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "SubscriptionProductId"
                ]
            },
            "x-queryable":true
        },
        "SourceNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The source number of the associated asset.",
            "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 subscurption product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceLineKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source line key of the associated asset.",
            "nullable":true,
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the associated asset.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the associated asset.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociatedAssetId":{
            "type":"integer",
            "description":"The unique identifier of the associated asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM",
            "type":"string",
            "description":"The unit of measure of the associated asset.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "UnitOfMeasureCode"
                ]
            }
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The unique identifier of the inventory item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of the associated asset.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "AssetId"
                ]
            }
        },
        "AssetName":{
            "title":"Asset Name",
            "type":"string",
            "description":"The name of the asset.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false,
                "dependencies":[
                    "AssetId"
                ]
            }
        },
        "AssetSerialNumber":{
            "title":"Asset Serial Number",
            "type":"string",
            "description":"The serial number of the asset.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "AssetId"
                ]
            }
        },
        "AssociatedAssetPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the associated asset.",
            "nullable":false,
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"The unique identifier of the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceLineNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The source line number of the associated asset.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "maxLength":30,
            "type":"string",
            "description":"The source system of the associated asset.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the associated asset was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the associated asset.",
            "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-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-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-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-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-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"
    }
}

ネストされたスキーマ : subscriptionProducts-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-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-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-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-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-charges-adjustments-item-response"
    }
}

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

タイプ: array

タイトル: Charge Milestone Events

ソースを表示

Array of: object subscriptionProducts-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-charges-chargeMilestoneEvents-item-response"
    }
}

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

タイプ: array

タイトル: Charge Tiers

ソースを表示

Array of: object subscriptionProducts-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-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-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-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-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-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

ソースを表示

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"
    }
}

ネストされたスキーマ : 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"
    }
}

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

タイプ: object

ソースを表示

AddressLine1: string

読取り専用: true

最大長: 255

請求先住所の住所行1。
AddressLine2: string

読取り専用: true

最大長: 255

請求先住所の住所行2。
AddToBillingAccountFlag: boolean

パーティを請求アカウントとして追加できるかどうかを示します。
AuthorizedAmount: number

トランザクションが承認された金額。
AuthRequestId: string

カード承認リクエスト識別子。
CardBillingAddressId: number

読取り専用: true

カード請求先住所のID。
CardHolderName: string

タイトル: Cardholder Name

クレジット・カード所有者の名前。
CardIssuerName: string

読取り専用: true

最大長: 255

カード会社の名前。
City: string

読取り専用: true

最大長: 255

請求先住所の市区町村。
Country: string

読取り専用: true

最大長: 255

請求先住所の国。
CreatedBy: string

読取り専用: true

最大長: 64

クレジット・カードを作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

クレジット・カードが作成された日付。
CreditCardId: integer (int64)

クレジット・カードの一意の識別子。
CreditCardPuid: string

最大長: 120

クレジット・カードの公開一意識別子。
ExpirationDate: 文字列(日付)

処理に使用されるクレジット・カード有効期限。
FirstName: string

クレジット・カード所有者の名。
InstrAssignmentId: integer (int64)

タイトル: Number

手段割当の一意の識別子。
IssuerCode: string

クレジット・カード発行会社。
LastName: string

クレジット・カード所有者の姓。
LastUpdateDate: string (date-time)

読取り専用: true

クレジット・カードが最後に更新された日付。
LastUpdatedBy: string

読取り専用: true

最大長: 64

クレジット・カードを最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

クレジット・カードを最後に更新したユーザーのログイン詳細。
links: array Links

タイトル: Links

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

マスクされたクレジット・カード番号。
Notes: string

タイトル: Notes

最大長: 300

クレジット・カードに関連付けられているノート(ある場合)。
PaymentSystemOrderNumber: string

クレジット・カード支払のオーダー番号。
PostalCode: string

読取り専用: true

最大長: 255

請求先住所の郵便番号。
RenewalCreditCardFlag: boolean

最大長: 1

クレジット・カードが更改支払方法として使用されるかどうかを示します。
State: string

読取り専用: true

最大長: 255

請求先住所の状態。
SubscriptionId: integer (int64)

サブスクリプションの一意の識別子。
SubscriptionProductId: integer (int64)

サブスクリプション製品の公開一意識別子。
TokenNumber: string

処理に使用されるクレジット・カード・トークン番号。
VoiceAuthCode: string

クレジット・カード音声承認情報。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the credit card was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "CardIssuerName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the card issuer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InstrAssignmentId":{
            "title":"Number",
            "type":"integer",
            "description":"The unique identifier of the instrument assignment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "CreditCardPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the credit card.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":255,
            "type":"string",
            "description":"The postal code of the billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentSystemOrderNumber":{
            "type":"string",
            "description":"The order number for the credit card payment.",
            "nullable":true,
            "x-queryable":false
        },
        "CardHolderName":{
            "title":"Cardholder Name",
            "type":"string",
            "description":"The name of the credit card holder.",
            "nullable":true,
            "x-queryable":true
        },
        "AddToBillingAccountFlag":{
            "type":"boolean",
            "description":"Indicates whether the party can be added as a billing account.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "precision":18
            },
            "x-queryable":true
        },
        "VoiceAuthCode":{
            "type":"string",
            "description":"The credit card voice authorization information.",
            "nullable":true,
            "x-queryable":false
        },
        "AuthRequestId":{
            "type":"string",
            "description":"The card authorization request identifier.",
            "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 public unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "precision":18
            },
            "x-queryable":true
        },
        "RenewalCreditCardFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the credit card is used as Renewal Payment Method.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditCardId":{
            "type":"integer",
            "description":"The unique identifier of the credit card.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "precision":18,
                "SUPPORTS_RANGE_PAGING":"true"
            },
            "x-queryable":true
        },
        "Notes":{
            "title":"Notes",
            "maxLength":300,
            "type":"string",
            "description":"The notes, if any, associated with the credit card.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the credit card.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the credit card.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "FirstName":{
            "type":"string",
            "description":"The first name of the credit card holder.",
            "nullable":true,
            "x-queryable":false
        },
        "MaskedNumber":{
            "type":"string",
            "description":"The masked credit card number.",
            "nullable":true,
            "x-queryable":false
        },
        "CardBillingAddressId":{
            "type":"number",
            "description":"The ID of the card billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssuerCode":{
            "type":"string",
            "description":"The credit card issuing company.",
            "nullable":true,
            "x-queryable":false
        },
        "City":{
            "maxLength":255,
            "type":"string",
            "description":"The city of the billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressLine2":{
            "maxLength":255,
            "type":"string",
            "description":"The address line 2 of the billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressLine1":{
            "maxLength":255,
            "type":"string",
            "description":"The address line 1 of the billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "type":"string",
            "description":"The credit card expiration date used for processing.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "State":{
            "maxLength":255,
            "type":"string",
            "description":"The state of the billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":255,
            "type":"string",
            "description":"The country of the billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AuthorizedAmount":{
            "type":"number",
            "description":"The amount the transaction was authorized for.",
            "nullable":true,
            "x-queryable":false
        },
        "LastName":{
            "type":"string",
            "description":"The last name of the credit card holder.",
            "nullable":true,
            "x-queryable":false
        },
        "TokenNumber":{
            "type":"string",
            "description":"The credit card token number used for processing.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the credit card was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the credit card.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "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-flexFields-item-response

タイプ: object

ソースを表示

__FLEX_Context: string

タイトル: Context Segment

最大長: 30

ユーザー付加フレックスフィールドの構造定義です。
__FLEX_Context_DisplayValue: string

タイトル: Context Segment

ユーザー付加フレックスフィールドの体系定義の表示名です。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
SubscriptionProductId: integer (int64)

サブスクリプション製品の一意の識別子。

{
    "type":"object",
    "properties":{
        "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":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"The display name for structure definition of the user descriptive flexfield.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"The structure definition of the user descriptive flexfield.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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-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"
    }
}

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

タイプ: object

ソースを表示

CreatedBy: string

読取り専用: true

最大長: 64

販売実績を作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

販売実績が作成された日付。
EndDate: 文字列(日付)

販売実績が終了した日付。
LastUpdateDate: string (date-time)

読取り専用: true

販売実績が最後に更新された日付。
LastUpdatedBy: string

読取り専用: true

最大長: 64

販売実績を最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

販売実績を最後に更新したユーザーのログイン詳細。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
パーセント: number

パーセント
QuotaFlag: boolean

読取り専用: true

最大長: 1

目標が達成されたかどうかを示します。
SalesCreditId: integer (int64)

販売実績の一意の識別子。
SalesCreditPuid: string

最大長: 120

販売実績の公開一意識別子。
SalesCreditType: string

販売実績のタイプ。
SalesCreditTypeId: integer (int64)

販売実績のタイプの一意の識別子。
SalesPerson: string

営業担当の名前。
SalesPersonNumber: string

タイトル: Salesperson Number

営業担当の代替識別子。
SalesrepId: integer (int64)

営業担当の一意の識別子。
StartDate: 文字列(日付)

販売実績が開始した日付。
SubscriptionId: integer (int64)

サブスクリプションの一意の識別子。
SubscriptionProductId: integer (int64)

サブスクリプション製品の一意の識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the sales credit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the sales credit was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the sales credit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Percentage":{
            "type":"number",
            "description":"The percentage",
            "nullable":false,
            "x-hints":{
                "precision":5,
                "scale":2
            },
            "x-queryable":true
        },
        "SalesPerson":{
            "type":"string",
            "description":"The name of the sales person.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "SalesCreditTypeId":{
            "type":"integer",
            "description":"The unique identifier of the type of the sales credit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "SalesrepId":{
            "type":"integer",
            "description":"The unique identifier of the sales representative.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SalesPersonNumber":{
            "title":"Salesperson Number",
            "type":"string",
            "description":"The alternate identifier of a salesperson.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "sortable":false
            }
        },
        "QuotaFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the quota has been fulfilled.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesCreditType":{
            "type":"string",
            "description":"The type of the sales credit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The date when the sales credit was ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The date when the sales credit started.",
            "format":"date",
            "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
        },
        "SalesCreditPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the sales credit.",
            "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
        },
        "SalesCreditId":{
            "type":"integer",
            "description":"The unique identifier of the sales credit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the sales credit 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 sales credit.",
            "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-serviceResources-item-response

タイプ: object

ソースを表示

CreatedBy: string

読取り専用: true

最大長: 64

サービス・リソースを作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

サービス・リソースが作成された日付。
EnabledFlag: boolean

タイトル: Enable Service Resource

最大長: 1

デフォルト値: true

サービス・リソースが有効かどうかを示します。
EndDate: 文字列(日付)

タイトル: End Date

サービス・リソースの終了日。
LastUpdateDate: string (date-time)

読取り専用: true

サービス・リソースが最後に更新された日付。
LastUpdatedBy: string

読取り専用: true

最大長: 64

サービス・リソースを最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

サービス・リソースを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

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

タイトル: Service Identifier

最大長: 120

サービスの一意の識別子。
ServiceResourceId: integer (int64)

サービス・リソースの一意の識別子。
ServiceResourcePuid: string

最大長: 120

サービス・リソースのPUID。
StartDate: 文字列(日付)

タイトル: Start Date

サービス・リソースの開始日。
SubscriptionId: integer (int64)

サブスクリプションの一意の識別子。
SubscriptionProductId: integer (int64)

サブスクリプション製品の一意の識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the service resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date on which the service resource was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ServiceResourcePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the service resource.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the service resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ServiceResourceId":{
            "type":"integer",
            "description":"The unique identifier of the service resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the service resource.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ServiceId":{
            "title":"Service Identifier",
            "maxLength":120,
            "type":"string",
            "description":"The unique identifier of the service.",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the service resource.",
            "format":"date",
            "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
        },
        "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
        },
        "EnabledFlag":{
            "title":"Enable Service Resource",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the service resource is enabled or not.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the service resource was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the service resource.",
            "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"
    }
}

リンク

ProductCloseCreditMethodVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_CLOSE_CREDIT_METHOD

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: CloseCreditMethod;ターゲット属性: LookupCode
表示属性: 意味

ProductCloseReasonVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_CLOSE_REASONS

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: CloseReason;ターゲット属性: LookupCode
表示属性: 意味

SalesProductTypeLookupVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DQSC_SALES_PRODUCT_TYPE

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: SalesProductType;ターゲット属性: LookupCode
表示属性: 意味

associatedAsset

操作: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/associatedAsset

パラメータ:

SubscriptionProductPuid: $request.path.SubscriptionProductPuid

billLines

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

パラメータ:

SubscriptionProductPuid: $request.path.SubscriptionProductPuid

取消

操作: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/cancel

パラメータ:

SubscriptionProductPuid: $request.path.SubscriptionProductPuid

このメソッドを使用すると、特定の日付の事由でサブスクリプション製品を取り消すことができます。

手数料

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

パラメータ:

SubscriptionProductPuid: $request.path.SubscriptionProductPuid

閉める

操作: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/close

パラメータ:

SubscriptionProductPuid: $request.path.SubscriptionProductPuid

このメソッドでは、理由付きで特定の日付にサブスクリプション製品をクローズできます

coveredLevels

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

パラメータ:

SubscriptionProductPuid: $request.path.SubscriptionProductPuid

creditCards

操作: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/creditCards

パラメータ:

SubscriptionProductPuid: $request.path.SubscriptionProductPuid

flexFields

操作: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/flexFields

パラメータ:

SubscriptionProductPuid: $request.path.SubscriptionProductPuid

付加フレックスフィールド・リソースは、付加フレックスフィールドの表示、作成、更新および削除に使用されます。

putOnHold

操作: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/putOnHold

パラメータ:

SubscriptionProductPuid: $request.path.SubscriptionProductPuid

このメソッドでは、サブスクリプション製品を保留にできます。

関係

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

パラメータ:

SubscriptionProductPuid: $request.path.SubscriptionProductPuid

removeHold

操作: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/removeHold

パラメータ:

SubscriptionProductPuid: $request.path.SubscriptionProductPuid

このメソッドでは、サブスクリプション製品の保留を解除できます。

再開

操作: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/resume

パラメータ:

SubscriptionProductPuid: $request.path.SubscriptionProductPuid

このメソッドでは、中断されたサブスクリプション製品を再開できます。

salesCredits

操作: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/salesCredits

パラメータ:

SubscriptionProductPuid: $request.path.SubscriptionProductPuid

サブスクリプションまたはサブスクリプション製品に定義されている販売実績を表示、作成、更新および削除するための販売実績リソースです。

serviceResources

操作: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/serviceResources

パラメータ:

SubscriptionProductPuid: $request.path.SubscriptionProductPuid

サービス・リソース・リソースは、サブスクリプション製品のサービス識別子を表示、作成、更新および削除するために使用されます。

一時停止

操作: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/suspend

パラメータ:

SubscriptionProductPuid: $request.path.SubscriptionProductPuid

このメソッドを使用すると、特定の日付に理由付きでサブスクリプション製品を一時停止できます。

undoClose

操作: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/undoClose

パラメータ:

SubscriptionProductPuid: $request.path.SubscriptionProductPuid

このメソッドでは、サブスクリプション製品のクローズを元に戻すことができます。

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対してPOSTリクエストを発行してサブスクリプション製品を作成する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionProducts

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています。

{

      "LineNumber": "4",
      "SubscriptionProductPuid": "300100182015426",
      "DefinitionOrganizationId": 204,
      "SubscriptionNumber": "CDRM_4016",
      "SalesProductType": "SUBSCRIPTION",
      "Description": "QP Item for SPT Subscription",
      "InventoryItemId": 300100012368232,
      "ItemUnitOfMeasure": "Ea",
      "ProductName": "QP_Item3",
      "Quantity": 1,
      "StartDate": "2019-05-30",
      "EndDate": null
}

レスポンス本文の例

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

{
  "SubscriptionProductId": 300100192686405,
  "SubscriptionId": 300100181994494,
  "LineNumber": "4",
  "SubscriptionProductPuid": "300100182015426",
  "DefinitionOrganizationId": 204,
  "SubscriptionNumber": "CDRM_4016",
  "SalesProductType": "SUBSCRIPTION",
  "Description": "QP Item for SPT Subscription",
  "InventoryItemId": 300100012368232,
  "ItemUnitOfMeasure": "Ea",
  "ProductName": "QP_Item3",
  "Quantity": 1,
  "StartDate": "2019-05-30",
  "EndDate": null,
  "CloseReason": null,
  "CloseCreditMethod": null,
  "CancelReason": null,
  "ClosedDate": null,
  "CanceledDate": null,
  "RenewedDate": null,
  "PriceListId": null,
  "UnitPrice": null,
  "Status": "ORA_DRAFT",
  "Currency": "USD",
  "InvoicingRuleId": -3,
  "InvoicingRuleName": "Arrears Invoice",
  "BillOnDay": null,
  "BillingOffsetDays": null,
  "BillingFrequency": "0zG",
  "BillingFrequencyName": "MONTH",
  "AccountingRuleId": 300100033038414,
  "AccountingRuleName": "3 Months",
  "TransactionTypeName": "ORA_OSS_Invoice",
  "InvoiceText": "[$Product Name]: [$Charge Name] [$Bill from Date]-[$Bill to Date]",
  "BillToAccountId": 300100006084313,
  "BillToAccountNumber": "300100006084312",
  "BillToAccountDescription": "FOS_Customer01",
  "BillToSiteUseId": 300100006084331,
  "BillToAddress": "151 N Street,CHICAGO, IL 60601",
  "ShipToPartyId": null,
  "ShipToPartyName": null,
  "ShipToPartySiteId": null,
  "ShipToPartySiteName": null,
  "PaymentMethod": null,
  "PaymentMethodName": null,
  "PONumber": null,
  "WireNumber": null,
  "PaymentTermsId": 300100033038407,
  "PaymentTermsName": "2 Net",
  "PrePaymentNumber": null,
  "TaxExemptionHandling": "S",
  "TaxExemptionHandlingName": "Standard",
  "ExemptCertificateNumber": null,
  "ExemptReason": null,
  "OutputTaxClassification": null,
  "ProductFiscClassification": null,
  "TaxError": null,
  "CoverageScheduleId": null,
  "RenewalType": "RENEW",
  "BillingDateCode": "ORA_PERIOD_START",
  "BillingDateName": "Period start",
  "TotalContractValue": null,
  "EstimatedTax": null,
  "PricingError": null,
  "PriceAsOf": "2019-08-20",
  "PriceTransactionOn": "2019-08-20",
  "InvoicedAmount": null,
  "CreditedAmount": null,
  "CanceledAmount": null,
  "ClosedAmount": null,
  "SourceSystem": null,
  "SourceKey": null,
  "SourceNumber": null,
  "SourceLineKey": null,
  "SourceLineNumber": null,
  "MonthlyRecurringRevenue": null,
  "Duration": null,
  "Period": null,
  "GenerateBillingSchedule": null,
  "ExternalAssetKey": null,
  "ExternalParentAssetKey": null,
  "ExternalPriceListId": null,
  "ExternalRootAssetKey": null,
  "PriceListName": null,
  "NextPricingDate": null,
  "PricingTermsStartDate": null,
  "PricingTermsPricingMethod": null,
  "PricingTermsPeriod": null,
  "PricingTermsDuration": null,
  "PricingTermsAdjustmentPCT": null,
  "CorpCurrencyCode": "USD",
  "CurcyConvRateType": "Corporate",
  "AmendCreditMethod": null,
  "AmendCreditMethodName": null,
  "AmendDescription": null,
  "AmendEffectiveDate": null,
  "AmendReason": null,
  "AmendReasonName": null,
  "StatusMeaning": "Draft",
  "EnablePricingTermsFlag": null,
  "TaxClassificationMeaning": null,
  "CreatedBy": "SALES_ADMIN",
  "CreationDate": "2019-08-20T06:31:32+00:00",
  "LastUpdatedBy": "SALES_ADMIN",
  "LastUpdateDate": "2019-08-20T06:31:35.145+00:00",
  "LastUpdateLogin": "9062D47DF31EDAF6E0533EFDF40A2696",
  "SummarizedBillingFlag": null,
  "InterfaceOffsetDays": null,
  "CoverageName": null,
  "links": ...
}

「トップに戻る」