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

機械翻訳について

要求決済の取得

get

/crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/ClaimSettlements/{ClaimSettlementCode}

リクエスト

パス・パラメータ

ClaimCode(required): string

MDF請求のユーザー定義の一意のラベル。
ClaimSettlementCode(required): string

MDF請求決済のユーザー定義の一意のラベル。

問合せパラメータ

dependency: string

このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。通常、これらは属性変更の影響をプレビューするために使用されます。このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。この問合せパラメータの値は、依存性フィールドのセットです。例: dependency=ProductId=2

フォーマット: <attr1>=<val1>,<attr2>=<value2>
expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

フォーマット : ?fields=Attribute1,Attribute2

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。

ヘッダー・パラメータ

Metadata-Context:

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

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

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : mdfClaims-ClaimSettlements-item-response

タイプ: object

ソースを表示

AccountingType: string

タイトル: Accounting Type

最大長: 30

バックエンド財務システムの貸方または借方を表すMDF請求決済の会計タイプ。
AccountingTypeMeaning: string

タイトル: Accounting Type

読取り専用: true

バックエンド財務システムの貸方または借方を表す、マーケティング要求決済の会計タイプです。
BudgetCurrencyExchangeRate: number

タイトル: Conversion Rate to Budget

読取り専用: true

デフォルト値: 1

マーケティング請求決済通貨を親予算通貨に換算するために使用される換算レート。
BudgetId: number

タイトル: Budget ID

読取り専用: true

MDF請求に関連付けられている親予算の一意の識別子。
BudgetName: string

タイトル: Name

読取り専用: true

最大長: 250

請求に関連付けられているMDF予算の名前。 MDF予算は、資金リクエストを介して請求に関連付けられます。
ClaimCode: string

タイトル: Code

最大長: 100

マーケティング請求のユーザー定義の一意のラベル。
ClaimCurrencyExchangeRate: number

タイトル: Conversion Rate to Claim

読取り専用: true

デフォルト値: 1

マーケティング請求決済通貨を親マーケティング請求通貨に換算するために使用される為替レート。
ClaimId: number

タイトル: Claim ID

MDF請求の一意の識別子。
ClaimName: string

タイトル: Name

読取り専用: true

最大長: 250

請求決済に関連付けられた請求の名前。
ClaimSettlementAmount: number

タイトル: Amount

MDF請求決済で決済された金額。
ClaimSettlementCode: string

タイトル: Code

最大長: 100

MDF請求決済のユーザー定義の一意のラベル。
ClaimSettlementId: integer

タイトル: Claim Settlement ID

MDF請求決済の一意の識別子。
ClaimSettlementType: string

タイトル: Type

最大長: 30

控除または支払など、MDF請求決済のタイプです。
ClaimSettlmntTypeMeaning: string

タイトル: Type

読取り専用: true

マーケティング要求決済のタイプ(控除、支払など)。
ClaimStatusCode: string

タイトル: Status

読取り専用: true

最大長: 30

請求決済のステータス。
ConversionCurrencyCode: string

タイトル: Conversion Currency Code

読取り専用: true

最大長: 30

要求決済に関連付けられた通貨コード。
ConversionRateType: string

タイトル: Conversion Rate Type

読取り専用: true

最大長: 30

要求決済に関連付けられた換算レート・タイプです。
ConvExchangeRate: number

タイトル: Conversion Exchange Rate

読取り専用: true

企業通貨に対する要求決済の通貨換算レート。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

MDF請求決済を作成したユーザー。
CreatedById: integer (int64)

タイトル: Created by ID

読取り専用: true

要求決済の作成者の一意の識別子。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

要求決済が作成された日付。
CurrencyCode: string

タイトル: Currency

最大長: 30

要求決済勘定に関連付けられた通貨コード。有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
CurrencyConversionDate: 文字列(日付)

タイトル: Currency Conversion Date

読取り専用: true

企業通貨に対する要求決済の通貨換算レートの日付。
Description: string

タイトル: Description

最大長: 1000

マーケティング請求決済の簡単な説明。
InvoiceReference: string

タイトル: Transaction Reference

最大長: 100

MDF請求決済で決済される請求書の参照識別子。
LastUpdateDate: string (date-time)

タイトル: Last Update Date

読取り専用: true

決済が最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

マーケティング請求決済を最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

決済を最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

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

タイトル: Liability Amount

読取り専用: true

デフォルト値: 0

未回収請求負債金額です。
PartnerId: integer (int64)

タイトル: Partner ID

読取り専用: true

パーティの一意識別子
PartnerName: string

タイトル: Partner

読取り専用: true

パーティの名前。
StatusCode: string

タイトル: Status

最大長: 30

デフォルト値: INCOMPLETE

マーケティング要求決済の完了ステータスを示すコード。
StatusMeaning: string

タイトル: Status

読取り専用: true

マーケティング請求決済の完了ステータス。
TransactionDate: 文字列(日付)

タイトル: Transaction Date

要求決済が処理されたか、完了としてマークされた日付。
TransactionMethod: string

タイトル: Transaction Method

最大長: 30

要求決済トランザクションが処理されたメソッド。
TransactionMethodMeaning: string

タイトル: Transaction Method

読取り専用: true

要求決済トランザクションの処理メソッド。

