External Payees
paymentsExternalPayees Based on 26C
Create, change and look up External Payees, with external party payment methods.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)
- Record key
PayeeId- Required on create
PartyNamePayeePartyIdentifierPayeePartyNumberPaymentFunctionCode- At a glance
- 47 fields2 finders1 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /fscmRestApi/resources/11.13.18.05/paymentsExternalPayees?fields=BankChargeBearerCode,BankChargeBearerName,BankInstructionCodeOne,BankInstructionCodeTwo,BankInstructionDetails&limit=25&onlyData=true
{
"items": [
{
"BankChargeBearerCode": "<string, max 30>",
"BankChargeBearerName": "<string, max 255>",
"BankInstructionCodeOne": "<string, max 30>",
"BankInstructionCodeTwo": "<string, max 30>",
"BankInstructionDetails": "<string, max 255>"
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's 26C REST specification.
Fields 47
| Attribute | Type | Use |
|---|---|---|
BankChargeBearerCode | text · max 30 | Optional on createUpdatableSearchable |
BankChargeBearerName | text · max 255 | Optional on createUpdatableSearchable |
BankInstructionCodeOne | text · max 30 | Optional on createUpdatableSearchable |
BankInstructionCodeTwo | text · max 30 | Optional on createUpdatableSearchable |
BankInstructionDetails | text · max 255 | Optional on createUpdatableSearchable |
BankInstructionNameOne | text · max 255 | Optional on createUpdatableSearchable |
BankInstructionNameTwo | text · max 255 | Optional on createUpdatableSearchable |
BankInstructionOneCountryAndName | text · max 255 | Optional on createUpdatable |
BankInstructionTwoCountryAndName | text · max 255 | Optional on createUpdatable |
DefaultPaymentMethodCode | text · max 30 | Read-onlySearchable |
DefaultPaymentMethodName | text · max 100 | Read-onlySearchable |
DeliveryChannelCode | text · max 30 | Optional on createUpdatableSearchable |
DeliveryChannelCountryAndMeaning | text · max 255 | Optional on createUpdatableSearchable |
DeliveryChannelName | text · max 255 | Optional on createUpdatableSearchable |
DeliveryMethod | text · max 30 | Optional on createUpdatableSearchable |
DeliveryMethodMeaning | text · max 255 | Optional on createUpdatableSearchable |
Email | text · max 255 | Optional on createUpdatableSearchable |
Fax | text · max 100 | Optional on createUpdatableSearchable |
Intent | text | Optional on createUpdatable |
OrganizationIdentifier | text · max 255 | Optional on createSearchable |
OrganizationName | text · max 240 | Optional on createSearchable |
OrganizationType | text · max 30 | Read-onlySearchable |
PartyName | text · max 360 | Required on createSearchable |
PayEachDocumentAloneOption | text · max 1 · default N | Optional on createUpdatableSearchable |
PayeeId | number | Optional on createSearchable |
PayeePartyIdentifier | number | Required on createSearchable |
PayeePartyNumber | text · max 30 | Required on createSearchable |
PayeePartySiteIdentifier | number | Optional on createSearchable |
PayeePartySiteNumber | text · max 30 | Optional on createSearchable |
PaymentFormatCode | text · max 30 | Optional on createUpdatableSearchable |
PaymentFormatName | text · max 300 | Optional on createUpdatableSearchable |
PaymentFunctionCode | text · max 30 | Required on createSearchable |
PaymentReasonCode | text · max 30 | Optional on createUpdatableSearchable |
PaymentReasonComments | text · max 240 | Optional on createUpdatableSearchable |
PaymentReasonCountryAndMeaning | text · max 255 | Optional on createUpdatableSearchable |
PaymentReasonName | text · max 255 | Optional on createUpdatableSearchable |
PaymentTextMessageOne | text · max 256 | Optional on createUpdatableSearchable |
PaymentTextMessageThree | text · max 256 | Optional on createUpdatableSearchable |
PaymentTextMessageTwo | text · max 256 | Optional on createUpdatableSearchable |
PersonId | number | Optional on createUpdatableSearchable |
ServiceLevelCode | text · max 30 | Optional on createUpdatableSearchable |
ServiceLevelName | text · max 255 | Optional on createUpdatableSearchable |
SettlementPriority | text · max 30 | Optional on createUpdatableSearchable |
SettlementPriorityMeaning | text · max 255 | Optional on createUpdatableSearchable |
SupplierNumber | text · max 30 | Optional on createSearchable |
SupplierSiteCode | text · max 240 | Optional on createSearchable |
SupplierSiteIdentifier | number | Optional on createSearchable |
Names, types, labels and flags from Oracle's REST specification (26C). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 2
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
ApplicablePayees·PayeePartyIdentifierPayeePartySiteIdentifierPaymentFunctionCodeSupplierSiteIdentifierExternalPayeeSearch·OrganizationNamePayeePartyIdentifierPayeePartyNumberPayeePartySiteIdentifierPayeePartySiteNumberPaymentFunctionCodeSupplierNumberSupplierSiteCodeSupplierSiteIdentifier
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 1
Child resources sit under one record: /fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/{PayeeId}/child/<name>. Add them to a GET with expand.
externalPartyPaymentMethodsGET · POST · PATCH External Party Payment Methods · 10 fieldsAddressNameExternalPartyPaymentMethodsIdFromDatePayeeIdPayeeNamePaymentMethodCodePaymentMethodNamePrimaryIndicatorSiteNameToDate
Use in AI Agent Studio
- Point a Business Object or REST tool at
/fscmRestApi/resources/11.13.18.05/paymentsExternalPayeesand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
ApplicablePayeesfor the agent's main search: its variables become clean tool parameters. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
- This resource can change data. Put a human approval step before any create, update, delete or action call.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:BankChargeBearerCode, notbankchargebearercode. - 3 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
- A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.