1. REST API for Oracle Fusion Cloud Financials
  2. Tasks
  3. External Payees

Update an external payee

patch

/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/{PayeeId}

Request

Path Parameters
Header Parameters
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Bank Charge Bearer Code
    Maximum Length: 30
    Code of an external payee who is responsible for paying regular or express bank charges, such as Payee or Payer. Values are from the IBY_BANK_CHARGE_BEARER lookup.
  • Title: Bank Charge Bearer Name
    Maximum Length: 255
    Name of an external payee who is responsible for paying regular or express bank charges, such as Payee or Payer.
  • Title: Bank Instruction Code One
    Maximum Length: 30
    Code of the first bank instruction to an external payee.
  • Title: Bank Instruction Code Two
    Maximum Length: 30
    Code of the second bank instruction to the external payee.
  • Title: Bank Instruction Details
    Maximum Length: 255
    Details of an additional bank instruction to an external payee.
  • Title: Bank Instruction Name One
    Maximum Length: 255
    Name of the first bank instruction to the external payee.
  • Title: Bank Instruction Name Two
    Maximum Length: 255
    Name of the second bank instruction to an external payee.
  • Maximum Length: 255
    Country code and name of the first bank instruction for an external payee.
  • Maximum Length: 255
    Country code and name of the second bank instruction for an external payee.
  • Title: Delivery Channel Code
    Maximum Length: 30
    Code of the delivery channel for an external payee.
  • Maximum Length: 255
    Concatenates the country code associated with a payment and the delivery channel name for an external payee.
  • Title: Delivery Channel Name
    Maximum Length: 255
    Name of the delivery channel for an external payee.
  • Title: Remittance Advice Delivery Method
    Maximum Length: 30
    Code representing the delivery method. Delivery method specified for external payees, such as EMAIL, FAX, PRINTED, EMAILPDF, and EMAILCSV based on values from the IBY_DELIVERY_METHODS lookup. Used unless the payment process profile is set to Override with Payee Delivery Method Preference.
  • Maximum Length: 255
    Delivery method specified for external payees, such as E-Mail, Fax, Printed, Email with PDF as attachment, and Email with CSV as attachment based on values from the IBY_DELIVERY_METHODS lookup. Used unless the payment process profile is set to Override with Payee Delivery Method Preference.
  • Digital Payment Account Assignments
    Title: Digital Payment Account Assignments
    The digital payment account assignment provides access to assignment records that define which digital payment accounts are linked to specific entities within the system. These assignments support account lifecycle management, payment routing, access control, and transaction processing.
  • Maximum Length: 255
    Email address at which an external payee receives remittance advice.
  • External Party Payment Methods
    Title: External Party Payment Methods
    The external party payment methods resource is used to view, create, and modify payment methods assigned to supplier payees.
  • Maximum Length: 100
    Fax number at which an external payee receives remittance advice.
  • Purpose of the external payee. The value is based on the payment function of the external payee. The following are the expected values: PAYABLES_DISB - Supplier, EMPLOYEE_EXP - Person, EMPLOYEE_EXP - Employee, AR_CUSTOMER_REFUNDS - Refund, CUSTOMER_PAYMENT - Customer, ONETIME_PAYMENT - Onetime, and ADHOC_PAYMENT - Adhoc.
  • Maximum Length: 1
    Default Value: N
    Indicates whether documents payable for an external payee are prevented from being grouped with other like documents payable for payment.
  • Title: Payment Format Code
    Maximum Length: 30
    Code of the payment format that is associated with an external payee.
  • Title: Payment Format Name
    Maximum Length: 300
    Name of the payment format that is associated with an external payee.
  • Title: Payment Reason Code
    Maximum Length: 30
    Code of the reason for paying an external payee.
  • Title: Payment Reason Comments
    Maximum Length: 240
    Text field available for entering information about an external payee payment.
  • Maximum Length: 255
    Concatenates the country code associated with a payment and the payment reason name for an external payee.
  • Title: Payment Reason Name
    Maximum Length: 255
    Name of the reason for paying an external payee.
  • Title: Payment Text Message 1
    Maximum Length: 256
    First text payment message to an external payee.
  • Title: Payment Text Message 3
    Maximum Length: 256
    Third text payment message to an external payee.
  • Title: Payment Text Message 2
    Maximum Length: 256
    Second text payment message to an external payee.
  • Person identifier when the external payee is an employee.
  • Title: Service Level Code
    Maximum Length: 30
    Code of the service level for an external payee.
  • Title: Service Level Name
    Maximum Length: 255
    Name of the service level for an external payee.
  • Title: Settlement Priority
    Maximum Length: 30
    Code representing the settlement priority. Priority for payment settlement by a financial institution or payment system for an external payee.
  • Maximum Length: 255
    Priority for payment settlement by a financial institution or payment system for an external payee.
