Update a payment method assigned to a payee
patch
/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/{PayeeId}/child/externalPartyPaymentMethods/{ExternalPartyPaymentMethodsId}
Request
Path Parameters
-
ExternalPartyPaymentMethodsId(required): integer(int64)
Value that uniquely identifies the external party payment method assignment.
-
PayeeId(required): integer(int64)
Application-generated identifier of the external payee.
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
-
ExternalPartyPaymentMethodsId: integer
(int64)
Value that uniquely identifies the external party payment method assignment.
-
FromDate: string
(date)
Title:
From Date
Date when a payment method assignment begins. -
PaymentMethodCode: string
Title:
Payment Method
Maximum Length:30
Code assigned to a payment method. -
PrimaryIndicator: string
Title:
Primary
Maximum Length:1
Primary payment method. -
ToDate: string
(date)
Title:
To Date
Date when a payment method assignment ends.
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 : paymentsExternalPayees-externalPartyPaymentMethods-item-response
Type:
Show Source
object
-
AddressName: string
Title:
Site Name
Read Only:true
Maximum Length:240
Address of the party. -
ExternalPartyPaymentMethodsId: integer
(int64)
Value that uniquely identifies the external party payment method assignment.
-
FromDate: string
(date)
Title:
From Date
Date when a payment method assignment begins. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PayeeId: integer
(int64)
Value that uniquely identifies the external payee.
-
PayeeName: string
Title:
Name
Read Only:true
Maximum Length:360
Name of an external payee. -
PaymentMethodCode: string
Title:
Payment Method
Maximum Length:30
Code assigned to a payment method. -
PaymentMethodName: string
Title:
Name
Read Only:true
Maximum Length:100
Name assigned to a payment method. -
PrimaryIndicator: string
Title:
Primary
Maximum Length:1
Primary payment method. -
SiteName: string
Title:
Site Name
Read Only:true
Maximum Length:240
Name of the party site. -
ToDate: string
(date)
Title:
To Date
Date when a payment method assignment ends.
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
The following example shows how to update a payment method assignment at supplier site level by submitting a PATCH request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/210/child/externalPartyPaymentMethods/300100180971531
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "ToDate": "2020-12-31" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "ExternalPartyPaymentMethodsId": 300100180971531, "PayeeId": 210, "PayeeName": "GE Capital", "PaymentMethodCode": "DK_101", "PaymentMethodName": "Domestic transfer - Immediate advice, letter to beneficiary", "PrimaryIndicator": "N", "FromDate": "2019-10-16", "ToDate": "2020-12-31", "SiteName": null, "AddressName": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/210/child/externalPartyPaymentMethods/300100180971531", "name": "externalPartyPaymentMethods", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/210/child/externalPartyPaymentMethods/300100180971531", "name": "externalPartyPaymentMethods", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/210", "name": "paymentsExternalPayees", "kind": "item" } ] }