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

サブスクリプション請求調整の更新

patch

/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}/child/billAdjustments/{BillAdjustmentPuid}

リクエスト

パス・パラメータ

BillAdjustmentPuid(required): string

請求修正PUID
BillLinePuid(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のデフォルト・バージョンを選択します。

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

application/json

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

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

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

トップに戻る

例:

次の例は、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/subscriptions/GP7890/child/products/GP-7890-PRDT-6/child/billLines/GP-7890-PRDT-6-BILL370/child/billAdjustments/GP-7890-PRDT-6-BADJ-3

リクエスト本文の例

次に、JSON形式のリクエスト本文の内容を示します。

{     
"AdjustmentName": "$200 off",     
"AdjustmentValue": 200, 
}

レスポンス本文の例

次に、JSON形式のレスポンス本文の内容を示します。

{     
"BillAdjustmentId": 300100177242435,     
"SubscriptionId": 300100177231524,     
"SubscriptionProductId": 300100177231527,     
"BillLineId": 100100108482578,     
"BillAdjustmentPuid": "GP-7890-PRDT-6-BADJ-3",     
"ChargeAdjustmentId": null,     
"AdjustmentName": "$200 off",     
"AdjustmentValue": 200,     
"AdjustmentType": "ORA_DISCOUNT_AMOUNT",     
"AdjustmentBasis": "ORA_LIST_PRICE",     
"Reason": "Customer is unhappy with the initial setup delays.",     
"Effectivity": null,     
"NumberOfPeriods": null,     
"PeriodFrom": null,     
"PeriodUntil": null,     
"SequenceNumber": 1,     
"AutoAdjustmentFlag": false,     
"CreatedBy": "CONMGR",     
"CreationDate": "2019-06-04T17:34:33+00:00",     
"LastUpdatedBy": "CONMGR",     
"LastUpdateDate": "2019-06-04T17:34:33.527+00:00",     
"LastUpdateLogin": "8A5689AE12D939D9E05322EAF40A63A4",     
"CurrencyCode": null,     
"BasisEnableFlag": "false",    
... 
}

「トップに戻る」