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

機械翻訳について

サブスクリプション製品の更新

patch

/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}

リクエスト

パス・パラメータ

SubscriptionNumber(required): string

サブスクリプションの代替識別子。
SubscriptionProductPuid(required): string

サブスクリプション製品PUID。

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

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

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

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

企業通貨コード。
CoverageName: string

タイトル: Template Name

カバレッジの名前。
CoverageScheduleId: integer (int64)

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

タイトル: Covered Levels

対象レベル・リソースは、サブスクリプション対象レベルを表示、作成、更新および削除するために使用されます。
creditCards: array Credit Cards

タイトル: Credit Cards

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

タイトル: Credited Amount

製品のクレジット金額。
CurcyConvRateType: string

最大長: 30

通貨換算レート・タイプ。
CustomerTrxTypeSequenceId: integer (int64)

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

最大長: 30

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

タイトル: Product Description

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

タイトル: Display Sequence

サブスクリプション製品の表示順序。
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: 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

品目単位。
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

サブスクリプション製品変更のスケジュール。
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

サブスクリプション製品の関連在庫品目のID。
RelatedProductDescription: string

タイトル: Description

関連する製品の説明。
RelatedProductName: string

タイトル: Product Name

最大長: 300

サブスクリプション製品の関連在庫品目の名前。
relationships: array Relationships

タイトル: Relationships

関係リソースは、サブスクリプション製品関係の表示、作成、更新および削除に使用されます。
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: 文字列(日付)

タイトル: Product Start Date

製品の開始日。
Status: string

タイトル: Status

最大長: 30

デフォルト値: DRAFT

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

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

タイトル: Subscription Number

最大長: 120

デフォルト値: Subscriptions.SubscriptionNumber

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

サブスクリプション製品の一意の識別子。
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: 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":{
        "PONumber":{
            "title":"PO Number",
            "maxLength":50,
            "type":"string",
            "description":"The PO number.",
            "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 next pricing date of the product.",
            "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.",
            "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 will be resumed.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ResumePeriod":{
            "type":"string",
            "description":"The time period after which the product will be resumed.",
            "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 from of the subscription product change.",
            "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 churn probability for 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.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-relationships-item-patch-request"
            }
        },
        "SourceKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source key.",
            "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"
            }
        },
        "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 source number.",
            "nullable":true,
            "x-queryable":false
        },
        "PricingTermsPeriod":{
            "title":"Pricing Term",
            "maxLength":15,
            "type":"string",
            "description":"The pricing terms period of the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CanceledDate":{
            "title":"Product Canceled Date",
            "type":"string",
            "description":"The date on which 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 percentage of price adjustment.",
            "nullable":true,
            "x-queryable":false
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The subscription product status.",
            "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
        },
        "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 credited amount of the product.",
            "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 payment terms name.",
            "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":"The amend description of the product.",
            "nullable":true,
            "x-queryable":false
        },
        "EstimatedTax":{
            "title":"Estimated Tax",
            "type":"number",
            "description":"The estimated tax of 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 charges for a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-charges-item-patch-request"
            }
        },
        "PricingTermsPricingMethod":{
            "title":"Pricing Method",
            "maxLength":30,
            "type":"string",
            "description":"The pricing terms pricing method of the product.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ShipToPartySiteName":{
            "title":"Ship-to Site",
            "type":"string",
            "description":"The ship-to party site name.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "serviceResources":{
            "title":"Service Resources",
            "type":"array",
            "description":"The service resources resource is used to view, create, update, and delete the service identifier for a subscription product.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-serviceResources-item-patch-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 suspension period should be auto extended.",
            "nullable":true,
            "x-queryable":false
        },
        "GracePeriod":{
            "title":"Grace Period in Days",
            "type":"integer",
            "description":"The grace period associated with the product.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AmendReasonName":{
            "type":"string",
            "description":"The amend reason name of the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InvoicedAmount":{
            "title":"Invoiced Amount",
            "type":"number",
            "description":"The invoiced amount of the product.",
            "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 output tax classification.",
            "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 of the product.",
            "nullable":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Product Description",
            "type":"string",
            "description":"The subscription product description.",
            "nullable":true,
            "x-queryable":false
        },
        "RelatedProductDescription":{
            "title":"Description",
            "type":"string",
            "description":"The related product description.",
            "nullable":true,
            "x-queryable":false
        },
        "CanceledAmount":{
            "title":"Canceled Amount",
            "type":"number",
            "description":"The canceled amount of the 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 invoice rule name.",
            "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
        },
        "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 payment method name.",
            "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 of the product.",
            "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/subscriptions-products-flexFields-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "EarlyTerminationPenaltyName":{
            "type":"string",
            "description":"The early termination penalty name.",
            "nullable":true
        },
        "BillingDateCode":{
            "title":"Billing Date Code",
            "maxLength":30,
            "type":"string",
            "description":"The billing date code.",
            "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.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-billLines-item-patch-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 total contract value.",
            "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 should be dropped while making the product change.",
            "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 view, create, update, and delete the subscription covered levels.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-item-patch-request"
            }
        },
        "CloseCreditMethod":{
            "title":"Close Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"The close credit method.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PricingTermsDuration":{
            "title":"Pricing Term Duration",
            "type":"number",
            "description":"The pricing terms duration of the product.",
            "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 end date of the product.",
            "format":"date",
            "nullable":true
        },
        "ClosedAmount":{
            "title":"Closed Amount",
            "type":"number",
            "description":"The closed amount of the product.",
            "nullable":true,
            "x-queryable":false
        },
        "RelatedProductName":{
            "title":"Product Name",
            "maxLength":300,
            "type":"string",
            "description":"The name of the related inventory item of the 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 unit price of the product.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalRootAssetKey":{
            "maxLength":120,
            "type":"string",
            "description":"The external root asset key of the product.",
            "nullable":true
        },
        "ResumeDuration":{
            "type":"integer",
            "description":"The time duration for which the product will be suspended.",
            "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 price transaction.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "GenerateBillingSchedule":{
            "title":"Generate billing schedule for full period",
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether 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 associated with the product.",
            "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 on which the product was closed.",
            "format":"date",
            "nullable":true
        },
        "SourceSystem":{
            "maxLength":30,
            "type":"string",
            "description":"The source system.",
            "nullable":true,
            "x-queryable":false
        },
        "ProductChangeReason":{
            "title":"Change Reason",
            "maxLength":300,
            "type":"string",
            "description":"The reason for the subscription 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 transaction type name.",
            "nullable":false,
            "x-queryable":false
        },
        "AmendReason":{
            "title":"Amendment Reason",
            "maxLength":30,
            "type":"string",
            "description":"The amend reason of the product.",
            "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":"The bill-to account description.",
            "nullable":true,
            "x-queryable":false
        },
        "BillToAccountNumber":{
            "title":"Billing Account",
            "type":"string",
            "description":"The bill-to account number.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "BillingDateName":{
            "type":"string",
            "description":"The billing date name.",
            "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":"The credit method used after suspension.",
            "nullable":true,
            "x-queryable":false
        },
        "StartDate":{
            "title":"Product Start Date",
            "type":"string",
            "description":"The start date of the product.",
            "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 exempt reason.",
            "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 pricing terms start date of the product.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "PriceAdjustmentBasis":{
            "title":"Price Adjustment Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis on which the price is adjusted.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RelatedInventoryItemId":{
            "title":"Related Inventory Item ID",
            "type":"integer",
            "description":"The ID of the related inventory item of the 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.",
            "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 item unit of measure.",
            "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":"The coverage schedule.",
            "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 subscription product period.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Duration":{
            "title":"Duration",
            "type":"integer",
            "description":"The duration of the product.",
            "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 renewal type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillOnDay":{
            "title":"Bill on Day",
            "type":"number",
            "description":"The bill on day.",
            "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 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 price adjustment type.",
            "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 card information associated with a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-creditCards-item-patch-request"
            }
        },
        "GenerateBillFullPeriodFlag":{
            "title":"Generate billing schedule for full period",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the billing schedule must be generated for the full period or not.",
            "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
        },
        "SalesProductType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The sales product type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AmendCreditMethod":{
            "title":"Amendment Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"The amend credit method of the product.",
            "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.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "CoverageName":{
            "title":"Template Name",
            "type":"string",
            "description":"The name of the coverage.",
            "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 ship-to party name.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ProductChangeSchedule":{
            "title":"Apply Change",
            "maxLength":30,
            "type":"string",
            "description":"The schedule for the subscription product change.",
            "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 accounting rule name.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InvoiceText":{
            "title":"Invoice Text",
            "maxLength":2000,
            "type":"string",
            "description":"The invoice text.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AmendCreditMethodName":{
            "type":"string",
            "description":"The amend credit method name of the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "NextBillStartDate":{
            "type":"string",
            "description":"The next bill start date of the product.",
            "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 amend effective date of the product.",
            "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 pricing terms adjustment of the product.",
            "nullable":true,
            "x-queryable":false
        },
        "TaxError":{
            "maxLength":2000,
            "type":"string",
            "description":"The taxation error for the product, if any.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceListName":{
            "maxLength":120,
            "type":"string",
            "description":"The price list name of the product.",
            "nullable":true,
            "x-queryable":false
        },
        "InterfaceOffsetDays":{
            "type":"integer",
            "description":"The number of offset days set by the interface.",
            "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 the 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.",
            "nullable":false,
            "default":"Subscriptions.SubscriptionNumber"
        },
        "RenewedDate":{
            "title":"Renewed On",
            "type":"string",
            "description":"The date on which 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 billing frequency name.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExemptCertificateNumber":{
            "title":"Tax Exemption Certificate Number",
            "maxLength":80,
            "type":"string",
            "description":"The exempt certificate number.",
            "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 is used to view, create, update, and delete the sales credits defined for subscription or subscription products.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-salesCredits-item-patch-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/subscriptions-products-associatedAsset-item-patch-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 related to the product.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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

タイプ: array

タイトル: Associated Assets

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

ソースを表示

Array of: object subscriptions-products-associatedAsset-item-patch-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/subscriptions-products-associatedAsset-item-patch-request"
    }
}

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

タイプ: array

タイトル: Bill Lines

請求明細リソースは、サブスクリプション請求明細詳細の表示、作成、更新および削除に使用されます。

ソースを表示

Array of: object schema

{
    "title":"Bill Lines",
    "type":"array",
    "description":"The bill lines resource is used to view, create, update, and delete the subscription bill line details.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-billLines-item-patch-request"
    }
}

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

タイプ: array

タイトル: Charges

手数料リソースは、サブスクリプションの手数料の表示、作成、更新および削除に使用されます。

ソースを表示

Array of: object subscriptions-products-charges-item-patch-request

{
    "title":"Charges",
    "type":"array",
    "description":"The charges resource is used to view, create, update, and delete the charges for a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-charges-item-patch-request"
    }
}

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

タイプ: array

タイトル: Covered Levels

対象レベル・リソースは、サブスクリプション対象レベルを表示、作成、更新および削除するために使用されます。

ソースを表示

Array of: object schema

{
    "title":"Covered Levels",
    "type":"array",
    "description":"The covered levels resource is used to view, create, update, and delete the subscription covered levels.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-item-patch-request"
    }
}

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

タイプ: array

タイトル: Credit Cards

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

ソースを表示

Array of: object subscriptions-products-creditCards-item-patch-request

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

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

タイプ: array

タイトル: Descriptive Flexfields

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

ソースを表示

Array of: object subscriptions-products-flexFields-item-patch-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/subscriptions-products-flexFields-item-patch-request"
    },
    "x-cardinality":"1"
}

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

タイプ: array

タイトル: Relationships

関係リソースは、サブスクリプション製品関係の表示、作成、更新および削除に使用されます。

ソースを表示

Array of: object subscriptions-products-relationships-item-patch-request

{
    "title":"Relationships",
    "type":"array",
    "description":"The relationships resource is used to view, create, update, and delete the subscription product relationships.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-relationships-item-patch-request"
    }
}

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

タイプ: array

タイトル: Sales Credits

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

ソースを表示

Array of: object schema

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

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

タイプ: array

タイトル: Service Resources

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

ソースを表示

Array of: object schema

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

ネストされたスキーマ : subscriptions-products-associatedAsset-item-patch-request

タイプ: object

ソースを表示

AssetName: string

タイトル: Asset Name

アセットの名前。
AssetSerialNumber: string

タイトル: Asset Serial Number

アセットのシリアル番号。
CorpCurrencyCode: string

最大長: 15

企業通貨コード。
CurcyConvRateType: string

最大長: 30

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

最大長: 15

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

在庫品目の一意の識別子。
ProductName: string

タイトル: Product Name

製品の名前。
数量: number

タイトル: Quantity

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

最大長: 120

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

最大長: 120

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

最大長: 120

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

最大長: 120

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

最大長: 30

関連付けられたアセットのソース・システム。
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"
                ]
            }
        },
        "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
        },
        "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
        },
        "SourceNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The source number of the associated asset.",
            "nullable":true
        },
        "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
        }
    }
}

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

タイプ: object

ソースを表示

金額: number

タイトル: Amount

請求の金額。
billAdjustments: array Bill Adjustments

タイトル: Bill Adjustments

請求修正リソースは、サブスクリプション請求修正詳細の表示、作成、更新および削除に使用されます。
BillingPeriod: number

タイトル: Sequence

請求期間。
BillLinePuid: string

最大長: 120

請求明細PUID。
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)

顧客トランザクション・タイプ連番の一意の識別子です。
DateBilledFrom: 文字列(日付)

タイトル: Bill-from Date

請求が完了した日付。
DateBilledTo: 文字列(日付)

タイトル: Bill-to Date

請求が完了した日付。
DateToInterface: 文字列(日付)

タイトル: Interface Date

インタフェースする日付。
InterfacedFlag: boolean

タイトル: Interfaced

最大長: 1

デフォルト値: false

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

請求書請求明細ID。
InvoiceDate: 文字列(日付)

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

タイトル: Invoice Text

最大長: 240

トランザクションの請求書テキスト。
ListPrice: number

定価。
MilestoneEventId: integer (int64)

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

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

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

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

最大長: 1000

価格設定エラー。
RecurringFlag: boolean

最大長: 1

この明細が固定処理かどうかを示します。
RevenueLineId: integer (int64)

収益明細の一意の識別子。
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)

請求に関連付けられているトランザクション識別子。
TrxLineId: integer (int64)

