Get all invoice holds
/fscmRestApi/resources/11.13.18.05/payablesInvoiceHoldsLOV
Request
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- HoldPlaceFinder: Finds the placement of the hold with the specified primary key.
Finder Variables:- InvoiceId; integer; The unique identifier of the supplier invoice.
- HoldReleaseFinder: Finds the release of the hold with the specified primary key.
Finder Variables:- HoldCode; string; The lookup code of the hold placed on the invoice.
- SystemMatchingHold; string; Indicates if the matching hold is placed by system. The valid values are Y or N.
- PrimaryKey: Finds the name of the specified primary key.
Finder Variables:- HoldLookupCode; string; The unique name of the invoice hold.
- HoldPlaceFinder: Finds the placement of the hold with the specified primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- Description; string; The information describing the invoice hold for external users.
- HoldLookupCode; string; The name of the created hold lookup code that is applied to an invoice.
- HoldType; string; The name of the hold type that can be applied to an invoice.
- Name; string; The name of the invoice hold.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
-
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 TopResponse
- application/json
Default Response
-
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.
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
array
Links
object
-
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.
array
Links
object
-
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
Example 1
The following example shows how to retrieve all the invoice holds list of values by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+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" } ] }
Example 2
The following example shows how to find valid hold names based on the InvoiceId
. Primarily, to eliminate open holds.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesInvoiceHoldsLOV?finder=HoldPlaceFinder;InvoiceId=123456
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" } ] }
Example 3
The following example shows how to find a list of valid release names that can be used to release an invoice hold.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesInvoiceHoldsLOV?finder=HoldReleaseFinder;SystemMatchingHold=Y
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "HoldLookupCode": "MATCH OVERRIDE", "HoldType": "MATCHING RELEASE REASON", "Description": "Matching hold released.", "Name": "Match override", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesInvoiceHoldsLOV/00030000000E4D41544348204F5645525249444500000009484F4C4420434F44450000000E4D41544348204F56455252494445", "name": "payablesInvoiceHoldsLOV", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesInvoiceHoldsLOV/00030000000E4D41544348204F5645525249444500000009484F4C4420434F44450000000E4D41544348204F56455252494445", "name": "payablesInvoiceHoldsLOV", "kind": "item" } ] }, { "HoldLookupCode": "Test matching release rea", "HoldType": "MATCHING RELEASE REASON", "Description": "Test matching release rea", "Name": "Test matching release rea", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesInvoiceHoldsLOV/00030000001954657374206D61746368696E672072656C656173652072656100000009484F4C4420434F44450000001954657374206D61746368696E672072656C6561736520726561", "name": "payablesInvoiceHoldsLOV", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesInvoiceHoldsLOV/00030000001954657374206D61746368696E672072656C656173652072656100000009484F4C4420434F44450000001954657374206D61746368696E672072656C6561736520726561", "name": "payablesInvoiceHoldsLOV", "kind": "item" } ] } ], "count": 2, "hasMore": false, "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" } ] }
Example 4
The following example shows how to find a list of valid release names that can be used to release an invoice hold using HoldCode
.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesInvoiceHoldsLOV?finder=HoldReleaseFinder;SystemMatchingHold=N,HoldCode=Amount
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "HoldLookupCode": "AMOUNT LOWERED", "HoldType": "INVOICE RELEASE REASON", "Description": "Invoice amount lowered.", "Name": "Reduced amount", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesInvoiceHoldsLOV/00030000000E414D4F554E54204C4F574552454400000009484F4C4420434F44450000000E414D4F554E54204C4F5745524544", "name": "payablesInvoiceHoldsLOV", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesInvoiceHoldsLOV/00030000000E414D4F554E54204C4F574552454400000009484F4C4420434F44450000000E414D4F554E54204C4F5745524544", "name": "payablesInvoiceHoldsLOV", "kind": "item" } ] }, ... ], "count": 16, "hasMore": false, "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" } ] }
Example 5
The following example shows how to find a list of valid release names that can be used to release a tax variance related invoice hold.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesInvoiceHoldsLOV?finder=HoldReleaseFinder;SystemMatchingHold=N,HoldCode=Tax%20Variance
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "HoldLookupCode": "Test variance Release rea", "HoldType": "VARIANCE RELEASE REASON", "Description": "Test variance Release reason", "Name": "Test variance Release rea", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesInvoiceHoldsLOV/000300000019546573742076617269616E63652052656C656173652072656100000009484F4C4420434F444500000019546573742076617269616E63652052656C6561736520726561", "name": "payablesInvoiceHoldsLOV", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesInvoiceHoldsLOV/000300000019546573742076617269616E63652052656C656173652072656100000009484F4C4420434F444500000019546573742076617269616E63652052656C6561736520726561", "name": "payablesInvoiceHoldsLOV", "kind": "item" } ] }, ... ], "count": 3, "hasMore": false, "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" } ] }