Get all holds
get
/fscmRestApi/resources/11.13.18.05/invoiceHolds
Request
Query Parameters
-
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:- PrimaryKey: Finds the invoice hold with the specified primary key.
Finder Variables:- HoldId; integer; The unique invoice hold identifier.
- PrimaryKey: Finds the invoice 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:- BusinessUnit; string; The business unit name for the invoice.
- ConsumptionAdviceLineNumber; number; The consumption advice line number associated to the invoice line that is placed on hold.
- ConsumptionAdviceNumber; string; The consumption advice number associated to the invoice line that is placed on hold.
- CreatedBy; string; The user who created the hold record.
- CreationDate; string; The date when the record was created.
- HeldBy; string; The user who placed the hold on the invoice.
- HoldDate; string; The date when the hold is placed on the invoice.
- HoldDetails; string; The details of the hold that is placed on the invoice line.
- HoldId; integer; The unique invoice hold identifier that is generated during a create action.
- HoldName; string; 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; The reason the hold was placed on the invoice.
- InvoiceNumber; string; The unique number for the supplier invoice.
- LastUpdateDate; string; The date when the record was last updated.
- LastUpdateLogin; string; The session login associated to the user who last updated the record.
- LastUpdatedBy; string; The user who last updated the record.
- LineHeld; number; The invoice line number on which the hold is placed.
- Party; string; The party to whom payment is made.
- PartyId; string; The unique identifier of the party to whom the payment is made.
- PurchaseOrderLineNumber; number; The purchase order line number associated to the invoice line that is placed on hold.
- PurchaseOrderNumber; string; The purchase order number associated to the invoice line that is placed on hold.
- PurchaseOrderScheduleLineNumber; number; The purchase order schedule line number associated to the invoice line that is placed on hold.
- ReceiptLineNumber; integer; The receipt line number associated to the invoice line that is placed on hold.
- ReceiptNumber; string; The receipt number associated to the invoice line that is placed on hold.
- ReleaseDate; string; The date when the invoice hold was released.
- ReleaseName; string; 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; The reason the hold was released on the invoice.
- Supplier; string; The supplier name on the invoice.
- WorkflowStatus; string; The holds resolution workflow status.
-
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".
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : invoiceHolds
Type:
Show Source
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : invoiceHolds-item-response
Type:
Show Source
object
-
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. -
Party: string
Maximum Length:
255
The party to whom payment is made. -
PartyId: string
Maximum Length:
255
The unique identifier of the party to whom the payment is made. -
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.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : invoiceHolds-invoiceHoldDff-item-response
Type:
Show Source
object
-
__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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following example shows how to retrieve all the invoice holds by submitting a GET request on the REST resource using cURL.
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/invoiceHolds
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "HoldId": 300100031585684, "InvoiceNumber": "AS-Holds-Test", "BusinessUnit": "Vision Operations", "Supplier": "Advanced Network Devices", ... "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoiceHolds/300100031585684", "name": "invoiceHolds", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoiceHolds/300100031585684/child/invoiceHoldDff", "name": "invoiceHoldDff", "kind": "collection" }, ... ] }, ... ], "count": 25, "hasMore": true, "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" } ] }