Nested Schema : Digital Payment Account Assignments
Type: array
Title: Digital Payment Account Assignments
The digital payment account assignment provides access to assignment records that define which digital payment accounts are linked to specific entities within the system. These assignments support account lifecycle management, payment routing, access control, and transaction processing.
Show Source
Nested Schema : External Party Payment Methods
Type: array
Title: External Party Payment Methods
The external party payment methods resource is used to view, create, and modify payment methods assigned to supplier payees.
Show Source
Nested Schema : schema
Type: object
Show Source
  • Title: Alias
    Maximum Length: 150
    Additional alias used to represent the virtual card digital payment account.
  • Title: Alias
    Maximum Length: 150
    Additional alias used to represent the virtual card digital payment account.
  • Title: Alias
    Maximum Length: 150
    Alias used to represent the digital payment account.
  • Title: Alias
    Maximum Length: 150
    Additional alias used to represent the digital payment account.
  • Title: Alias
    Maximum Length: 150
    Additional alias used to represent the digital payment account.
  • Title: Bank Account
    Maximum Length: 100
    Bank account assigned to the digital payment account.
  • Title: Country Code
    Maximum Length: 2
    Country code of the digital payment account.
  • Title: Currency Code
    Maximum Length: 15
    Currency code of the digital payment account.
  • Title: Registration Status
    Maximum Length: 80
    Registration status of the provider for the digital payment account.
  • Title: Display Name
    Maximum Length: 150
    Display name of the digital payment account.
  • Title: Digital Payment Account ID
    Unique identifier of the digital payment account.
  • Title: End Date
    The date when the relationship between the payment instrument and the payer or payee becomes inactive in the payment instrument assignment.
  • Title: Inactive On
    The date when the digital payment account expires.
  • Title: Primary
    Maximum Length: 30
    Indicates whether the payment instrument is the primary payment instrument for the payer or payee within the instrument assignment. A primary payment instrument automatically populates the transactions.
  • Title: Remit Advice Identifier
    Maximum Length: 150
    Additional unique identifier for a separate remittance advice.
  • Title: Remit Advice Identifier
    Maximum Length: 150
    Additional unique identifier for separate remittance advice.
  • Title: Remit Advice Identifier
    Maximum Length: 150
    Remittance advice identifier used for separate remittance advice processing.
  • Title: Remit Advice Identifier
    Maximum Length: 150
    Additional unique identifier for a separate remittance advice.
  • Title: Remit Advice Identifier
    Maximum Length: 150
    Additional remittance advice identifier used for separate remittance advice processing.
  • Title: Start Date
    The date when the relationship between the payment instrument and the payer or payee becomes active in the payment instrument assignment.
  • Title: Token
    Maximum Length: 150
    Substitute identifier of the digital payment account.
