Jump to

• Request
• Response
• Examples

Get an invoice hold

get

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

Request

Path Parameters

• HoldId(required): integer(int64)
  The unique invoice hold identifier that is generated during a create action.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 : invoiceHolds-item-response

Type: object

Show Source

• BusinessUnit: string
  Maximum Length: 255

  The business unit name for the invoice.
• ConsumptionAdviceLineNumber: number
  Title: Consumption Advice Line

  Read Only: true

  The consumption advice line number associated to the invoice line that is placed on hold.
• ConsumptionAdviceNumber: string
  Title: Consumption Advice

  Read Only: true

  Maximum Length: 20

  The consumption advice number associated to the invoice line that is placed on hold.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the hold record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• HeldBy: string
  Title: Held By

  Read Only: true

  The user who placed the hold on the invoice.
• HoldDate: string (date-time)
  Title: Hold Date

  Read Only: true

  The date when the hold is placed on the invoice.
• HoldDetails: string
  Title: Hold Details

  Read Only: true

  Maximum Length: 2000

  The details of the hold that is placed on the invoice line.
• HoldId: integer (int64)
  Title: Hold ID

  Read Only: true

  The unique invoice hold identifier that is generated during a create action.
• HoldName: string
  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.
• HoldReason: string
  Maximum Length: 240

  The reason the hold was placed on the invoice.
• invoiceHoldDff: array 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.
• InvoiceNumber: string
  Maximum Length: 255

  The unique number for the supplier invoice.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The session login associated to the user who last updated the record.
• LineHeld: number
  Title: Line Held

  Read Only: true

  The invoice line number on which the hold is placed.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PurchaseOrderLineNumber: number
  Title: Line

  Read Only: true

  The purchase order line number associated to the invoice line that is placed on hold.
• PurchaseOrderNumber: string
  Title: Order

  Read Only: true

  Maximum Length: 30

  The purchase order number associated to the invoice line that is placed on hold.
• PurchaseOrderScheduleLineNumber: number
  Title: Schedule

  Read Only: true

  The purchase order schedule line number associated to the invoice line that is placed on hold.
• ReceiptLineNumber: integer (int64)
  Read Only: true

  The receipt line number associated to the invoice line that is placed on hold.
• ReceiptNumber: string
  Read Only: true

  Maximum Length: 30

  The receipt number associated to the invoice line that is placed on hold.
• ReleaseDate: string (date-time)
  Title: Release Date

  Read Only: true

  The date when the invoice hold was released.
• ReleaseName: string
  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.
• ReleaseReason: string
  Title: Release Reason

  Maximum Length: 240

  The reason the hold was released on the invoice.
• Supplier: string
  Maximum Length: 255

  The supplier name on the invoice.
