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

Create a global descriptive flexfield for an invoice installment

post

/fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceInstallments/{invoiceInstallmentsUniqID}/child/invoiceInstallmentGdf

Request

Path Parameters
  • 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.
  • 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.
Supported Media Types
Request Body - application/json ()
Root Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJL__5FBR__5FAPXINWKB__5FAP__5FPAY__5FSCHEDVO-item-post-request
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJLxMXPaymentSchedulesVO-item-post-request
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 : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJL__5FBR__5FAPXINWKB__5FAP__5FPAY__5FSCHEDVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJLxMXPaymentSchedulesVO-item-response
Type: object
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Links
LVVO_V___FLEX_Context
Parameters:
  • finder: ValidValuesFinder%3Bflex_vst_bind1%3DJG_AP_PAYMENT_SCHEDULES%2CBind_DataSource%3Doracle.apps.flex.financials.payables.invoices.transactions.restModel.installmentsGdf.view.InstallmentRestGdfJG_5FGDF_5FCONTEXTS_5FBY_5FCOUNTRYVSO
The following properties are defined on the LOV link relation:
  • Source Attribute: __FLEX_Context_DisplayValue; Target Attribute: Value
  • Display Attribute: Value, Description
LVVO___FLEX_Context
Parameters:
  • finder: ValidValuesFinder%3Bflex_vst_bind1%3DJG_AP_PAYMENT_SCHEDULES%2CBind_DataSource%3Doracle.apps.flex.financials.payables.invoices.transactions.restModel.installmentsGdf.view.InstallmentRestGdfJG_5FGDF_5FCONTEXTS_5FBY_5FCOUNTRYVSO
The following properties are defined on the LOV link relation:
  • Source Attribute: __FLEX_Context; Target Attribute: Id
  • Display Attribute: Value
Back to Top

Examples

The following example shows how to create a global 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/300100174997532/child/invoiceInstallments

Example Response Body

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

{
    "items": [
        {
            "InstallmentNumber": 1,
            "UnpaidAmount": 5,
            "FirstDiscountAmount": null,
            "FirstDiscountDate": null,
            ...
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100174997532/child/invoiceInstallments/00020000000EACED00057708000110F08453E81C0000000EACED000577080000000000000001",
                    "name": "invoiceInstallments",
                    "kind": "item",
                    "properties": {
                                     "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
                                  }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100174997532/child/invoiceInstallments/00020000000EACED00057708000110F08453E81C0000000EACED000577080000000000000001",
                    "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/300100174997532/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/300100174997532/child/invoiceInstallments/00020000000EACED00057708000110F08453E81C0000000EACED000577080000000000000001

Here's the cURL command that uses the hash key in the self URI to create a global 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/300100174997532/child/invoiceInstallments/00020000000EACED00057708000110F08453E81C0000000EACED000577080000000000000001/child/invoiceInstallmentGdf

Example Request Payload

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

{
"_Interest__Type_Display": "Amount",
"_Interest__Rate___2F__Amount": 12
}

Example Response Body

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

{
    "InvoiceId": 300100174997532,
    "InstallmentNumber": 1,
    "_Interest__Type_Display": "Amount",
    "_Interest__Rate___2F__Amount": 12,
    ...
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100174997532/child/invoiceInstallments/00020000000EACED00057708000110F08453E81C0000000EACED000577080000000000000001/child/invoiceInstallmentGdf/00020000000EACED00057708000110F08453E81C0000000EACED000577080000000000000001",
            "name": "invoiceInstallmentGdf",
            "kind": "item",
            "properties": {
                             "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000778"
                          }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100174997532/child/invoiceInstallments/00020000000EACED00057708000110F08453E81C0000000EACED000577080000000000000001/child/invoiceInstallmentGdf/00020000000EACED00057708000110F08453E81C0000000EACED000577080000000000000001",
            "name": "invoiceInstallmentGdf",
            "kind": "item"
        },
        ...
    ]
}
Back to Top