Nested Schema : paymentsExternalPayees-externalPartyPaymentMethods-item-patch-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : paymentsExternalPayees-item-response
Type: object
Show Source
  • Title: Bank Charge Bearer Code
    Maximum Length: 30
    Code of an external payee who is responsible for paying regular or express bank charges, such as Payee or Payer. Values are from the IBY_BANK_CHARGE_BEARER lookup.
  • Title: Bank Charge Bearer Name
    Maximum Length: 255
    Name of an external payee who is responsible for paying regular or express bank charges, such as Payee or Payer.
  • Title: Bank Instruction Code One
    Maximum Length: 30
    Code of the first bank instruction to an external payee.
  • Title: Bank Instruction Code Two
    Maximum Length: 30
    Code of the second bank instruction to the external payee.
  • Title: Bank Instruction Details
    Maximum Length: 255
    Details of an additional bank instruction to an external payee.
  • Title: Bank Instruction Name One
    Maximum Length: 255
    Name of the first bank instruction to the external payee.
  • Title: Bank Instruction Name Two
    Maximum Length: 255
    Name of the second bank instruction to an external payee.
  • Maximum Length: 255
    Country code and name of the first bank instruction for an external payee.
  • Maximum Length: 255
    Country code and name of the second bank instruction for an external payee.
  • Title: Default Payment Method Code
    Read Only: true
    Maximum Length: 30
    Code of the default payment method for an external payee.
  • Title: Default Payment Method Name
    Read Only: true
    Maximum Length: 100
    Name of the default payment method for an external payee.
  • Title: Delivery Channel Code
    Maximum Length: 30
    Code of the delivery channel for an external payee.
  • Maximum Length: 255
    Concatenates the country code associated with a payment and the delivery channel name for an external payee.
  • Title: Delivery Channel Name
    Maximum Length: 255
    Name of the delivery channel for an external payee.
  • Title: Remittance Advice Delivery Method
    Maximum Length: 30
    Code representing the delivery method. Delivery method specified for external payees, such as EMAIL, FAX, PRINTED, EMAILPDF, and EMAILCSV based on values from the IBY_DELIVERY_METHODS lookup. Used unless the payment process profile is set to Override with Payee Delivery Method Preference.
  • Maximum Length: 255
    Delivery method specified for external payees, such as E-Mail, Fax, Printed, Email with PDF as attachment, and Email with CSV as attachment based on values from the IBY_DELIVERY_METHODS lookup. Used unless the payment process profile is set to Override with Payee Delivery Method Preference.
  • Digital Payment Account Assignments
    Title: Digital Payment Account Assignments
    The digital payment account assignment provides access to assignment records that define which digital payment accounts are linked to specific entities within the system. These assignments support account lifecycle management, payment routing, access control, and transaction processing.
  • Maximum Length: 255
    Email address at which an external payee receives remittance advice.
  • External Party Payment Methods
    Title: External Party Payment Methods
    The external party payment methods resource is used to view, create, and modify payment methods assigned to supplier payees.
  • Maximum Length: 100
    Fax number at which an external payee receives remittance advice.
  • Purpose of the external payee. The value is based on the payment function of the external payee. The following are the expected values: PAYABLES_DISB - Supplier, EMPLOYEE_EXP - Person, EMPLOYEE_EXP - Employee, AR_CUSTOMER_REFUNDS - Refund, CUSTOMER_PAYMENT - Customer, ONETIME_PAYMENT - Onetime, and ADHOC_PAYMENT - Adhoc.
  • Links
  • Maximum Length: 255
    Identifier of the business unit associated with an external payee.
  • Title: Organization Name
    Maximum Length: 240
    Name of the business unit associated with an external payee.
  • Title: Organization Type
    Read Only: true
    Maximum Length: 30
    Type of organization, such as a business unit, that has a relationship with an external payee. Values are from the IBY_ORGANIZATION_TYPES lookup.
  • Title: Name
    Maximum Length: 360
    Name of an external payee.
  • Maximum Length: 1
    Default Value: N
    Indicates whether documents payable for an external payee are prevented from being grouped with other like documents payable for payment.
  • Application-generated identifier of the external payee.
  • Title: Payee Party Identifier
    Identifier of an external payee.
  • Title: Registry ID
    Maximum Length: 30
    Application-generated party number in Trading Community Architecture.
  • Title: Payee Party Site Identifier
    Identifier of an external payee site.
  • Title: Site Number
    Maximum Length: 30
    Number of an external payee site.
  • Title: Payment Format Code
    Maximum Length: 30
    Code of the payment format that is associated with an external payee.
  • Title: Payment Format Name
    Maximum Length: 300
    Name of the payment format that is associated with an external payee.
  • Title: Payment Function
    Maximum Length: 30
    Code that indicates the function or purpose of the payment. Values from the IBY_PAYMENT_FUNCTIONS lookup include SUPPLIER_PAYMENT, CUSTOMER_REFUNDS, and Others.
  • Title: Payment Reason Code
    Maximum Length: 30
    Code of the reason for paying an external payee.
  • Title: Payment Reason Comments
    Maximum Length: 240
    Text field available for entering information about an external payee payment.
  • Maximum Length: 255
    Concatenates the country code associated with a payment and the payment reason name for an external payee.
  • Title: Payment Reason Name
    Maximum Length: 255
    Name of the reason for paying an external payee.
  • Title: Payment Text Message 1
    Maximum Length: 256
    First text payment message to an external payee.
  • Title: Payment Text Message 3
    Maximum Length: 256
    Third text payment message to an external payee.
  • Title: Payment Text Message 2
    Maximum Length: 256
    Second text payment message to an external payee.
  • Person identifier when the external payee is an employee.
  • Title: Service Level Code
    Maximum Length: 30
    Code of the service level for an external payee.
  • Title: Service Level Name
    Maximum Length: 255
    Name of the service level for an external payee.
  • Title: Settlement Priority
    Maximum Length: 30
    Code representing the settlement priority. Priority for payment settlement by a financial institution or payment system for an external payee.
  • Maximum Length: 255
    Priority for payment settlement by a financial institution or payment system for an external payee.
  • Title: Supplier Number
    Maximum Length: 30
    Application-generated party number in Procurement.
  • Title: Site
    Maximum Length: 240
    Code of a supplier site.
  • Title: Supplier Site Identifier
    Identifier of a supplier site.