トランザクション明細の一意の識別子。
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 transaction identifier associated with the billing.",
            "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
        },
        "UsagePricedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether usage line has been priced or not.",
            "nullable":true
        },
        "ListPrice":{
            "type":"number",
            "description":"The list price.",
            "nullable":true
        },
        "TransactionTax":{
            "title":"Tax",
            "type":"number",
            "description":"The tax related to 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 bill line PUID.",
            "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.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-billLines-billAdjustments-item-patch-request"
            }
        },
        "BillingPeriod":{
            "title":"Sequence",
            "type":"number",
            "description":"The billing period.",
            "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.",
            "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 unique identifier of the transaction line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "UsageCaptureDate":{
            "type":"string",
            "description":"The usage capture date.",
            "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.",
            "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 alternate identifier 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":"The unique identifier of the customer transaction type sequence.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TruedUpYn":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates whether the bill line has a true up 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 invoice text of the transaction.",
            "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 charge period.",
            "nullable":true
        },
        "TransactionDate":{
            "title":"Invoice Date",
            "type":"string",
            "description":"The date of the transaction.",
            "format":"date",
            "nullable":true
        },
        "InvoiceBillLineId":{
            "type":"integer",
            "description":"The invoice bill line ID.",
            "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 of the bill.",
            "nullable":true
        },
        "DateBilledTo":{
            "title":"Bill-to Date",
            "type":"string",
            "description":"The date to which the billing is done.",
            "format":"date",
            "nullable":false
        },
        "UsageQuantity":{
            "title":"Usage Quantity",
            "type":"number",
            "description":"The usage quantity.",
            "nullable":true
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the coverage 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 of the transaction.",
            "nullable":true
        },
        "RecurringFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this line is recurring or not.",
            "nullable":false
        },
        "DateBilledFrom":{
            "title":"Bill-from Date",
            "type":"string",
            "description":"The date from which the billing is done.",
            "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 pricing error.",
            "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.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-billLines-billAdjustments-item-patch-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)

請求修正ID
BillAdjustmentPuid: string

最大長: 120

請求修正PUID
BillLineId: integer (int64)

請求明細ID
ChargeAdjustmentId: integer (int64)

手数料修正ID
CurrencyCode: string

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

最大長: 30

調整の有効性
NumberOfPeriods: number

期間数
PeriodFrom: number

期間:自
PeriodUntil: number

期間:至
Reason: string

タイトル: Reason Details

最大長: 120

調整事由
SequenceNumber: number

タイトル: Sequence

連番
SubscriptionId: integer (int64)

サブスクリプションID
SubscriptionProductId: integer (int64)

サブスクリプション製品ID

{
    "type":"object",
    "properties":{
        "BillAdjustmentId":{
            "type":"integer",
            "description":"The bill adjustment ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Flag indicating whether the adjustment is automatic or not",
            "nullable":false
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment basis",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The charge adjustment ID",
            "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 adjustment effectivity",
            "nullable":true
        },
        "Reason":{
            "title":"Reason Details",
            "maxLength":120,
            "type":"string",
            "description":"The adjustment reason",
            "nullable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment type",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CurrencyCode":{
            "type":"string",
            "description":"The currency code. 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
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The adjustment value",
            "nullable":false
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"number",
            "description":"The sequence number",
            "nullable":false
        },
        "NumberOfPeriods":{
            "type":"number",
            "description":"The number of periods",
            "nullable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The bill line ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BillAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The bill adjustment PUID",
            "nullable":false
        },
        "AdjustmentName":{
            "title":"Adjustment",
            "maxLength":120,
            "type":"string",
            "description":"The adjustment name",
            "nullable":true
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until",
            "nullable":true
        },
        "BasisEnableFlag":{
            "type":"boolean",
            "description":"Indicates if the basis has been enabled for the bill.",
            "nullable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from",
            "nullable":true
        }
    }
}

ネストされたスキーマ : subscriptions-products-charges-item-patch-request

タイプ: object

ソースを表示

adjustments: array Adjustments

タイトル: Adjustments

調整リソースは、サブスクリプション料金に対する調整の表示、作成、更新および削除に使用されます。
AggregationMethod: string

最大長: 30

手数料に使用される集計メソッド。
手当: number

タイトル: Allowance

手当
AssetMeterYn: boolean

最大長: 1

アセット・メーターかどうかを示すフラグ。
BillLineId: integer (int64)

請求明細ID
BlockSize: number

タイトル: Block Size

ブロック・サイズ
ChargeDefinition: string

タイトル: Charge Name

最大長: 30

手数料の目的を示す定義。
ChargeDefinitionName: string

手数料定義名
ChargeId: integer (int64)

手数料ID
chargeMilestoneEvents: array Charge Milestone Events

タイトル: Charge Milestone Events

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

タイトル: Charge Name

最大長: 120

手数料名
ChargePuid: string

最大長: 120

手数料PUID
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)

サブスクリプションID
SubscriptionProductId: integer (int64)

サブスクリプション製品ID
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 charge PUID",
            "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/subscriptions-products-charges-chargeMilestoneEvents-item-patch-request"
            }
        },
        "adjustments":{
            "title":"Adjustments",
            "type":"array",
            "description":"The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-charges-adjustments-item-patch-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 price periodicity name",
            "nullable":true
        },
        "PrePaymentNumber":{
            "title":"Prepayment Number",
            "type":"integer",
            "description":"The prepayment number",
            "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 unit list price",
            "nullable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number",
            "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 subscription product ID",
            "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 charge name",
            "nullable":true
        },
        "QuotedTcv":{
            "type":"number",
            "description":"The quoted TCV of the charge.",
            "nullable":true
        },
        "TieredFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"The flag indicating whether the charge has tiers",
            "nullable":true
        },
        "UsagePriceLockFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Flag indicating 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 for a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-charges-chargeTiers-item-patch-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",
            "nullable":false
        },
        "RollupFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the charges are rolled up.",
            "nullable":true
        },
        "TierType":{
            "title":"Tier Type",
            "maxLength":30,
            "type":"string",
            "description":"The tier type",
            "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 charge definition name",
            "nullable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "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 true up period.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExternalKey":{
            "maxLength":120,
            "type":"string",
            "description":"The external key",
            "nullable":true
        },
        "Allowance":{
            "title":"Allowance",
            "type":"number",
            "description":"The allowance",
            "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",
            "nullable":true
        },
        "TrueUpPeriod":{
            "title":"True Up Period",
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the true up period.",
            "nullable":true,
            "default":"ORA_OSS_USAGE_BILLING_PERIOD"
        },
        "BillLineId":{
            "type":"integer",
            "description":"The bill line ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BlockSize":{
            "title":"Block Size",
            "type":"number",
            "description":"The block size",
            "nullable":true
        }
    }
}

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

タイプ: array

タイトル: Adjustments

調整リソースは、サブスクリプション料金に対する調整の表示、作成、更新および削除に使用されます。

ソースを表示

Array of: object schema

{
    "title":"Adjustments",
    "type":"array",
    "description":"The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-charges-adjustments-item-patch-request"
    }
}

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

タイプ: array

タイトル: Charge Milestone Events

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

ソースを表示

Array of: object schema

{
    "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/subscriptions-products-charges-chargeMilestoneEvents-item-patch-request"
    }
}

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

タイプ: array

タイトル: Charge Tiers

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

ソースを表示

Array of: object subscriptions-products-charges-chargeTiers-item-patch-request

{
    "title":"Charge Tiers",
    "type":"array",
    "description":"The charge tiers resource is used to view, create, update, and delete the subscription charge tier details for a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-charges-chargeTiers-item-patch-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)

手数料修正ID
ChargeAdjustmentPuid: string

最大長: 120

手数料調整PUID
ChargeId: integer (int64)

手数料ID
Effectivity: string

タイトル: Effectivity

最大長: 30

調整の有効性
NumberOfPeriods: number

期間数
ObjectVersionNumber: 整数(int32)

オブジェクト・バージョン番号
PeriodFrom: number

期間:自
PeriodUntil: number

期間:至
Reason: string

タイトル: Reason Description

最大長: 120

調整事由
SequenceNumber: 整数(int32)

タイトル: Sequence

連番
SubscriptionId: integer (int64)

サブスクリプションID
SubscriptionProductId: integer (int64)

サブスクリプション製品ID

{
    "type":"object",
    "properties":{
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Flag indicating whether the adjustment is automatic or not",
            "nullable":true
        },
        "ChargeAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The charge adjustment PUID",
            "nullable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment basis",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The charge adjustment ID",
            "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 adjustment reason",
            "nullable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment type",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The adjustment value",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence number",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "NumberOfPeriods":{
            "type":"number",
            "description":"The number of periods",
            "nullable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until",
            "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 adjustment name",
            "nullable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from",
            "nullable":true
        }
    }
}

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

タイプ: object

ソースを表示

BillingOffset: number

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

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

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

最大長: 120

デフォルト値: Charges.ChargePuid

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

マイルストン・イベントの完了日。
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
            }
        },
        "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"
                ]
            }
        }
    }
}

ネストされたスキーマ : subscriptions-products-charges-chargeTiers-item-patch-request

タイプ: object

ソースを表示

AdditionalNumberFive: number

タイトル: Additional Number Five

追加番号5
AdditionalNumberFour: number

タイトル: Additional Number Four

追加番号4
AdditionalNumberOne: number

タイトル: Additional Number One

追加番号1
AdditionalNumberSix: number

タイトル: Additional Number Six

追加番号6
AdditionalNumberThree: number

タイトル: Additional Number Three

追加番号3
AdditionalNumberTwo: number

タイトル: Additional Number Two

追加番号2
AdditionalTextOne: string

タイトル: Additional Text One

最大長: 4000

追加テキスト1
AdditionalTextTwo: string

タイトル: Additional Text Two

最大長: 4000

追加テキスト2
AdditionalTimestampOne: string (date-time)

タイトル: Additional Time-stamp One

追加タイムスタンプ1
AdditionalTimestampThree: string (date-time)

タイトル: Additional Time-stamp Three

追加タイムスタンプ3
AdditionalTimestampTwo: string (date-time)

タイトル: Additional Time-stamp Two

追加タイムスタンプ2
AddtionalTextThree: string

タイトル: Additional Text Three

最大長: 4000

追加テキスト3
BlockSize: number

タイトル: Block Size

ブロック・サイズ
ChargeId: integer (int64)

手数料ID
ChargeTierId: integer (int64)

手数料階層ID
ChargeTierPuid: string

最大長: 120

手数料階層PUID
ListPrice: number

タイトル: List Price

定価
PriceFormat: string

タイトル: Price Format

最大長: 30

価格書式
SequenceNumber: number

連番
SubscriptionId: integer (int64)

サブスクリプションID
SubscriptionProductId: integer (int64)

サブスクリプション製品ID
TierFrom: number

タイトル: Tier From

階層:自
TierTo: number

タイトル: Tier To

階層:至

{
    "type":"object",
    "properties":{
        "ChargeTierId":{
            "type":"integer",
            "description":"The charge tier ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AdditionalTimestampTwo":{
            "title":"Additional Time-stamp Two",
            "type":"string",
            "description":"The additional timestamp two",
            "format":"date-time",
            "nullable":true
        },
        "AdditionalNumberFour":{
            "title":"Additional Number Four",
            "type":"number",
            "description":"The additional number four",
            "nullable":true
        },
        "ChargeTierPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The charge tier PUID",
            "nullable":false
        },
        "AdditionalNumberThree":{
            "title":"Additional Number Three",
            "type":"number",
            "description":"The additional number three",
            "nullable":true
        },
        "AdditionalTimestampOne":{
            "title":"Additional Time-stamp One",
            "type":"string",
            "description":"The additional timestamp one",
            "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 price format",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AdditionalTextOne":{
            "title":"Additional Text One",
            "maxLength":4000,
            "type":"string",
            "description":"The additional text one",
            "nullable":true
        },
        "AdditionalNumberFive":{
            "title":"Additional Number Five",
            "type":"number",
            "description":"The additional number five",
            "nullable":true
        },
        "AdditionalNumberSix":{
            "title":"Additional Number Six",
            "type":"number",
            "description":"The additional number six",
            "nullable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "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":"The additional text three",
            "nullable":true
        },
        "AdditionalNumberOne":{
            "title":"Additional Number One",
            "type":"number",
            "description":"The additional number one",
            "nullable":true
        },
        "SequenceNumber":{
            "type":"number",
            "description":"The sequence number",
            "nullable":false
        },
        "AdditionalTextTwo":{
            "title":"Additional Text Two",
            "maxLength":4000,
            "type":"string",
            "description":"The additional text two",
            "nullable":true
        },
        "AdditionalTimestampThree":{
            "title":"Additional Time-stamp Three",
            "type":"string",
            "description":"The additional timestamp three",
            "format":"date-time",
            "nullable":true
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "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":"The additional number two",
            "nullable":true
        }
    }
}

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

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

手数料リソースは、サブスクリプションの手数料の表示、作成、更新および削除に使用されます。
childCoveredLevels: array Child Covered Levels

タイトル: Child Covered Levels

子対象レベル・リソースは、サブスクリプションの子対象レベルを表示、作成、更新および削除するために使用されます。
ClosedAmount: number

対象レベルがクローズされた金額。
ClosedDate: 文字列(日付)

タイトル: Covered Level Close Date

対象レベルがクローズされた日付。
CloseDescription: string

タイトル: Covered Level Close Description

最大長: 2000

子対象レベルに関連付けられたクローズ摘要。
CloseReason: string

タイトル: Covered Level Close Reason

最大長: 30

対象レベルがクローズされた事由。
CorpCurrencyCode: string

最大長: 15

アカウントに関連付けられた企業通貨コード。受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
CoveredLevelName: string

タイトル: Covered Level Name

最大長: 300

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

親の対象となる親。
CoveredLevlName: string

タイトル: Covered Level Name

子対象レベルに関連付けられた対象レベルの名前。
CoveredLevlNumber: string

タイトル: Covered Level Number

子対象レベルに関連付けられた対象レベルの代替識別子。
CreditedAmount: number

対象レベルのクレジット金額。
CurcyConvRateType: string

最大長: 30

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

最大長: 15

通貨コード。有効な値のリストは、参照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

関係リソースは、サブスクリプション製品関係の表示、作成、更新および削除に使用されます。
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: 文字列(日付)

タイトル: 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

合計契約額
TypeName: string

タイトル: Covered Level Type

対象レベルに関連付けられたタイプ名。
UnitPrice: number

タイトル: Unit Price

子対象レベルに関連付けられた対象レベルの単価です。

