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

Update global descriptive flexfields for an invoice distribution

patch

/fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceDistributions/{InvoiceDistributionId}/child/invoiceDistributionGdf/{InvoiceDistributionId3}

Request

Path Parameters
  • The unique identifier for the invoice distribution that is generated while creating an invoice distribution.
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
  • This is the hash key of the attributes which make up the composite key for the Invoice Lines resource and used to uniquely identify an instance of Invoice Lines. The client should not generate the hash key value. Instead, the client should query on the Invoice Lines collection resource in order to navigate to a specific instance of Invoice Lines 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 : 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_distributionsGdf_view_DistributionRestGdfFVxUSAPInvoiceDistributionsVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsGdf_view_DistributionRestGdfJExPLInvoiceDistributionsVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsGdf_view_DistributionRestGdfJExRUInvoiceDistributionsVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsGdf_view_DistributionRestGdfJLxCOInvoiceDistributionsVO-item-patch-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_distributionsGdf_view_DistributionRestGdfFVxUSAPInvoiceDistributionsVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsGdf_view_DistributionRestGdfJExPLInvoiceDistributionsVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsGdf_view_DistributionRestGdfJExRUInvoiceDistributionsVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsGdf_view_DistributionRestGdfJLxCOInvoiceDistributionsVO-item-response
Type: object
Show Source
Links
LVVO_V___FLEX_Context
Parameters:
  • finder: ValidValuesFinder%3Bflex_vst_bind1%3DJGxAPInvoiceDistributions%2CBind_DataSource%3Doracle.apps.flex.financials.payables.invoices.transactions.restModel.distributionsGdf.view.DistributionRestGdfJG_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%3DJGxAPInvoiceDistributions%2CBind_DataSource%3Doracle.apps.flex.financials.payables.invoices.transactions.restModel.distributionsGdf.view.DistributionRestGdfJG_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 retrieve and update a global descriptive flexfield of an invoice distribution of an invoice line:

  • Get all the invoice lines for an invoice.
  • Use the self URI of the specific invoice line.
  • Get all the invoice distributions of the invoice line.
  • Use the self URI of the specific invoice distribution.
  • Get all the global descriptive flexfields of the invoice distribution.
  • Use the self URI of the specific global descriptive flexfield.
  • Submit a PATCH request on the REST resource using cURL.

Here's the cURL command to retrieve all the invoice lines:

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155673303/child/invoiceLines

Example Response Body

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

{
    "items": [
        {
            "LineNumber": 1,
            "LineAmount": 100,
            "AccountingDate": "2008-02-18",
            "UOM": null,
            ...
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155673303/child/invoiceLines/00020000000EACED00057708000110F0832D0AD70000000AACED0005770400000001",
                    "name": "invoiceLines",
                    "kind": "item",
                    "properties": {
                                     "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000978"
                                  }
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155673303/child/invoiceLines/00020000000EACED00057708000110F0832D0AD70000000AACED0005770400000001/child/invoiceLineGdf",
                    "name": "invoiceLineGdf",
                    "kind": "collection"
                },
                ...
            ]
        },
        ...
    ],
    "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/300100155673303/child/invoiceLines",
            "name": "invoiceLines",
            "kind": "collection"
        }
    ]
}

A hash key of InvoiceId and LineNumber identifies an invoice line.

Here's the cURL command that uses the hash key in the self URI to retrieve the invoice line:

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155673303/child/invoiceLines/00020000000EACED00057708000110F0832D0AD70000000AACED0005770400000001

Here's the cURL command that uses the child URI of the invoice line to retrieve all the invoice distributions:

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155673303/child/invoiceLines/00020000000EACED00057708000110F084220D300000000AACED0005770400000001//child/invoiceDistributions

Here's the cURL command that uses the self URI to retrieve the invoice distribution:

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155673303/child/invoiceLines/00020000000EACED00057708000110F084220D300000000AACED0005770400000001/child/invoiceDistributions/1865117

Here's the cURL command that uses the child URI of the invoice distribution to retrieve all the global descriptive flexfields:

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155673303/child/invoiceLines/00020000000EACED00057708000110F084220D300000000AACED0005770400000001/child/invoiceDistributions/1865117/child/invoiceDistributionGdf

Here's the cURL command that uses the self URI to retrieve the global descriptive flexfield:

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155673303/child/invoiceLines/00020000000EACED00057708000110F084220D300000000AACED0005770400000001/child/invoiceDistributions/1865117/child/invoiceDistributionGdf/1865117

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

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155673303/child/invoiceLines/00020000000EACED00057708000110F084220D300000000AACED0005770400000001/child/invoiceDistributions/1865117/child/invoiceDistributionGdf/1865117

Example Request Payload

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

{
 "__FLEX_Context": "JExPLInvoiceDistributions",
 "adjustedTaxPointDate": "2019-02-01"
}

Example Response Body

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

{
    "InvoiceDistributionId": 1865117,
    "__FLEX_Context": "JExPLInvoiceDistributions",
    "__FLEX_Context_DisplayValue": "Invoice Distributions for Poland",
    "adjustedTaxPointDate": "2019-02-01",
    "taxPointDateHistory": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155673303/child/invoiceLines/00020000000EACED00057708000110F0832D0AD70000000AACED0005770400000001/child/invoiceDistributions/1865117/child/invoiceDistributionGdf/1865117",
            "name": "invoiceDistributionGdf",
            "kind": "item",
            "properties": {
                             "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478"
                          }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155673303/child/invoiceLines/00020000000EACED00057708000110F0832D0AD70000000AACED0005770400000001/child/invoiceDistributions/1865117/child/invoiceDistributionGdf/1865117",
            "name": "invoiceDistributionGdf",
            "kind": "item"
        },
        ...
    ]
}
Back to Top