Nested Schema : Digital Payment Account Assignments
Type: array
Title: Digital Payment Account Assignments
The digital payment account assignment provides access to assignment records that define which digital payment accounts are linked to specific entities within the system. These assignments support account lifecycle management, payment routing, access control, and transaction processing.
Show Source
Nested Schema : External Party Payment Methods
Type: array
Title: External Party Payment Methods
The external party payment methods resource is used to view, create, and modify payment methods assigned to supplier payees.
Show Source
Nested Schema : paymentsExternalPayees-digitalPaymentAccountAssignments-item-response
Type: object
Show Source
  • Title: Account Usage Type
    Read Only: true
    Maximum Length: 80
    Purpose of the digital payment account.
  • Title: Alias
    Maximum Length: 150
    Additional alias used to represent the virtual card digital payment account.
  • Title: Alias
    Maximum Length: 150
    Additional alias used to represent the virtual card digital payment account.
  • Title: Alias
    Maximum Length: 150
    Alias used to represent the digital payment account.
  • Title: Alias
    Maximum Length: 150
    Additional alias used to represent the digital payment account.
  • Title: Alias
    Maximum Length: 150
    Additional alias used to represent the digital payment account.
  • Title: Alias Type
    Read Only: true
    Maximum Length: 80
    Type of alias used to represent the digital payment account.
  • Title: Bank Account
    Maximum Length: 100
    Bank account assigned to the digital payment account.
  • Title: Card Platform
    Read Only: true
    Maximum Length: 80
    Name of the payment system used by the virtual card program.
  • Title: Country Code
    Maximum Length: 2
    Country code of the digital payment account.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the digital payment account assignment.
  • Title: Creation Date
    Read Only: true
    The date and time when the digital payment account assignment was created.
  • Title: Currency Code
    Maximum Length: 15
    Currency code of the digital payment account.
  • Title: Registration Status
    Maximum Length: 80
    Registration status of the provider for the digital payment account.
  • Title: Display Name
    Maximum Length: 150
    Display name of the digital payment account.
  • Title: Digital Payment Account ID
    Unique identifier of the digital payment account.
  • Title: End Date
    The date when the relationship between the payment instrument and the payer or payee becomes inactive in the payment instrument assignment.
  • Title: Inactive On
    The date when the digital payment account expires.
  • Title: Instrument Payment Use ID
    Read Only: true
    Unique identifier of the instrument assignment.
  • Title: Instrument Type
    Read Only: true
    Maximum Length: 80
    Type of payment instrument used in the instrument assignment.
  • Title: Start Date
    Read Only: true
    The date when the digital payment account was issued.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the digital payment account assignment was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the digital payment account assignment.
  • Links
  • Title: Owner Party Name
    Read Only: true
    Maximum Length: 360
    Party name of the digital payment account owner.
  • Title: Owner Party Number
    Read Only: true
    Maximum Length: 30
    Party number of the digital payment account owner.
  • Title: Payment Flow
    Read Only: true
    Maximum Length: 80
    Payment flow that determines whether the instrument assignment is used for outgoing or incoming payments.
  • Title: Payment Mode
    Read Only: true
    Maximum Length: 80
    Payment method used by the digital payment account.
  • Title: Primary
    Maximum Length: 30
    Indicates whether the payment instrument is the primary payment instrument for the payer or payee within the instrument assignment. A primary payment instrument automatically populates the transactions.
  • Title: Remit Advice Identifier
    Maximum Length: 150
    Additional unique identifier for a separate remittance advice.
  • Title: Remit Advice Identifier
    Maximum Length: 150
    Additional unique identifier for separate remittance advice.
  • Title: Remit Advice Identifier
    Maximum Length: 150
    Remittance advice identifier used for separate remittance advice processing.
  • Title: Remit Advice Identifier
    Maximum Length: 150
    Additional unique identifier for a separate remittance advice.
  • Title: Remit Advice Identifier
    Maximum Length: 150
    Additional remittance advice identifier used for separate remittance advice processing.
  • Title: Remit Advice Identifier Type
    Read Only: true
    Maximum Length: 80
    Type of remittance advice identifier assigned to the digital payment account.
  • Title: Start Date
    The date when the relationship between the payment instrument and the payer or payee becomes active in the payment instrument assignment.
  • Title: Straight Through Processing
    Read Only: true
    Maximum Length: 1
    Indicates whether straight through processing is enabled for the digital payment account.
  • Title: Token
    Maximum Length: 150
    Substitute identifier of the digital payment account.
  • Title: Token Type
    Read Only: true
    Maximum Length: 80
    Type of token assigned to the digital payment account.
  • Title: Card Program
    Maximum Length: 100
    Virtual card program associated with the digital payment account.
