Get Invoice Holds Using a Child Resource Attribute

Your Accounts Payable Supervisor or Manager would like to view all invoice holds using some information that is captured on the invoice holds in a descriptive flexfield. For example, invoice holds approved by business.

Example URL

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

GET

/fscmRestApi/resources/11.13.18.05/invoiceHolds?q=invoiceHoldDff. approvedBy='Business'

cURL Command

curl --location --request GET 'https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/ invoiceHolds?q=invoiceHoldDff.approvedBy='Business'
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": [
    {
      "HoldId": 300100187353833,
      "InvoiceNumber": "AND_Unmatched_Invoice",
      "BusinessUnit": "Vision Operations",
      "Supplier": "Advanced Network Devices",
      "LineHeld": null,
      "HoldDate": "2020-05-29T06:53:19.001+00:00",
      "HoldDetails": null,
      "HoldReason": "Invoice amount exceeded limit.",
      "ReleaseReason": null,
      "WorkflowStatus": null,
      "ReleaseName": null,
      "HoldName": "Amount",
      "ReleaseDate": null,
      "HeldBy": "Kerry Jones",
      "CreatedBy": "AP_SUPV_OPERATIONS",
      "CreationDate": "2020-05-29T06:53:19.001+00:00",
      "LastUpdateDate": "2020-05-29T06:59:59.079+00:00",
      "LastUpdatedBy": "AP_SUPV_OPERATIONS",
      "LastUpdateLogin": "A645FBE0336AF85CE0538C96F40A2399",
      "PurchaseOrderNumber": null,
      "PurchaseOrderLineNumber": null,
      "PurchaseOrderScheduleLineNumber": null,
      "ReceiptNumber": null,
      "ReceiptLineNumber": null,
      "ConsumptionAdviceNumber": null,
      "ConsumptionAdviceLineNumber": null,
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoiceHolds/300100187353833",
          "name": "invoiceHolds",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
          }
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoiceHolds/300100187353833",
          "name": "invoiceHolds",
          "kind": "item"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoiceHolds/300100187353833/lov/HoldNameLookupVVO1",
          "name": "HoldNameLookupVVO1",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoiceHolds/300100187353833/lov/ReleaseNameVVO1",
          "name": "ReleaseNameVVO1",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoiceHolds/300100187353833/child/invoiceHoldDff",
          "name": "invoiceHoldDff",
          "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/invoiceHolds",
      "name": "invoiceHolds",
      "kind": "collection"
    }
  ]
}