1. REST API Get Started V4REST API for Oracle Fusion Cloud Financials
  2. Use Cases
  3. Manage Payables Payments
  4. Query Payables Payments
  5. Get Payments Using a Child Resource Attribute

Get Payments Using a Child Resource Attribute

Your Accounts Payable Supervisor wants to view all the payments that have a certain specification on the payment header in a descriptive flexfield. For example, payments where latepayment is Y.

Example URL

Here's an example of the resource URL to display data from payables payments REST API:

GET

/fscmRestApi/resources/11.13.18.05/payablesPayments?q=paymentDff.latepayment='Y'

cURL Command

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments ?q=paymentDff.latepayment='Y'

Supported media types:

  • Content-Type: application/json
  • Add a Header as REST-Framework-Version and value as 2 or above

Example Response

Here's an example of the response body in JSON format:

{
  "items": [
    {
      "CheckId": 68536,
      "PaymentId": 1207,
      "PaymentReference": 218,
      "PaperDocumentNumber": 1005,
      "PaymentNumber": 1005,
      "PaymentFileReference": 40899,
      "PaymentProcessRequest": "CE-F-1",
      "PaymentAmount": 3050,
      "PaymentDate": "2013-07-09",
      "AccountingDate": "2013-07-09",
      "PaymentDescription": null,
      "ConversionRate": 0.01,
      "ConversionDate": "2013-07-09",
      "ConversionRateType": "Corporate",
      "ClearingDate": null,
      "ClearingAmount": null,
      "ClearingLedgerAmount": null,
      "ClearingConversionRate": null,
      "ClearingConversionDate": null,
      "ClearingConversionRateType": null,
      "CrossCurrencyRateType": null,
      "MaturityDate": null,
      "MaturityConversionRateType": "Corporate",
      "MaturityConversionDate": null,
      "MaturityConversionRate": null,
      "AnticipatedValueDate": null,
      "ClearingValueDate": null,
      "StopDate": null,
      "VoidDate": null,
      "VoidAccountingDate": null,
      "PaymentStatus": "Negotiable",
      "SeparateRemittanceAdviceCreated": null,
      "AccountingStatus": "Accounted",
      "ReconciledFlag": false,
      "PaymentType": "Payment Process Request",
      "PaymentCurrency": "EUR",
      "WithheldAmount": null,
      "BankChargeAmount": null,
      "LegalEntity": "Vision Operations",
      "BusinessUnit": "Vision Operations",
      "PaymentFunction": null,
      "Payee": "Advanced Network Devices",
      "ProcurementBU": null,
      "PayeeSite": "FRESNO",
      "EmployeeAddress": null,
      "SupplierNumber": "1013",
      "ThirdPartySupplier": null,
      "ThirdPartyAddressName": null,
      "ExternalBankAccountId": null,
      "RemitToAccountNumber": null,
      "DisbursementBankAccountNumber": "XXXXXXXXXXXXXunt1",
      "DisbursementBankAccountName": "CEForeignAccount-EUR",
      "PaymentMethodCode": "EFT",
      "PaymentMethod": "Electronic",
      "PaymentDocument": "CE-For-Doc",
      "PaymentProcessProfile": "AP Basic Printed",
      "DocumentCategory": null,
      "DocumentSequence": null,
      "VoucherNumber": null,
      "PaymentBaseAmount": 3999.77,
      "PaymentBaseCurrency": "USD",
      "AddressLine1": "5600 Independence Ave",
      "AddressLine2": null,
      "AddressLine3": null,
      "AddressLine4": null,
      "City": "Fresno",
      "County": null,
      "Province": null,
      "State": "CA",
      "Country": "US",
      "Zip": "95602",
      "CreatedBy": "AP_SUPV_OPERATIONS",
      "CreationDate": "2013-08-19T17:05:37+00:00",
      "LastUpdatedBy": "AP_SUPV_OPERATIONS",
      "LastUpdateDate": "2020-05-21T10:02:52.520+00:00",
      "LastUpdateLogin": "A4773FC3F1B33251E053D713F50AB740",
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/68536",
          "name": "payablesPayments",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
          }
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/68536",
          "name": "payablesPayments",
          "kind": "item"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/68536/lov/BankAccountPaymentDocumentNoBuPVO",
          "name": "BankAccountPaymentDocumentNoBuPVO",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/68536/lov/DisbursementBankAccountVVO",
          "name": "DisbursementBankAccountVVO",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/68536/lov/SupplierSiteVVO",
          "name": "SupplierSiteVVO",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/68536/lov/PaymentFunctionPVO",
          "name": "PaymentFunctionPVO",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/68536/lov/ProcurementBusinessUnitVVO",
          "name": "ProcurementBusinessUnitVVO",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/68536/lov/EmployeeAddressTypeVVO",
          "name": "EmployeeAddressTypeVVO",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/68536/lov/ApplicablePaymentProfilePVO",
          "name": "ApplicablePaymentProfilePVO",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/68536/lov/PaymentBusinessUnitPVO",
          "name": "PaymentBusinessUnitPVO",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/68536/lov/RemitToSupplierPVO",
          "name": "RemitToSupplierPVO",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/68536/lov/TradingPartnerVVO",
          "name": "TradingPartnerVVO",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/68536/lov/PaymentTypeVVO",
          "name": "PaymentTypeVVO",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/68536/lov/PaymentMethodPVO",
          "name": "PaymentMethodPVO",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/68536/lov/DailyConversionTypePVO",
          "name": "DailyConversionTypePVO",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/68536/lov/RemitToAddressPVO",
          "name": "RemitToAddressPVO",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/68536/child/paymentDff",
          "name": "paymentDff",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/68536/child/paymentGdf",
          "name": "paymentGdf",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/68536/child/relatedInvoices",
          "name": "relatedInvoices",
          "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/payablesPayments",
      "name": "payablesPayments",
      "kind": "collection"
    }
  ]
}