Nested Schema : paymentsExternalPayees-externalPartyPaymentMethods-item-response
Type: object
Show Source
Links
digitalPaymentAccountAssignments
Parameters:
  • PayeeId: $request.path.PayeeId
The digital payment account assignment provides access to assignment records that define which digital payment accounts are linked to specific entities within the system. These assignments support account lifecycle management, payment routing, access control, and transaction processing.
externalPartyPaymentMethods
Parameters:
  • PayeeId: $request.path.PayeeId
The external party payment methods resource is used to view, create, and modify payment methods assigned to supplier payees.
Back to Top

Examples

Example 1

The following example shows how to update a external payee 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/300100173366595

Example Request Body

The following example shows the contents of the request body in JSON format:

{
    "DeliveryMethod": "EMAIL",
    "Email":"valid.email@example.com",
    "Intent": "Supplier"
}

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "PayeeId": 300100173366595,
    "DeliveryMethod": "EMAIL",
    "Email":"valid.email@example.com",
    "Intent": "Supplier",
    ...
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/300100173366595",
            "name": "paymentsExternalPayees",
            "kind": "item",
            "properties": {
                             "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                          }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/300100173366595",
            "name": "paymentsExternalPayees",
            "kind": "item"
        },
        ...
    ]
}

Example 2

The following example shows how to update an external payee for a supplier 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/300100180882048

Example Request Body

The following example shows the contents of the response body in JSON format:

{
    "DeliveryMethod": "EMAIL",
    "Email": "test@example.com",
    "Intent": "Supplier"
}

Example Response Body

The following example shows the contents of the response body in JSON format:

{
  "PayeeId": 300100180882048,
  "PaymentFunctionCode": "PAYABLES_DISB",
  "OrganizationIdentifier": null,
  "OrganizationName": null,
  "OrganizationType": null,
  "PayEachDocumentAloneOption": "N",
  "DefaultPaymentMethodCode": null,
  "DefaultPaymentMethodName": null,
  "BankChargeBearerCode": null,
  "BankChargeBearerName": null,
  "BankInstructionCodeOne": null,
  "BankInstructionNameOne": null,
  "BankInstructionCodeTwo": null,
  "BankInstructionNameTwo": null,
  "BankInstructionDetails": null,
  "PaymentReasonCode": null,
  "PaymentReasonName": null,
  "PaymentReasonComments": null,
  "PaymentTextMessageOne": null,
  "PaymentTextMessageTwo": null,
  "PaymentTextMessageThree": null,
  "DeliveryChannelCode": null,
  "DeliveryChannelName": null,
  "ServiceLevelCode": null,
  "ServiceLevelName": null,
  "SettlementPriority": null,
  "DeliveryMethod": "EMAIL",
  "Email": "test@example.com",
  "Fax": null,
  "PayeePartyIdentifier": 333937,
  "PartyName": null,
  "PayeePartyNumber": null,
  "PayeePartySiteIdentifier": null,
  "SupplierNumber": null,
  "SupplierSiteCode": null,
  "SupplierSiteIdentifier": null,
  "PayeePartySiteNumber": null,
  "PaymentFormatCode": null,
  "PaymentFormatName": null,
  "PersonId": null,
  "Intent": "Supplier",
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/300100180882048",
      "name": "paymentsExternalPayees",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
      }
    },
    {
      "rel": "canonical",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/300100180882048",
      "name": "paymentsExternalPayees",
      "kind": "item"
    },
    {
      "rel": "child",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/300100180882048/child/externalPartyPaymentMethods",
      "name": "externalPartyPaymentMethods",
      "kind": "collection"
    }
  ]
}

Example 3

The following example shows how to update an external payee for a supplier site 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/300100180897625

Example Request Body

The following example shows the contents of the request body in JSON format:

