請求明細の更新
patch
/crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}
リクエスト
パス・パラメータ
- BillLinePuid(required): string
請求明細の公開一意識別子。
- SubscriptionProductPuid(required): string
サブスクリプション製品の公開一意識別子。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
サポートされるメディア・タイプ
- application/json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object
-
金額: number
タイトル:
Amount
請求が生成される金額。 -
billAdjustments: array Bill Adjustments
タイトル:
Bill Adjustments
請求修正リソースは、調整名、調整値、調整タイプ、事由および有効性などのサブスクリプション請求修正詳細を表示、作成、更新および削除するために使用されます。 -
BillingPeriod: number
タイトル:
Sequence
請求が生成される期間。 -
BillLinePuid: string
最大長:
120
請求明細の公開一意識別子。 -
BusinessUnitId: integer
請求明細に関連付けられているビジネス・ユニットのID。
-
ChargeDefinition: string
最大長:
30
手数料の目的を示す定義。 -
ChargeId: integer (int64)
手数料の一意の識別子。
-
ChargeName: string
タイトル:
Charge Name
最大長:120
請求明細に関連付けられた手数料の名前。 -
ChargePeriod: number
タイトル:
Period
請求された使用期間。 -
ChargePeriodFactor: number
請求明細に関連付けられた変更期間ファクタ。
-
CoveredLevelId: integer (int64)
対象レベルの一意の識別子。
-
CreditMemoAmount: number
クレジット・メモの金額。
-
CreditMemoFlag: string
請求明細に関連付けられたクレジット・メモがあるかどうかを示します。
-
CreditMemoReason: string
クレジット・メモを上げる事由。
-
CreditMemoReasonCode: string
最大長:
30
クレジット・メモ事由コードのコード。 -
CustomerTrxTypeSequenceId: integer (int64)
顧客取引タイプ連番ID
-
DateBilledFrom: 文字列(日付)
タイトル:
Bill-from Date
請求が生成された日付。 -
DateBilledTo: 文字列(日付)
タイトル:
Bill-to Date
請求が生成される最終日。 -
DateToInterface: 文字列(日付)
タイトル:
Interface Date
請求明細のインタフェース日。 -
InterfacedFlag: boolean
タイトル:
Interfaced
最大長:1
デフォルト値:false
請求明細がインタフェースされているかどうかを示します。 -
InvoiceBillLineId: integer (int64)
請求書請求明細の一意の識別子。
-
InvoiceDate: 文字列(日付)
請求書が提起された日付。
-
InvoiceText: string
タイトル:
Invoice Text
最大長:240
請求明細請求書のテキスト。 -
ListPrice: number
請求明細に関連付けられた製品の定価。
-
MilestoneEventId: integer (int64)
請求明細に関連付けられたマイルストン・イベントのID。
-
MilestoneEventName: string
請求明細に関連付けられたマイルストン・イベントの名前。
-
NewCreditMemoPUID: string
新規クレジット・メモの一意の公開識別子。
-
PricedQuantity: number
請求明細が請求された数量。
-
PricingError: string
最大長:
1000
価格設定のエラー(ある場合)。 -
RecurringFlag: 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)
ARトランザクションID。
-
TrxLineId: integer (int64)
ARトランザクション明細ID。
-
UsageAcquiredFlag: boolean
最大長:
1
使用状況が取得されたかどうかを示します。 -
UsageCaptureDate: 文字列(日付)
使用状況が取得された日付。
-
UsageChargeType: string
タイトル:
Usage Charge Type
最大長:30
使用手数料のタイプ。 -
UsageChargeTypeName: string
使用手数料タイプの名前。
-
UsageFlag: boolean
最大長:
1
明細が使用明細かどうかを示します。 -
UsagePricedFlag: boolean
最大長:
1
使用明細が価格設定されているかどうかを示します。 -
UsageQuantity: number
タイトル:
Usage Quantity
使用量の数量。
ネストされたスキーマ : 請求修正
タイプ:
array
タイトル:
Bill Adjustments
請求修正リソースは、調整名、調整値、調整タイプ、事由および有効性などのサブスクリプション請求修正詳細を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : スキーマ
タイプ:
ソースを表示
object
-
AdjustmentBasis: string
タイトル:
Basis
最大長:30
請求が調整される基準。 -
AdjustmentName: string
タイトル:
Adjustment
最大長:120
請求修正の名前。 -
AdjustmentReasonCode: string
最大長:
30
調整事由のコード。 -
AdjustmentType: string
タイトル:
Type
最大長:30
請求修正のタイプ。 -
AdjustmentValue: number
タイトル:
Value
請求の調整に使用する値。 -
AutoAdjustmentFlag: boolean
最大長:
3
調整が自動かどうかを示します。 -
BasisEnableFlag: boolean
基準が請求修正に対して有効になっているかどうかを示します。
-
BillAdjustmentId: integer (int64)
請求修正の一意の識別子。
-
BillAdjustmentPuid: string
最大長:
120
請求修正の公開一意識別子。 -
BillLineId: integer (int64)
請求明細の一意の識別子。
-
ChargeAdjustmentId: integer (int64)
手数料修正の一意の識別子です。
-
CurrencyCode: string
請求修正に使用される現在のコード。
-
Effectivity: string
最大長:
30
請求修正の有効性。 -
NumberOfPeriods: number
期間数
-
PeriodFrom: number
請求が調整された期間。
-
PeriodUntil: number
請求が調整されるまでの期間。
-
Reason: string
タイトル:
Reason Details
最大長:120
請求が調整された事由です。 -
SequenceNumber: number
タイトル:
Sequence
請求修正のシーケンス番号。 -
SubscriptionId: integer (int64)
サブスクリプションの一意の識別子。
-
SubscriptionProductId: integer (int64)
サブスクリプション製品の一意の識別子。
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : subscriptionProducts-billLines-item-response
タイプ:
ソースを表示
object
-
金額: number
タイトル:
Amount
請求が生成される金額。 -
billAdjustments: array Bill Adjustments
タイトル:
Bill Adjustments
請求修正リソースは、調整名、調整値、調整タイプ、事由および有効性などのサブスクリプション請求修正詳細を表示、作成、更新および削除するために使用されます。 -
BillingPeriod: number
タイトル:
Sequence
請求が生成される期間。 -
BillLineId: integer (int64)
請求明細の一意の識別子。
-
BillLinePuid: string
最大長:
120
請求明細の公開一意識別子。 -
BusinessUnitId: integer
請求明細に関連付けられているビジネス・ユニットのID。
-
ChargeDefinition: string
最大長:
30
手数料の目的を示す定義。 -
ChargeId: integer (int64)
手数料の一意の識別子。
-
ChargeName: string
タイトル:
Charge Name
最大長:120
請求明細に関連付けられた手数料の名前。 -
ChargePeriod: number
タイトル:
Period
請求された使用期間。 -
ChargePeriodFactor: number
請求明細に関連付けられた変更期間ファクタ。
-
ChargePuid: string
読取り専用:
true
手数料の公開一意識別子。 -
CoveredLevelId: integer (int64)
対象レベルの一意の識別子。
-
CreatedBy: string
読取り専用:
true
最大長:64
請求明細を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
請求明細が作成された日付。 -
CreditMemoAmount: number
クレジット・メモの金額。
-
CreditMemoFlag: string
請求明細に関連付けられたクレジット・メモがあるかどうかを示します。
-
CreditMemoReason: string
クレジット・メモを上げる事由。
-
CreditMemoReasonCode: string
最大長:
30
クレジット・メモ事由コードのコード。 -
CustomerTrxTypeSequenceId: integer (int64)
顧客取引タイプ連番ID
-
DateBilledFrom: 文字列(日付)
タイトル:
Bill-from Date
請求が生成された日付。 -
DateBilledTo: 文字列(日付)
タイトル:
Bill-to Date
請求が生成される最終日。 -
DateToInterface: 文字列(日付)
タイトル:
Interface Date
請求明細のインタフェース日。 -
InterfacedFlag: boolean
タイトル:
Interfaced
最大長:1
デフォルト値:false
請求明細がインタフェースされているかどうかを示します。 -
InvoiceBillLineId: integer (int64)
請求書請求明細の一意の識別子。
-
InvoiceDate: 文字列(日付)
請求書が提起された日付。
-
InvoiceText: string
タイトル:
Invoice Text
最大長:240
請求明細請求書のテキスト。 -
LastUpdateDate: string (date-time)
読取り専用:
true
請求明細が最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
請求明細を最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
請求明細を最後に更新したユーザーのログイン詳細。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ListPrice: number
請求明細に関連付けられた製品の定価。
-
MilestoneEventId: integer (int64)
請求明細に関連付けられたマイルストン・イベントのID。
-
MilestoneEventName: string
請求明細に関連付けられたマイルストン・イベントの名前。
-
NewCreditMemoPUID: string
新規クレジット・メモの一意の公開識別子。
-
PricedQuantity: number
請求明細が請求された数量。
-
PricingError: string
最大長:
1000
価格設定のエラー(ある場合)。 -
RecurringFlag: boolean
最大長:
1
明細が固定処理かどうかを示します。 -
RevenueLineId: integer (int64)
収益明細の一意の識別子。
-
SentDate: 文字列(日付)
タイトル:
Sent Date
請求書情報が売掛管理に送信される日付。 -
SubscriptionId: integer (int64)
サブスクリプションの一意の識別子。
-
SubscriptionProductId: integer (int64)
サブスクリプション製品の一意の識別子。
-
TransactionAmount: number
タイトル:
Invoice Amount
トランザクションが発生した金額。 -
TransactionClass: string
タイトル:
Transaction Class
最大長:30
トランザクションのクラス。 -
TransactionClassMeaning: string
タイトル:
Class
トランザクション区分参照の意味。 -
TransactionDate: 文字列(日付)
タイトル:
Invoice Date
トランザクションが発生した日付。 -
TransactionNumber: string
タイトル:
Invoice Number
最大長:30
トランザクションの番号。 -
TransactionTax: number
タイトル:
Tax
トランザクションに課せられた税金です。 -
TransactionTypeName: string
サブスクリプション請求明細のトランザクション・タイプ名。
-
TruedUpYn: string
最大長:
3
請求明細に調整期間があるかどうかを示します。 -
TrxId: integer (int64)
ARトランザクションID。
-
TrxLineId: integer (int64)
ARトランザクション明細ID。
-
UsageAcquiredFlag: boolean
最大長:
1
使用状況が取得されたかどうかを示します。 -
UsageCaptureDate: 文字列(日付)
使用状況が取得された日付。
-
UsageChargeType: string
タイトル:
Usage Charge Type
最大長:30
使用手数料のタイプ。 -
UsageChargeTypeName: string
使用手数料タイプの名前。
-
UsageFlag: boolean
最大長:
1
明細が使用明細かどうかを示します。 -
UsagePricedFlag: boolean
最大長:
1
使用明細が価格設定されているかどうかを示します。 -
UsageQuantity: number
タイトル:
Usage Quantity
使用量の数量。
ネストされたスキーマ : 請求修正
タイプ:
array
タイトル:
Bill Adjustments
請求修正リソースは、調整名、調整値、調整タイプ、事由および有効性などのサブスクリプション請求修正詳細を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : subscriptionProducts-billLines-billAdjustments-item-response
タイプ:
ソースを表示
object
-
AdjustmentBasis: string
タイトル:
Basis
最大長:30
請求が調整される基準。 -
AdjustmentName: string
タイトル:
Adjustment
最大長:120
請求修正の名前。 -
AdjustmentReasonCode: string
最大長:
30
調整事由のコード。 -
AdjustmentType: string
タイトル:
Type
最大長:30
請求修正のタイプ。 -
AdjustmentValue: number
タイトル:
Value
請求の調整に使用する値。 -
AutoAdjustmentFlag: boolean
最大長:
3
調整が自動かどうかを示します。 -
BasisEnableFlag: boolean
基準が請求修正に対して有効になっているかどうかを示します。
-
BillAdjustmentId: integer (int64)
請求修正の一意の識別子。
-
BillAdjustmentPuid: string
最大長:
120
請求修正の公開一意識別子。 -
BillLineId: integer (int64)
請求明細の一意の識別子。
-
ChargeAdjustmentId: integer (int64)
手数料修正の一意の識別子です。
-
CreatedBy: string
読取り専用:
true
最大長:64
請求修正を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
請求修正が作成された日付。 -
CurrencyCode: string
請求修正に使用される現在のコード。
-
Effectivity: string
最大長:
30
請求修正の有効性。 -
LastUpdateDate: string (date-time)
読取り専用:
true
請求修正が最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
請求修正を最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
請求修正を最後に更新したユーザーのログイン詳細。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
NumberOfPeriods: number
期間数
-
PeriodFrom: number
請求が調整された期間。
-
PeriodUntil: number
請求が調整されるまでの期間。
-
Reason: string
タイトル:
Reason Details
最大長:120
請求が調整された事由です。 -
SequenceNumber: number
タイトル:
Sequence
請求修正のシーケンス番号。 -
SubscriptionId: integer (int64)
サブスクリプションの一意の識別子。
-
SubscriptionProductId: integer (int64)
サブスクリプション製品の一意の識別子。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
リンク
- billAdjustments
-
パラメータ:
- BillLinePuid:
$request.path.BillLinePuid
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
請求修正 - BillLinePuid:
例:
次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行して、請求明細を更新する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionProducts/300100182015426/child/billLines/GP-5678-PRDT-1-BILL-309
リクエスト本文の例
次の例は、JSON形式のリクエスト本文のコンテンツを示しています。
{ "Amount": 2600 }
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "BillLineId": 300100192686411, "BillLinePuid": "GP-5678-PRDT-1-BILL-309", "SubscriptionId": 300100181994494, "SubscriptionProductId": 300100192686405, "CoveredLevelId": null, "ChargeId": 300100177231506, "ChargePuid": null, "BillingPeriod": 0, "DateToInterface": "2019-06-04", "DateBilledFrom": "2019-01-01", "DateBilledTo": "2019-12-25", "Amount": 2600, "RecurringFlag": false, "UsageFlag": false, "UsageAcquiredFlag": null, "UsagePricedFlag": true, "InterfacedFlag": false, "TransactionClass": "INV", "TransactionDate": null, "TransactionNumber": null, "TransactionTax": null, "TransactionAmount": null, "InvoiceText": "[$Item Name]: Activation Fee 2019-01-01-2019-12-25", "InvoiceBillLineId": null, "UsageCaptureDate": null, "UsageQuantity": null, "ChargePeriod": 0, "PricingError": null, "ListPrice": 3000, "RevenueLineId": null, "CreatedBy": "SALES_ADMIN", "CreationDate": "2019-08-20T07:24:12+00:00", "LastUpdatedBy": "SALES_ADMIN", "LastUpdateDate": "2019-08-20T07:24:12.100+00:00", "LastUpdateLogin": "9062D47DF31EDAF6E0533EFDF40A2696", "TransactionClassMeaning": "Invoice", "InvoiceDate": null, "NewCreditMemoPUID": null, "CreditMemoAmount": null, "CreditMemoFlag": null, "CreditMemoReason": null, "links": ... }