{
    "type":"object",
    "properties":{
        "AccountingType":{
            "title":"Accounting Type",
            "maxLength":30,
            "type":"string",
            "description":"The accounting type of the MDF claim settlement, which represents credit or debit in the back-end financial system.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the claim settlement was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceReference":{
            "title":"Transaction Reference",
            "maxLength":100,
            "type":"string",
            "description":"The reference identifier of the invoice to be settled with the MDF claim settlement.",
            "nullable":true,
            "x-queryable":true
        },
        "BudgetCurrencyExchangeRate":{
            "title":"Conversion Rate to Budget",
            "type":"number",
            "description":"The exchange rate used to convert the marketing claim settlement currency to the parent budget currency.",
            "nullable":false,
            "readOnly":true,
            "default":1,
            "x-queryable":true
        },
        "ClaimId":{
            "title":"Claim ID",
            "type":"number",
            "description":"The unique identifier of the MDF claim.",
            "nullable":false,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"A brief description of the marketing claim settlement.",
            "nullable":true,
            "x-queryable":true
        },
        "OutstandingClaimLiabilityAmount":{
            "title":"Liability Amount",
            "type":"number",
            "description":"The outstanding claim liability amount.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-queryable":true
        },
        "ClaimStatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the claim settlement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerId":{
            "title":"Partner ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CurrencyConversionDate":{
            "title":"Currency Conversion Date",
            "type":"string",
            "description":"The date of currency exchange rate for the claim settlement against the corporate currency.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the completion status of the marketing claim settlement.",
            "nullable":false,
            "default":"INCOMPLETE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ConversionRateType":{
            "title":"Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The conversion rate type associated with the claim settlement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":30,
            "type":"string",
            "description":"The currency code associated with the claim settlement account. 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":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ClaimSettlementCode":{
            "title":"Code",
            "maxLength":100,
            "type":"string",
            "description":"The user-defined, unique label for the MDF claim settlement.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedById":{
            "title":"Created by ID",
            "type":"integer",
            "description":"The unique identifier of the creator of the claim settlement.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ConvExchangeRate":{
            "title":"Conversion Exchange Rate",
            "type":"number",
            "description":"The currency exchange rate for the claim settlement against the corporate currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimSettlementType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the MDF claim settlement, for example deduction or payment.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ClaimCode":{
            "title":"Code",
            "maxLength":100,
            "type":"string",
            "description":"The user-defined, unique label for the marketing claim.",
            "nullable":false,
            "x-queryable":true
        },
        "AccountingTypeMeaning":{
            "title":"Accounting Type",
            "type":"string",
            "description":"The accounting type of the marketing claim settlement, which represents a credit or debit in the back-end financial system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TransactionMethodMeaning":{
            "title":"Transaction Method",
            "type":"string",
            "description":"The method by which claim settlement transaction is processed.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "TransactionMethod"
                ]
            },
            "x-queryable":true
        },
        "TransactionDate":{
            "title":"Transaction Date",
            "type":"string",
            "description":"The date when the claim settlement was processed or marked as complete.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the marketing claim settlement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the MDF claim settlement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BudgetId":{
            "title":"Budget ID",
            "type":"number",
            "description":"The unique identifier of the parent budget associated with the MDF claim.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PartnerName":{
            "title":"Partner",
            "type":"string",
            "description":"The name of the party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionMethod":{
            "title":"Transaction Method",
            "maxLength":30,
            "type":"string",
            "description":"The method by which the claim settlement transaction was processed.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ClaimName":{
            "title":"Name",
            "maxLength":250,
            "type":"string",
            "description":"The name of the claim associated with the claim settlement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Status",
            "type":"string",
            "description":"The completion status of the marketing claim settlement.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "StatusCode"
                ]
            },
            "x-queryable":true
        },
        "ClaimSettlmntTypeMeaning":{
            "title":"Type",
            "type":"string",
            "description":"The type of marketing claim settlement, for example deduction or payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConversionCurrencyCode":{
            "title":"Conversion Currency Code",
            "maxLength":30,
            "type":"string",
            "description":"The currency code associated with the claim settlement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimSettlementId":{
            "title":"Claim Settlement ID",
            "type":"integer",
            "description":"The unique identifier of the MDF claim settlement.",
            "nullable":false,
            "x-queryable":true
        },
        "ClaimSettlementAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount settled in the MDF claim settlement.",
            "nullable":false,
            "x-queryable":true
        },
        "BudgetName":{
            "title":"Name",
            "maxLength":250,
            "type":"string",
            "description":"The name of the MDF budget associated with the claim. MDF budget is associated to the claim through fund request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the settlement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the settlement was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimCurrencyExchangeRate":{
            "title":"Conversion Rate to Claim",
            "type":"number",
            "description":"The exchange rate used to convert the marketing claim settlement currency to the parent marketing claim currency.",
            "nullable":false,
            "readOnly":true,
            "default":1,
            "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."
        }
    }
}

リンク

AccountingTypeLOVVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMKT_MDF_CLAIM_STLMNT_ACC_TYPE%2CBindLookupCode%3D{AccountingType}

要求決済会計タイプを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: AccountingType;ターゲット属性: LookupCode
表示属性: 意味

ClaimStlmntTypeLOVVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMKT_MDF_CLAIM_STLMNT_TYPE%2CBindLookupCode%3D{ClaimSettlementType}

要求決済タイプを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: ClaimSettlementType;ターゲット属性: LookupCode
表示属性: 意味

CurrencyLOVVA

操作: /crmRestApi/resources/11.13.18.05/ratedCurrencies

USD、CADまたはユーロなど、MDF請求決済に関連付けられた通貨コードを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: CurrencyCode;ターゲット属性: CurrencyCode
表示属性: CurrencyCode

StatusLOVVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMKT_MDF_CLAIM_STLMNT_STATUS%2CBindLookupCode%3D{StatusCode}

MDF請求決済のステータスを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: StatusCode;ターゲット属性: LookupCode
表示属性: 意味

TransactionMethodVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKT_MDFCLAIMSETT_TRANS%2CBindLookupCode%3D{TransactionMethod}

要求決済トランザクション・メソッドを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: TransactionMethod;ターゲット属性: LookupCode
表示属性: 意味

「トップに戻る」