{
    "DeliveryMethod": "EMAIL",
    "Email": "test@example.com",
    "Intent": "Supplier Site"
}

Example Response Body

The following example shows the contents of the response body in JSON format:

{
  "PayeeId": 300100180897625,
  "PaymentFunctionCode": "PAYABLES_DISB",
  "OrganizationIdentifier": null,
  "OrganizationName": null,
  "OrganizationType": null,
  "PayEachDocumentAloneOption": "N",
  "DefaultPaymentMethodCode": null,
  "DefaultPaymentMethodName": null,
  "BankChargeBearerCode": null,
  "BankChargeBearerName": null,
  "BankInstructionCodeOne": null,
  "BankInstructionNameOne": null,
  "BankInstructionCodeTwo": null,
  "BankInstructionNameTwo": null,
  "BankInstructionDetails": null,
  "PaymentReasonCode": null,
  "PaymentReasonName": null,
  "PaymentReasonComments": null,
  "PaymentTextMessageOne": null,
  "PaymentTextMessageTwo": null,
  "PaymentTextMessageThree": null,
  "DeliveryChannelCode": null,
  "DeliveryChannelName": null,
  "ServiceLevelCode": null,
  "ServiceLevelName": null,
  "SettlementPriority": null,
  "DeliveryMethod": "EMAIL",
  "Email": "test@example.com",
  "Fax": null,
  "PayeePartyIdentifier": 333937,
  "PartyName": null,
  "PayeePartyNumber": null,
  "PayeePartySiteIdentifier": 186215,
  "SupplierNumber": null,
  "SupplierSiteCode": null,
  "SupplierSiteIdentifier": 999992000428884,
  "PayeePartySiteNumber": null,
  "PaymentFormatCode": null,
  "PaymentFormatName": null,
  "PersonId": null,
  "Intent": "Supplier",
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/300100180897625",
      "name": "paymentsExternalPayees",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
      }
    },
    {
      "rel": "canonical",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/300100180897625",
      "name": "paymentsExternalPayees",
      "kind": "item"
    },
    {
      "rel": "child",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/300100180897625/child/externalPartyPaymentMethods",
      "name": "externalPartyPaymentMethods",
      "kind": "collection"
    }
  ]
}

Example 4

The following example shows how to update an external payee for a customer refund 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/300100180898002

Example Request Body

The following example shows the contents of the request body in JSON format:

{
    "DeliveryMethod": "EMAIL",
    "Email": "test@example.com",
    "Intent": "Customer"
}

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "PayeeId": 300100180898002,
    "PaymentFunctionCode": "AR_CUSTOMER_REFUNDS",
    "OrganizationIdentifier": null,
    "OrganizationName": null,
    "OrganizationType": null,
    "PayEachDocumentAloneOption": "N",
    "DefaultPaymentMethodCode": null,
    "DefaultPaymentMethodName": null,
    "BankChargeBearerCode": null,
    "BankChargeBearerName": null,
    "BankInstructionCodeOne": null,
    "BankInstructionNameOne": null,
    "BankInstructionCodeTwo": null,
    "BankInstructionNameTwo": null,
    "BankInstructionDetails": null,
    "PaymentReasonCode": null,
    "PaymentReasonName": null,
    "PaymentReasonComments": null,
    "PaymentTextMessageOne": null,
    "PaymentTextMessageTwo": null,
    "PaymentTextMessageThree": null,
    "DeliveryChannelCode": null,
    "DeliveryChannelName": null,
    "ServiceLevelCode": null,
    "ServiceLevelName": null,
    "SettlementPriority": null,
    "DeliveryMethod": "EMAIL",
    "Email": "test@example.com",
    "Fax": null,
    "PayeePartyIdentifier": 1455998,
    "PartyName": null,
    "PayeePartyNumber": null,
    "PayeePartySiteIdentifier": 567618,
    "SupplierNumber": null,
    "SupplierSiteCode": null,
    "SupplierSiteIdentifier": null,
    "PayeePartySiteNumber": null,
    "PaymentFormatCode": null,
    "PaymentFormatName": null,
    "PersonId": null,
    "Intent": "Customer",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/300100180898002",
            "name": "paymentsExternalPayees",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/300100180898002",
            "name": "paymentsExternalPayees",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/300100180898002/child/externalPartyPaymentMethods",
            "name": "externalPartyPaymentMethods",
            "kind": "collection"
        }
    ]
}

Example 5

The following example shows how to update an external payee for an employee in payroll 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/300100177471395

Example Request Body

