Jump to

• Request
• Response
• Examples

Update descriptive flexfields for an invoice distribution

patch

/fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceDistributions/{InvoiceDistributionId}/child/invoiceDistributionDff/{InvoiceDistributionId2}

Request

Path Parameters

• InvoiceDistributionId(required): integer(int64)
  The unique identifier for the invoice distribution that is generated while creating an invoice distribution.
• InvoiceDistributionId2(required): integer(int64)
  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=
• invoiceLinesUniqID(required): string
  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.
• 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.

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 150

  The descriptive flexfield context name for the invoice distribution.
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  The descriptive flexfield context display value for the invoice distribution.
• InvoiceDistributionId: integer (int64)
  The unique identifier for the invoice distribution to which the descriptive flexfield is associated.

{
    "type":"object",
    "properties":{
        "InvoiceDistributionId":{
            "type":"integer",
            "description":"The unique identifier for the invoice distribution to which the descriptive flexfield is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"The descriptive flexfield context display value for the invoice distribution.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":150,
            "type":"string",
            "description":"The descriptive flexfield context name for the invoice distribution.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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-invoiceLines-invoiceDistributions-invoiceDistributionDff-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 150

  The descriptive flexfield context name for the invoice distribution.
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  The descriptive flexfield context display value for the invoice distribution.
• InvoiceDistributionId: integer (int64)
  The unique identifier for the invoice distribution to which the descriptive flexfield is associated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "InvoiceDistributionId":{
            "type":"integer",
            "description":"The unique identifier for the invoice distribution to which the descriptive flexfield is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"The descriptive flexfield context display value for the invoice distribution.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":150,
            "type":"string",
            "description":"The descriptive flexfield context name for the invoice distribution.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

LVVO_V___FLEX_Context

Operation: /fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts

Parameters:

• finder: ValidValuesFinder%3BBind_ApplicationId%3D200%2CBind_DescriptiveFlexfieldCode%3DAP_INVOICE_DISTRIBUTIONS

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

Operation: /fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts

Parameters:

• finder: ValidValuesFinder%3BBind_ApplicationId%3D200%2CBind_DescriptiveFlexfieldCode%3DAP_INVOICE_DISTRIBUTIONS

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 distribution of an invoice line:

• Get all the invoice lines of 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 descriptive flexfields of the invoice distribution.
• 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 lines.

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/300100155475915/child/invoiceLines

Example Response Body

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

{
    "items": [
        {
            "LineNumber": 1,
            "LineAmount": 2212.75,
            "AccountingDate": "2018-11-01",
            "UOM": null,
            ...
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155475915/child/invoiceLines/00040000000EACED00057708000110F0832A07CB0000000AACED000577040000000100000011494E564F494345204C494E452054595045000000044954454D",
                    "name": "invoiceLines",
                    "kind": "item",
                    "properties": {
                                     "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                                  }
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155475915/child/invoiceLines/00040000000EACED00057708000110F0832A07CB0000000AACED000577040000000100000011494E564F494345204C494E452054595045000000044954454D/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/300100155475915/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 specific invoice line.

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/300100155475915/child/invoiceLines/00040000000EACED00057708000110F0832A07CB0000000AACED000577040000000100000011494E564F494345204C494E452054595045000000044954454D

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/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155475915/child/invoiceLines/00040000000EACED00057708000110F0832A07CB0000000AACED000577040000000100000011494E564F494345204C494E452054595045000000044954454D/child/invoiceDistributions

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

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/300100155475915/child/invoiceLines/00040000000EACED00057708000110F0832A07CB0000000AACED000577040000000100000011494E564F494345204C494E452054595045000000044954454D/child/invoiceDistributions/1810066

Here's the cURL command that uses the child URI of the invoice distribution 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/300100155475915/child/invoiceLines/00040000000EACED00057708000110F0832A07CB0000000AACED000577040000000100000011494E564F494345204C494E452054595045000000044954454D/child/invoiceDistributions/1810066/child/invoiceDistributionDff

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/300100155475915/child/invoiceLines/00040000000EACED00057708000110F0832A07CB0000000AACED000577040000000100000011494E564F494345204C494E452054595045000000044954454D/child/invoiceDistributions/1810066/child/invoiceDistributionDff

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/300100155475915/child/invoiceLines/00040000000EACED00057708000110F0832A07CB0000000AACED000577040000000100000011494E564F494345204C494E452054595045000000044954454D/child/invoiceDistributions/1810066/child/invoiceDistributionDff

Example Request Payload

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

{
    "AdditionalDistributionInfo": "Pending"
}

Example Response Body

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

{
    "InvoiceDistributionId": 1810066,
    "AdditionalDistributionInfo": "Pending",
    "__FLEX_Context": null,
    "__FLEX_Context_DisplayValue": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155475915/child/invoiceLines/00040000000EACED00057708000110F0832A07CB0000000AACED000577040000000100000011494E564F494345204C494E452054595045000000044954454D/child/invoiceDistributions/1810066/child/invoiceDistributionDff/1810066",
            "name": "invoiceDistributionDff",
            "kind": "item",
            "properties": {
                             "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478"
                          }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155475915/child/invoiceLines/00040000000EACED00057708000110F0832A07CB0000000AACED000577040000000100000011494E564F494345204C494E452054595045000000044954454D/child/invoiceDistributions/1810066/child/invoiceDistributionDff/1810066",
            "name": "invoiceDistributionDff",
            "kind": "item"
        },
        ...
   ]
}

Back to Top