1. REST API for Oracle Fusion Cloud Financials
  2. Tasks
  3. Invoices
  4. Invoice Installments
  5. Invoice Installments Descriptive Flexfields

Update descriptive flexfields for an invoice installment

patch

/fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceInstallments/{invoiceInstallmentsUniqID}/child/invoiceInstallmentDff/{invoiceInstallmentDffUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key--- InvoiceId and InstallmentNumber ---for the Invoice Installments Descriptive Flexfields resource and used to uniquely identify an instance of Invoice Installments Descriptive Flexfields. The client should not generate the hash key value. Instead, the client should query on the Invoice Installments Descriptive Flexfields collection resource with a filter on the primary key values in order to navigate to a specific instance of Invoice Installments Descriptive Flexfields.

    For example: invoiceInstallmentDff?q=InvoiceId=<value1>;InstallmentNumber=<value2>
  • 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.
  • 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.
Header Parameters
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : invoices-invoiceInstallments-invoiceInstallmentDff-item-response
Type: object
Show Source
Links
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
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
Back to Top

Examples

The following example shows how to retrieve and update a descriptive flexfield of an invoice installment of an invoice:

  • Get all the invoice installments of an invoice.
  • Use the self URI of the specific invoice installment.
  • Get all the descriptive flexfields of the invoice installment.
  • Use the self URI of the specific descriptive flexfield.
  • Submit a PATCH 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/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100128521001/child/invoiceInstallments

Example Request Payload

The following example shows the contents of the request body in JSON format:

{
    "items": [
        {
            "InstallmentNumber": 1,
            "UnpaidAmount": 0,
            "FirstDiscountAmount": null,
            "FirstDiscountDate": 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"
                                  }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100128521001/child/invoiceInstallments/00020000000EACED00057708000110F0818EBB290000000EACED000577080000000000000001",
                    "name": "invoiceInstallments",
                    "kind": "item"
                },
                ...
            ]
        },
        ...
    ],
    "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 specific invoice installment.

curl -i -u "<username>:<password>" -H "Content-Type: application/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 child URI of the invoice installment to retrieve all the descriptive flexfields.

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100128521001/child/invoiceInstallments/00020000000EACED00057708000110F0818EBB290000000EACED000577080000000000000001/child/invoiceInstallmentDff

A hash key of InvoiceId and InstallmentNumber identifies a descriptive flexfield.

Here's the cURL command that uses the self URI to retrieve the specific descriptive flexfield.

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100128521001/child/invoiceInstallments/00020000000EACED00057708000110F0818EBB290000000EACED000577080000000000000001/child/invoiceInstallmentDff/00020000000EACED00057708000110F0832A07CB0000000EACED000577080000000000000001

Here's the cURL command that uses the self URI to update the descriptive flexfield.

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100128521001/child/invoiceInstallments/00020000000EACED00057708000110F0818EBB290000000EACED000577080000000000000001/child/invoiceInstallmentDff/00020000000EACED00057708000110F0832A07CB0000000EACED000577080000000000000001

Example Request Payload

The following example shows the contents of the request body in JSON format:

{
    "EscheatmentDate": "2018-09-19"
}

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "InvoiceId": 300100155475915,
    "PaymentNumber": 1,
    "EscheatmentDate": "2018-09-19",
    "_Payment__mode": null,
    ...
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155475915/child/invoiceInstallments/00020000000EACED00057708000110F0832A07CB0000000EACED000577080000000000000001/child/invoiceInstallmentDff/00020000000EACED00057708000110F0832A07CB0000000EACED000577080000000000000001",
            "name": "invoiceInstallmentDff",
            "kind": "item",
            "properties": {
                             "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000878"
                          }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155475915/child/invoiceInstallments/00020000000EACED00057708000110F0832A07CB0000000EACED000577080000000000000001/child/invoiceInstallmentDff/00020000000EACED00057708000110F0832A07CB0000000EACED000577080000000000000001",
            "name": "invoiceInstallmentDff",
            "kind": "item"
        },
        ...
    ]
}
Back to Top