The following example shows the contents of the request body in JSON format:

{
    "PaymentReasonComments": "Test-123",
    "PersonId": 300100038590274,
    "Intent": "Person"
}

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "PayeeId": 300100177471395,
    "PaymentFunctionCode": "EMPLOYEE_EXP",
    "OrganizationIdentifier": null,
    "OrganizationName": null,
    "OrganizationType": null,
    "PayEachDocumentAloneOption": "N",
    "DefaultPaymentMethodCode": null,
    "DefaultPaymentMethodName": null,
    "BankChargeBearerCode": null,
    "BankChargeBearerName": null,
    "BankInstructionCodeOne": null,
    "BankInstructionNameOne": null,
    "BankInstructionCodeTwo": null,
    "BankInstructionNameTwo": null,
    "BankInstructionDetails": null,
    "PaymentReasonCode": null,
    "PaymentReasonName": null,
    "PaymentReasonComments": "Test-123",
    "PaymentTextMessageOne": null,
    "PaymentTextMessageTwo": null,
    "PaymentTextMessageThree": null,
    "DeliveryChannelCode": null,
    "DeliveryChannelName": null,
    "ServiceLevelCode": null,
    "ServiceLevelName": null,
    "SettlementPriority": null,
    "DeliveryMethod": null,
    "Email": null,
    "Fax": null,
    "PayeePartyIdentifier": 300100038057642,
    "PartyName": null,
    "PayeePartyNumber": null,
    "PayeePartySiteIdentifier": null,
    "SupplierNumber": null,
    "SupplierSiteCode": null,
    "SupplierSiteIdentifier": null,
    "PayeePartySiteNumber": null,
    "PaymentFormatCode": null,
    "PaymentFormatName": null,
    "PersonId": 300100038590274,
    "Intent": "Person",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/300100177471395",
            "name": "paymentsExternalPayees",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/300100177471395",
            "name": "paymentsExternalPayees",
            "kind": "item"
        }
    ]
}

Example 6

The following example shows how to update an external payee for an employee in expenses 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/300100180898209

Example Request Body

The following example shows the contents of the request body in JSON format:

{
    "PaymentReasonComments": "Test-123",
    "Intent": "Employee"
}

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "PayeeId": 300100180898209,
    "PaymentFunctionCode": "EMPLOYEE_EXP",
    "OrganizationIdentifier": null,
    "OrganizationName": null,
    "OrganizationType": null,
    "PayEachDocumentAloneOption": "N",
    "DefaultPaymentMethodCode": null,
    "DefaultPaymentMethodName": null,
    "BankChargeBearerCode": null,
    "BankChargeBearerName": null,
    "BankInstructionCodeOne": null,
    "BankInstructionNameOne": null,
    "BankInstructionCodeTwo": null,
    "BankInstructionNameTwo": null,
    "BankInstructionDetails": null,
    "PaymentReasonCode": null,
    "PaymentReasonName": null,
    "PaymentReasonComments": "Test-123",
    "PaymentTextMessageOne": null,
    "PaymentTextMessageTwo": null,
    "PaymentTextMessageThree": null,
    "DeliveryChannelCode": null,
    "DeliveryChannelName": null,
    "ServiceLevelCode": null,
    "ServiceLevelName": null,
    "SettlementPriority": null,
    "DeliveryMethod": null,
    "Email": null,
    "Fax": null,
    "PayeePartyIdentifier": 300100148480036,
    "PartyName": null,
    "PayeePartyNumber": null,
    "PayeePartySiteIdentifier": null,
    "SupplierNumber": null,
    "SupplierSiteCode": null,
    "SupplierSiteIdentifier": null,
    "PayeePartySiteNumber": null,
    "PaymentFormatCode": null,
    "PaymentFormatName": null,
    "PersonId": null,
    "Intent": "Employee",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/300100180898209",
            "name": "paymentsExternalPayees",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/300100180898209",
            "name": "paymentsExternalPayees",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/300100180898209/child/externalPartyPaymentMethods",
            "name": "externalPartyPaymentMethods",
            "kind": "collection"
        }
    ]
}

Example 7

The following example shows how to update an external payee for an ad-hoc payee in cash management 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/300100180582389

Example Request Body

The following example shows the contents of the request body in JSON format:

{
    "DeliveryMethod": "EMAIL",
    "Email": "test@example.com",
    "Intent": "Adhoc"
}

Example Response Body

The following example shows the contents of the response body in JSON format:

