Update an invoice hold

patch

/fscmRestApi/resources/11.13.18.05/invoiceHolds/{HoldId}

Request

Path Parameters
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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Invoice Holds Descriptive Flexfields
    Title: Invoice Holds Descriptive Flexfields
    The invoice holds descriptive flexfields resource is used to manage details about the descriptive flexfield references for an invoice hold.
  • Maximum Length: 255
    The name of the release that was used to release the hold. A list of accepted values is defined in the lookup type HOLD CODE. The value for this attribute can be reviewed using the Setup and Maintenance work area and the Manage Payables Lookups task.
  • Title: Release Reason
    Maximum Length: 240
    The reason the hold was released on the invoice.
Nested Schema : Invoice Holds Descriptive Flexfields
Type: array
Title: Invoice Holds Descriptive Flexfields
The invoice holds descriptive flexfields resource is used to manage details about the descriptive flexfield references for an invoice hold.
Show Source
Nested Schema : invoiceHolds-invoiceHoldDff-item-patch-request
Type: object
Show Source
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 : invoiceHolds-item-response
Type: object
Show Source
  • Maximum Length: 255
    The business unit name for the invoice.
  • Title: Consumption Advice Line
    Read Only: true
    The consumption advice line number associated to the invoice line that is placed on hold.
  • Title: Consumption Advice
    Read Only: true
    Maximum Length: 20
    The consumption advice number associated to the invoice line that is placed on hold.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the hold record.
  • Title: Creation Date
    Read Only: true
    The date when the record was created.
  • Title: Held By
    Read Only: true
    The user who placed the hold on the invoice.
  • Title: Hold Date
    Read Only: true
    The date when the hold is placed on the invoice.
  • Title: Hold Details
    Read Only: true
    Maximum Length: 2000
    The details of the hold that is placed on the invoice line.
  • Title: Hold ID
    Read Only: true
    The unique invoice hold identifier that is generated during a create action.
  • Maximum Length: 255
    The name of the hold placed on the invoice. A list of accepted values is defined in the lookup type HOLD CODE. The value for this attribute can be reviewed using the Setup and Maintenance work area and the Manage Payables Lookups task.
  • Maximum Length: 240
    The reason the hold was placed on the invoice.
  • Invoice Holds Descriptive Flexfields
    Title: Invoice Holds Descriptive Flexfields
    The invoice holds descriptive flexfields resource is used to manage details about the descriptive flexfield references for an invoice hold.
  • Maximum Length: 255
    The unique number for the supplier invoice.
  • Title: Last Update Date
    Read Only: true
    The date when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The session login associated to the user who last updated the record.
  • Title: Line Held
    Read Only: true
    The invoice line number on which the hold is placed.
  • Links
  • Title: Line
    Read Only: true
    The purchase order line number associated to the invoice line that is placed on hold.
  • Title: Order
    Read Only: true
    Maximum Length: 30
    The purchase order number associated to the invoice line that is placed on hold.
  • Title: Schedule
    Read Only: true
    The purchase order schedule line number associated to the invoice line that is placed on hold.
  • Read Only: true
    The receipt line number associated to the invoice line that is placed on hold.
  • Read Only: true
    Maximum Length: 30
    The receipt number associated to the invoice line that is placed on hold.
  • Title: Release Date
    Read Only: true
    The date when the invoice hold was released.
  • Maximum Length: 255
    The name of the release that was used to release the hold. A list of accepted values is defined in the lookup type HOLD CODE. The value for this attribute can be reviewed using the Setup and Maintenance work area and the Manage Payables Lookups task.
  • Title: Release Reason
    Maximum Length: 240
    The reason the hold was released on the invoice.
  • Maximum Length: 255
    The supplier name on the invoice.
  • Title: Workflow Status
    Read Only: true
    Maximum Length: 80
    The holds resolution workflow status.
Nested Schema : Invoice Holds Descriptive Flexfields
Type: array
Title: Invoice Holds Descriptive Flexfields
The invoice holds descriptive flexfields resource is used to manage details about the descriptive flexfield references for an invoice hold.
Show Source
Nested Schema : invoiceHolds-invoiceHoldDff-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to update an invoice hold by submitting a PATCH request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoiceHolds/300100170746046

Example Request Payload

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

{
 "ReleaseName": "Amount approved"
}

Example Response Body

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

{
    "HoldId": 300100170746046,
    "InvoiceNumber": "REST Unmatched Invoice",
    "BusinessUnit": "Vision Operations",
    "Supplier": "Advanced Network Devices",
    "LineHeld": null,
    "HoldDate": "2018-11-26T06:42:57.003+00:00",
    "HoldDetails": null,
    "HoldReason": "Invoice amount exceeded limit.",
    "ReleaseReason": "Invoice amount approved by supervisor or manager.",
    "WorkflowStatus": null,
    "ReleaseName": "Amount approved",
    "HoldName": "Amount",
    "ReleaseDate": "2018-11-26T06:49:45.035+00:00",
    "HeldBy": "Kerry Jones",
    "CreatedBy": "AP_SUPV_OPERATIONS",
    "CreationDate": "2018-11-26T06:42:57.003+00:00",
    "LastUpdateDate": "2018-11-26T06:49:45.035+00:00",
    "LastUpdatedBy": "AP_SUPV_OPERATIONS",
    "LastUpdateLogin": "7B273F6DCA3CF7D0E0533BFDF40AFF00",
    "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/300100170746046",
            "name": "invoiceHolds",
            "kind": "item",
            "properties": {
                             "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                          }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoiceHolds/300100170746046",
            "name": "invoiceHolds",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoiceHolds/300100170746046/lov/HoldNameLookupVVO1",
            "name": "HoldNameLookupVVO1",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoiceHolds/300100170746046/lov/ReleaseNameVVO1",
            "name": "ReleaseNameVVO1",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoiceHolds/300100170746046/child/invoiceHoldDff",
            "name": "invoiceHoldDff",
            "kind": "collection"
        }
    ]
}
Back to Top