REST API for Oracle Fusion Cloud Financials

Get an invoice hold

get

/fscmRestApi/resources/11.13.18.05/payablesInvoiceHoldsLOV/{HoldLookupCode}

Request

Path Parameters

HoldLookupCode(required): string

The name of the created hold lookup code that is applied to an invoice.

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.

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.

Root Schema : payablesInvoiceHoldsLOV-item-response

Type: object

Show Source

Description: string

Read Only: true

Maximum Length: 240

The information describing the invoice hold for external users.
HoldLookupCode: string

Title: Name

Read Only: true

Maximum Length: 25

The name of the created hold lookup code that is applied to an invoice.
HoldType: string

Title: Type

Read Only: true

Maximum Length: 25

The name of the hold type that can be applied to an invoice.
links: array Links

Title: Links

The link relations associated with the resource instance.
Name: string

Read Only: true

Maximum Length: 80

The name of the invoice hold.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"The information describing the invoice hold for external users.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldType":{
            "title":"Type",
            "maxLength":25,
            "type":"string",
            "description":"The name of the hold type that can be applied to an invoice.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldLookupCode":{
            "title":"Name",
            "maxLength":25,
            "type":"string",
            "description":"The name of the created hold lookup code that is applied to an invoice.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "maxLength":80,
            "type":"string",
            "description":"The name of the invoice hold.",
            "nullable":false,
            "readOnly":true,
            "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."
        }
    }
}

Examples

The following example shows how to retrieve an invoice hold.

Get all the invoice holds list of values and use the self URI of the specific invoice hold.

Here's the cURL command to retrieve all the invoice holds list of values:

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/payablesInvoiceHoldsLOV

Example Response Body

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

{
  "items": [
    {
      "HoldLookupCode": "AMOUNT",
      "HoldType": "INVOICE HOLD REASON",
      "Description": "Invoice amount exceeded limit.",
      "Name": "Amount",
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesInvoiceHoldsLOV/000300000006414D4F554E5400000009484F4C4420434F444500000006414D4F554E54",
          "name": "payablesInvoiceHoldsLOV",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesInvoiceHoldsLOV/000300000006414D4F554E5400000009484F4C4420434F444500000006414D4F554E54",
          "name": "payablesInvoiceHoldsLOV",
          "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/payablesInvoiceHoldsLOV",
      "name": "payablesInvoiceHoldsLOV",
      "kind": "collection"
    }
  ]
}

A hash key of HoldLookupCode and HoldType identifies an invoice hold.

Here's the cURL command that uses the hash key in the self URI to retrieve the invoice hold:

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/payablesInvoiceHoldsLOV/000300000006414D4F554E5400000009484F4C4420434F444500000006414D4F554E54

Example Response Body

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

{
  "HoldLookupCode": "AMOUNT",
  "HoldType": "INVOICE HOLD REASON",
  "Description": "Invoice amount exceeded limit.",
  "Name": "Amount",
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesInvoiceHoldsLOV/000300000006414D4F554E5400000009484F4C4420434F444500000006414D4F554E54",
      "name": "payablesInvoiceHoldsLOV",
      "kind": "item"
    },
    {
      "rel": "canonical",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesInvoiceHoldsLOV/000300000006414D4F554E5400000009484F4C4420434F444500000006414D4F554E54",
      "name": "payablesInvoiceHoldsLOV",
      "kind": "item"
    }
  ]
}