Create a descriptive flexfield for an invoice installment
/fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceInstallments/{invoiceInstallmentsUniqID}/child/invoiceInstallmentDff
Request
-
invoiceInstallmentsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Invoice Installments resource and used to uniquely identify an instance of Invoice Installments. The client should not generate the hash key value. Instead, the client should query on the Invoice Installments collection resource in order to navigate to a specific instance of Invoice Installments to get the hash key.
-
invoicesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Invoices resource and used to uniquely identify an instance of Invoices. The client should not generate the hash key value. Instead, the client should query on the Invoices collection resource in order to navigate to a specific instance of Invoices to get the hash key.
-
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
- application/json
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:150
The descriptive flexfield context name for the invoice installment. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
The descriptive flexfield context display value for the invoice installment. -
InstallmentNumber: integer
(int64)
Title:
Payment Number
The number used to identify an invoice installment to which the descriptive flexfield is associated. -
InvoiceId: integer
(int64)
The unique identifier for the invoice to which the installment descriptive flexfield is associated.
Response
- 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
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:150
The descriptive flexfield context name for the invoice installment. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
The descriptive flexfield context display value for the invoice installment. -
InstallmentNumber: integer
(int64)
Title:
Payment Number
The number used to identify an invoice installment to which the descriptive flexfield is associated. -
InvoiceId: integer
(int64)
The unique identifier for the invoice to which the installment descriptive flexfield is associated.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.
- LVVO_V___FLEX_Context
-
Parameters:
- finder:
ValidValuesFinder%3BBind_ApplicationId%3D200%2CBind_DescriptiveFlexfieldCode%3DAP_PAYMENT_SCHEDULES
The following properties are defined on the LOV link relation:- Source Attribute: __FLEX_Context_DisplayValue; Target Attribute: Name
- Display Attribute: Name, Description
- finder:
- LVVO___FLEX_Context
-
Parameters:
- finder:
ValidValuesFinder%3BBind_ApplicationId%3D200%2CBind_DescriptiveFlexfieldCode%3DAP_PAYMENT_SCHEDULES
The following properties are defined on the LOV link relation:- Source Attribute: __FLEX_Context; Target Attribute: ContextCode
- Display Attribute: Name
- finder:
Examples
The following example shows how to create a descriptive flexfield for an invoice installment.
Get all the invoice installments of an invoice and use the self URI of the specific invoice installment. Then, submit a POST request on the REST resource using cURL.
Here's the cURL command to retrieve all the invoice installments:
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/invoices/300100128521001/child/invoiceInstallments
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"items": [
{
"InstallmentNumber": 1,
"UnpaidAmount": 0,
"FirstDiscountAmount": null,
...
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100128521001/child/invoiceInstallments/00020000000EACED00057708000110F0818EBB290000000EACED000577080000000000000001",
"name": "invoiceInstallments",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000678"
}
},
...
]
},
...
],
"count": 10,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100128521001/child/invoiceInstallments",
"name": "invoiceInstallments",
"kind": "collection"
}
]
}
A
hash key of InvoiceId
and InstallmentNumber
identifies an
invoice installment.
Here's the cURL command that uses the hash key in the self URI to retrieve the invoice installment:
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/invoices/300100128521001/child/invoiceInstallments/00020000000EACED00057708000110F0818EBB290000000EACED000577080000000000000001
Here's the cURL command that uses the hash key in the self URI to create a descriptive flexfield:
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/invoices/300100128521001/child/invoiceInstallments/00020000000EACED00057708000110F0818EBB290000000EACED000577080000000000000001/child/invoiceInstallmentDff
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "EscheatmentDate": "2018-09-15" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "InvoiceId": 300100155475915, "PaymentNumber": 1, "EscheatmentDate": "2018-09-15", "_Payment__mode": null, "__FLEX_Context": "AB", "__FLEX_Context_DisplayValue": "AB", "_AB1": null, "_AB2": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/resources/11.13.18.05/invoices/300100155475915/child/invoiceInstallments/00020000000EACED00057708000110F0832A07CB0000000EACED000577080000000000000001/child/invoiceInstallmentDff/00020000000EACED00057708000110F0832A07CB0000000EACED000577080000000000000001", "name": "invoiceInstallmentDff", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000778" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/resources/11.13.18.05/invoices/300100155475915/child/invoiceInstallments/00020000000EACED00057708000110F0832A07CB0000000EACED000577080000000000000001/child/invoiceInstallmentDff/00020000000EACED00057708000110F0832A07CB0000000EACED000577080000000000000001", "name": "invoiceInstallmentDff", "kind": "item" }, ... ] }