Create an external payee
/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees
Request
-
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
- application/json
object
-
BankChargeBearerCode: string
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. -
BankChargeBearerName: string
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. -
BankInstructionCodeOne: string
Title:
Bank Instruction Code One
Maximum Length:30
Code of the first bank instruction to an external payee. -
BankInstructionCodeTwo: string
Title:
Bank Instruction Code Two
Maximum Length:30
Code of the second bank instruction to the external payee. -
BankInstructionDetails: string
Title:
Bank Instruction Details
Maximum Length:255
Details of an additional bank instruction to an external payee. -
BankInstructionNameOne: string
Title:
Bank Instruction Name One
Maximum Length:255
Name of the first bank instruction to the external payee. -
BankInstructionNameTwo: string
Title:
Bank Instruction Name Two
Maximum Length:255
Name of the second bank instruction to an external payee. -
DeliveryChannelCode: string
Title:
Delivery Channel Code
Maximum Length:30
Code of the delivery channel for an external payee. -
DeliveryChannelName: string
Title:
Delivery Channel Name
Maximum Length:255
Name of the delivery channel for an external payee. -
DeliveryMethod: string
Title:
Remittance Advice Delivery Method
Maximum Length:30
Delivery method that is set on the external payee level. If the Override with Payee Delivery Method Preference option on the payment process profile is turned off, the setting is ignored. Values from the IBY_DELIVERY_METHODS lookup include EMAIL, FAX, and PRINTED. -
Email: string
Maximum Length:
255
Email address at which an external payee receives remittance advice. -
externalPartyPaymentMethods: array
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. -
Fax: string
Maximum Length:
100
Fax number at which an external payee receives remittance advice. -
Intent: string
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.
-
OrganizationIdentifier: string
Maximum Length:
255
Identifier of the business unit associated with an external payee. -
OrganizationName: string
Title:
Organization Name
Maximum Length:240
Name of the business unit associated with an external payee. -
PartyName(required): string
Title:
Name
Maximum Length:360
Name of an external payee. -
PayEachDocumentAloneOption: string
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. -
PayeeId: integer
(int64)
Application-generated identifier of the external payee.
-
PayeePartyIdentifier(required): integer
(int64)
Title:
Payee Party Identifier
Identifier of an external payee. -
PayeePartyNumber(required): string
Title:
Registry ID
Maximum Length:30
Application-generated party number in Trading Community Architecture. -
PayeePartySiteIdentifier: integer
(int64)
Title:
Payee Party Site Identifier
Identifier of an external payee site. -
PayeePartySiteNumber: string
Title:
Site Number
Maximum Length:30
Number of an external payee site. -
PaymentFormatCode: string
Title:
Payment Format Code
Maximum Length:30
Code of the payment format that is associated with an external payee. -
PaymentFormatName: string
Title:
Payment Format Name
Maximum Length:300
Name of the payment format that is associated with an external payee. -
PaymentFunctionCode(required): string
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. -
PaymentReasonCode: string
Title:
Payment Reason Code
Maximum Length:30
Code of the reason for paying an external payee. -
PaymentReasonComments: string
Title:
Payment Reason Comments
Maximum Length:240
Text field available for entering information about an external payee payment. -
PaymentReasonName: string
Title:
Payment Reason Name
Maximum Length:255
Name of the reason for paying an external payee. -
PaymentTextMessageOne: string
Title:
Payment Text Message 1
Maximum Length:256
First text payment message to an external payee. -
PaymentTextMessageThree: string
Title:
Payment Text Message 3
Maximum Length:256
Third text payment message to an external payee. -
PaymentTextMessageTwo: string
Title:
Payment Text Message 2
Maximum Length:256
Second text payment message to an external payee. -
PersonId: integer
Person identifier when the external payee is an employee.
-
ServiceLevelCode: string
Title:
Service Level Code
Maximum Length:30
Code of the service level for an external payee. -
ServiceLevelName: string
Title:
Service Level Name
Maximum Length:255
Name of the service level for an external payee. -
SettlementPriority: string
Title:
Settlement Priority
Maximum Length:30
Priority with which the financial institution or payment system settles payments for an external payee. -
SupplierNumber: string
Title:
Supplier Number
Maximum Length:30
Application-generated party number in Procurement. -
SupplierSiteCode: string
Title:
Site
Maximum Length:240
Code of a supplier site. -
SupplierSiteIdentifier: integer
(int64)
Title:
Supplier Site Identifier
Identifier of a supplier site.
array
External Party Payment Methods
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. -
PayeeId: integer
(int64)
Value that uniquely identifies the external payee.
-
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
- application/json
Default Response
-
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.
object
-
BankChargeBearerCode: string
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. -
BankChargeBearerName: string
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. -
BankInstructionCodeOne: string
Title:
Bank Instruction Code One
Maximum Length:30
Code of the first bank instruction to an external payee. -
BankInstructionCodeTwo: string
Title:
Bank Instruction Code Two
Maximum Length:30
Code of the second bank instruction to the external payee. -
BankInstructionDetails: string
Title:
Bank Instruction Details
Maximum Length:255
Details of an additional bank instruction to an external payee. -
BankInstructionNameOne: string
Title:
Bank Instruction Name One
Maximum Length:255
Name of the first bank instruction to the external payee. -
BankInstructionNameTwo: string
Title:
Bank Instruction Name Two
Maximum Length:255
Name of the second bank instruction to an external payee. -
DefaultPaymentMethodCode: string
Title:
Default Payment Method Code
Read Only:true
Maximum Length:30
Code of the default payment method for an external payee. -
DefaultPaymentMethodName: string
Title:
Default Payment Method Name
Read Only:true
Maximum Length:100
Name of the default payment method for an external payee. -
DeliveryChannelCode: string
Title:
Delivery Channel Code
Maximum Length:30
Code of the delivery channel for an external payee. -
DeliveryChannelName: string
Title:
Delivery Channel Name
Maximum Length:255
Name of the delivery channel for an external payee. -
DeliveryMethod: string
Title:
Remittance Advice Delivery Method
Maximum Length:30
Delivery method that is set on the external payee level. If the Override with Payee Delivery Method Preference option on the payment process profile is turned off, the setting is ignored. Values from the IBY_DELIVERY_METHODS lookup include EMAIL, FAX, and PRINTED. -
Email: string
Maximum Length:
255
Email address at which an external payee receives remittance advice. -
externalPartyPaymentMethods: array
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. -
Fax: string
Maximum Length:
100
Fax number at which an external payee receives remittance advice. -
Intent: string
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationIdentifier: string
Maximum Length:
255
Identifier of the business unit associated with an external payee. -
OrganizationName: string
Title:
Organization Name
Maximum Length:240
Name of the business unit associated with an external payee. -
OrganizationType: string
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. -
PartyName: string
Title:
Name
Maximum Length:360
Name of an external payee. -
PayEachDocumentAloneOption: string
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. -
PayeeId: integer
(int64)
Application-generated identifier of the external payee.
-
PayeePartyIdentifier: integer
(int64)
Title:
Payee Party Identifier
Identifier of an external payee. -
PayeePartyNumber: string
Title:
Registry ID
Maximum Length:30
Application-generated party number in Trading Community Architecture. -
PayeePartySiteIdentifier: integer
(int64)
Title:
Payee Party Site Identifier
Identifier of an external payee site. -
PayeePartySiteNumber: string
Title:
Site Number
Maximum Length:30
Number of an external payee site. -
PaymentFormatCode: string
Title:
Payment Format Code
Maximum Length:30
Code of the payment format that is associated with an external payee. -
PaymentFormatName: string
Title:
Payment Format Name
Maximum Length:300
Name of the payment format that is associated with an external payee. -
PaymentFunctionCode: string
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. -
PaymentReasonCode: string
Title:
Payment Reason Code
Maximum Length:30
Code of the reason for paying an external payee. -
PaymentReasonComments: string
Title:
Payment Reason Comments
Maximum Length:240
Text field available for entering information about an external payee payment. -
PaymentReasonName: string
Title:
Payment Reason Name
Maximum Length:255
Name of the reason for paying an external payee. -
PaymentTextMessageOne: string
Title:
Payment Text Message 1
Maximum Length:256
First text payment message to an external payee. -
PaymentTextMessageThree: string
Title:
Payment Text Message 3
Maximum Length:256
Third text payment message to an external payee. -
PaymentTextMessageTwo: string
Title:
Payment Text Message 2
Maximum Length:256
Second text payment message to an external payee. -
PersonId: integer
Person identifier when the external payee is an employee.
-
ServiceLevelCode: string
Title:
Service Level Code
Maximum Length:30
Code of the service level for an external payee. -
ServiceLevelName: string
Title:
Service Level Name
Maximum Length:255
Name of the service level for an external payee. -
SettlementPriority: string
Title:
Settlement Priority
Maximum Length:30
Priority with which the financial institution or payment system settles payments for an external payee. -
SupplierNumber: string
Title:
Supplier Number
Maximum Length:30
Application-generated party number in Procurement. -
SupplierSiteCode: string
Title:
Site
Maximum Length:240
Code of a supplier site. -
SupplierSiteIdentifier: integer
(int64)
Title:
Supplier Site Identifier
Identifier of a supplier site.
array
External Party Payment Methods
array
Links
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.
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
- 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. - PayeeId:
Examples
Example 1
The following example shows how to create an external payee by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "PayeePartyIdentifier":336590, "PayeePartySiteIdentifier": 188868, "SupplierSiteIdentifier": 999992000465212, "PaymentFunctionCode": "PAYABLES_DISB", "Intent": "Supplier" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "PayeePartyIdentifier":336590, "PayeePartySiteIdentifier": 188868, "SupplierSiteIdentifier": 999992000465212, "PaymentFunctionCode": "PAYABLES_DISB", "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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "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 create an external payee for a supplier by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees
Example Request Body
The following example shows the contents of the request body in JSON format:
{ "PayeePartyIdentifier":333937, "PaymentFunctionCode": "PAYABLES_DISB", "Intent": "Supplier" }
Example Request 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": null, "Email": null, "Fax": null, "PayeePartyIdentifier": 333937, "PartyName": "JACK N JILL INC", "PayeePartyNumber": "139161", "PayeePartySiteIdentifier": null, "SupplierNumber": "47659", "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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "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" } ]e }
Example 3
The following example shows how to create an external payee for a supplier site by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees
Example Request Body
The following example shows the contents of the request body in JSON format:
{ "PayeePartyIdentifier": 333937, "PayeePartySiteIdentifier": 186215, "SupplierSiteIdentifier": 999992000428884, "PaymentFunctionCode": "PAYABLES_DISB", "Intent": "Supplier" }
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": null, "Email": null, "Fax": null, "PayeePartyIdentifier": 333937, "PartyName": "JACK N JILL INC", "PayeePartyNumber": "139161", "PayeePartySiteIdentifier": 186215, "SupplierNumber": "47659", "SupplierSiteCode": "POZ55120", "SupplierSiteIdentifier": 999992000428884, "PayeePartySiteNumber": "58814", "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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "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 create an external payee for customer refund by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees
Example Request Body
The following example shows the contents of the request body in JSON format:
{ "PayeePartyIdentifier":1455998, "PayeePartySiteIdentifier": 567618, "PaymentFunctionCode": "AR_CUSTOMER_REFUNDS", "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": null, "Email": null, "Fax": null, "PayeePartyIdentifier": 1455998, "PartyName": "WILK SHIRT CORP", "PayeePartyNumber": "1259314", "PayeePartySiteIdentifier": 567618, "SupplierNumber": null, "SupplierSiteCode": null, "SupplierSiteIdentifier": null, "PayeePartySiteNumber": "446275", "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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "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 create an external payee for an employee in Payroll by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees
Example Request Body
The following example shows the contents of the request body in JSON format:
{ "PayeePartyIdentifier": 300100038057642, "PaymentFunctionCode": "EMPLOYEE_EXP", "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": null, "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": "ZHRX_VS BV_CUSTUSER01", "PayeePartyNumber": "CDRM_76070", "PayeePartySiteIdentifier": null, "SupplierNumber": null, "SupplierSiteCode": null, "SupplierSiteIdentifier": null, "PayeePartySiteNumber": null, "PaymentFormatCode": null, "PaymentFormatName": null, "PersonId": null, "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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "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 create an external payee for an employee in Expenses by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees
Example Request Body
The following example shows the contents of the request body in JSON format:
{ "PayeePartyIdentifier": 300100148480036, "PaymentFunctionCode": "EMPLOYEE_EXP", "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": null, "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": "CVBUYER01_DK", "PayeePartyNumber": "CDRM_733616", "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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "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 create an external payee for an adhoc payee in Cash Management by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees
Example Request Body
The following example shows the contents of the request body in JSON format:
{ "PayeePartyIdentifier":300100121773260, "PaymentFunctionCode": "ADHOC_PAYMENT", "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": null, "Email": null, "Fax": null, "PayeePartyIdentifier": 300100121773260, "PartyName": "CE_ADHOC_Payee", "PayeePartyNumber": "CDRM_681211", "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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "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 create an external payee for a bank payee in Cash Management by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees
Example Request Body
The following example shows the contents of the request body in JSON format:
{ "PayeePartyIdentifier":299160, "PaymentFunctionCode": "CASH_PAYMENT", "Intent": "BAT" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "PayeeId": 300100180582390, "PaymentFunctionCode": "CASH_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": null, "Email": null, "Fax": null, "PayeePartyIdentifier": 299160, "PartyName": "Vision ADB", "PayeePartyNumber": "50389", "PayeePartySiteIdentifier": null, "SupplierNumber": null, "SupplierSiteCode": null, "SupplierSiteIdentifier": null, "PayeePartySiteNumber": null, "PaymentFormatCode": null, "PaymentFormatName": null, "PersonId": null, "Intent": "BAT", "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/300100180582390", "name": "paymentsExternalPayees", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/300100180582390", "name": "paymentsExternalPayees", "kind": "item" }, { "rel": "child", "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/300100180582390/child/externalPartyPaymentMethods", "name": "externalPartyPaymentMethods", "kind": "collection" } ] }
Example 9
The following example shows how to create an external payee for a onetime payee in Payables by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees
Example Request Body
The following example shows the contents of the request body in JSON format:
{ "PayeePartyIdentifier":100100050897855, "PaymentFunctionCode": "ONETIME_PAYMENT", "Intent": "Onetime" }
Example Response 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": null, "Email": null, "Fax": null, "PayeePartyIdentifier": 100100050897855, "PartyName": "BK_GPAY_RPT_TP_ORG_CDRM", "PayeePartyNumber": "Registry_RPT_CDRM", "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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "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" } ] }