機械翻訳について

ジャンプ先

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

サブスクリプション請求明細の作成

post

/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines

リクエスト

パス・パラメータ

• CoveredLevelPuid(required): string
  対象レベルPUID
• SubscriptionNumber(required): string
  サブスクリプションの代替識別子。
• SubscriptionProductPuid(required): string
  サブスクリプション製品PUID。

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
• Upsert-Mode:
  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

• application/json

リクエスト本文 - application/json ()

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

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

タイプ: object

ソースを表示

• 金額: number
  タイトル: Amount

  請求の金額。
• billAdjustments: array Bill Adjustments
  タイトル: Bill Adjustments

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

  請求期間。
• BillLineId: integer (int64)
  請求明細の一意の識別子。
• BillLinePuid(required): 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(required): 文字列(日付)
  タイトル: Bill-from Date

  請求が完了した日付。
• DateBilledTo(required): 文字列(日付)
  タイトル: Bill-to Date

  請求が完了した日付。
• DateToInterface(required): 文字列(日付)
  タイトル: 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(required): boolean
  最大長: 1

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

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

  トランザクションの金額。
• TransactionClass: string
  タイトル: Transaction Class

  最大長: 30

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

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

  トランザクションの日付。
• TransactionNumber: string
  タイトル: Invoice Number

  最大長: 30

  トランザクションの代替識別子。
• TransactionTax: number
  タイトル: Tax

  トランザクションに関連する税金。
• TransactionTypeName: string
  サブスクリプション請求明細のトランザクション・タイプ名。
• TruedUpYn: string
  最大長: 3

  請求明細に調整期間があるかどうかを示します。
• TrxId: integer (int64)
  請求に関連付けられているトランザクション識別子。
• 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

  使用量。

{
    "required":[
        "BillLinePuid",
        "BillingPeriod",
        "DateBilledFrom",
        "DateBilledTo",
        "DateToInterface",
        "RecurringFlag"
    ],
    "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
        },
        "SentDate":{
            "title":"Sent Date",
            "type":"string",
            "description":"The date invoice information is sent to receivables.",
            "format":"date",
            "nullable":true
        },
        "UsagePricedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether 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-post-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
        },
        "BillLineId":{
            "type":"integer",
            "description":"The unique identifier of the bill line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DateBilledFrom":{
            "title":"Bill-from Date",
            "type":"string",
            "description":"The date from which the 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-post-request

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

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

タイプ: object

ソースを表示

• AdjustmentBasis: string
  タイトル: Basis

  最大長: 30

  修正基準
• AdjustmentName: string
  タイトル: Adjustment

  最大長: 120

  調整名
• AdjustmentReasonCode: string
  最大長: 30

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

  最大長: 30

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

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

  調整が自動かどうかを示すフラグ
• BasisEnableFlag: boolean
  基準が請求に対して有効になっているかどうかを示します。
• BillAdjustmentId: integer (int64)
  請求修正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
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

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

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

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

リンク

billAdjustments

操作: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid}/child/billAdjustments

パラメータ:

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

請求修正

「トップに戻る」