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

請求修正の作成

post

/crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}/child/billAdjustments

リクエスト

パス・パラメータ

BillLinePuid(required): string

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

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

ヘッダー・パラメータ

Metadata-Context:

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

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

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

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

application/json

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

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

タイプ: object

ソースを表示

AdjustmentBasis: string

タイトル: Basis

最大長: 30

請求が調整される基準。
AdjustmentName: string

タイトル: Adjustment

最大長: 120

請求修正の名前。
AdjustmentReasonCode: string

最大長: 30

調整事由のコード。
AdjustmentType: string

タイトル: Type

最大長: 30

請求修正のタイプ。
AdjustmentValue: number

タイトル: Value

請求の調整に使用する値。
AutoAdjustmentFlag: boolean

最大長: 3

調整が自動かどうかを示します。
BasisEnableFlag: boolean

基準が請求修正に対して有効になっているかどうかを示します。
BillAdjustmentId: integer (int64)

請求修正の一意の識別子。
BillAdjustmentPuid: string

最大長: 120

請求修正の公開一意識別子。
BillLineId: integer (int64)

請求明細の一意の識別子。
ChargeAdjustmentId: integer (int64)

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

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

最大長: 30

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

期間数
PeriodFrom: number

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

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

タイトル: Reason Details

最大長: 120

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

タイトル: Sequence

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

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

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

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

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

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

タイプ: object

ソースを表示

AdjustmentBasis: string

タイトル: Basis

最大長: 30

請求が調整される基準。
AdjustmentName: string

タイトル: Adjustment

最大長: 120

請求修正の名前。
AdjustmentReasonCode: string

最大長: 30

調整事由のコード。
AdjustmentType: string

タイトル: Type

最大長: 30

請求修正のタイプ。
AdjustmentValue: number

タイトル: Value

請求の調整に使用する値。
AutoAdjustmentFlag: boolean

最大長: 3

調整が自動かどうかを示します。
BasisEnableFlag: boolean

基準が請求修正に対して有効になっているかどうかを示します。
BillAdjustmentId: integer (int64)

請求修正の一意の識別子。
BillAdjustmentPuid: string

最大長: 120

請求修正の公開一意識別子。
BillLineId: integer (int64)

請求明細の一意の識別子。
ChargeAdjustmentId: integer (int64)

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

読取り専用: true

最大長: 64

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

読取り専用: true

請求修正が作成された日付。
CurrencyCode: string

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

最大長: 30

請求修正の有効性。
LastUpdateDate: string (date-time)

読取り専用: true

請求修正が最後に更新された日付。
LastUpdatedBy: string

読取り専用: true

最大長: 64

請求修正を最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

請求修正を最後に更新したユーザーのログイン詳細。
links: array Links

タイトル: Links

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

期間数
PeriodFrom: number

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

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

タイトル: Reason Details

最大長: 120

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

タイトル: Sequence

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

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

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the bill adjustment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the adjustment is automatic or not.",
            "nullable":false,
            "x-queryable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis on which the bill is adjusted.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Reason":{
            "title":"Reason Details",
            "maxLength":120,
            "type":"string",
            "description":"The reason why the bill is adjusted.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "type":"string",
            "description":"The current code used for the bill adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"number",
            "description":"The sequence number of the bill adjustment.",
            "nullable":false,
            "x-queryable":true
        },
        "NumberOfPeriods":{
            "type":"number",
            "description":"The number of periods",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the bill adjustment.",
            "nullable":false,
            "x-queryable":true
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until which the bill is adjusted.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from which the bill was adjusted.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the bill adjustment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillAdjustmentId":{
            "type":"integer",
            "description":"The unique identifier of the bill adjustment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the bill adjustment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The unique identifier of the charge adjustment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdjustmentReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code of the adjustment reason.",
            "nullable":true,
            "x-queryable":true
        },
        "Effectivity":{
            "maxLength":30,
            "type":"string",
            "description":"The effectivity of the bill adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the bill adjustment.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The value by which the bill is adjusted.",
            "nullable":false,
            "x-queryable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The unique identifier of the bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdjustmentName":{
            "title":"Adjustment",
            "maxLength":120,
            "type":"string",
            "description":"The name of the bill adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "BasisEnableFlag":{
            "type":"boolean",
            "description":"Indicates if the base has been enabled for the bill adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the bill adjustment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the bill adjustment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

タイプ: 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リソースに対してPOSTリクエストを発行することによって請求修正を作成する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionProducts/300100182015426/child/billLines/GP-5678-PRDT-1-BILL-309/child/billAdjustments

リクエスト本文の例

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

{
    "BillAdjustmentPuid": "GP-7890-PRDT-6-BADJ-3",
    "AdjustmentName": "$100 off",
    "AdjustmentValue": 100,
    "AdjustmentType": "ORA_DISCOUNT_AMOUNT",
    "AdjustmentBasis": "ORA_LIST_PRICE",
    "Reason": "Customer is unhappy with the initial setup delays.",
    "SequenceNumber": 1,
    "AutoAdjustmentFlag": false
}

レスポンス本文の例

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

{
  "BillAdjustmentId": 300100192686412,
  "SubscriptionId": 300100181994494,
  "SubscriptionProductId": 300100192686405,
  "BillLineId": 300100192686411,
  "BillAdjustmentPuid": "GP-7890-PRDT-6-BADJ-3",
  "ChargeAdjustmentId": null,
  "AdjustmentName": "$100 off",
  "AdjustmentValue": 100,
  "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": "SALES_ADMIN",
  "CreationDate": "2019-08-20T07:58:49+00:00",
  "LastUpdatedBy": "SALES_ADMIN",
  "LastUpdateDate": "2019-08-20T07:58:49.286+00:00",
  "LastUpdateLogin": "9062D47DF31EDAF6E0533EFDF40A2696",
  "CurrencyCode": null,
  "BasisEnableFlag": "false",
  "links":
 	...
}

「トップに戻る」