Create a collection promise
post
/fscmRestApi/resources/11.13.18.05/collectionPromises
Request
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.
Supported Media Types
- application/json
Root Schema : schema
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. -
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. -
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 : schema
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. -
PromiseDetailId: integer
(int64)
The unique identifier of promise to pay.
Response
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-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.
Links
- collectionPromiseDFF
-
Operation: /fscmRestApi/resources/11.13.18.05/collectionPromises/{PromiseDetailId}/child/collectionPromiseDFFParameters:
- PromiseDetailId:
$request.path.PromiseDetailId
The collection promises descriptive flexfields resource is used to query and add descriptive flexfield values to a promise to pay. - PromiseDetailId:
Examples
The following example shows how to create a collection promise by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionPromises
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "PromiseDate": "2018-07-11", "PaymentAccount": "Test Account", "PaymentMethod":"AR_AutoRec_RRF1", "PromiseItemNumber": "REST TEST Balance", "BusinessUnit":"Vision Operations", "BillToCustomerAccount":"1006", "TransactionNumber":"511543", "TransactionDate": "2006-04-21", "InstallmentNumber": 1, "PromiseAmount":11000.97 }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "PromiseDetailId": 300100169110057, "PromiseDate": "2018-07-11", "PromiseAmount": 11000.97, "Currency": "CAD", "PaymentMethod": "AR_AutoRec_RRF1", "PaymentAccount": "Test Account", "PromiseItemNumber": "REST TEST Balance", "BusinessUnit": "Vision Operations", "BillToCustomerAccount": "1006", "CreatedBy": "COLLECTIONS_MGR_OPERATIONS", "CreationDate": "2018-10-26T09:26:41.003+00:00", "LastUpdatedBy": "COLLECTIONS_MGR_OPERATIONS", "LastUpdateDate": "2018-10-26T09:26:42.072+00:00", "TransactionNumber": "511543", "TransactionDate": "2006-04-21", "InstallmentNumber": 1, "PromiseBalanceAmount": null, "PromiseMadeBy": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionPromises/300100169110057", "name": "collectionPromises", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionPromises/300100169110057", "name": "collectionPromises", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionPromises/300100169110057/lov/custAccounts", "name": "custAccounts", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionPromises/300100169110057/lov/businessUnits", "name": "businessUnits", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionPromises/300100169110057/lov/paymentMethods", "name": "paymentMethods", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionPromises/300100169110057/child/collectionPromiseDFF", "name": "collectionPromiseDFF", "kind": "collection" } ] }