{
    "type":"object",
    "properties":{
        "TypeName":{
            "title":"Covered Level Type",
            "type":"string",
            "description":"The type name associated with 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 child covered level.",
            "nullable":true
        },
        "ProductName":{
            "title":"Product Name",
            "type":"string",
            "description":"The name of the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "Address":{
            "title":"Address",
            "type":"string",
            "description":"The address of the party site associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "ParentCoveredLevelId":{
            "type":"integer",
            "description":"The parent level for the level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PartyName":{
            "title":"Party Name",
            "type":"string",
            "description":"The name of the party associated with child covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CancelDescription":{
            "title":"Cancellation Description",
            "maxLength":2000,
            "type":"string",
            "description":"The cancel description associated with a child covered level.",
            "nullable":true
        },
        "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
        },
        "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 total when the covered level was closed.",
            "nullable":true
        },
        "SuspendCreditMethod":{
            "maxLength":30,
            "type":"string",
            "description":"The suspend method for the credit after the covered level was closed.",
            "nullable":true
        },
        "StartDate":{
            "title":"Covered Level Start Date",
            "type":"string",
            "description":"The start date for the covered level.",
            "format":"date",
            "nullable":false
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code. 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.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-relationships-item-patch-request"
            }
        },
        "TaxAmount":{
            "type":"number",
            "description":"The amount of tax to be deducted.",
            "nullable":true
        },
        "SourceKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source key of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CloseReason":{
            "title":"Covered Level Close Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason when 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 associated with child covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CoveredLevelParentPuid":{
            "type":"string",
            "description":"The covered parent for the parent.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The source number of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "PartySiteId":{
            "type":"integer",
            "description":"The unique identifier of the party site associated with child covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CanceledDate":{
            "title":"Canceled Date",
            "type":"string",
            "description":"The date of cancellation.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ExplodeAssetHierarchy":{
            "type":"string",
            "description":"The explode hierarchy for the asset.",
            "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 account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true
        },
        "ItemUnitOfMeasure":{
            "maxLength":15,
            "type":"string",
            "description":"The unit of measure used by the item.",
            "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 credited amount for the covered level.",
            "nullable":true
        },
        "Period":{
            "maxLength":80,
            "type":"string",
            "description":"The period during which the covered level is used.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Duration":{
            "type":"integer",
            "description":"The duration for which the covered level is active.",
            "nullable":true,
            "x-queryable":false
        },
        "StatusName":{
            "title":"Status",
            "type":"string",
            "description":"The description of the status.",
            "nullable":true
        },
        "RenewalType":{
            "title":"Renewal Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of 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 universal serial number associated with the asset.",
            "nullable":true
        },
        "charges":{
            "title":"Charges",
            "type":"array",
            "description":"The charges resource is used to view, create, update, and delete the charges for a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-charges-item-patch-request"
            }
        },
        "CancelReason":{
            "title":"Cancellation Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason for cancellation.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SuppressedCreditAmount":{
            "type":"number",
            "description":"The suppressed amount for the credit.",
            "nullable":true
        },
        "PriceUnitOfMeasureName":{
            "title":"Pricing UOM",
            "type":"string",
            "description":"The name of the unit of measure.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "childCoveredLevels":{
            "title":"Child Covered Levels",
            "type":"array",
            "description":"The child covered levels resource is used to view, create, update, and delete the subscription child covered levels.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-childCoveredLevels-item-patch-request"
            }
        },
        "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 return method for the credit after the covered level was closed.",
            "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 invoiced amount.",
            "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 child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CoveredLevlNumber":{
            "title":"Covered Level Number",
            "type":"string",
            "description":"The alternate identifier of the covered level associated with child 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":"The description of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CanceledAmount":{
            "type":"number",
            "description":"The amount that was cancelled.",
            "nullable":true
        },
        "PriceAsOf":{
            "type":"string",
            "description":"The price of the covered level.",
            "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 associated with child covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "InvoiceText":{
            "maxLength":2000,
            "type":"string",
            "description":"The text to be included in the invoice.",
            "nullable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the associated subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CustomerAccountId":{
            "type":"integer",
            "description":"The unique identifier of the customer account associated with child covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaxError":{
            "maxLength":4000,
            "type":"string",
            "description":"The tax error for the covered level.",
            "nullable":true
        },
        "CustomerName":{
            "title":"Customer Account",
            "type":"string",
            "description":"The name of the customer associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceLineKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source line key of the child 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 child covered level should be repriced or not. If passed as 'true', the subscription child covered level 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.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-billLines-item-patch-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",
            "nullable":true
        },
        "SuspendReason":{
            "title":"Covered Level Suspend Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason when the covered level was suspended.",
            "nullable":true,
            "x-queryable":false
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity for which the bill line was charged.",
            "nullable":false,
            "default":1
        },
        "PriceUnitOfMeasure":{
            "maxLength":30,
            "type":"string",
            "description":"The unit of measure used by the item.",
            "nullable":true
        },
        "HierarchyTotal":{
            "type":"number",
            "description":"The total when the covered level was closed.",
            "nullable":true
        },
        "EndDate":{
            "title":"Covered Level End Date",
            "type":"string",
            "description":"The end date for the covered level.",
            "format":"date",
            "nullable":true
        },
        "ClosedAmount":{
            "type":"number",
            "description":"The amount when the covered level was closed.",
            "nullable":true
        },
        "CoveredLevlName":{
            "title":"Covered Level Name",
            "type":"string",
            "description":"The name of the covered level associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "OverrideCreditAmount":{
            "title":"Override Credit Amount",
            "type":"number",
            "description":"The override credit amount of the child covered level.",
            "nullable":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 associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "UnitPrice":{
            "title":"Unit Price",
            "type":"number",
            "description":"The unit price of the covered level associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "GenerateBillingSchedule":{
            "type":"string",
            "description":"The schedule by the bill is generated.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party associated with child covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RemoveHoldFlag":{
            "type":"boolean",
            "description":"Indicates if the covered level's hold 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":"Any errors associated with the pricing.",
            "nullable":true
        },
        "CloseDescription":{
            "title":"Covered Level Close Description",
            "maxLength":2000,
            "type":"string",
            "description":"The close description associated with a child covered level.",
            "nullable":true
        },
        "SourceSystem":{
            "maxLength":30,
            "type":"string",
            "description":"The source system of the child covered level.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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

タイプ: array

タイトル: Bill Lines

請求明細リソースは、サブスクリプション請求明細詳細の表示、作成、更新および削除に使用されます。

ソースを表示

Array of: object subscriptions-products-coveredLevels-billLines-item-patch-request

{
    "title":"Bill Lines",
    "type":"array",
    "description":"The bill lines resource is used to view, create, update, and delete the subscription bill line details.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-billLines-item-patch-request"
    }
}

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

タイプ: array

タイトル: Charges

手数料リソースは、サブスクリプションの手数料の表示、作成、更新および削除に使用されます。

ソースを表示

Array of: object subscriptions-products-coveredLevels-charges-item-patch-request

{
    "title":"Charges",
    "type":"array",
    "description":"The charges resource is used to view, create, update, and delete the charges for a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-charges-item-patch-request"
    }
}

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

タイプ: array

タイトル: Child Covered Levels

子対象レベル・リソースは、サブスクリプションの子対象レベルを表示、作成、更新および削除するために使用されます。

ソースを表示

Array of: object schema

{
    "title":"Child Covered Levels",
    "type":"array",
    "description":"The child covered levels resource is used to view, create, update, and delete the subscription child covered levels.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-childCoveredLevels-item-patch-request"
    }
}

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

タイプ: array

タイトル: Relationships

関係リソースは、サブスクリプション製品関係の表示、作成、更新および削除に使用されます。

ソースを表示

Array of: object subscriptions-products-coveredLevels-relationships-item-patch-request

{
    "title":"Relationships",
    "type":"array",
    "description":"The relationships resource is used to view, create, update, and delete the subscription product relationships.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-relationships-item-patch-request"
    }
}

ネストされたスキーマ : subscriptions-products-coveredLevels-billLines-item-patch-request

タイプ: object

ソースを表示

金額: number

タイトル: Amount

請求の金額。
billAdjustments: array Bill Adjustments

タイトル: Bill Adjustments

請求修正リソースは、サブスクリプション請求修正詳細の表示、作成、更新および削除に使用されます。
BillingPeriod: number

タイトル: Sequence

請求期間。
BillLinePuid: string

最大長: 120

請求明細PUID。
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)

顧客トランザクション・タイプ連番の一意の識別子です。
DateBilledFrom: 文字列(日付)

タイトル: Bill-from Date

請求が完了した日付。
DateBilledTo: 文字列(日付)

タイトル: Bill-to Date

請求が完了した日付。
DateToInterface: 文字列(日付)

タイトル: Interface Date

インタフェースする日付。
InterfacedFlag: boolean

タイトル: Interfaced

最大長: 1

デフォルト値: false

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

請求書請求明細ID。
InvoiceDate: 文字列(日付)

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

タイトル: Invoice Text

最大長: 240

トランザクションの請求書テキスト。
ListPrice: number

定価。
MilestoneEventId: integer (int64)

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

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

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

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

最大長: 1000

価格設定エラー。
RecurringFlag: boolean

最大長: 1

この明細が固定処理かどうかを示します。
RevenueLineId: integer (int64)

収益明細の一意の識別子。
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)

請求に関連付けられているトランザクション識別子。
TrxLineId: integer (int64)

トランザクション明細の一意の識別子。
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 transaction identifier associated with the billing.",
            "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
        },
        "UsagePricedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether usage line has been priced or not.",
            "nullable":true
        },
        "ListPrice":{
            "type":"number",
            "description":"The list price.",
            "nullable":true
        },
        "TransactionTax":{
            "title":"Tax",
            "type":"number",
            "description":"The tax related to 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 bill line PUID.",
            "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.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-billLines-billAdjustments-item-patch-request"
            }
        },
        "BillingPeriod":{
            "title":"Sequence",
            "type":"number",
            "description":"The billing period.",
            "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.",
            "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 unique identifier of the transaction line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "UsageCaptureDate":{
            "type":"string",
            "description":"The usage capture date.",
            "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.",
            "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 alternate identifier 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":"The unique identifier of the customer transaction type sequence.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TruedUpYn":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates whether the bill line has a true up 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 invoice text of the transaction.",
            "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 charge period.",
            "nullable":true
        },
        "TransactionDate":{
            "title":"Invoice Date",
            "type":"string",
            "description":"The date of the transaction.",
            "format":"date",
            "nullable":true
        },
        "InvoiceBillLineId":{
            "type":"integer",
            "description":"The invoice bill line ID.",
            "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 of the bill.",
            "nullable":true
        },
        "DateBilledTo":{
            "title":"Bill-to Date",
            "type":"string",
            "description":"The date to which the billing is done.",
            "format":"date",
            "nullable":false
        },
        "UsageQuantity":{
            "title":"Usage Quantity",
            "type":"number",
            "description":"The usage quantity.",
            "nullable":true
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the coverage 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 of the transaction.",
            "nullable":true
        },
        "RecurringFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this line is recurring or not.",
            "nullable":false
        },
        "DateBilledFrom":{
            "title":"Bill-from Date",
            "type":"string",
            "description":"The date from which the billing is done.",
            "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 pricing error.",
            "nullable":true
        }
    }
}

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

タイプ: array

タイトル: Bill Adjustments

請求修正リソースは、サブスクリプション請求修正詳細の表示、作成、更新および削除に使用されます。

ソースを表示

Array of: object subscriptions-products-coveredLevels-billLines-billAdjustments-item-patch-request

{
    "title":"Bill Adjustments",
    "type":"array",
    "description":"The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-billLines-billAdjustments-item-patch-request"
    }
}

ネストされたスキーマ : subscriptions-products-coveredLevels-billLines-billAdjustments-item-patch-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)

請求修正ID
BillAdjustmentPuid: string

最大長: 120

請求修正PUID
BillLineId: integer (int64)

請求明細ID
ChargeAdjustmentId: integer (int64)

手数料修正ID
CurrencyCode: string

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

最大長: 30

調整の有効性
NumberOfPeriods: number

期間数
PeriodFrom: number

期間:自
PeriodUntil: number

期間:至
Reason: string

タイトル: Reason Details

最大長: 120

調整事由
SequenceNumber: number

タイトル: Sequence

連番
SubscriptionId: integer (int64)

サブスクリプションID
SubscriptionProductId: integer (int64)

サブスクリプション製品ID

{
    "type":"object",
    "properties":{
        "BillAdjustmentId":{
            "type":"integer",
            "description":"The bill adjustment ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Flag indicating whether the adjustment is automatic or not",
            "nullable":false
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment basis",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The charge adjustment ID",
            "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 adjustment effectivity",
            "nullable":true
        },
        "Reason":{
            "title":"Reason Details",
            "maxLength":120,
            "type":"string",
            "description":"The adjustment reason",
            "nullable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment type",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CurrencyCode":{
            "type":"string",
            "description":"The currency code. 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
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The adjustment value",
            "nullable":false
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"number",
            "description":"The sequence number",
            "nullable":false
        },
        "NumberOfPeriods":{
            "type":"number",
            "description":"The number of periods",
            "nullable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The bill line ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BillAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The bill adjustment PUID",
            "nullable":false
        },
        "AdjustmentName":{
            "title":"Adjustment",
            "maxLength":120,
            "type":"string",
            "description":"The adjustment name",
            "nullable":true
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until",
            "nullable":true
        },
        "BasisEnableFlag":{
            "type":"boolean",
            "description":"Indicates if the basis has been enabled for the bill.",
            "nullable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from",
            "nullable":true
        }
    }
}

ネストされたスキーマ : subscriptions-products-coveredLevels-charges-item-patch-request

タイプ: object

ソースを表示

adjustments: array Adjustments

タイトル: Adjustments

調整リソースは、サブスクリプション料金に対する調整の表示、作成、更新および削除に使用されます。
AggregationMethod: string

最大長: 30

手数料に使用される集計メソッド。
手当: number

タイトル: Allowance

手当
AssetMeterYn: boolean

最大長: 1

アセット・メーターかどうかを示すフラグ。
BillLineId: integer (int64)

請求明細ID
BlockSize: number

タイトル: Block Size

ブロック・サイズ
ChargeDefinition: string

タイトル: Charge Name

最大長: 30

手数料の目的を示す定義。
ChargeDefinitionName: string

手数料定義名
ChargeId: integer (int64)

手数料ID
chargeMilestoneEvents: array Charge Milestone Events

タイトル: Charge Milestone Events

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

タイトル: Charge Name

最大長: 120

手数料名
ChargePuid: string

最大長: 120

手数料PUID
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)

サブスクリプションID
SubscriptionProductId: integer (int64)

サブスクリプション製品ID
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 charge PUID",
            "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/subscriptions-products-coveredLevels-charges-chargeMilestoneEvents-item-patch-request"
            }
        },
        "adjustments":{
            "title":"Adjustments",
            "type":"array",
            "description":"The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-charges-adjustments-item-patch-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 price periodicity name",
            "nullable":true
        },
        "PrePaymentNumber":{
            "title":"Prepayment Number",
            "type":"integer",
            "description":"The prepayment number",
            "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 unit list price",
            "nullable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number",
            "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 subscription product ID",
            "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 charge name",
            "nullable":true
        },
        "QuotedTcv":{
            "type":"number",
            "description":"The quoted TCV of the charge.",
            "nullable":true
        },
        "TieredFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"The flag indicating whether the charge has tiers",
            "nullable":true
        },
        "UsagePriceLockFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Flag indicating 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 for a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-charges-chargeTiers-item-patch-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",
            "nullable":false
        },
        "RollupFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the charges are rolled up.",
            "nullable":true
        },
        "TierType":{
            "title":"Tier Type",
            "maxLength":30,
            "type":"string",
            "description":"The tier type",
            "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 charge definition name",
            "nullable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "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 true up period.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExternalKey":{
            "maxLength":120,
            "type":"string",
            "description":"The external key",
            "nullable":true
        },
        "Allowance":{
            "title":"Allowance",
            "type":"number",
            "description":"The allowance",
            "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",
            "nullable":true
        },
        "TrueUpPeriod":{
            "title":"True Up Period",
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the true up period.",
            "nullable":true,
            "default":"ORA_OSS_USAGE_BILLING_PERIOD"
        },
        "BillLineId":{
            "type":"integer",
            "description":"The bill line ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BlockSize":{
            "title":"Block Size",
            "type":"number",
            "description":"The block size",
            "nullable":true
        }
    }
}

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

タイプ: array

タイトル: Adjustments

調整リソースは、サブスクリプション料金に対する調整の表示、作成、更新および削除に使用されます。

ソースを表示

Array of: object subscriptions-products-coveredLevels-charges-adjustments-item-patch-request

{
    "title":"Adjustments",
    "type":"array",
    "description":"The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-charges-adjustments-item-patch-request"
    }
}

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

タイプ: array

タイトル: Charge Milestone Events

ソースを表示

Array of: object subscriptions-products-coveredLevels-charges-chargeMilestoneEvents-item-patch-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/subscriptions-products-coveredLevels-charges-chargeMilestoneEvents-item-patch-request"
    }
}

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

タイプ: array

タイトル: Charge Tiers

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

ソースを表示

Array of: object subscriptions-products-coveredLevels-charges-chargeTiers-item-patch-request

{
    "title":"Charge Tiers",
    "type":"array",
    "description":"The charge tiers resource is used to view, create, update, and delete the subscription charge tier details for a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-charges-chargeTiers-item-patch-request"
    }
}

ネストされたスキーマ : subscriptions-products-coveredLevels-charges-adjustments-item-patch-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)

手数料修正ID
ChargeAdjustmentPuid: string

最大長: 120

手数料調整PUID
ChargeId: integer (int64)

手数料ID
Effectivity: string

タイトル: Effectivity

最大長: 30

調整の有効性
NumberOfPeriods: number

期間数
ObjectVersionNumber: 整数(int32)

オブジェクト・バージョン番号
PeriodFrom: number

期間:自
PeriodUntil: number

期間:至
Reason: string

タイトル: Reason Description

最大長: 120

調整事由
SequenceNumber: 整数(int32)

タイトル: Sequence

連番
SubscriptionId: integer (int64)

サブスクリプションID
SubscriptionProductId: integer (int64)

サブスクリプション製品ID

