1. REST API for Oracle Fusion Cloud Financials
  2. Tasks
  3. List of Values
  4. Payment Methods List of Values

Get all payment methods

get

/fscmRestApi/resources/11.13.18.05/disbursementPaymentMethodsLOV

Request

Query Parameters
  • 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).
  • 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
  • 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:

    • ApplicablePaymentMethodFinder: Finds all applicable payment methods associated with the specified payment method code.
      Finder Variables:
      • ApplicationId; integer; Application identifier of the applicable payment method.
      • PayProcTrxnTypeCode; string; Payment process transaction type code of the applicable payment method.
      • PayeePartyId; integer; Payee party identifier of the applicable payment method.
      • PayeePartySiteId; integer; Payee party site identifier of the applicable payment method.
      • PayerLegalEntityId; integer; Payer legal entity identifier of the applicable payment method.
      • PayerOrganizationId; integer; Payer organization identifier of the applicable payment method.
      • PayerPayingOrgType; string; Payer organization type of the applicable payment method.
      • PaymentCurrencyCode; string; Payment currency code of the applicable payment method.
      • PaymentFunction; string.
      • SupplierSiteId; integer; Supplier site identifier of the applicable payment method.
    • DefaultPaymentMethodFinder: Finds all payment methods associated with the specified payment method code.
      Finder Variables:
      • ApplicationId; integer; Application identifier of the default payment method.
      • PayProcTrxnTypeCode; string; Payment process transaction type code of the default payment method.
      • PayeePartyId; integer; Payee party identifier of the default payment method.
      • PayeePartySiteId; integer; Payee party site identifier of the default payment method.
      • PayerLegalEntityId; integer; Payer legal entity identifier of the default payment method.
      • PayerOrganizationId; integer; Payer organization identifier of the default payment method.
      • PayerPayingOrgType; string; Payer organization type of the default payment method.
      • PaymentCurrencyCode; string; Payment currency code of the default payment method.
      • PaymentFunction; string.
      • SupplierSiteId; integer; Supplier site identifier of the default payment method.
    • PrimaryKey: Finds the payment method that matches the specified payment method code.
      Finder Variables:
      • PaymentMethodCode; string; Payment method code that matches the primary key criteria specified.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • ApplicationId; integer; Identifier of the application that is enabled for a payment method.
    • AutoPayeeAssignIndicator; string; Option that indicates automatic assignment of a payment method to all payees.
    • BillsPayablePaymentMethodIndicator; string; Option that indicates whether a payment method is used to issue bills payable, which are future-dated payments.
    • MaturityDateOverride; integer; Number of days added to the payment date on a bills payable payment, which determines its new maturity date.
    • PaymentMethodCode; string; User-specified code of a payment method, which is used as the primary key.
    • PaymentMethodDescription; string; User-specified description of a payment method.
    • PaymentMethodName; string; User-specified name of a payment method.
  • 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
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : disbursementPaymentMethodsLOV
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : disbursementPaymentMethodsLOV-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to retrieve all the payment methods at the supplier site level, for assignment or while creating Payables invoice, 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/disbursementPaymentMethodsLOV?finder=ApplicablePaymentMethodFinder;ApplicationId=200,PayerLegalEntityId=204,PayerOrganizationId=204,PayerPayingOrgType=OPERATING_UNIT,PayeePartyId=300100032575688,PayeePartySiteId=300100032575700,SupplierSiteId=300100032575707,PayProcTrxnTypeCode=PAYABLES_DOC,PaymentCurrencyCode=USD,PaymentFunction=PAYABLES_DISB

Example Response Body

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

{
  "items": [
    {
      "PaymentMethodCode": "NETTING",
      "PaymentMethodName": "AP AR Netting",
      "PaymentMethodDescription": "For Netting Payments",
      "BillsPayablePaymentMethodIndicator": "N",
      "MaturityDateOverride": null,
      "ApplicationId": 200,
      "AutoPayeeAssignIndicator": null,
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/disbursementPaymentMethodsLOV/NETTING",
          "name": "disbursementPaymentMethodsLOV",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/disbursementPaymentMethodsLOV/NETTING",
          "name": "disbursementPaymentMethodsLOV",
          "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/disbursementPaymentMethodsLOV",
      "name": "disbursementPaymentMethodsLOV",
      "kind": "collection"
    }
  ]
}

The following example shows how to retrieve the default payment method when creating a Payables invoice 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/disbursementPaymentMethodsLOV?finder=DefaultPaymentMethodFinder;ApplicationId=200,PayerLegalEntityId=204,PayerOrganizationId=204,PayerPayingOrgType=OPERATING_UNIT,PayeePartyId=300100032575688,PayeePartySiteId=300100032575700,SupplierSiteId=300100032575707,PayProcTrxnTypeCode=PAYABLES_DOC,PaymentCurrencyCode=USD,PaymentFunction=PAYABLES_DISB

Example Response Body

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

{
    "items": [
        {
            "AccountGroupName": "Wine Revenues",
            "AccountName": "Chardonnay",
            "LedgerName": "Vision Foods - USA Ledger",
            "Currency": "USD",
            "CurrentAccountingPeriod": "Jan-16",
            "AccountCombination": "3121-311-3111-1211-40110-1121-1111-0000",
            "ActualBalance": "-13148402.00",
            "BudgetBalance": "-12953000.00",
            "AmountType": "PTD"
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/ledgerBalances",
            "name": "ledgerBalances",
            "kind": "collection"
        }
    ]
}

The following example shows how to retrieve all the payment methods when creating ad-hoc payment from 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/disbursementPaymentMethodsLOV?finder=ApplicablePaymentMethodFinder;ApplicationId=260,PayerLegalEntityId=204,PayerOrganizationId=204,PayerPayingOrgType=OPERATING_UNIT,PayeePartyId=299160,PayProcTrxnTypeCode=PAYABLES_DOC,PaymentCurrencyCode=USD,PaymentFunction=CASH_PAYMENT

Example Response Body

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

{
  "items": [
    {
      "PaymentMethodCode": "CHECK",
      "PaymentMethodName": "Check",
      "PaymentMethodDescription": null,
      "BillsPayablePaymentMethodIndicator": "N",
      "MaturityDateOverride": null,
      "ApplicationId": 260,
      "AutoPayeeAssignIndicator": null,
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/disbursementPaymentMethodsLOV/CHECK",
          "name": "disbursementPaymentMethodsLOV",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/disbursementPaymentMethodsLOV/CHECK",
          "name": "disbursementPaymentMethodsLOV",
          "kind": "item"
        }
      ]
    },
 ...
  "count": 4,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/disbursementPaymentMethodsLOV",
      "name": "disbursementPaymentMethodsLOV",
      "kind": "collection"
    }
  ]
}
Back to Top