{
  "PayeeId": 300100180582389,
  "PaymentFunctionCode": "ADHOC_PAYMENT",
  "OrganizationIdentifier": null,
  "OrganizationName": null,
  "OrganizationType": null,
  "PayEachDocumentAloneOption": "N",
  "DefaultPaymentMethodCode": null,
  "DefaultPaymentMethodName": null,
  "BankChargeBearerCode": null,
  "BankChargeBearerName": null,
  "BankInstructionCodeOne": null,
  "BankInstructionNameOne": null,
  "BankInstructionCodeTwo": null,
  "BankInstructionNameTwo": null,
  "BankInstructionDetails": null,
  "PaymentReasonCode": null,
  "PaymentReasonName": null,
  "PaymentReasonComments": null,
  "PaymentTextMessageOne": null,
  "PaymentTextMessageTwo": null,
  "PaymentTextMessageThree": null,
  "DeliveryChannelCode": null,
  "DeliveryChannelName": null,
  "ServiceLevelCode": null,
  "ServiceLevelName": null,
  "SettlementPriority": null,
  "DeliveryMethod": "EMAIL",
  "Email": "test@example.com",
  "Fax": null,
  "PayeePartyIdentifier": 300100121773260,
  "PartyName": null,
  "PayeePartyNumber": null,
  "PayeePartySiteIdentifier": null,
  "SupplierNumber": null,
  "SupplierSiteCode": null,
  "SupplierSiteIdentifier": null,
  "PayeePartySiteNumber": null,
  "PaymentFormatCode": null,
  "PaymentFormatName": null,
  "PersonId": null,
  "Intent": "Adhoc",
  "links": [
    {
      "rel": "self",
      "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/300100180582389",
      "name": "paymentsExternalPayees",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
      }
    },
    {
      "rel": "canonical",
      "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/300100180582389",
      "name": "paymentsExternalPayees",
      "kind": "item"
    },
    {
      "rel": "child",
      "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/300100180582389/child/externalPartyPaymentMethods",
      "name": "externalPartyPaymentMethods",
      "kind": "collection"
    }
  ]
}

Example 8

The following example shows how to update an external payee for a onetime payee in payables 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/300100180582391

Example Request Body

The following example shows the contents of the request body in JSON format:

{
    "DeliveryMethod": "EMAIL",
    "Email": "test@example.com",
    "Intent": "Onetime"
}

Example Respond Body

The following example shows the contents of the response body in JSON format:

{
  "PayeeId": 300100180582391,
  "PaymentFunctionCode": "ONETIME_PAYMENT",
  "OrganizationIdentifier": null,
  "OrganizationName": null,
  "OrganizationType": null,
  "PayEachDocumentAloneOption": "N",
  "DefaultPaymentMethodCode": null,
  "DefaultPaymentMethodName": null,
  "BankChargeBearerCode": null,
  "BankChargeBearerName": null,
  "BankInstructionCodeOne": null,
  "BankInstructionNameOne": null,
  "BankInstructionCodeTwo": null,
  "BankInstructionNameTwo": null,
  "BankInstructionDetails": null,
  "PaymentReasonCode": null,
  "PaymentReasonName": null,
  "PaymentReasonComments": null,
  "PaymentTextMessageOne": null,
  "PaymentTextMessageTwo": null,
  "PaymentTextMessageThree": null,
  "DeliveryChannelCode": null,
  "DeliveryChannelName": null,
  "ServiceLevelCode": null,
  "ServiceLevelName": null,
  "SettlementPriority": null,
  "DeliveryMethod": "EMAIL",
  "Email": "test@example.com",
  "Fax": null,
  "PayeePartyIdentifier": 100100050897855,
  "PartyName": null,
  "PayeePartyNumber": null,
  "PayeePartySiteIdentifier": null,
  "SupplierNumber": null,
  "SupplierSiteCode": null,
  "SupplierSiteIdentifier": null,
  "PayeePartySiteNumber": null,
  "PaymentFormatCode": null,
  "PaymentFormatName": null,
  "PersonId": null,
  "Intent": "Onetime",
  "links": [
    {
      "rel": "self",
      "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/300100180582391",
      "name": "paymentsExternalPayees",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
      }
    },
    {
      "rel": "canonical",
      "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/300100180582391",
      "name": "paymentsExternalPayees",
      "kind": "item"
    },
    {
      "rel": "child",
      "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/300100180582391/child/externalPartyPaymentMethods",
      "name": "externalPartyPaymentMethods",
      "kind": "collection"
    }
  ]
}
Back to Top