{
    "type":"object",
    "properties":{
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Flag indicating whether the adjustment is automatic or not",
            "nullable":true
        },
        "ChargeAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The charge adjustment PUID",
            "nullable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment basis",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The charge adjustment ID",
            "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 adjustment reason",
            "nullable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment type",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The adjustment value",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence number",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "NumberOfPeriods":{
            "type":"number",
            "description":"The number of periods",
            "nullable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until",
            "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 adjustment name",
            "nullable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from",
            "nullable":true
        }
    }
}

ネストされたスキーマ : subscriptions-products-coveredLevels-charges-chargeMilestoneEvents-item-patch-request

タイプ: object

ソースを表示

BillingOffset: number

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

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

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

最大長: 120

デフォルト値: Charges.ChargePuid

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

マイルストン・イベントの完了日。
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
            }
        },
        "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"
                ]
            }
        }
    }
}

ネストされたスキーマ : subscriptions-products-coveredLevels-charges-chargeTiers-item-patch-request

タイプ: object

ソースを表示

AdditionalNumberFive: number

タイトル: Additional Number Five

追加番号5
AdditionalNumberFour: number

タイトル: Additional Number Four

追加番号4
AdditionalNumberOne: number

タイトル: Additional Number One

追加番号1
AdditionalNumberSix: number

タイトル: Additional Number Six

追加番号6
AdditionalNumberThree: number

タイトル: Additional Number Three

追加番号3
AdditionalNumberTwo: number

タイトル: Additional Number Two

追加番号2
AdditionalTextOne: string

タイトル: Additional Text One

最大長: 4000

追加テキスト1
AdditionalTextTwo: string

タイトル: Additional Text Two

最大長: 4000

追加テキスト2
AdditionalTimestampOne: string (date-time)

タイトル: Additional Time-stamp One

追加タイムスタンプ1
AdditionalTimestampThree: string (date-time)

タイトル: Additional Time-stamp Three

追加タイムスタンプ3
AdditionalTimestampTwo: string (date-time)

タイトル: Additional Time-stamp Two

追加タイムスタンプ2
AddtionalTextThree: string

タイトル: Additional Text Three

最大長: 4000

追加テキスト3
BlockSize: number

タイトル: Block Size

ブロック・サイズ
ChargeId: integer (int64)

手数料ID
ChargeTierId: integer (int64)

手数料階層ID
ChargeTierPuid: string

最大長: 120

手数料階層PUID
ListPrice: number

タイトル: List Price

定価
PriceFormat: string

タイトル: Price Format

最大長: 30

価格書式
SequenceNumber: number

連番
SubscriptionId: integer (int64)

サブスクリプションID
SubscriptionProductId: integer (int64)

サブスクリプション製品ID
TierFrom: number

タイトル: Tier From

階層:自
TierTo: number

タイトル: Tier To

階層:至

{
    "type":"object",
    "properties":{
        "ChargeTierId":{
            "type":"integer",
            "description":"The charge tier ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AdditionalTimestampTwo":{
            "title":"Additional Time-stamp Two",
            "type":"string",
            "description":"The additional timestamp two",
            "format":"date-time",
            "nullable":true
        },
        "AdditionalNumberFour":{
            "title":"Additional Number Four",
            "type":"number",
            "description":"The additional number four",
            "nullable":true
        },
        "ChargeTierPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The charge tier PUID",
            "nullable":false
        },
        "AdditionalNumberThree":{
            "title":"Additional Number Three",
            "type":"number",
            "description":"The additional number three",
            "nullable":true
        },
        "AdditionalTimestampOne":{
            "title":"Additional Time-stamp One",
            "type":"string",
            "description":"The additional timestamp one",
            "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 price format",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AdditionalTextOne":{
            "title":"Additional Text One",
            "maxLength":4000,
            "type":"string",
            "description":"The additional text one",
            "nullable":true
        },
        "AdditionalNumberFive":{
            "title":"Additional Number Five",
            "type":"number",
            "description":"The additional number five",
            "nullable":true
        },
        "AdditionalNumberSix":{
            "title":"Additional Number Six",
            "type":"number",
            "description":"The additional number six",
            "nullable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "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":"The additional text three",
            "nullable":true
        },
        "AdditionalNumberOne":{
            "title":"Additional Number One",
            "type":"number",
            "description":"The additional number one",
            "nullable":true
        },
        "SequenceNumber":{
            "type":"number",
            "description":"The sequence number",
            "nullable":false
        },
        "AdditionalTextTwo":{
            "title":"Additional Text Two",
            "maxLength":4000,
            "type":"string",
            "description":"The additional text two",
            "nullable":true
        },
        "AdditionalTimestampThree":{
            "title":"Additional Time-stamp Three",
            "type":"string",
            "description":"The additional timestamp three",
            "format":"date-time",
            "nullable":true
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "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":"The additional number two",
            "nullable":true
        }
    }
}

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

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

アセットに関連付けられたユニバーサル・シリアル番号。
CalculatedCreditAmount: number

タイトル: Calculated Credit Amount

子対象レベルの計算済貸方金額。
CancelDescription: string

タイトル: Cancellation Description

最大長: 2000

子対象レベルに関連付けられた取消摘要。
CanceledAmount: number

取り消された金額。
CanceledDate: 文字列(日付)

タイトル: Canceled Date

取消日。
CancelReason: string

タイトル: Cancellation Reason

最大長: 30

取消の事由。
ClosedAmount: number

対象レベルがクローズされた金額。
ClosedDate: 文字列(日付)

タイトル: Covered Level Close Date

対象レベルがクローズされた日付。
CloseDescription: string

タイトル: Covered Level Close Description

最大長: 2000

子対象レベルに関連付けられたクローズ摘要。
CloseReason: string

タイトル: Covered Level Close Reason

最大長: 30

対象レベルがクローズされた事由。
CorpCurrencyCode: string

最大長: 15

アカウントに関連付けられた企業通貨コード。受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
CoveredLevelName: string

タイトル: Covered Level Name

最大長: 300

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

親の対象となる親。
CoveredLevlName: string

タイトル: Covered Level Name

子対象レベルに関連付けられた対象レベルの名前。
CoveredLevlNumber: string

タイトル: Covered Level Number

子対象レベルに関連付けられた対象レベルの代替識別子。
CreditedAmount: number

対象レベルのクレジット金額。
CurcyConvRateType: string

最大長: 30

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

最大長: 15

通貨コード。有効な値のリストは、参照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

請求明細が請求された数量。
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: 文字列(日付)

タイトル: 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

合計契約額
TypeName: string

タイトル: Covered Level Type

対象レベルに関連付けられたタイプ名。
UnitPrice: number

タイトル: Unit Price

子対象レベルに関連付けられた対象レベルの単価です。

{
    "type":"object",
    "properties":{
        "TypeName":{
            "title":"Covered Level Type",
            "type":"string",
            "description":"The type name associated with 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 child covered level.",
            "nullable":true
        },
        "ProductName":{
            "title":"Product Name",
            "type":"string",
            "description":"The name of the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "Address":{
            "title":"Address",
            "type":"string",
            "description":"The address of the party site associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "ParentCoveredLevelId":{
            "type":"integer",
            "description":"The parent level for the level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PartyName":{
            "title":"Party Name",
            "type":"string",
            "description":"The name of the party associated with child covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CancelDescription":{
            "title":"Cancellation Description",
            "maxLength":2000,
            "type":"string",
            "description":"The cancel description associated with a child covered level.",
            "nullable":true
        },
        "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
        },
        "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 total when the covered level was closed.",
            "nullable":true
        },
        "SuspendCreditMethod":{
            "maxLength":30,
            "type":"string",
            "description":"The suspend method for the credit after the covered level was closed.",
            "nullable":true
        },
        "StartDate":{
            "title":"Covered Level Start Date",
            "type":"string",
            "description":"The start date for the covered level.",
            "format":"date",
            "nullable":false
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code. 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
            }
        },
        "TaxAmount":{
            "type":"number",
            "description":"The amount of tax to be deducted.",
            "nullable":true
        },
        "SourceKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source key of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CloseReason":{
            "title":"Covered Level Close Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason when 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 associated with child covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CoveredLevelParentPuid":{
            "type":"string",
            "description":"The covered parent for the parent.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The source number of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "PartySiteId":{
            "type":"integer",
            "description":"The unique identifier of the party site associated with child covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CanceledDate":{
            "title":"Canceled Date",
            "type":"string",
            "description":"The date of cancellation.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ExplodeAssetHierarchy":{
            "type":"string",
            "description":"The explode hierarchy for the asset.",
            "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 account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true
        },
        "ItemUnitOfMeasure":{
            "maxLength":15,
            "type":"string",
            "description":"The unit of measure used by the item.",
            "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 credited amount for the covered level.",
            "nullable":true
        },
        "Period":{
            "maxLength":80,
            "type":"string",
            "description":"The period during which the covered level is used.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Duration":{
            "type":"integer",
            "description":"The duration for which the covered level is active.",
            "nullable":true,
            "x-queryable":false
        },
        "StatusName":{
            "title":"Status",
            "type":"string",
            "description":"The description of the status.",
            "nullable":true
        },
        "RenewalType":{
            "title":"Renewal Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of 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 universal serial number associated with the asset.",
            "nullable":true
        },
        "CancelReason":{
            "title":"Cancellation Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason for cancellation.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SuppressedCreditAmount":{
            "type":"number",
            "description":"The suppressed amount for the credit.",
            "nullable":true
        },
        "PriceUnitOfMeasureName":{
            "title":"Pricing UOM",
            "type":"string",
            "description":"The 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 return method for the credit after the covered level was closed.",
            "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 invoiced amount.",
            "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 child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CoveredLevlNumber":{
            "title":"Covered Level Number",
            "type":"string",
            "description":"The alternate identifier of the covered level associated with child 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":"The description of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CanceledAmount":{
            "type":"number",
            "description":"The amount that was cancelled.",
            "nullable":true
        },
        "PriceAsOf":{
            "type":"string",
            "description":"The price of the covered level.",
            "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 associated with child covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "InvoiceText":{
            "maxLength":2000,
            "type":"string",
            "description":"The text to be included in the invoice.",
            "nullable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the associated subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CustomerAccountId":{
            "type":"integer",
            "description":"The unique identifier of the customer account associated with child covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaxError":{
            "maxLength":4000,
            "type":"string",
            "description":"The tax error for the covered level.",
            "nullable":true
        },
        "CustomerName":{
            "title":"Customer Account",
            "type":"string",
            "description":"The name of the customer associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceLineKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source line key of the child 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 child covered level should be repriced or not. If passed as 'true', the subscription child covered level will be repriced.",
            "nullable":true,
            "x-queryable":false
        },
        "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",
            "nullable":true
        },
        "SuspendReason":{
            "title":"Covered Level Suspend Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason when the covered level was suspended.",
            "nullable":true,
            "x-queryable":false
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity for which the bill line was charged.",
            "nullable":false,
            "default":1
        },
        "PriceUnitOfMeasure":{
            "maxLength":30,
            "type":"string",
            "description":"The unit of measure used by the item.",
            "nullable":true
        },
        "HierarchyTotal":{
            "type":"number",
            "description":"The total when the covered level was closed.",
            "nullable":true
        },
        "EndDate":{
            "title":"Covered Level End Date",
            "type":"string",
            "description":"The end date for the covered level.",
            "format":"date",
            "nullable":true
        },
        "ClosedAmount":{
            "type":"number",
            "description":"The amount when the covered level was closed.",
            "nullable":true
        },
        "CoveredLevlName":{
            "title":"Covered Level Name",
            "type":"string",
            "description":"The name of the covered level associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "OverrideCreditAmount":{
            "title":"Override Credit Amount",
            "type":"number",
            "description":"The override credit amount of the child covered level.",
            "nullable":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 associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "UnitPrice":{
            "title":"Unit Price",
            "type":"number",
            "description":"The unit price of the covered level associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "GenerateBillingSchedule":{
            "type":"string",
            "description":"The schedule by the bill is generated.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party associated with child covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RemoveHoldFlag":{
            "type":"boolean",
            "description":"Indicates if the covered level's hold 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":"Any errors associated with the pricing.",
            "nullable":true
        },
        "CloseDescription":{
            "title":"Covered Level Close Description",
            "maxLength":2000,
            "type":"string",
            "description":"The close description associated with a child covered level.",
            "nullable":true
        },
        "SourceSystem":{
            "maxLength":30,
            "type":"string",
            "description":"The source system of the child covered level.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

ネストされたスキーマ : subscriptions-products-coveredLevels-relationships-item-patch-request

タイプ: object

ソースを表示

OperationLinksPuid: string

最大長: 120

操作によってPUIDがリンクされます。
SourceAssetKey: string

最大長: 120

ソース・アセット・キー。
SourceProdAssociationId: integer (int64)

ソース製品関連の一意の識別子。
SourceProdAssociationPuid: string

最大長: 120

ソース製品関連PUID。
SourceProductPuid: string

最大長: 120

ソース製品PUID。
SourceRootAssetKey: string

最大長: 120

ソース・ルート・アセット・キー。
TargetProdAssociationId: integer (int64)

ターゲット製品関連の一意の識別子。
TargetProdAssociationPuid: string

最大長: 120

ターゲット製品関連PUID。
TargetProductPuid: string

最大長: 120

ターゲット製品PUID。

{
    "type":"object",
    "properties":{
        "OperationLinksPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The operation links PUID.",
            "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 source product PUID.",
            "nullable":true
        },
        "SourceRootAssetKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source root asset key.",
            "nullable":true
        },
        "SourceProdAssociationPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The source product association PUID.",
            "nullable":true
        },
        "TargetProductPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The target product PUID.",
            "nullable":true
        },
        "TargetProdAssociationPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The target product association PUID.",
            "nullable":true
        }
    }
}

ネストされたスキーマ : subscriptions-products-creditCards-item-patch-request

タイプ: object

ソースを表示

AddToBillingAccountFlag: boolean

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

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

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

タイトル: Cardholder Name

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

最大長: 120

クレジット・カードPUID。
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 assignment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "CreditCardPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The credit card PUID.",
            "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 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
        },
        "Notes":{
            "title":"Notes",
            "maxLength":300,
            "type":"string",
            "description":"The notes associated with the credit card.",
            "nullable":true
        }
    }
}

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

ネストされたスキーマ : subscriptions-products-relationships-item-patch-request

タイプ: object

ソースを表示

OperationLinksPuid: string

最大長: 120

操作によってPUIDがリンクされます。
SourceAssetKey: string

最大長: 120

ソース・アセット・キー。
SourceProdAssociationId: integer (int64)

ソース製品関連の一意の識別子。
SourceProdAssociationPuid: string

最大長: 120

ソース製品関連PUID。
SourceProductPuid: string

最大長: 120

ソース製品PUID。
SourceRootAssetKey: string

最大長: 120

ソース・ルート・アセット・キー。
TargetProdAssociationId: integer (int64)

ターゲット製品関連の一意の識別子。
TargetProdAssociationPuid: string

最大長: 120

ターゲット製品関連PUID。
TargetProductPuid: string

最大長: 120

ターゲット製品PUID。

{
    "type":"object",
    "properties":{
        "OperationLinksPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The operation links PUID.",
            "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 source product PUID.",
            "nullable":true
        },
        "SourceRootAssetKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source root asset key.",
            "nullable":true
        },
        "SourceProdAssociationPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The source product association PUID.",
            "nullable":true
        },
        "TargetProductPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The target product PUID.",
            "nullable":true
        },
        "TargetProdAssociationPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The target product association PUID.",
            "nullable":true
        }
    }
}

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

タイプ: object

ソースを表示

EndDate: 文字列(日付)

クレジット・カードが無効になる日付。
パーセント: number

