Oracle Fusion FSCM endpoint reference

Payments External Payees REST API

Get all external payees

GET https://your-pod.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees

Everything on this page is extracted from Oracle's official OpenAPI specification for Fusion Cloud FSCM: 40 queryable q fields, 3 named finders, and 1 child resource. Unsure how q works? See the Oracle Fusion API guide.

Supported operations

GET /paymentsExternalPayees
GET /paymentsExternalPayees/{id}
PATCH /paymentsExternalPayees/{id}
POST /paymentsExternalPayees

Finders (3)

Finders are named, pre-built queries with bound parameters. They can search values plain q filters cannot reach.

Finder Bind variables
ApplicablePayees
ExternalPayeeSearch
PrimaryKey

Example finder request

GET /fscmRestApi/resources/11.13.18.05/paymentsExternalPayees?finder=ApplicablePayees

Queryable q fields (40)

Only these fields can appear in a q filter expression on /paymentsExternalPayees. Filtering on any other field returns 400 Bad Request.

Example q request

GET /fscmRestApi/resources/11.13.18.05/paymentsExternalPayees?q=BankChargeBearerCode='<value>'&onlyData=true&limit=25
Field Type Operators
BankChargeBearerCode string = !=
BankChargeBearerName string = !=
BankInstructionCodeOne string = !=
BankInstructionCodeTwo string = !=
BankInstructionDetails string = !=
BankInstructionNameOne string = !=
BankInstructionNameTwo string = !=
DefaultPaymentMethodCode string = !=
DefaultPaymentMethodName string = !=
DeliveryChannelCode string = !=
DeliveryChannelName string = !=
DeliveryMethod string = !=
Email string = !=
Fax string = !=
OrganizationIdentifier string = !=
OrganizationName string = !=
OrganizationType string = !=
PartyName string = !=
PayEachDocumentAloneOption string LIKE
PayeeId integer = !=
PayeePartyIdentifier integer = !=
PayeePartyNumber string = !=
PayeePartySiteIdentifier integer = !=
PayeePartySiteNumber string = !=
PaymentFormatCode string = !=
PaymentFormatName string = !=
PaymentFunctionCode string = !=
PaymentReasonCode string = !=
PaymentReasonComments string = !=
PaymentReasonName string = !=
PaymentTextMessageOne string = !=
PaymentTextMessageThree string = !=
PaymentTextMessageTwo string = !=
PersonId integer = !=
ServiceLevelCode string = !=
ServiceLevelName string = !=
SettlementPriority string = !=
SupplierNumber string = !=
SupplierSiteCode string = !=
SupplierSiteIdentifier integer = !=

Child resources (1)

Each child is reachable at /paymentsExternalPayees/{id}/child/<name> and most can also be inlined with expand.

externalPartyPaymentMethods

Response fields (42)

Top-level attributes returned for each row. Use fields= to request a subset and shrink the payload.

BankChargeBearerCodeBankChargeBearerNameBankInstructionCodeOneBankInstructionCodeTwoBankInstructionDetailsBankInstructionNameOneBankInstructionNameTwoDefaultPaymentMethodCodeDefaultPaymentMethodNameDeliveryChannelCodeDeliveryChannelNameDeliveryMethodEmailFaxIntentOrganizationIdentifierOrganizationNameOrganizationTypePartyNamePayEachDocumentAloneOptionPayeeIdPayeePartyIdentifierPayeePartyNumberPayeePartySiteIdentifierPayeePartySiteNumberPaymentFormatCodePaymentFormatNamePaymentFunctionCodePaymentReasonCodePaymentReasonCommentsPaymentReasonNamePaymentTextMessageOnePaymentTextMessageThreePaymentTextMessageTwoPersonIdServiceLevelCodeServiceLevelNameSettlementPrioritySupplierNumberSupplierSiteCodeSupplierSiteIdentifierexternalPartyPaymentMethods

Build this query visually in OPAL

OPAL bundles this endpoint — and 59,000+ more — fully searchable offline, with a visual Q Builder and Finder Builder that only offer the fields listed above, so your filter can't 400. Download free · see features.

Related reference & reading