Update one relationship
patch
/fscmRestApi/resources/11.13.18.05/suppliers/{SupplierId}/child/sites/{SupplierSiteId}/child/thirdPartyPaymentRelationships/{TppRelationshipId}
Request
Path Parameters
-
SupplierId(required): integer(int64)
Value that uniquely identifies the supplier.
-
SupplierSiteId(required): integer(int64)
Value that uniquely identifies the supplier site.
-
TppRelationshipId(required): integer(int64)
Value that uniquely identifies a supplier site third-party payment relationship.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DefaultRelationshipFlag: boolean
Title:
Default
Maximum Length:1
Default Value:false
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. -
Description: string
Title:
Description
Maximum Length:1000
Details that are included in the payment file. -
ToDate: string
(date)
Title:
To Date
Date when the third-party payment relationship is no longer effective.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : suppliers-sites-thirdPartyPaymentRelationships-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the supplier record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the supplier record. -
DefaultRelationshipFlag: boolean
Title:
Default
Maximum Length:1
Default Value:false
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. -
Description: string
Title:
Description
Maximum Length:1000
Details that are included in the payment file. -
FromDate: string
(date)
Title:
From Date
Date when the third-party payment relationship becomes effective. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time when the user most recently updated the supplier record. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who most recently updated the supplier record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RemitToAddress: string
Title:
Address Name
Maximum Length:240
Address of the party designated to receive payment on behalf of the supplier on the invoice. -
RemitToAddressId: integer
(int64)
Value that uniquely identifies the address of the party designated to receive payment on behalf of the supplier on the invoice.
-
RemitToSupplier: string
Title:
Remit-to Supplier
Maximum Length:360
Name of the party designated to receive payment on behalf of the supplier on the invoice. -
RemitToSupplierPartyId: integer
(int64)
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).
-
ToDate: string
(date)
Title:
To Date
Date when the third-party payment relationship is no longer effective. -
TppRelationshipId: integer
(int64)
Value that uniquely identifies a supplier site third-party payment relationship.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to update a third-party payment relationship.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/suppliers/SupplierId/child/sites/SupplierSiteId/child/thirdPartyPaymentRelationships/TppRelationshipId"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{ "RemitToSupplier": "CV_SuppC08", "RemitToAddress": "VO FIXTURE GOOD", "FromDate": "2019-11-18", "ToDate": "2020-12-31", "Description": "updated third party relationship", "DefaultRelationshipFlag": true }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "TppRelationshipId": 300100184732418, "DefaultRelationshipFlag": true, "RemitToSupplier": "CV_SuppC08", "RemitToSupplierPartyId": 134991, "RemitToAddress": "VO FIXTURE GOOD", "RemitToAddressId": 173447, "FromDate": "2019-11-18", "ToDate": "2020-12-31", "Description": "updated 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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "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" } ] }