販売実績のパーセント。
SalesCreditId: integer (int64)

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

最大長: 120

販売実績PUID。
SalesCreditTypeId: integer (int64)

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

営業担当。
SalesPersonNumber: string

タイトル: Salesperson Number

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

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

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

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

サブスクリプション製品ID。

{
    "type":"object",
    "properties":{
        "StartDate":{
            "type":"string",
            "description":"The date when the sales credit starts.",
            "format":"date",
            "nullable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Percentage":{
            "type":"number",
            "description":"The percentage of sales credit.",
            "nullable":false,
            "x-hints":{
                "precision":5,
                "scale":2
            }
        },
        "SalesPerson":{
            "type":"string",
            "description":"The sales person.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "SalesCreditPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The sales credit PUID.",
            "nullable":false
        },
        "SalesCreditTypeId":{
            "type":"integer",
            "description":"The unique identifier of the sales credit type.",
            "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
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EndDate":{
            "type":"string",
            "description":"The date when the credit card becomes invalid.",
            "format":"date",
            "nullable":true
        },
        "SalesCreditId":{
            "type":"integer",
            "description":"The unique identifier of the sales credit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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

タイプ: 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のデフォルト・バージョンを選択します。

ルート・スキーマ : subscriptions-products-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

企業通貨コード。
CoverageName: string

タイトル: Template Name

カバレッジの名前。
CoverageScheduleId: integer (int64)

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

タイトル: Covered Levels

対象レベル・リソースは、サブスクリプション対象レベルを表示、作成、更新および削除するために使用されます。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

製品を作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

製品が作成された日付。
creditCards: array Credit Cards

タイトル: Credit Cards

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

タイトル: Credited Amount

製品のクレジット金額。
CurcyConvRateType: string

最大長: 30

通貨換算レート・タイプ。
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のソース文書タイプの一意の識別子。
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

サブスクリプション製品変更のスケジュール。
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

サブスクリプション製品の関連在庫品目のID。
RelatedProductDescription: string

タイトル: Description

関連する製品の説明。
RelatedProductName: string

タイトル: Product Name

最大長: 300

サブスクリプション製品の関連在庫品目の名前。
relationships: array Relationships

タイトル: Relationships

関係リソースは、サブスクリプション製品関係の表示、作成、更新および削除に使用されます。
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

サブスクリプション製品PUID。
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 next pricing date of the product.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "CurcyConvRateType":{
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion 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 will be resumed.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ChurnProbability":{
            "title":"Churn Probability",
            "type":"number",
            "description":"The churn probability for the product.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source key.",
            "nullable":true,
            "x-queryable":false
        },
        "Currency":{
            "maxLength":15,
            "type":"string",
            "description":"The subscription product currency.",
            "nullable":false,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the product.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The subscription product status.",
            "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 product.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SubscriptionProductPuid":{
            "title":"Subscription Product Number",
            "maxLength":120,
            "type":"string",
            "description":"The subscription product PUID.",
            "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 credited amount of the product.",
            "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 payment terms name.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AmendDescription":{
            "title":"Amendment Description",
            "maxLength":300,
            "type":"string",
            "description":"The amend description of 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,
            "x-queryable":true
        },
        "charges":{
            "title":"Charges",
            "type":"array",
            "description":"The charges resource is used to view, create, update, and delete the charges for a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-charges-item-response"
            }
        },
        "ShipToPartySiteName":{
            "title":"Ship-to Site",
            "type":"string",
            "description":"The ship-to party site name.",
            "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 suspension period should be auto extended.",
            "nullable":true,
            "x-queryable":false
        },
        "GracePeriod":{
            "title":"Grace Period in Days",
            "type":"integer",
            "description":"The grace period associated with the product.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AmendReasonName":{
            "type":"string",
            "description":"The amend reason name of the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OutputTaxClassification":{
            "maxLength":50,
            "type":"string",
            "description":"The output tax classification.",
            "nullable":true,
            "x-queryable":false
        },
        "MonthlyRecurringRevenue":{
            "title":"MRR",
            "type":"number",
            "description":"The monthly recurring revenue of the product.",
            "nullable":true,
            "x-queryable":false
        },
        "CanceledAmount":{
            "title":"Canceled Amount",
            "type":"number",
            "description":"The canceled amount of the product.",
            "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 tax classification meaning.",
            "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 billing date code.",
            "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.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-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 pricing terms duration of the product.",
            "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 end date of the product.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentTypeId":{
            "title":"Document Type",
            "type":"integer",
            "description":"The unique 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 closed amount of the product.",
            "nullable":true,
            "x-queryable":false
        },
        "RelatedProductName":{
            "title":"Product Name",
            "maxLength":300,
            "type":"string",
            "description":"The name of the related inventory item of the 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 unit price of the product.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalRootAssetKey":{
            "maxLength":120,
            "type":"string",
            "description":"The external root asset key of the product.",
            "nullable":true,
            "x-queryable":true
        },
        "ResumeDuration":{
            "type":"integer",
            "description":"The time duration for which the product will be suspended.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceTransactionOn":{
            "type":"string",
            "description":"The price transaction.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "GenerateBillingSchedule":{
            "title":"Generate billing schedule for full period",
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether 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 product was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AmendReason":{
            "title":"Amendment Reason",
            "maxLength":30,
            "type":"string",
            "description":"The amend reason of the product.",
            "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 bill-to account number.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "BillingDateName":{
            "type":"string",
            "description":"The billing date name.",
            "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 ID of the related inventory item of the 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":"The duration of the product.",
            "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 renewal type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PriceAdjustmentType":{
            "title":"Price Adjustment Type",
            "maxLength":30,
            "type":"string",
            "description":"The price adjustment type.",
            "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 sales product type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PriceAsOf":{
            "title":"Price as of Date",
            "type":"string",
            "description":"The price of the product.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "CoverageName":{
            "title":"Template Name",
            "type":"string",
            "description":"The name of the coverage.",
            "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 schedule for the subscription product change.",
            "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 accounting rule name.",
            "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 pricing terms adjustment of the product.",
            "nullable":true,
            "x-queryable":false
        },
        "TaxError":{
            "maxLength":2000,
            "type":"string",
            "description":"The taxation error for the product, if any.",
            "nullable":true,
            "x-queryable":false
        },
        "InterfaceOffsetDays":{
            "type":"integer",
            "description":"The number of offset days set by the interface.",
            "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 the 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.",
            "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 exempt certificate number.",
            "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 status meaning of the product.",
            "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/subscriptions-products-associatedAsset-item-response"
            }
        },
        "PONumber":{
            "title":"PO Number",
            "maxLength":50,
            "type":"string",
            "description":"The PO number.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PaymentMethod"
                ]
            }
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the product 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 time period after which the product will be resumed.",
            "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 from of the subscription product change.",
            "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.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-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 if the product uses summarized billing.",
            "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 source number.",
            "nullable":true,
            "x-queryable":false
        },
        "PricingTermsPeriod":{
            "title":"Pricing Term",
            "maxLength":15,
            "type":"string",
            "description":"The pricing terms period of the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CanceledDate":{
            "title":"Product Canceled Date",
            "type":"string",
            "description":"The date on which 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 percentage of price adjustment.",
            "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 of 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 pricing terms pricing method of the product.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "serviceResources":{
            "title":"Service Resources",
            "type":"array",
            "description":"The service resources resource is used to view, create, update, and delete the service identifier for a subscription product.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-serviceResources-item-response"
            }
        },
        "InvoicedAmount":{
            "title":"Invoiced Amount",
            "type":"number",
            "description":"The invoiced amount of the product.",
            "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":"The subscription product description.",
            "nullable":true,
            "x-queryable":false
        },
        "RelatedProductDescription":{
            "title":"Description",
            "type":"string",
            "description":"The related product description.",
            "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 invoice rule name.",
            "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.",
            "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 payment method name.",
            "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 of the product.",
            "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/subscriptions-products-flexFields-item-response"
            },
            "x-cardinality":"1"
        },
        "EarlyTerminationPenaltyName":{
            "type":"string",
            "description":"The early termination penalty name.",
            "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 total contract value.",
            "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 should be dropped while making the product change.",
            "nullable":true,
            "x-queryable":false
        },
        "coveredLevels":{
            "title":"Covered Levels",
            "type":"array",
            "description":"The covered levels resource is used to view, create, update, and delete the subscription covered levels.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-item-response"
            }
        },
        "CloseCreditMethod":{
            "title":"Close Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"The close credit method.",
            "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 associated with the product.",
            "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 on which the product was closed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "maxLength":30,
            "type":"string",
            "description":"The source system.",
            "nullable":true,
            "x-queryable":false
        },
        "ProductChangeReason":{
            "title":"Change Reason",
            "maxLength":300,
            "type":"string",
            "description":"The reason for the subscription product change.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TransactionTypeName":{
            "title":"Transaction Type",
            "maxLength":30,
            "type":"string",
            "description":"The transaction type name.",
            "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":"The bill-to account description.",
            "nullable":true,
            "x-queryable":false
        },
        "SuspendCreditMethod":{
            "title":"Suspend Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"The credit method used after suspension.",
            "nullable":true,
            "x-queryable":false
        },
        "StartDate":{
            "title":"Product Start Date",
            "type":"string",
            "description":"The start date of the product.",
            "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 exempt reason.",
            "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 pricing terms start date of the product.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "PriceAdjustmentBasis":{
            "title":"Price Adjustment Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis on 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.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemUnitOfMeasure":{
            "title":"Pricing UOM Code",
            "maxLength":15,
            "type":"string",
            "description":"The item unit of measure.",
            "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":"The coverage schedule.",
            "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 subscription product period.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillOnDay":{
            "title":"Bill on Day",
            "type":"number",
            "description":"The bill on day.",
            "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 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 card information associated with a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-creditCards-item-response"
            }
        },
        "GenerateBillFullPeriodFlag":{
            "title":"Generate billing schedule for full period",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the billing schedule must be generated for the full period or not.",
            "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 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 amend credit method of the product.",
            "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 ship-to party name.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "InvoiceText":{
            "title":"Invoice Text",
            "maxLength":2000,
            "type":"string",
            "description":"The invoice text.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AmendCreditMethodName":{
            "type":"string",
            "description":"The amend credit method name of the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "NextBillStartDate":{
            "type":"string",
            "description":"The next bill start date of the product.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "AmendEffectiveDate":{
            "title":"Amendment Effective Date",
            "type":"string",
            "description":"The amend effective date of the product.",
            "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 price list name of the product.",
            "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 on which 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 billing frequency name.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "salesCredits":{
            "title":"Sales Credits",
            "type":"array",
            "description":"The sales credits resource is used to view, create, update, and delete the sales credits defined for subscription or subscription products.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-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 related to the product.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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

タイプ: array

タイトル: Associated Assets

ソースを表示

Array of: object subscriptions-products-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/subscriptions-products-associatedAsset-item-response"
    }
}

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

タイプ: array

タイトル: Bill Lines

請求明細リソースは、サブスクリプション請求明細詳細の表示、作成、更新および削除に使用されます。

ソースを表示

Array of: object subscriptions-products-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.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-billLines-item-response"
    }
}

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

タイプ: array

タイトル: Charges

手数料リソースは、サブスクリプションの手数料の表示、作成、更新および削除に使用されます。

ソースを表示

Array of: object subscriptions-products-charges-item-response

{
    "title":"Charges",
    "type":"array",
    "description":"The charges resource is used to view, create, update, and delete the charges for a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-charges-item-response"
    }
}

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

タイプ: array

タイトル: Covered Levels

対象レベル・リソースは、サブスクリプション対象レベルを表示、作成、更新および削除するために使用されます。

ソースを表示

Array of: object subscriptions-products-coveredLevels-item-response

{
    "title":"Covered Levels",
    "type":"array",
    "description":"The covered levels resource is used to view, create, update, and delete the subscription covered levels.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-item-response"
    }
}

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

タイプ: array

タイトル: Credit Cards

ソースを表示

Array of: object subscriptions-products-creditCards-item-response

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

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

タイプ: array

タイトル: Descriptive Flexfields

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

ソースを表示

Array of: object subscriptions-products-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/subscriptions-products-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 subscriptions-products-relationships-item-response

{
    "title":"Relationships",
    "type":"array",
    "description":"The relationships resource is used to view, create, update, and delete the subscription product relationships.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-relationships-item-response"
    }
}

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

タイプ: array

タイトル: Sales Credits

ソースを表示

Array of: object subscriptions-products-salesCredits-item-response

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

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

タイプ: array

タイトル: Service Resources

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

ソースを表示

Array of: object subscriptions-products-serviceResources-item-response

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

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

ネストされたスキーマ : subscriptions-products-billLines-item-response

タイプ: object

ソースを表示

金額: number

タイトル: Amount

請求の金額。
billAdjustments: array Bill Adjustments

タイトル: Bill Adjustments

請求修正リソースは、サブスクリプション請求修正詳細の表示、作成、更新および削除に使用されます。
BillingPeriod: number

タイトル: Sequence

請求期間。
BillLineId: integer (int64)

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

最大長: 120

請求明細PUID。
BusinessUnitId: integer

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

最大長: 30

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

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

タイトル: Charge Name

最大長: 120

手数料の名前。
ChargePeriod: number

タイトル: Period

課金期間。
ChargePeriodFactor: number

請求明細に関連付けられた変更期間ファクタ。
ChargePuid: string

読取り専用: true

手数料PUID。
CoveredLevelId: integer (int64)

カバレッジ・レベルの一意の識別子。
CreatedBy: string

読取り専用: true

最大長: 64

請求明細を作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

請求明細が作成された日付。
CreditMemoAmount: number

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

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

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

最大長: 30

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

顧客トランザクション・タイプ連番の一意の識別子です。
DateBilledFrom: 文字列(日付)

タイトル: Bill-from Date

請求が完了した日付。
DateBilledTo: 文字列(日付)

タイトル: Bill-to Date

請求が完了した日付。
DateToInterface: 文字列(日付)

タイトル: Interface Date

インタフェースする日付。
InterfacedFlag: boolean

タイトル: Interfaced

最大長: 1

デフォルト値: false

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

請求書請求明細ID。
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)

請求に関連付けられているトランザクション識別子。
TrxLineId: integer (int64)

トランザクション明細の一意の識別子。
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 transaction identifier associated with the billing.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the bill 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 charge PUID.",
            "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 usage line has been priced or not.",
            "nullable":true,
            "x-queryable":true
        },
        "ListPrice":{
            "type":"number",
            "description":"The list price.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionTax":{
            "title":"Tax",
            "type":"number",
            "description":"The tax related to 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 bill line PUID.",
            "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 bill 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.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-billLines-billAdjustments-item-response"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the bill line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillingPeriod":{
            "title":"Sequence",
            "type":"number",
            "description":"The billing period.",
            "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.",
            "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 unique identifier of the transaction line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UsageCaptureDate":{
            "type":"string",
            "description":"The usage capture date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the bill 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.",
            "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 alternate identifier 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":"The unique identifier of the customer transaction type sequence.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TruedUpYn":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates whether the bill line has a true up 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 invoice text of the transaction.",
            "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 charge period.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionDate":{
            "title":"Invoice Date",
            "type":"string",
            "description":"The date of the transaction.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceBillLineId":{
            "type":"integer",
            "description":"The invoice bill line ID.",
            "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 of the bill.",
            "nullable":true,
            "x-queryable":true
        },
        "DateBilledTo":{
            "title":"Bill-to Date",
            "type":"string",
            "description":"The date to which the billing is done.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "UsageQuantity":{
            "title":"Usage Quantity",
            "type":"number",
            "description":"The usage quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the coverage 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 of the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "RecurringFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this 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 billing is done.",
            "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 pricing error.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the bill line was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

タイプ: array

タイトル: Bill Adjustments

請求修正リソースは、サブスクリプション請求修正詳細の表示、作成、更新および削除に使用されます。

ソースを表示

Array of: object subscriptions-products-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.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-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"
    }
}

ネストされたスキーマ : subscriptions-products-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)

請求修正ID
BillAdjustmentPuid: string

最大長: 120

請求修正PUID
BillLineId: integer (int64)

請求明細ID
ChargeAdjustmentId: integer (int64)

手数料修正ID
CreatedBy: string

読取り専用: true

最大長: 64

作成者
CreationDate: string (date-time)

読取り専用: true

作成日
CurrencyCode: string

通貨コード。有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
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)

サブスクリプションID
SubscriptionProductId: integer (int64)

サブスクリプション製品ID

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The creation date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Flag indicating whether the adjustment is automatic or not",
            "nullable":false,
            "x-queryable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment basis",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Reason":{
            "title":"Reason Details",
            "maxLength":120,
            "type":"string",
            "description":"The adjustment reason",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "type":"string",
            "description":"The currency code. 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
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"number",
            "description":"The sequence number",
            "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 subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The bill adjustment PUID",
            "nullable":false,
            "x-queryable":true
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The last updated by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillAdjustmentId":{
            "type":"integer",
            "description":"The bill adjustment ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The created by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The charge adjustment ID",
            "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 adjustment effectivity",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment type",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The adjustment value",
            "nullable":false,
            "x-queryable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The bill line ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdjustmentName":{
            "title":"Adjustment",
            "maxLength":120,
            "type":"string",
            "description":"The adjustment name",
            "nullable":true,
            "x-queryable":true
        },
        "BasisEnableFlag":{
            "type":"boolean",
            "description":"Indicates if the basis has been enabled for the bill.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The last update date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The last update login",
            "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"
    }
}

ネストされたスキーマ : subscriptions-products-charges-item-response

タイプ: object

ソースを表示

adjustments: array Adjustments

タイトル: Adjustments

調整リソースは、サブスクリプション料金に対する調整の表示、作成、更新および削除に使用されます。
AggregationMethod: string

最大長: 30

手数料に使用される集計メソッド。
手当: number

タイトル: Allowance

手当
AssetMeterYn: boolean

最大長: 1

アセット・メーターかどうかを示すフラグ。
BillLineId: integer (int64)

請求明細ID
BlockSize: number

タイトル: Block Size

ブロック・サイズ
ChargeDefinition: string

タイトル: Charge Name

最大長: 30

手数料の目的を示す定義。
ChargeDefinitionName: string

手数料定義名
ChargeId: integer (int64)

手数料ID
chargeMilestoneEvents: array Charge Milestone Events

タイトル: Charge Milestone Events

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

タイトル: Charge Name

最大長: 120

手数料名
ChargePuid: string

最大長: 120

手数料PUID
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)

サブスクリプションID
SubscriptionProductId: integer (int64)

サブスクリプション製品ID
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 creation date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The charge PUID",
            "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/subscriptions-products-charges-chargeMilestoneEvents-item-response"
            }
        },
        "adjustments":{
            "title":"Adjustments",
            "type":"array",
            "description":"The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-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 price periodicity name",
            "nullable":true,
            "x-queryable":true
        },
        "PrePaymentNumber":{
            "title":"Prepayment Number",
            "type":"integer",
            "description":"The prepayment number",
            "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 unit list price",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number",
            "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 subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The last updated by",
            "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 created by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeName":{
            "title":"Charge Name",
            "maxLength":120,
            "type":"string",
            "description":"The charge name",
            "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":"The flag indicating whether the charge has tiers",
            "nullable":true,
            "x-queryable":true
        },
        "UsagePriceLockFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Flag indicating 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 for a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-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",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The last update login",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the charges are rolled up.",
            "nullable":true,
            "x-queryable":true
        },
        "TierType":{
            "title":"Tier Type",
            "maxLength":30,
            "type":"string",
            "description":"The tier type",
            "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 charge definition name",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "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 true up period.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExternalKey":{
            "maxLength":120,
            "type":"string",
            "description":"The external key",
            "nullable":true,
            "x-queryable":true
        },
        "Allowance":{
            "title":"Allowance",
            "type":"number",
            "description":"The allowance",
            "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",
            "nullable":true,
            "x-queryable":true
        },
        "TrueUpPeriod":{
            "title":"True Up Period",
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the true up period.",
            "nullable":true,
            "default":"ORA_OSS_USAGE_BILLING_PERIOD",
            "x-queryable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The bill line ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "format":"int64",
            "nullable":false,
            "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 last update date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

タイプ: array

タイトル: Adjustments

調整リソースは、サブスクリプション料金に対する調整の表示、作成、更新および削除に使用されます。

ソースを表示

Array of: object subscriptions-products-charges-adjustments-item-response

{
    "title":"Adjustments",
    "type":"array",
    "description":"The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-charges-adjustments-item-response"
    }
}

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

タイプ: array

タイトル: Charge Milestone Events

ソースを表示

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

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

タイプ: array

タイトル: Charge Tiers

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

ソースを表示

Array of: object subscriptions-products-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 for a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-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"
    }
}

