機械翻訳について

ジャンプ先

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

経常収益の更新

patch

/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/RecurringRevenue/{RevnId}

リクエスト

パス・パラメータ

• ChildRevenueUniqID(required): string
  これは、収益アイテム・リソースの複合キーを構成し、収益アイテムのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、収益アイテムの特定のインスタンスに移動してハッシュ・キーを取得するために、収益アイテム・コレクション・リソースを問い合せる必要があります。
• OptyNumber(required): string
  商談の一意の代替識別子。
• RevnId(required): integer(int64)
  収益識別子。

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• EffectiveDate: 文字列(日付)
  タイトル: Line Close Date

  この収益の見積クローズ日 - 商談のクローズ日からデフォルト設定されます。
• NonRecurringRevenue: number
  タイトル: Nonrecurring Revenue

  収益明細の経常外収益金額。
• 数量: number
  タイトル: Quantity

  製品数量
• RecurRevenue: number
  タイトル: Recurring Revenue

  収益明細の経常収益金額。
• RevnAmount: number
  タイトル: Line Revenue

  デフォルト値: 0

  収益金額。
• RevnNumber: string
  タイトル: Revenue Number

  最大長: 30

  ユーザー編集可能な収益番号。 REVN_IDからデフォルト設定されます。 一意である必要があり、NULLにはできません。
• UsageRevenue: number
  タイトル: Usage Revenue

  収益明細の使用収益金額。

{
    "type":"object",
    "properties":{
        "RecurRevenue":{
            "title":"Recurring Revenue",
            "type":"number",
            "description":"The recurring revenue amount on the revenue line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Quantity",
                    "UnitPrice"
                ]
            }
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Product quantity.",
            "nullable":true
        },
        "UsageRevenue":{
            "title":"Usage Revenue",
            "type":"number",
            "description":"The usage revenue amount on the revenue line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Quantity",
                    "UnitPrice"
                ]
            }
        },
        "RevnAmount":{
            "title":"Line Revenue",
            "type":"number",
            "description":"Revenue amount.",
            "nullable":true,
            "default":0,
            "x-hints":{
                "dependencies":[
                    "Quantity",
                    "UnitPrice"
                ]
            }
        },
        "EffectiveDate":{
            "title":"Line Close Date",
            "type":"string",
            "description":"Estimated close date for this revenue - defaulted from opportunity's close date.",
            "format":"date",
            "nullable":true
        },
        "NonRecurringRevenue":{
            "title":"Nonrecurring Revenue",
            "type":"number",
            "description":"The non recurring revenue amount on the revenue line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Quantity",
                    "UnitPrice"
                ]
            }
        },
        "RevnNumber":{
            "title":"Revenue Number",
            "maxLength":30,
            "type":"string",
            "description":"User editable revenue number. Defaulted from REVN_ID. Needs to be unique, cannot be NULL.",
            "nullable":false
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : opportunities-ChildRevenue-RecurringRevenue-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  レコードが作成された日付。
• EffectiveDate: 文字列(日付)
  タイトル: Line Close Date

  この収益の見積クローズ日 - 商談のクローズ日からデフォルト設定されます。
• LastUpdateDate: string (date-time)
  読取り専用: true

  レコードが最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  レコードを最後に更新したユーザーのログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• NonRecurringRevenue: number
  タイトル: Nonrecurring Revenue

  収益明細の経常外収益金額。
• 数量: number
  タイトル: Quantity

  製品数量
• RecurParentRevnId: integer (int64)
  繰返しの親売上IDを示します。
• RecurRevenue: number
  タイトル: Recurring Revenue

  収益明細の経常収益金額。
• RevnAmount: number
  タイトル: Line Revenue

  デフォルト値: 0

  収益金額。
• RevnAmtCurcyCode: string
  読取り専用: true

  この商談の売上を計算するために使用する通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。
• RevnId: integer (int64)
  収益識別子。
• RevnNumber: string
  タイトル: Revenue Number

  最大長: 30

  ユーザー編集可能な収益番号。 REVN_IDからデフォルト設定されます。 一意である必要があり、NULLにはできません。
• UsageRevenue: number
  タイトル: Usage Revenue

  収益明細の使用収益金額。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RevnAmtCurcyCode":{
            "type":"string",
            "description":"The currency code used to calculate the revenue for this opportunity. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Product quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "UsageRevenue":{
            "title":"Usage Revenue",
            "type":"number",
            "description":"The usage revenue amount on the revenue line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Quantity",
                    "UnitPrice"
                ]
            }
        },
        "RevnNumber":{
            "title":"Revenue Number",
            "maxLength":30,
            "type":"string",
            "description":"User editable revenue number. Defaulted from REVN_ID. Needs to be unique, cannot be NULL.",
            "nullable":false,
            "x-queryable":true
        },
        "RecurParentRevnId":{
            "type":"integer",
            "description":"Indicates the parent revenue id for the recurrence.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RecurRevenue":{
            "title":"Recurring Revenue",
            "type":"number",
            "description":"The recurring revenue amount on the revenue line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Quantity",
                    "UnitPrice"
                ]
            }
        },
        "RevnId":{
            "type":"integer",
            "description":"Revenue identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RevnAmount":{
            "title":"Line Revenue",
            "type":"number",
            "description":"Revenue amount.",
            "nullable":true,
            "default":0,
            "x-hints":{
                "dependencies":[
                    "Quantity",
                    "UnitPrice"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveDate":{
            "title":"Line Close Date",
            "type":"string",
            "description":"Estimated close date for this revenue - defaulted from opportunity's close date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "NonRecurringRevenue":{
            "title":"Nonrecurring Revenue",
            "type":"number",
            "description":"The non recurring revenue amount on the revenue line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Quantity",
                    "UnitPrice"
                ]
            }
        }
    }
}

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

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

「トップに戻る」