Get all collection promises
get
/fscmRestApi/resources/11.13.18.05/collectionPromises
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 collection promise that matches the primary key criteria specified.
Finder Variables:- PromiseDetailId; integer; The unique identifier of the promise to pay.
- promisesFinder: Finds the collection promise that matches the specified transaction, installment number, promise date, promise amount, canceled promises, and broken promises.
Finder Variables:- BindInstallmentNumber; integer; The installment number of a transaction against which a promise is created.
- BindPromiseAmount; number; The promise amount of a collection promise.
- BindPromiseDate; string; The promise date of a collection promise.
- BindTransactionNumber; string; The transaction number of a collection promise.
- IncludeBrokenPromises; string; The state of the promise.
- IncludeCancelledPromises; string; The status of the promise.
- PrimaryKey: Finds the collection promise that matches the primary key criteria specified.
-
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:- InstallmentNumber; integer; The sequence number of an installment in the transaction.
- PromiseAmount; number; The amount that is promised against an installment of an invoice.
- PromiseDate; string; The date when the promise is created.
- PromiseDetailId; integer; The unique identifier of the promise to pay.
- TransactionNumber; string; The unique identifier of the transaction for which the promise is created.
-
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 : collectionPromises
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 : collectionPromises-item-response
Type:
Show Source
object
-
BillToCustomerAccount: string
Title:
Bill-to Customer Account
Maximum Length:30
The account reference of the bill-to customer. -
BusinessUnit: string
Title:
Business Unit
Maximum Length:240
The name of the business unit for which the promise is registered. -
collectionPromiseDFF: array
Collection Promises Descriptive Flexfields
Title:
Collection Promises Descriptive Flexfields
The collection promises descriptive flexfields resource is used to query and add descriptive flexfield values to a promise to pay. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
Currency: string
Title:
Currency
Maximum Length:15
The currency code in which the promise amount is registered. -
InstallmentNumber: integer
(int64)
Title:
Installment Number
The sequence number of an installment in the transaction. -
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. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PaymentAccount: string
Title:
Payment Account
Maximum Length:240
The bank account or the credit card account to be used to make the payment. -
PaymentMethod: string
Title:
Payment Method
Maximum Length:30
The payment method by which the promised amount is to be paid. -
PromiseAmount: number
Title:
Promise Amount
The amount that is promised against an installment of an invoice. -
PromiseBalanceAmount: string
Title:
Promise Balance Amount
Indicates full open balance of the installment as the promised amount. -
PromiseDate: string
(date)
Title:
Promise Date
The date when the promise is created. -
PromiseDetailId: integer
(int64)
Title:
Promise Detail ID
The unique identifier of the promise to pay. -
PromiseItemNumber: string
Title:
Promise Item Number
Maximum Length:240
Indicates the promised item number. -
PromiseMadeBy: string
Title:
Promise Made By
Maximum Length:255
The person who entered the promise information. -
TransactionDate: string
(date)
Title:
Transaction Date
The date when the transaction is created. -
TransactionNumber: string
Title:
Transaction Number
Maximum Length:255
The unique identifier of the transaction for which the promise is created.
Nested Schema : Collection Promises Descriptive Flexfields
Type:
array
Title:
Collection Promises Descriptive Flexfields
The collection promises descriptive flexfields resource is used to query and add descriptive flexfield values to a promise to pay.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : collectionPromises-collectionPromiseDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
The descriptive flexfield context name for collection promises. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
The descriptive flexfield context display value for collection promises. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PromiseDetailId: integer
(int64)
The unique identifier of promise to pay.
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 collection promises 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 -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionPromises
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "PromiseDetailId": 100100018989152, "PromiseDate": "2014-07-21", "PromiseAmount": 2640, "Currency": "USD", "PaymentMethod": null, "PaymentAccount": null, "PromiseItemNumber": null, "BusinessUnit": "Vision Operations", "BillToCustomerAccount": "1001", "CreatedBy": "COLLECTIONS_MGR_OPERATIONS", "CreationDate": "2014-07-21T08:06:21+00:00", "LastUpdatedBy": "COLLECTIONS_MGR_OPERATIONS", "LastUpdateDate": "2014-07-21T08:06:21+00:00", "TransactionNumber": "10349", "TransactionDate": "2014-07-21", "InstallmentNumber": 1, "PromiseBalanceAmount": null, "PromiseMadeBy": "Dan Himelstein", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionPromises/100100018989152", "name": "collectionPromises", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionPromises/100100018989152", "name": "collectionPromises", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionPromises/100100018989152/lov/custAccounts", "name": "custAccounts", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionPromises/100100018989152/lov/businessUnits", "name": "businessUnits", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionPromises/100100018989152/lov/paymentMethods", "name": "paymentMethods", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionPromises/100100018989152/child/collectionPromiseDFF", "name": "collectionPromiseDFF", "kind": "collection" } ] }, ... ], "count": 12, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionPromises", "name": "collectionPromises", "kind": "collection" } ] }