ネストされたスキーマ : subscriptions-products-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)

手数料修正ID
ChargeAdjustmentPuid: string

最大長: 120

手数料調整PUID
ChargeId: integer (int64)

手数料ID
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)

サブスクリプションID
SubscriptionProductId: integer (int64)

サブスクリプション製品ID

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The creation date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Flag indicating whether the adjustment is automatic or not",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment basis",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Reason":{
            "title":"Reason Description",
            "maxLength":120,
            "type":"string",
            "description":"The adjustment reason",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence number",
            "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 subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The last updated by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The created by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The charge adjustment PUID",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The charge adjustment ID",
            "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 adjustment type",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The adjustment value",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "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 adjustment name",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The last update date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The last update login",
            "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"
    }
}

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

ネストされたスキーマ : subscriptions-products-charges-chargeTiers-item-response

タイプ: object

ソースを表示

AdditionalNumberFive: number

タイトル: Additional Number Five

追加番号5
AdditionalNumberFour: number

タイトル: Additional Number Four

追加番号4
AdditionalNumberOne: number

タイトル: Additional Number One

追加番号1
AdditionalNumberSix: number

タイトル: Additional Number Six

追加番号6
AdditionalNumberThree: number

タイトル: Additional Number Three

追加番号3
AdditionalNumberTwo: number

タイトル: Additional Number Two

追加番号2
AdditionalTextOne: string

タイトル: Additional Text One

最大長: 4000

追加テキスト1
AdditionalTextTwo: string

タイトル: Additional Text Two

最大長: 4000

追加テキスト2
AdditionalTimestampOne: string (date-time)

タイトル: Additional Time-stamp One

追加タイムスタンプ1
AdditionalTimestampThree: string (date-time)

タイトル: Additional Time-stamp Three

追加タイムスタンプ3
AdditionalTimestampTwo: string (date-time)

タイトル: Additional Time-stamp Two

追加タイムスタンプ2
AddtionalTextThree: string

タイトル: Additional Text Three

最大長: 4000

追加テキスト3
BlockSize: number

タイトル: Block Size

ブロック・サイズ
ChargeId: integer (int64)

手数料ID
ChargeTierId: integer (int64)

手数料階層ID
ChargeTierPuid: string

最大長: 120

手数料階層PUID
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)

サブスクリプションID
SubscriptionProductId: integer (int64)

サブスクリプション製品ID
TierFrom: number

タイトル: Tier From

階層:自
TierTo: number

タイトル: Tier To

階層:至

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The creation date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalTimestampTwo":{
            "title":"Additional Time-stamp Two",
            "type":"string",
            "description":"The additional timestamp two",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeTierPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The charge tier PUID",
            "nullable":false,
            "x-queryable":true
        },
        "AdditionalNumberThree":{
            "title":"Additional Number Three",
            "type":"number",
            "description":"The additional number three",
            "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":"The additional number five",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "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":"The additional text three",
            "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 subscription product ID",
            "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":"The additional number two",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The last updated by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeTierId":{
            "type":"integer",
            "description":"The charge tier ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The created by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalNumberFour":{
            "title":"Additional Number Four",
            "type":"number",
            "description":"The additional number four",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalTimestampOne":{
            "title":"Additional Time-stamp One",
            "type":"string",
            "description":"The additional timestamp one",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PriceFormat":{
            "title":"Price Format",
            "maxLength":30,
            "type":"string",
            "description":"The price format",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdditionalTextOne":{
            "title":"Additional Text One",
            "maxLength":4000,
            "type":"string",
            "description":"The additional text one",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalNumberSix":{
            "title":"Additional Number Six",
            "type":"number",
            "description":"The additional number six",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalNumberOne":{
            "title":"Additional Number One",
            "type":"number",
            "description":"The additional number one",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalTextTwo":{
            "title":"Additional Text Two",
            "maxLength":4000,
            "type":"string",
            "description":"The additional text two",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalTimestampThree":{
            "title":"Additional Time-stamp Three",
            "type":"string",
            "description":"The additional timestamp three",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "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 last update date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The last update login",
            "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"
    }
}

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

手数料リソースは、サブスクリプションの手数料の表示、作成、更新および削除に使用されます。
childCoveredLevels: array Child Covered Levels

タイトル: Child Covered Levels

子対象レベル・リソースは、サブスクリプションの子対象レベルを表示、作成、更新および削除するために使用されます。
ClosedAmount: number

対象レベルがクローズされた金額。
ClosedDate: 文字列(日付)

タイトル: Covered Level Close Date

対象レベルがクローズされた日付。
CloseDescription: string

タイトル: Covered Level Close Description

最大長: 2000

子対象レベルに関連付けられたクローズ摘要。
CloseReason: string

タイトル: Covered Level Close Reason

最大長: 30

対象レベルがクローズされた事由。
CorpCurrencyCode: string

最大長: 15

アカウントに関連付けられた企業通貨コード。受け入れられる値のリストは、参照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

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

最大長: 15

通貨コード。有効な値のリストは、参照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

