Jump to

• Request
• Response
• Examples

Get all external payees

get

/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • ApplicablePayees: Finds external payees that match specified search parameters.
    Finder Variables:
    • Intent; string.
    • PayeePartyIdentifier; integer; The party identifier of an external payee.
    • PayeePartySiteIdentifier; integer; The party site identifier of an external payee.
    • PaymentFunctionCode; string; The payment function code assigned to an external payee.
    • SupplierSiteIdentifier; integer; The supplier site identifier of an external payee.
  • ExternalPayeeSearch: Finds external payees that match specified search parameters.
    Finder Variables:
    • Intent; string.
    • OrganizationName; string; The organization name of an external payee.
    • PartyName; string.
    • PayeePartyIdentifier; integer; The party identifier of an external payee.
    • PayeePartyNumber; string; The party number of an external payee.
    • PayeePartySiteIdentifier; integer; The party site identifier of an external payee.
    • PayeePartySiteNumber; string; The party site number of an external payee.
    • PaymentFunctionCode; string; The payment function code that is assigned to an external payee.
    • SupplierNumber; string; The supplier number of an external payee.
    • SupplierSiteCode; string; The supplier site code of an external payee.
    • SupplierSiteIdentifier; integer; The supplier site identifier of an external payee.
  • PrimaryKey: Finds the external payee with the specified primary key.
    Finder Variables:
    • PayeeId; integer; The identifier of an external payee.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • BankChargeBearerCode; string; 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; Name of an external payee who is responsible for paying regular or express bank charges, such as Payee or Payer.
  • BankInstructionCodeOne; string; Code of the first bank instruction to an external payee.
  • BankInstructionCodeTwo; string; Code of the second bank instruction to the external payee.
  • BankInstructionDetails; string; Details of an additional bank instruction to an external payee.
  • BankInstructionNameOne; string; Name of the first bank instruction to the external payee.
  • BankInstructionNameTwo; string; Name of the second bank instruction to an external payee.
  • DefaultPaymentMethodCode; string; Code of the default payment method for an external payee.
  • DefaultPaymentMethodName; string; Name of the default payment method for an external payee.
  • DeliveryChannelCode; string; Code of the delivery channel for an external payee.
  • DeliveryChannelName; string; Name of the delivery channel for an external payee.
  • DeliveryMethod; string; 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; Email address at which an external payee receives remittance advice.
  • Fax; string; Fax number at which an external payee receives remittance advice.
  • OrganizationIdentifier; string; Identifier of the business unit associated with an external payee.
  • OrganizationName; string; Name of the business unit associated with an external payee.
  • OrganizationType; string; 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; Name of an external payee.
  • PayEachDocumentAloneOption; string; Indicates whether documents payable for an external payee are prevented from being grouped with other like documents payable for payment.
  • PayeeId; integer; Application-generated identifier of the external payee.
  • PayeePartyIdentifier; integer; Identifier of an external payee.
  • PayeePartyNumber; string; Application-generated party number in Trading Community Architecture.
  • PayeePartySiteIdentifier; integer; Identifier of an external payee site.
  • PayeePartySiteNumber; string; Number of an external payee site.
  • PaymentFormatCode; string; Code of the payment format that is associated with an external payee.
  • PaymentFormatName; string; Name of the payment format that is associated with an external payee.
  • PaymentFunctionCode; string; 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; Code of the reason for paying an external payee.
  • PaymentReasonComments; string; Text field available for entering information about an external payee payment.
  • PaymentReasonName; string; Name of the reason for paying an external payee.
  • PaymentTextMessageOne; string; First text payment message to an external payee.
  • PaymentTextMessageThree; string; Third text payment message to an external payee.
  • PaymentTextMessageTwo; string; Second text payment message to an external payee.
  • PersonId; integer; Person identifier when the external payee is an employee.
  • ServiceLevelCode; string; Code of the service level for an external payee.
  • ServiceLevelName; string; Name of the service level for an external payee.
  • SettlementPriority; string; Priority with which the financial institution or payment system settles payments for an external payee.
  • SupplierNumber; string; Application-generated party number in Procurement.
  • SupplierSiteCode; string; Code of a supplier site.
  • SupplierSiteIdentifier; integer; Identifier of a supplier site.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/paymentsExternalPayees-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object paymentsExternalPayees-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/paymentsExternalPayees-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : paymentsExternalPayees-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "title":"Organization Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the business unit associated with an external payee.",
            "nullable":true,
            "x-queryable":true
        },
        "PayeePartySiteNumber":{
            "title":"Site Number",
            "maxLength":30,
            "type":"string",
            "description":"Number of an external payee site.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BankInstructionDetails":{
            "title":"Bank Instruction Details",
            "maxLength":255,
            "type":"string",
            "description":"Details of an additional bank instruction to an external payee.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentReasonComments":{
            "title":"Payment Reason Comments",
            "maxLength":240,
            "type":"string",
            "description":"Text field available for entering information about an external payee payment.",
            "nullable":true,
            "x-queryable":true
        },
        "ServiceLevelCode":{
            "title":"Service Level Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the service level for an external payee.",
            "nullable":true,
            "x-queryable":true
        },
        "Email":{
            "maxLength":255,
            "type":"string",
            "description":"Email address at which an external payee receives remittance advice.",
            "nullable":true,
            "x-queryable":true
        },
        "DeliveryChannelName":{
            "title":"Delivery Channel Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the delivery channel for an external payee.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"Name of an external payee.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SupplierSiteCode":{
            "title":"Site",
            "maxLength":240,
            "type":"string",
            "description":"Code of a supplier site.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SupplierSiteIdentifier":{
            "title":"Supplier Site Identifier",
            "type":"integer",
            "description":"Identifier of a supplier site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BankInstructionNameTwo":{
            "title":"Bank Instruction Name Two",
            "maxLength":255,
            "type":"string",
            "description":"Name of the second bank instruction to an external payee.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PaymentTextMessageTwo":{
            "title":"Payment Text Message 2",
            "maxLength":256,
            "type":"string",
            "description":"Second text payment message to an external payee.",
            "nullable":true,
            "x-queryable":true
        },
        "PayEachDocumentAloneOption":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether documents payable for an external payee are prevented from being grouped with other like documents payable for payment.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "PaymentReasonCode":{
            "title":"Payment Reason Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the reason for paying an external payee.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultPaymentMethodName":{
            "title":"Default Payment Method Name",
            "maxLength":100,
            "type":"string",
            "description":"Name of the default payment method for an external payee.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ServiceLevelName":{
            "title":"Service Level Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the service level for an external payee.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BankChargeBearerCode":{
            "title":"Bank Charge Bearer Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "BankInstructionCodeOne":{
            "title":"Bank Instruction Code One",
            "maxLength":30,
            "type":"string",
            "description":"Code of the first bank instruction to an external payee.",
            "nullable":true,
            "x-queryable":true
        },
        "DeliveryMethod":{
            "title":"Remittance Advice Delivery Method",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "SettlementPriority":{
            "title":"Settlement Priority",
            "maxLength":30,
            "type":"string",
            "description":"Priority with which the financial institution or payment system settles payments for an external payee.",
            "nullable":true,
            "x-queryable":true
        },
        "DeliveryChannelCode":{
            "title":"Delivery Channel Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the delivery channel for an external payee.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentFormatName":{
            "title":"Payment Format Name",
            "maxLength":300,
            "type":"string",
            "description":"Name of the payment format that is associated with an external payee.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Intent":{
            "type":"string",
            "description":"Purpose of the external payee. The value is based on the payment function of the external payee. The following are the expected values:\nPAYABLES_DISB - Supplier, EMPLOYEE_EXP - Person, EMPLOYEE_EXP - Employee, AR_CUSTOMER_REFUNDS - Refund, CUSTOMER_PAYMENT - Customer, ONETIME_PAYMENT - Onetime, and ADHOC_PAYMENT - Adhoc.",
            "nullable":true,
            "x-queryable":false
        },
        "PayeePartyIdentifier":{
            "title":"Payee Party Identifier",
            "type":"integer",
            "description":"Identifier of an external payee.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationType":{
            "title":"Organization Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of organization, such as a business unit, that has a relationship with an external payee. Values are from the IBY_ORGANIZATION_TYPES lookup.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierNumber":{
            "title":"Supplier Number",
            "maxLength":30,
            "type":"string",
            "description":"Application-generated party number in Procurement.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PaymentTextMessageThree":{
            "title":"Payment Text Message 3",
            "maxLength":256,
            "type":"string",
            "description":"Third text payment message to an external payee.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationIdentifier":{
            "maxLength":255,
            "type":"string",
            "description":"Identifier of the business unit associated with an external payee.",
            "nullable":true,
            "x-queryable":true
        },
        "PayeePartySiteIdentifier":{
            "title":"Payee Party Site Identifier",
            "type":"integer",
            "description":"Identifier of an external payee site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BankInstructionCodeTwo":{
            "title":"Bank Instruction Code Two",
            "maxLength":30,
            "type":"string",
            "description":"Code of the second bank instruction to the external payee.",
            "nullable":true,
            "x-queryable":true
        },
        "PayeeId":{
            "type":"integer",
            "description":"Application-generated identifier of the external payee.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "BankInstructionNameOne":{
            "title":"Bank Instruction Name One",
            "maxLength":255,
            "type":"string",
            "description":"Name of the first bank instruction to the external payee.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PaymentReasonName":{
            "title":"Payment Reason Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the reason for paying an external payee.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Person identifier when the external payee is an employee.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PayeePartyNumber":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"Application-generated party number in Trading Community Architecture.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BankChargeBearerName":{
            "title":"Bank Charge Bearer Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of an external payee who is responsible for paying regular or express bank charges, such as Payee or Payer.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DefaultPaymentMethodCode":{
            "title":"Default Payment Method Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the default payment method for an external payee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentFormatCode":{
            "title":"Payment Format Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the payment format that is associated with an external payee.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PaymentTextMessageOne":{
            "title":"Payment Text Message 1",
            "maxLength":256,
            "type":"string",
            "description":"First text payment message to an external payee.",
            "nullable":true,
            "x-queryable":true
        },
        "externalPartyPaymentMethods":{
            "title":"External Party Payment Methods",
            "type":"array",
            "description":"The external party payment methods resource is used to view, create, and modify payment methods assigned to supplier payees.",
            "items":{
                "$ref":"#/components/schemas/paymentsExternalPayees-externalPartyPaymentMethods-item-response"
            }
        },
        "Fax":{
            "maxLength":100,
            "type":"string",
            "description":"Fax number at which an external payee receives remittance advice.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentFunctionCode":{
            "title":"Payment Function",
            "maxLength":30,
            "type":"string",
            "description":"Code that indicates the function or purpose of the payment. Values from the IBY_PAYMENT_FUNCTIONS lookup include SUPPLIER_PAYMENT, CUSTOMER_REFUNDS, and Others.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

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

• Array of: object paymentsExternalPayees-externalPartyPaymentMethods-item-response

{
    "title":"External Party Payment Methods",
    "type":"array",
    "description":"The external party payment methods resource is used to view, create, and modify payment methods assigned to supplier payees.",
    "items":{
        "$ref":"#/components/schemas/paymentsExternalPayees-externalPartyPaymentMethods-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : paymentsExternalPayees-externalPartyPaymentMethods-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "AddressName":{
            "title":"Site Name",
            "maxLength":240,
            "type":"string",
            "description":"Address of the party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayeeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the external payee.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SiteName":{
            "title":"Site Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the party site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryIndicator":{
            "title":"Primary",
            "maxLength":1,
            "type":"string",
            "description":"Primary payment method.",
            "nullable":true,
            "x-queryable":true
        },
        "PayeeName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"Name of an external payee.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FromDate":{
            "title":"From Date",
            "type":"string",
            "description":"Date when a payment method assignment begins.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ToDate":{
            "title":"To Date",
            "type":"string",
            "description":"Date when a payment method assignment ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentMethodCode":{
            "title":"Payment Method",
            "maxLength":30,
            "type":"string",
            "description":"Code assigned to a payment method.",
            "nullable":false,
            "x-queryable":true
        },
        "ExternalPartyPaymentMethodsId":{
            "type":"integer",
            "description":"Value that uniquely identifies the external party payment method assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PaymentMethodName":{
            "title":"Name",
            "maxLength":100,
            "type":"string",
            "description":"Name assigned to a payment method.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

Example 1

The following example shows how to retrieve all the external payees by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees?finder=ExternalPayeeSearch;PayeePartyIdentifier=44378,Intent=Supplier

Example Response Body

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

{
    "items": [
        {
            "PayeeId": 1238,
            "PaymentFunctionCode": "PAYABLES_DISB",
            "OrganizationIdentifier": "204",
            "OrganizationName": "Vision Operations",
            ...
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/1238",
                    "name": "paymentsExternalPayees",
                    "kind": "item",
                    "properties": {
                                     "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                                  }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/1238",
                    "name": "paymentsExternalPayees",
                    "kind": "item"
                },
                ...
            ]
        },
        ...
	],
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees",
            "name": "paymentsExternalPayees",
            "kind": "collection"
        }
    ]
}	

Example 2

The following example shows how to retrieve all the payees for a supplier by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees?finder=ExternalPayeeSearch;Intent=Supplier,PayeePartyIdentifier=333937&q=SupplierSiteIdentifier IS NULL

Example Response Body

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

{
    "items": [
        {
            "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": "[e-mail]",
            "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": null,
            "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"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees",
            "name": "paymentsExternalPayees",
            "kind": "collection"
        }
    ]
}

Example 3

The following example shows how to retrieve all the payees for a supplier site by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees?finder=ExternalPayeeSearch;Intent=Supplier,PayeePartyIdentifier=333937,SupplierSiteIdentifier=999992000428884
 

Example Response Body

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

{
    "items": [
        {
            "PayeeId": 300100180897625,
            "PaymentFunctionCode": "PAYABLES_DISB",
            "OrganizationIdentifier": "1668",
            "OrganizationName": "Progress UK",
            "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": "[e-mail]",
            "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": null,
            "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"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees",
            "name": "paymentsExternalPayees",
            "kind": "collection"
        }
    ]
}

Example 4

The following example shows how to retrieve all the payees for customer refund by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees?finder=ExternalPayeeSearch;Intent=Customer,PayeePartyIdentifier=1455998,PayeePartySiteIdentifier=567618
 

Example Response Body

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

{
    "items": [
        {
            "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": "[e-mail]",
            "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": null,
            "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"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees",
            "name": "paymentsExternalPayees",
            "kind": "collection"
        }
    ]
}

Example 5

The following example shows how to retrieve all the payees for an employee in Payroll by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees?finder=ExternalPayeeSearch;Intent=Person,PayeePartyIdentifier=300100038056894
 

Example Response Body

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

{
    "items": [
        {
            "PayeeId": 300100177406393,
            "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",
            "PaymentTextMessageOne": null,
            "PaymentTextMessageTwo": null,
            "PaymentTextMessageThree": null,
            "DeliveryChannelCode": null,
            "DeliveryChannelName": null,
            "ServiceLevelCode": null,
            "ServiceLevelName": null,
            "SettlementPriority": null,
            "DeliveryMethod": null,
            "Email": null,
            "Fax": null,
            "PayeePartyIdentifier": 300100038056894,
            "PartyName": "ZHRX_VS BV_SECUSER",
            "PayeePartyNumber": "CDRM_75839",
            "PayeePartySiteIdentifier": null,
            "SupplierNumber": null,
            "SupplierSiteCode": null,
            "SupplierSiteIdentifier": null,
            "PayeePartySiteNumber": null,
            "PaymentFormatCode": null,
            "PaymentFormatName": null,
            "PersonId": null,
            "Intent": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/300100177406393",
                    "name": "paymentsExternalPayees",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/300100177406393",
                    "name": "paymentsExternalPayees",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees",
            "name": "paymentsExternalPayees",
            "kind": "collection"
        }
    ]
}

Example 6

The following example shows how to retrieve all the payees for an employee in Expenses by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees?finder=ExternalPayeeSearch;Intent=Employee,PayeePartyIdentifier=300100148480036
 

Example Response Body

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

{
  "items": [
    {
      "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": "CVBUYER01_DK",
      "PayeePartyNumber": "CDRM_733616",
      "PayeePartySiteIdentifier": null,
      "SupplierNumber": null,
      "SupplierSiteCode": null,
      "SupplierSiteIdentifier": null,
      "PayeePartySiteNumber": null,
      "PaymentFormatCode": null,
      "PaymentFormatName": null,
      "PersonId": null,
      "Intent": null,
      "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"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees",
      "name": "paymentsExternalPayees",
      "kind": "collection"
    }
  ]
}

Example 7

The following example shows how to retrieve all the payees for an ad-hoc payee in Cash Management by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees?finder=ExternalPayeeSearch;Intent=Adhoc,PayeePartyIdentifier=300100121773260
 

Example Response Body

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

{
  "items": [
    {
      "PayeeId": 100010023961174,
      "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": null,
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/100010023961174",
          "name": "paymentsExternalPayees",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
          }
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/100010023961174",
          "name": "paymentsExternalPayees",
          "kind": "item"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/100010023961174/child/externalPartyPaymentMethods",
          "name": "externalPartyPaymentMethods",
          "kind": "collection"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees",
      "name": "paymentsExternalPayees",
      "kind": "collection"
    }
  ]
}

Example 8

The following example shows how to retrieve all the onetime payees in Payables by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees?finder=ExternalPayeeSearch;Intent=Onetime,PayeePartyIdentifier=100100050897855
 

Example Response Body

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

{
  "items": [
    {
      "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": "[e-mail]",
      "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": null,
      "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"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentsExternalPayees",
      "name": "paymentsExternalPayees",
      "kind": "collection"
    }
  ]
}

Back to Top