機械翻訳について

ジャンプ先

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

1つの関係の作成

post

/fscmRestApi/resources/11.13.18.05/suppliers/{SupplierId}/child/sites/{SupplierSiteId}/child/thirdPartyPaymentRelationships

リクエスト

パス・パラメータ

• SupplierId(required): integer(int64)
  サプライヤを一意に識別する値。
• SupplierSiteId(required): integer(int64)
  サプライヤ・サイトを一意に識別する値。

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
• Upsert-Mode:
  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は有効日RESTリソースではサポートされていません。

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

• application/json

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

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

タイプ: object

ソースを表示

• DefaultRelationshipFlag: boolean
  タイトル: Default

  最大長: 1

  デフォルト値: false

  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、これがデフォルトの第三者支払関係です。 falseの場合、これはデフォルトの第三者支払関係ではありません。 デフォルト値はfalseです。
• Description: string
  タイトル: Description

  最大長: 1000

  支払ファイルに含まれる詳細。
• FromDate: string (date)
  タイトル: From Date

  第三者支払関係が有効になる日付。
• RemitToAddress: string
  タイトル: Address Name

  最大長: 240

  請求書のサプライヤの代理として支払の受入を指定されたパーティの住所。
• RemitToAddressId: integer (int64)
  請求書のサプライヤの代理として支払を受け取るよう指定されたパーティの住所を一意に識別する値。
• RemitToSupplier: string
  タイトル: Remit-to Supplier

  最大長: 360

  請求書のサプライヤにかわって支払を受領するように指定されたパーティの名前。
• RemitToSupplierPartyId: integer (int64)
  請求書のサプライヤのかわりに支払を受け取るよう指定されたパーティを一意に識別する値です。 支払を受け取るように指定されたパーティは、SupplierPartyId属性によって識別されます(SupplierIdではありません)。
• ToDate: string (date)
  タイトル: To Date

  第三者支払関係が有効でなくなる日付。
• TppRelationshipId: integer (int64)
  サプライヤ・サイト第三者支払関係を一意に識別する値。

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"Details that are included in the payment file.",
            "nullable":true
        },
        "TppRelationshipId":{
            "type":"integer",
            "description":"Value that uniquely identifies a supplier site third-party payment relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "RemitToSupplierPartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the party designated to receive payment on behalf of the supplier on the invoice. The party designated to receive payment is identified through the SupplierPartyId attribute (and not SupplierId).",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "RemitToAddressId":{
            "type":"integer",
            "description":"Value that uniquely identifies the address of the party designated to receive payment on behalf of the supplier on the invoice.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "RemitToSupplier":{
            "title":"Remit-to Supplier",
            "maxLength":360,
            "type":"string",
            "description":"Name of the party designated to receive payment on behalf of the supplier on the invoice.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FromDate":{
            "title":"From Date",
            "type":"string",
            "description":"Date when the third-party payment relationship becomes effective.",
            "format":"date",
            "nullable":false
        },
        "ToDate":{
            "title":"To Date",
            "type":"string",
            "description":"Date when the third-party payment relationship is no longer effective.",
            "format":"date",
            "nullable":true
        },
        "RemitToAddress":{
            "title":"Address Name",
            "maxLength":240,
            "type":"string",
            "description":"Address of the party designated to receive payment on behalf of the supplier on the invoice.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DefaultRelationshipFlag":{
            "title":"Default",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then it's the default third-party payment relationship.  If false, then it's not the default third-party payment relationship. The default value is false.",
            "nullable":false,
            "default":false
        }
    }
}

トップに戻る

レスポンス

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文 ()

ルート・スキーマ : suppliers-sites-thirdPartyPaymentRelationships-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  サプライヤ・レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  ユーザーがサプライヤ・レコードを作成した日付。
• DefaultRelationshipFlag: boolean
  タイトル: Default

  最大長: 1

  デフォルト値: false

  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、これがデフォルトの第三者支払関係です。 falseの場合、これはデフォルトの第三者支払関係ではありません。 デフォルト値はfalseです。
• Description: string
  タイトル: Description

  最大長: 1000

  支払ファイルに含まれる詳細。
• FromDate: string (date)
  タイトル: From Date

  第三者支払関係が有効になる日付。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  ユーザーが最後にサプライヤ・レコードを更新した日時。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  最後にサプライヤ・レコードを更新したユーザー。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• RemitToAddress: string
  タイトル: Address Name

  最大長: 240

  請求書のサプライヤの代理として支払の受入を指定されたパーティの住所。
• RemitToAddressId: integer (int64)
  請求書のサプライヤの代理として支払を受け取るよう指定されたパーティの住所を一意に識別する値。