関係リソースは、サブスクリプション製品関係の表示、作成、更新および削除に使用されます。
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 record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CalculatedCreditAmount":{
            "title":"Calculated Credit Amount",
            "type":"number",
            "description":"The calculated credit amount of the child covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "Address":{
            "title":"Address",
            "type":"string",
            "description":"The address of the party site associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CancelDescription":{
            "title":"Cancellation Description",
            "maxLength":2000,
            "type":"string",
            "description":"The cancel description associated with a child covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "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
        },
        "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 total when the covered level was closed.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code. 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.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-relationships-item-response"
            }
        },
        "TaxAmount":{
            "type":"number",
            "description":"The amount of tax to be deducted.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source key of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CloseReason":{
            "title":"Covered Level Close Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason when the covered level was closed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CoveredLevelParentPuid":{
            "type":"string",
            "description":"The covered parent for the parent.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The source number of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "PartySiteId":{
            "type":"integer",
            "description":"The unique identifier of the party site associated with child covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CanceledDate":{
            "title":"Canceled Date",
            "type":"string",
            "description":"The date of cancellation.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ExplodeAssetHierarchy":{
            "type":"string",
            "description":"The explode hierarchy for the asset.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "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 record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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 credited amount for the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusName":{
            "title":"Status",
            "type":"string",
            "description":"The description of the status.",
            "nullable":true,
            "x-queryable":true
        },
        "charges":{
            "title":"Charges",
            "type":"array",
            "description":"The charges resource is used to view, create, update, and delete the charges for a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-charges-item-response"
            }
        },
        "SuppressedCreditAmount":{
            "type":"number",
            "description":"The suppressed amount for the credit.",
            "nullable":true,
            "x-queryable":true
        },
        "childCoveredLevels":{
            "title":"Child Covered Levels",
            "type":"array",
            "description":"The child covered levels resource is used to view, create, update, and delete the subscription child covered levels.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-childCoveredLevels-item-response"
            }
        },
        "PriceListId":{
            "type":"integer",
            "description":"The unique identifier of the price list.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "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 invoiced amount.",
            "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
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "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":"The description of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CanceledAmount":{
            "type":"number",
            "description":"The amount that was cancelled.",
            "nullable":true,
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Number",
            "maxLength":300,
            "type":"string",
            "description":"The line number.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the associated 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
        },
        "billLines":{
            "title":"Bill Lines",
            "type":"array",
            "description":"The bill lines resource is used to view, create, update, and delete the subscription bill line details.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-billLines-item-response"
            }
        },
        "TotalContractValue":{
            "title":"Covered Level Contract Value",
            "type":"number",
            "description":"The total contract value",
            "nullable":true,
            "x-queryable":true
        },
        "SuspendReason":{
            "title":"Covered Level Suspend Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason when the covered level was suspended.",
            "nullable":true,
            "x-queryable":false
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the covered level.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HierarchyTotal":{
            "type":"number",
            "description":"The total when the covered level was closed.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"Covered Level End Date",
            "type":"string",
            "description":"The end date for the covered level.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ClosedAmount":{
            "type":"number",
            "description":"The amount when the covered level was closed.",
            "nullable":true,
            "x-queryable":true
        },
        "CoveredLevlName":{
            "title":"Covered Level Name",
            "type":"string",
            "description":"The name of the covered level associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "OverrideCreditAmount":{
            "title":"Override Credit Amount",
            "type":"number",
            "description":"The override credit amount of the child 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
        },
        "UnitPrice":{
            "title":"Unit Price",
            "type":"number",
            "description":"The unit price of the covered level associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "GenerateBillingSchedule":{
            "type":"string",
            "description":"The schedule by the bill is generated.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party associated with child covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClosedDate":{
            "title":"Covered Level Close Date",
            "type":"string",
            "description":"The date when the covered level was closed.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "CloseDescription":{
            "title":"Covered Level Close Description",
            "maxLength":2000,
            "type":"string",
            "description":"The close description associated with a child covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "maxLength":30,
            "type":"string",
            "description":"The source system of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeName":{
            "title":"Covered Level Type",
            "type":"string",
            "description":"The type name associated with the covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProductName":{
            "title":"Product Name",
            "type":"string",
            "description":"The name of the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ParentCoveredLevelId":{
            "type":"integer",
            "description":"The parent level for the level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Party Name",
            "type":"string",
            "description":"The name of the party associated with child covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "SuspendCreditMethod":{
            "maxLength":30,
            "type":"string",
            "description":"The suspend method for the credit after the covered level was closed.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Covered Level Start Date",
            "type":"string",
            "description":"The start date for the covered level.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CustomerNumber":{
            "title":"Customer Account Number",
            "type":"string",
            "description":"The alternate unique identifier of the customer associated with child covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "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"
            }
        },
        "CorpCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemUnitOfMeasure":{
            "maxLength":15,
            "type":"string",
            "description":"The unit of measure used by the item.",
            "nullable":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
        },
        "Period":{
            "maxLength":80,
            "type":"string",
            "description":"The period during which the covered level is used.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Duration":{
            "type":"integer",
            "description":"The duration for which the covered level is active.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewalType":{
            "title":"Renewal Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of 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 universal serial number associated with the asset.",
            "nullable":true,
            "x-queryable":true
        },
        "CancelReason":{
            "title":"Cancellation Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason for cancellation.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SerialNumber":{
            "title":"Covered Asset Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"The serial number of the child covered level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceUnitOfMeasureName":{
            "title":"Pricing UOM",
            "type":"string",
            "description":"The name of the unit of measure.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReturnCreditMethod":{
            "title":"Close Credit Method",
            "maxLength":230,
            "type":"string",
            "description":"The return method for the credit after the covered level was closed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SourceLineNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The source line number of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CoveredLevlNumber":{
            "title":"Covered Level Number",
            "type":"string",
            "description":"The alternate identifier of the covered level associated with child 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
        },
        "PriceAsOf":{
            "type":"string",
            "description":"The price of the covered level.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PartySite":{
            "title":"Party Site Number",
            "type":"string",
            "description":"The name of the party site associated with child covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "InvoiceText":{
            "maxLength":2000,
            "type":"string",
            "description":"The text to be included in the invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerAccountId":{
            "type":"integer",
            "description":"The unique identifier of the customer account associated with child covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaxError":{
            "maxLength":4000,
            "type":"string",
            "description":"The tax error for the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerName":{
            "title":"Customer Account",
            "type":"string",
            "description":"The name of the customer associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceLineKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source line key of the child 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 child covered level should be repriced or not. If passed as 'true', the subscription child covered level will be repriced.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewedDate":{
            "type":"string",
            "description":"The date when the covered level was renewed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity for which the bill line was charged.",
            "nullable":false,
            "default":1,
            "x-queryable":true
        },
        "PriceUnitOfMeasure":{
            "maxLength":30,
            "type":"string",
            "description":"The unit of measure used by the item.",
            "nullable":true,
            "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 associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "RemoveHoldFlag":{
            "type":"boolean",
            "description":"Indicates if the covered level's hold has to be removed.",
            "nullable":true,
            "x-queryable":false
        },
        "PricingError":{
            "maxLength":1000,
            "type":"string",
            "description":"Any errors associated with the pricing.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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

タイプ: array

タイトル: Bill Lines

請求明細リソースは、サブスクリプション請求明細詳細の表示、作成、更新および削除に使用されます。

ソースを表示

Array of: object subscriptions-products-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.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-billLines-item-response"
    }
}

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

タイプ: array

タイトル: Charges

手数料リソースは、サブスクリプションの手数料の表示、作成、更新および削除に使用されます。

ソースを表示

Array of: object subscriptions-products-coveredLevels-charges-item-response

{
    "title":"Charges",
    "type":"array",
    "description":"The charges resource is used to view, create, update, and delete the charges for a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-charges-item-response"
    }
}

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

タイプ: array

タイトル: Child Covered Levels

子対象レベル・リソースは、サブスクリプションの子対象レベルを表示、作成、更新および削除するために使用されます。

ソースを表示

Array of: object subscriptions-products-coveredLevels-childCoveredLevels-item-response

{
    "title":"Child Covered Levels",
    "type":"array",
    "description":"The child covered levels resource is used to view, create, update, and delete the subscription child covered levels.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-childCoveredLevels-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 subscriptions-products-coveredLevels-relationships-item-response

{
    "title":"Relationships",
    "type":"array",
    "description":"The relationships resource is used to view, create, update, and delete the subscription product relationships.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-relationships-item-response"
    }
}

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

タイプ: object

ソースを表示

金額: number

タイトル: Amount

請求の金額。
billAdjustments: array Bill Adjustments

タイトル: Bill Adjustments

請求修正リソースは、サブスクリプション請求修正詳細の表示、作成、更新および削除に使用されます。
BillingPeriod: number

タイトル: Sequence

請求期間。
BillLineId: integer (int64)

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

最大長: 120

請求明細PUID。
BusinessUnitId: integer

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

最大長: 30

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

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

タイトル: Charge Name

最大長: 120

手数料の名前。
ChargePeriod: number

タイトル: Period

課金期間。
ChargePeriodFactor: number

請求明細に関連付けられた変更期間ファクタ。
ChargePuid: string

読取り専用: true

手数料PUID。
CoveredLevelId: integer (int64)

カバレッジ・レベルの一意の識別子。
CreatedBy: string

読取り専用: true

最大長: 64

請求明細を作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

請求明細が作成された日付。
CreditMemoAmount: number

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

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

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

最大長: 30

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

顧客トランザクション・タイプ連番の一意の識別子です。
DateBilledFrom: 文字列(日付)

タイトル: Bill-from Date

請求が完了した日付。
DateBilledTo: 文字列(日付)

タイトル: Bill-to Date

請求が完了した日付。
DateToInterface: 文字列(日付)

タイトル: Interface Date

インタフェースする日付。
InterfacedFlag: boolean

タイトル: Interfaced

最大長: 1

デフォルト値: false

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

請求書請求明細ID。
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)

請求に関連付けられているトランザクション識別子。
TrxLineId: integer (int64)

トランザクション明細の一意の識別子。
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 transaction identifier associated with the billing.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the bill 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 charge PUID.",
            "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 usage line has been priced or not.",
            "nullable":true,
            "x-queryable":true
        },
        "ListPrice":{
            "type":"number",
            "description":"The list price.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionTax":{
            "title":"Tax",
            "type":"number",
            "description":"The tax related to 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 bill line PUID.",
            "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 bill 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.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-billLines-billAdjustments-item-response"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the bill line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillingPeriod":{
            "title":"Sequence",
            "type":"number",
            "description":"The billing period.",
            "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.",
            "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 unique identifier of the transaction line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UsageCaptureDate":{
            "type":"string",
            "description":"The usage capture date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the bill 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.",
            "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 alternate identifier 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":"The unique identifier of the customer transaction type sequence.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TruedUpYn":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates whether the bill line has a true up 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 invoice text of the transaction.",
            "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 charge period.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionDate":{
            "title":"Invoice Date",
            "type":"string",
            "description":"The date of the transaction.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceBillLineId":{
            "type":"integer",
            "description":"The invoice bill line ID.",
            "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 of the bill.",
            "nullable":true,
            "x-queryable":true
        },
        "DateBilledTo":{
            "title":"Bill-to Date",
            "type":"string",
            "description":"The date to which the billing is done.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "UsageQuantity":{
            "title":"Usage Quantity",
            "type":"number",
            "description":"The usage quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the coverage 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 of the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "RecurringFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this 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 billing is done.",
            "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 pricing error.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the bill line was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

タイプ: array

タイトル: Bill Adjustments

請求修正リソースは、サブスクリプション請求修正詳細の表示、作成、更新および削除に使用されます。

ソースを表示

Array of: object subscriptions-products-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.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-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"
    }
}

ネストされたスキーマ : subscriptions-products-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)

請求修正ID
BillAdjustmentPuid: string

最大長: 120

請求修正PUID
BillLineId: integer (int64)

請求明細ID
ChargeAdjustmentId: integer (int64)

手数料修正ID
CreatedBy: string

読取り専用: true

最大長: 64

作成者
CreationDate: string (date-time)

読取り専用: true

作成日
CurrencyCode: string

通貨コード。有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
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)

サブスクリプションID
SubscriptionProductId: integer (int64)

サブスクリプション製品ID

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The creation date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Flag indicating whether the adjustment is automatic or not",
            "nullable":false,
            "x-queryable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment basis",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Reason":{
            "title":"Reason Details",
            "maxLength":120,
            "type":"string",
            "description":"The adjustment reason",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "type":"string",
            "description":"The currency code. 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
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"number",
            "description":"The sequence number",
            "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 subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The bill adjustment PUID",
            "nullable":false,
            "x-queryable":true
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The last updated by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillAdjustmentId":{
            "type":"integer",
            "description":"The bill adjustment ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The created by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The charge adjustment ID",
            "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 adjustment effectivity",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment type",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The adjustment value",
            "nullable":false,
            "x-queryable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The bill line ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdjustmentName":{
            "title":"Adjustment",
            "maxLength":120,
            "type":"string",
            "description":"The adjustment name",
            "nullable":true,
            "x-queryable":true
        },
        "BasisEnableFlag":{
            "type":"boolean",
            "description":"Indicates if the basis has been enabled for the bill.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The last update date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The last update login",
            "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"
    }
}

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

タイプ: object

ソースを表示

adjustments: array Adjustments

タイトル: Adjustments

調整リソースは、サブスクリプション料金に対する調整の表示、作成、更新および削除に使用されます。
AggregationMethod: string

最大長: 30

手数料に使用される集計メソッド。
手当: number

タイトル: Allowance

手当
AssetMeterYn: boolean

最大長: 1

アセット・メーターかどうかを示すフラグ。
BillLineId: integer (int64)

請求明細ID
BlockSize: number

タイトル: Block Size

ブロック・サイズ
ChargeDefinition: string

タイトル: Charge Name

最大長: 30

手数料の目的を示す定義。
ChargeDefinitionName: string

手数料定義名
ChargeId: integer (int64)

手数料ID
chargeMilestoneEvents: array Charge Milestone Events

タイトル: Charge Milestone Events

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

タイトル: Charge Name

最大長: 120

手数料名
ChargePuid: string

最大長: 120

手数料PUID
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)

サブスクリプションID
SubscriptionProductId: integer (int64)

サブスクリプション製品ID
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 creation date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The charge PUID",
            "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/subscriptions-products-coveredLevels-charges-chargeMilestoneEvents-item-response"
            }
        },
        "adjustments":{
            "title":"Adjustments",
            "type":"array",
            "description":"The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-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 price periodicity name",
            "nullable":true,
            "x-queryable":true
        },
        "PrePaymentNumber":{
            "title":"Prepayment Number",
            "type":"integer",
            "description":"The prepayment number",
            "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 unit list price",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number",
            "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 subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The last updated by",
            "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 created by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeName":{
            "title":"Charge Name",
            "maxLength":120,
            "type":"string",
            "description":"The charge name",
            "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":"The flag indicating whether the charge has tiers",
            "nullable":true,
            "x-queryable":true
        },
        "UsagePriceLockFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Flag indicating 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 for a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-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",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The last update login",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the charges are rolled up.",
            "nullable":true,
            "x-queryable":true
        },
        "TierType":{
            "title":"Tier Type",
            "maxLength":30,
            "type":"string",
            "description":"The tier type",
            "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 charge definition name",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "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 true up period.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExternalKey":{
            "maxLength":120,
            "type":"string",
            "description":"The external key",
            "nullable":true,
            "x-queryable":true
        },
        "Allowance":{
            "title":"Allowance",
            "type":"number",
            "description":"The allowance",
            "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",
            "nullable":true,
            "x-queryable":true
        },
        "TrueUpPeriod":{
            "title":"True Up Period",
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the true up period.",
            "nullable":true,
            "default":"ORA_OSS_USAGE_BILLING_PERIOD",
            "x-queryable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The bill line ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "format":"int64",
            "nullable":false,
            "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 last update date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

タイプ: array

タイトル: Adjustments

調整リソースは、サブスクリプション料金に対する調整の表示、作成、更新および削除に使用されます。

ソースを表示

Array of: object subscriptions-products-coveredLevels-charges-adjustments-item-response

{
    "title":"Adjustments",
    "type":"array",
    "description":"The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-charges-adjustments-item-response"
    }
}

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

タイプ: array

タイトル: Charge Milestone Events

ソースを表示

Array of: object subscriptions-products-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/subscriptions-products-coveredLevels-charges-chargeMilestoneEvents-item-response"
    }
}

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

タイプ: array

タイトル: Charge Tiers

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

ソースを表示

Array of: object subscriptions-products-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 for a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-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"
    }
}

ネストされたスキーマ : subscriptions-products-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)

手数料修正ID
ChargeAdjustmentPuid: string

最大長: 120

手数料調整PUID
ChargeId: integer (int64)

手数料ID
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)

サブスクリプションID
SubscriptionProductId: integer (int64)

サブスクリプション製品ID

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The creation date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Flag indicating whether the adjustment is automatic or not",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment basis",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Reason":{
            "title":"Reason Description",
            "maxLength":120,
            "type":"string",
            "description":"The adjustment reason",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence number",
            "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 subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The last updated by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The created by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The charge adjustment PUID",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The charge adjustment ID",
            "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 adjustment type",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The adjustment value",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "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 adjustment name",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The last update date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The last update login",
            "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"
    }
}

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

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

タイプ: object

ソースを表示

AdditionalNumberFive: number

タイトル: Additional Number Five

追加番号5
AdditionalNumberFour: number

タイトル: Additional Number Four

追加番号4
AdditionalNumberOne: number

タイトル: Additional Number One

追加番号1
AdditionalNumberSix: number

タイトル: Additional Number Six

追加番号6
AdditionalNumberThree: number

タイトル: Additional Number Three

追加番号3
AdditionalNumberTwo: number

タイトル: Additional Number Two

追加番号2
AdditionalTextOne: string

タイトル: Additional Text One

最大長: 4000

追加テキスト1
AdditionalTextTwo: string

タイトル: Additional Text Two

最大長: 4000

追加テキスト2
AdditionalTimestampOne: string (date-time)

タイトル: Additional Time-stamp One

追加タイムスタンプ1
AdditionalTimestampThree: string (date-time)

タイトル: Additional Time-stamp Three

追加タイムスタンプ3
AdditionalTimestampTwo: string (date-time)

タイトル: Additional Time-stamp Two

追加タイムスタンプ2
AddtionalTextThree: string

タイトル: Additional Text Three

最大長: 4000

追加テキスト3
BlockSize: number

タイトル: Block Size

ブロック・サイズ
ChargeId: integer (int64)

手数料ID
ChargeTierId: integer (int64)

手数料階層ID
ChargeTierPuid: string

最大長: 120

手数料階層PUID
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)

サブスクリプションID
SubscriptionProductId: integer (int64)

サブスクリプション製品ID
TierFrom: number

タイトル: Tier From

階層:自
TierTo: number

タイトル: Tier To

階層:至

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The creation date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalTimestampTwo":{
            "title":"Additional Time-stamp Two",
            "type":"string",
            "description":"The additional timestamp two",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeTierPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The charge tier PUID",
            "nullable":false,
            "x-queryable":true
        },
        "AdditionalNumberThree":{
            "title":"Additional Number Three",
            "type":"number",
            "description":"The additional number three",
            "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":"The additional number five",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "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":"The additional text three",
            "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 subscription product ID",
            "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":"The additional number two",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The last updated by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeTierId":{
            "type":"integer",
            "description":"The charge tier ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The created by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalNumberFour":{
            "title":"Additional Number Four",
            "type":"number",
            "description":"The additional number four",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalTimestampOne":{
            "title":"Additional Time-stamp One",
            "type":"string",
            "description":"The additional timestamp one",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PriceFormat":{
            "title":"Price Format",
            "maxLength":30,
            "type":"string",
            "description":"The price format",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdditionalTextOne":{
            "title":"Additional Text One",
            "maxLength":4000,
            "type":"string",
            "description":"The additional text one",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalNumberSix":{
            "title":"Additional Number Six",
            "type":"number",
            "description":"The additional number six",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalNumberOne":{
            "title":"Additional Number One",
            "type":"number",
            "description":"The additional number one",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalTextTwo":{
            "title":"Additional Text Two",
            "maxLength":4000,
            "type":"string",
            "description":"The additional text two",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalTimestampThree":{
            "title":"Additional Time-stamp Three",
            "type":"string",
            "description":"The additional timestamp three",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "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 last update date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The last update login",
            "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"
    }
}

ネストされたスキーマ : subscriptions-products-coveredLevels-childCoveredLevels-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

アセットに関連付けられたユニバーサル・シリアル番号。
CalculatedCreditAmount: number

タイトル: Calculated Credit Amount

子対象レベルの計算済貸方金額。
CancelDescription: string

タイトル: Cancellation Description

最大長: 2000

子対象レベルに関連付けられた取消摘要。
CanceledAmount: number

取り消された金額。
CanceledDate: 文字列(日付)

タイトル: Canceled Date

取消日。
CancelReason: string

タイトル: Cancellation Reason

最大長: 30

取消の事由。
ClosedAmount: number

対象レベルがクローズされた金額。
ClosedDate: 文字列(日付)

タイトル: Covered Level Close Date

対象レベルがクローズされた日付。
CloseDescription: string

タイトル: Covered Level Close Description

最大長: 2000

子対象レベルに関連付けられたクローズ摘要。
CloseReason: string

タイトル: Covered Level Close Reason

最大長: 30

対象レベルがクローズされた事由。
CorpCurrencyCode: string

最大長: 15

アカウントに関連付けられた企業通貨コード。受け入れられる値のリストは、参照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

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

最大長: 15

通貨コード。有効な値のリストは、参照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

請求明細が請求された数量。
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 record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeName":{
            "title":"Covered Level Type",
            "type":"string",
            "description":"The type name associated with 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 child covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductName":{
            "title":"Product Name",
            "type":"string",
            "description":"The name of the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "Address":{
            "title":"Address",
            "type":"string",
            "description":"The address of the party site associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "ParentCoveredLevelId":{
            "type":"integer",
            "description":"The parent level for the level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Party Name",
            "type":"string",
            "description":"The name of the party associated with child covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CancelDescription":{
            "title":"Cancellation Description",
            "maxLength":2000,
            "type":"string",
            "description":"The cancel description associated with a child covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "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
        },
        "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 total when the covered level was closed.",
            "nullable":true,
            "x-queryable":true
        },
        "SuspendCreditMethod":{
            "maxLength":30,
            "type":"string",
            "description":"The suspend method for the credit after the covered level was closed.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Covered Level Start Date",
            "type":"string",
            "description":"The start date for the covered level.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code. 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
        },
        "TaxAmount":{
            "type":"number",
            "description":"The amount of tax to be deducted.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source key of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CloseReason":{
            "title":"Covered Level Close Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason when 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 associated with child covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CoveredLevelParentPuid":{
            "type":"string",
            "description":"The covered parent for the parent.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The source number of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "PartySiteId":{
            "type":"integer",
            "description":"The unique identifier of the party site associated with child covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CanceledDate":{
            "title":"Canceled Date",
            "type":"string",
            "description":"The date of cancellation.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ExplodeAssetHierarchy":{
            "type":"string",
            "description":"The explode hierarchy for the asset.",
            "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 account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemUnitOfMeasure":{
            "maxLength":15,
            "type":"string",
            "description":"The unit of measure used by the item.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "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 record.",
            "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 credited amount for the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "Period":{
            "maxLength":80,
            "type":"string",
            "description":"The period during which the covered level is used.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Duration":{
            "type":"integer",
            "description":"The duration for which the covered level is active.",
            "nullable":true,
            "x-queryable":false
        },
        "StatusName":{
            "title":"Status",
            "type":"string",
            "description":"The description of the status.",
            "nullable":true,
            "x-queryable":true
        },
        "RenewalType":{
            "title":"Renewal Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of 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 universal serial number associated with the asset.",
            "nullable":true,
            "x-queryable":true
        },
        "CancelReason":{
            "title":"Cancellation Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason for cancellation.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SuppressedCreditAmount":{
            "type":"number",
            "description":"The suppressed amount for the credit.",
            "nullable":true,
            "x-queryable":true
        },
        "SerialNumber":{
            "title":"Covered Asset Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"The serial number of the child covered level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceUnitOfMeasureName":{
            "title":"Pricing UOM",
            "type":"string",
            "description":"The 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 return method for the credit after the covered level was closed.",
            "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 invoiced amount.",
            "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 child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CoveredLevlNumber":{
            "title":"Covered Level Number",
            "type":"string",
            "description":"The alternate identifier of the covered level associated with child 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 of the user who last updated the record.",
            "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":"The description of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CanceledAmount":{
            "type":"number",
            "description":"The amount that was cancelled.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceAsOf":{
            "type":"string",
            "description":"The price of the covered level.",
            "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 associated with child covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "InvoiceText":{
            "maxLength":2000,
            "type":"string",
            "description":"The text to be included in the invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the associated 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 associated with child covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaxError":{
            "maxLength":4000,
            "type":"string",
            "description":"The tax error for the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerName":{
            "title":"Customer Account",
            "type":"string",
            "description":"The name of the customer associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceLineKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source line key of the child 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 child covered level should be repriced or not. If passed as 'true', the subscription child covered level will be repriced.",
            "nullable":true,
            "x-queryable":false
        },
        "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",
            "nullable":true,
            "x-queryable":true
        },
        "SuspendReason":{
            "title":"Covered Level Suspend Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason when the covered level was suspended.",
            "nullable":true,
            "x-queryable":false
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity for which the bill line was charged.",
            "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 by the item.",
            "nullable":true,
            "x-queryable":true
        },
        "HierarchyTotal":{
            "type":"number",
            "description":"The total when the covered level was closed.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"Covered Level End Date",
            "type":"string",
            "description":"The end date for the covered level.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ClosedAmount":{
            "type":"number",
            "description":"The amount when the covered level was closed.",
            "nullable":true,
            "x-queryable":true
        },
        "CoveredLevlName":{
            "title":"Covered Level Name",
            "type":"string",
            "description":"The name of the covered level associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "OverrideCreditAmount":{
            "title":"Override Credit Amount",
            "type":"number",
            "description":"The override credit amount of the child 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 associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "UnitPrice":{
            "title":"Unit Price",
            "type":"number",
            "description":"The unit price of the covered level associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "GenerateBillingSchedule":{
            "type":"string",
            "description":"The schedule by the bill is generated.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party associated with child covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RemoveHoldFlag":{
            "type":"boolean",
            "description":"Indicates if the covered level's hold 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":"Any errors associated with the pricing.",
            "nullable":true,
            "x-queryable":true
        },
        "CloseDescription":{
            "title":"Covered Level Close Description",
            "maxLength":2000,
            "type":"string",
            "description":"The close description associated with a child covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "maxLength":30,
            "type":"string",
            "description":"The source system of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "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"
    }
}

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

操作によってPUIDがリンクされます。
RelationshipTypeCode: string

最大長: 30

関係タイプ・コード。
SourceAssetKey: string

最大長: 120

ソース・アセット・キー。
SourceProdAssociationId: integer (int64)

ソース製品関連の一意の識別子。
SourceProdAssociationPuid: string

最大長: 120

ソース製品関連PUID。
SourceProductPuid: string

最大長: 120

ソース製品PUID。
SourceRootAssetKey: string

最大長: 120

ソース・ルート・アセット・キー。
TargetProdAssociationId: integer (int64)

ターゲット製品関連の一意の識別子。
TargetProdAssociationPuid: string

最大長: 120

ターゲット製品関連PUID。
TargetProductPuid: string

最大長: 120

ターゲット製品PUID。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "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 source product PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The relationship type code.",
            "nullable":false,
            "x-queryable":true
        },
        "OperationLinksPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The operation links PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number.",
            "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 source product association PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetProductPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The target product PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetProdAssociationPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The target product association PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record 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 record.",
            "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"
    }
}

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

クレジット・カードPUID。
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 record 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 assignment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "CreditCardPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The credit card PUID.",
            "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 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 associated with the credit card.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "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 record 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 of the user who last updated the record.",
            "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"
    }
}

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

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

操作によってPUIDがリンクされます。
RelationshipTypeCode: string

最大長: 30

関係タイプ・コード。
SourceAssetKey: string

最大長: 120

ソース・アセット・キー。
SourceProdAssociationId: integer (int64)

ソース製品関連の一意の識別子。
SourceProdAssociationPuid: string

最大長: 120

ソース製品関連PUID。
SourceProductPuid: string

最大長: 120

ソース製品PUID。
SourceRootAssetKey: string

最大長: 120

ソース・ルート・アセット・キー。
TargetProdAssociationId: integer (int64)

ターゲット製品関連の一意の識別子。
TargetProdAssociationPuid: string

最大長: 120

ターゲット製品関連PUID。
TargetProductPuid: string

最大長: 120

ターゲット製品PUID。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "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 source product PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The relationship type code.",
            "nullable":false,
            "x-queryable":true
        },
        "OperationLinksPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The operation links PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number.",
            "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 source product association PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetProductPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The target product PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetProdAssociationPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The target product association PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record 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 record.",
            "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"
    }
}

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

販売実績PUID。
SalesCreditType: string

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

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

営業担当。
SalesPersonNumber: string

タイトル: Salesperson Number

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

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

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

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

サブスクリプション製品ID。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Percentage":{
            "type":"number",
            "description":"The percentage of sales credit.",
            "nullable":false,
            "x-hints":{
                "precision":5,
                "scale":2
            },
            "x-queryable":true
        },
        "SalesPerson":{
            "type":"string",
            "description":"The sales person.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "SalesCreditTypeId":{
            "type":"integer",
            "description":"The unique identifier of the sales credit type.",
            "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 the quota of the sales credit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesCreditType":{
            "type":"string",
            "description":"The sales credit type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The date when the credit card becomes invalid.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The date when the sales credit starts.",
            "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 sales credit PUID.",
            "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 subscription product ID.",
            "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 record 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 record.",
            "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"
    }
}

ネストされたスキーマ : subscriptions-products-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/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/associatedAsset

パラメータ:

SubscriptionNumber: $request.path.SubscriptionNumber
SubscriptionProductPuid: $request.path.SubscriptionProductPuid

billLines

操作: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/billLines

パラメータ:

SubscriptionNumber: $request.path.SubscriptionNumber
SubscriptionProductPuid: $request.path.SubscriptionProductPuid

製品請求明細

取消

操作: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/action/cancel

パラメータ:

SubscriptionNumber: $request.path.SubscriptionNumber
SubscriptionProductPuid: $request.path.SubscriptionProductPuid

このメソッドを使用すると、サブスクリプション製品を取り消すことができます。取り消すにはサブスクリプション製品Puidを指定する必要があります。

手数料

操作: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges

パラメータ:

SubscriptionNumber: $request.path.SubscriptionNumber
SubscriptionProductPuid: $request.path.SubscriptionProductPuid

製品手数料

閉める

操作: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/action/close

パラメータ:

SubscriptionNumber: $request.path.SubscriptionNumber
SubscriptionProductPuid: $request.path.SubscriptionProductPuid

このメソッドでは、サブスクリプション製品をクローズできます。

coveredLevels

操作: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels

パラメータ:

SubscriptionNumber: $request.path.SubscriptionNumber
SubscriptionProductPuid: $request.path.SubscriptionProductPuid

製品関連ビュー・オブジェクト

creditCards

操作: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/creditCards

パラメータ:

SubscriptionNumber: $request.path.SubscriptionNumber
SubscriptionProductPuid: $request.path.SubscriptionProductPuid

クレジット・カード・ビュー・オブジェクト

flexFields

操作: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/flexFields

パラメータ:

SubscriptionNumber: $request.path.SubscriptionNumber
SubscriptionProductPuid: $request.path.SubscriptionProductPuid

製品フレックス・フィールド

putOnHold

操作: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/action/putOnHold

パラメータ:

SubscriptionNumber: $request.path.SubscriptionNumber
SubscriptionProductPuid: $request.path.SubscriptionProductPuid

このメソッドでは、保留を解除するまでサブスクリプション製品を保留にできます。

関係

操作: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/relationships

パラメータ:

SubscriptionNumber: $request.path.SubscriptionNumber
SubscriptionProductPuid: $request.path.SubscriptionProductPuid

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

removeHold

操作: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/action/removeHold

パラメータ:

SubscriptionNumber: $request.path.SubscriptionNumber
SubscriptionProductPuid: $request.path.SubscriptionProductPuid

このメソッドでは、サブスクリプション製品に設定された保留を削除できます。

再開

操作: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/action/resume

パラメータ:

SubscriptionNumber: $request.path.SubscriptionNumber
SubscriptionProductPuid: $request.path.SubscriptionProductPuid

このメソッドでは、中断されたサブスクリプション製品を再開できます。

salesCredits

操作: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/salesCredits

パラメータ:

SubscriptionNumber: $request.path.SubscriptionNumber
SubscriptionProductPuid: $request.path.SubscriptionProductPuid

serviceResources

操作: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/serviceResources

パラメータ:

SubscriptionNumber: $request.path.SubscriptionNumber
SubscriptionProductPuid: $request.path.SubscriptionProductPuid

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

一時停止

操作: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/action/suspend

パラメータ:

SubscriptionNumber: $request.path.SubscriptionNumber
SubscriptionProductPuid: $request.path.SubscriptionProductPuid

このメソッドでは、サブスクリプション製品を一時停止できます。サブスクリプション製品Puidを一時停止するには、サブスクリプション製品Puidを指定する必要があります。

undoClose

操作: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/action/undoClose

パラメータ:

SubscriptionNumber: $request.path.SubscriptionNumber
SubscriptionProductPuid: $request.path.SubscriptionProductPuid

このメソッドでは、サブスクリプション製品のクローズを元に戻すことができます。

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行することによってサブスクリプション製品を更新する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptions/GP-5678/child/products/GP-5678-PRDT-1

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています。

{
    "EndDate": "2019-12-20"
}

レスポンス本文の例

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

{
    "SubscriptionProductId": 300100177254429,
    "SubscriptionId": 300100177254423,
    "LineNumber": "1",
    "SubscriptionProductPuid": "GP-5678-PRDT-1",
    "DefinitionOrganizationId": 204,
    "SubscriptionNumber": "GP-5678",
    "SalesProductType": "SUBSCRIPTION",
    "Description": "QP Item for SPT Subscription",
    "InventoryItemId": 300100012368232,
    "ItemUnitOfMeasure": "Ea",
    "ProductName": "QP_Item3",
    "Quantity": 1,
    "StartDate": "2019-01-01",
    "EndDate": "2019-12-20",
    "CloseReason": null,
    "CloseCreditMethod": null,
    "CancelReason": null,
    "ClosedDate": null,
    "CanceledDate": null,
    "RenewedDate": null,
    "PriceListId": null,
    "UnitPrice": null,
    "Status": "ORA_DRAFT",
    "Currency": "USD",
    "InvoicingRuleId": -2,
    "InvoicingRuleName": "Advance Invoice",
    "BillOnDay": null,
    "BillingOffsetDays": null,
    "BillingFrequency": "0zG",
    "BillingFrequencyName": "MONTH",
    "AccountingRuleId": 300100033038413,
    "AccountingRuleName": "3 Months, Deferred",
    "TransactionTypeName": "ORA_OSS_Invoice",
    "InvoiceText": "[$Item Name]: [$Charge Name] [$Bill from Date]-[$Bill to Date]",
    "BillToAccountId": 1001,
    "BillToAccountNumber": "1001",
    "BillToAccountDescription": "A T & T SOLUTIONS INC",
    "BillToSiteUseId": 1006,
    "BillToAddress": "32 Ave of the Americas,NEW YORK, NY 10013",
    "ShipToPartyId": null,
    "ShipToPartyName": null,
    "ShipToPartySiteId": null,
    "ShipToPartySiteName": null,
    "PaymentMethod": null,
    "PaymentMethodName": null,
    "PONumber": null,
    "WireNumber": null,
    "PaymentTermsId": 1064,
    "PaymentTermsName": "Immediate",
    "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-06-04",
    "PriceTransactionOn": "2019-06-04",
    "InvoicedAmount": null,
    "CreditedAmount": null,
    "CanceledAmount": null,
    "ClosedAmount": null,
    "SourceSystem": null,
    "SourceKey": null,
    "SourceNumber": null,
    "SourceLineKey": null,
    "SourceLineNumber": null,
    "MonthlyRecurringRevenue": null,
    "Duration": 354,
    "Period": "DY",
    "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": "CONMGR",
    "CreationDate": "2019-06-04T05:18:01+00:00",
    "LastUpdatedBy": "CONMGR",
    "LastUpdateDate": "2019-06-04T05:18:02.375+00:00",
    "LastUpdateLogin": "8A5689BEEA6839CBE05322EAF40A0656",
    "SummarizedBillingFlag": null,
    "InterfaceOffsetDays": null,
    "CoverageName": null,
    ...
}

「トップに戻る」