• WorkflowStatus: string
  Title: Workflow Status

  Read Only: true

  Maximum Length: 80

  The holds resolution workflow status.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineHeld":{
            "title":"Line Held",
            "type":"number",
            "description":"The invoice line number on which the hold is placed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReleaseName":{
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "HoldName"
                ]
            },
            "x-queryable":true
        },
        "ReceiptLineNumber":{
            "type":"integer",
            "description":"The receipt line number associated to the invoice line that is placed on hold.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HeldBy":{
            "title":"Held By",
            "type":"string",
            "description":"The user who placed the hold on the invoice.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PurchaseOrderScheduleLineNumber":{
            "title":"Schedule",
            "type":"number",
            "description":"The purchase order schedule line number associated to the invoice line that is placed on hold.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldName":{
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "HoldName1"
                ]
            },
            "x-queryable":true
        },
        "ReleaseReason":{
            "title":"Release Reason",
            "maxLength":240,
            "type":"string",
            "description":"The reason the hold was released on the invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Supplier":{
            "maxLength":255,
            "type":"string",
            "description":"The supplier name on the invoice.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            },
            "x-queryable":true
        },
        "InvoiceNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The unique number for the supplier invoice.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InvoiceId1"
                ]
            },
            "x-queryable":true
        },
        "PurchaseOrderLineNumber":{
            "title":"Line",
            "type":"number",
            "description":"The purchase order line number associated to the invoice line that is placed on hold.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiptNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The receipt number associated to the invoice line that is placed on hold.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the hold record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PurchaseOrderNumber":{
            "title":"Order",
            "maxLength":30,
            "type":"string",
            "description":"The purchase order number associated to the invoice line that is placed on hold.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConsumptionAdviceLineNumber":{
            "title":"Consumption Advice Line",
            "type":"number",
            "description":"The consumption advice line number associated to the invoice line that is placed on hold.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReleaseDate":{
            "title":"Release Date",
            "type":"string",
            "description":"The date when the invoice hold was released.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkflowStatus":{
            "title":"Workflow Status",
            "maxLength":80,
            "type":"string",
            "description":"The holds resolution workflow status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldReason":{
            "maxLength":240,
            "type":"string",
            "description":"The reason the hold was placed on the invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "invoiceHoldDff":{
            "title":"Invoice Holds Descriptive Flexfields",
            "type":"array",
            "description":"The invoice holds descriptive flexfields resource is used to manage details about the descriptive flexfield references for an invoice hold.",
            "items":{
                "$ref":"#/components/schemas/invoiceHolds-invoiceHoldDff-item-response"
            },
            "x-cardinality":"1"
        },
        "HoldId":{
            "title":"Hold ID",
            "type":"integer",
            "description":"The unique invoice hold identifier that is generated during a create action.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "HoldDetails":{
            "title":"Hold Details",
            "maxLength":2000,
            "type":"string",
            "description":"The details of the hold that is placed on the invoice line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnit":{
            "maxLength":255,
            "type":"string",
            "description":"The business unit name for the invoice.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BusinessUnitId"
                ]
            },
            "x-queryable":true
        },
        "HoldDate":{
            "title":"Hold Date",
            "type":"string",
            "description":"The date when the hold is placed on the invoice.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConsumptionAdviceNumber":{
            "title":"Consumption Advice",
            "maxLength":20,
            "type":"string",
            "description":"The consumption advice number associated to the invoice line that is placed on hold.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object invoiceHolds-invoiceHoldDff-item-response

{
    "title":"Invoice Holds Descriptive Flexfields",
    "type":"array",
    "description":"The invoice holds descriptive flexfields resource is used to manage details about the descriptive flexfield references for an invoice hold.",
    "items":{
        "$ref":"#/components/schemas/invoiceHolds-invoiceHoldDff-item-response"
    },
    "x-cardinality":"1"
}

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 : invoiceHolds-invoiceHoldDff-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 150

  The descriptive flexfield context name for the invoice hold.
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  The descriptive flexfield context display value for the invoice hold.
• HoldId: integer (int64)
  Title: Hold ID

  The unique invoice hold identifier that is generated during a create action.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "HoldId":{
            "title":"Hold ID",
            "type":"integer",
            "description":"The unique invoice hold identifier that is generated during a create action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"The descriptive flexfield context display value for the invoice hold.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":150,
            "type":"string",
            "description":"The descriptive flexfield context name for the invoice hold.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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."
        }
    }
}

Links

invoiceHoldDff

Operation: /fscmRestApi/resources/11.13.18.05/invoiceHolds/{HoldId}/child/invoiceHoldDff

Parameters:

• HoldId: $request.path.HoldId

The invoice holds descriptive flexfields resource is used to manage details about the descriptive flexfield references for an invoice hold.

Back to Top

Examples

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

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

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": null,
    "WorkflowStatus": null,
    "ReleaseName": null,
    "HoldName": "Amount",
    "ReleaseDate": null,
    "HeldBy": "Kerry Jones",
    "CreatedBy": "AP_SUPV_OPERATIONS",
    "CreationDate": "2018-11-26T06:42:57.003+00:00",
    "LastUpdateDate": "2018-11-26T06:42:58.066+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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                          }
        },
        {
            "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