• RemitToSupplier: string
  タイトル: Remit-to Supplier

  最大長: 360

  請求書のサプライヤにかわって支払を受領するように指定されたパーティの名前。
• RemitToSupplierPartyId: integer (int64)
  請求書のサプライヤのかわりに支払を受け取るよう指定されたパーティを一意に識別する値です。 支払を受け取るように指定されたパーティは、SupplierPartyId属性によって識別されます(SupplierIdではありません)。
• ToDate: string (date)
  タイトル: To Date

  第三者支払関係が有効でなくなる日付。
• TppRelationshipId: integer (int64)
  サプライヤ・サイト第三者支払関係を一意に識別する値。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the supplier record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the supplier record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the supplier record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"Details that are included in the payment file.",
            "nullable":true,
            "x-queryable":true
        },
        "RemitToSupplierPartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the party designated to receive payment on behalf of the supplier on the invoice. The party designated to receive payment is identified through the SupplierPartyId attribute (and not SupplierId).",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "RemitToAddressId":{
            "type":"integer",
            "description":"Value that uniquely identifies the address of the party designated to receive payment on behalf of the supplier on the invoice.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "RemitToSupplier":{
            "title":"Remit-to Supplier",
            "maxLength":360,
            "type":"string",
            "description":"Name of the party designated to receive payment on behalf of the supplier on the invoice.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RemitToAddress":{
            "title":"Address Name",
            "maxLength":240,
            "type":"string",
            "description":"Address of the party designated to receive payment on behalf of the supplier on the invoice.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DefaultRelationshipFlag":{
            "title":"Default",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then it's the default third-party payment relationship.  If false, then it's not the default third-party payment relationship. The default value is false.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "TppRelationshipId":{
            "type":"integer",
            "description":"Value that uniquely identifies a supplier site third-party payment relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FromDate":{
            "title":"From Date",
            "type":"string",
            "description":"Date when the third-party payment relationship becomes effective.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ToDate":{
            "title":"To Date",
            "type":"string",
            "description":"Date when the third-party payment relationship is no longer effective.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the supplier record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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

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

ネストされたスキーマ : プロパティ

タイプ: object

ソースを表示

• changeIndicator: string
  リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

トップに戻る

例

この例では、第三者支払関係を作成する方法を説明します。

cURLコマンドの例

次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します。

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/suppliers/SupplierId/child/sites/SupplierSiteId/child/thirdPartyPaymentRelationships"

リクエスト本文の例

次の例には、JSON形式のリクエスト本文のコンテンツが含まれます。 cURLコマンドの「リクエスト・ペイロード」は、リクエスト本文の例の内容に置き換えます。 リクエスト・ペイロードでは、コマンドが作成するレコードで使用される属性値を指定します。

{
	"RemitToSupplier":   "CV_SuppC08",
	"RemitToAddress": "VO FIXTURE GOOD",
	"FromDate": "2019-11-18",
	"ToDate": "2019-12-31",
	"Description": "new third party relationship",
	"DefaultRelationshipFlag": true
}

レスポンス本文の例

次の例には、レスポンス本文の内容がJSON形式で含まれます:

{
	"TppRelationshipId": 300100184732418,
	"DefaultRelationshipFlag": true,
	"RemitToSupplier": "CV_SuppC08",
	"RemitToSupplierPartyId": 134991,
	"RemitToAddress": "VO FIXTURE GOOD",
	"RemitToAddressId": 173447,
	"FromDate": "2019-11-18",
	"ToDate": "2019-12-31",
	"Description": "new third party relationship",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/suppliers/300100184731456/child/sites/300100184732416/child/thirdPartyPaymentRelationships/300100184732418",
		"name": "thirdPartyPaymentRelationships",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/suppliers/300100184731456/child/sites/300100184732416/child/thirdPartyPaymentRelationships/300100184732418",
		"name": "thirdPartyPaymentRelationships",
		"kind": "item"
	},
	{
		"rel": "parent",
		"href": "https://servername/fscmRestApi/resources/version/suppliers/300100184731456/child/sites/300100184732416",
		"name": "sites",
		"kind": "item"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/suppliers/300100184731456/child/sites/300100184732416/child/thirdPartyPaymentRelationships/300100184732418/lov/RemitToSupplierLookup",
		"name": "RemitToSupplierLookup",
		"kind": "collection"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/suppliers/300100184731456/child/sites/300100184732416/child/thirdPartyPaymentRelationships/300100184732418/lov/RemitToAddressLookup",
		"name": "RemitToAddressLookup",
		"kind": "collection"
	}
	]
}

「トップに戻る」