REST API for Oracle Fusion Cloud Financials

Update descriptive flexfields for a payment

patch

/fscmRestApi/resources/11.13.18.05/payablesPayments/{CheckId}/child/paymentDff/{CheckId2}

Request

Path Parameters

CheckId(required): integer(int64)

The unique identifier assigned to every payment made.
CheckId2(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=

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

Root Schema : Discriminator: __FLEX_Context

Type: object

Discriminator: __FLEX_Context

{
    "discriminator":{
        "propertyName":"__FLEX_Context",
        "mapping":{
            "Context1":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext1VO-item-patch-request",
            "Context2":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext2VO-item-patch-request"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext1VO-item-patch-request"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext2VO-item-patch-request"
        }
    ]
}

Match One Schema

Show Source

Context1 - object oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext1VO-item-patch-request
Context2 - object oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext2VO-item-patch-request

{
    "discriminator":{
        "propertyName":"__FLEX_Context",
        "mapping":{
            "Context1":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext1VO-item-patch-request",
            "Context2":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext2VO-item-patch-request"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext1VO-item-patch-request"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext2VO-item-patch-request"
        }
    ]
}

Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext1VO-item-patch-request

Type: object

Show Source

__FLEX_Context: string

Title: Context

Maximum Length: 150

Default Value: Context1

The descriptive flexfield context name for the payment.
__FLEX_Context_DisplayValue: string

Title: Context

The descriptive flexfield context display value for the payment.

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Context",
            "type":"string",
            "description":"The descriptive flexfield context display value for the payment.",
            "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",
            "maxLength":"150",
            "type":"string",
            "description":"The descriptive flexfield context name for the payment.",
            "nullable":true,
            "default":"Context1",
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"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"
                }
            }
        }
    }
}

Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext2VO-item-patch-request

Type: object

Show Source

__FLEX_Context: string

Title: Context

Maximum Length: 150

Default Value: Context2

The descriptive flexfield context name for the payment.
__FLEX_Context_DisplayValue: string

Title: Context

The descriptive flexfield context display value for the payment.

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Context",
            "type":"string",
            "description":"The descriptive flexfield context display value for the payment.",
            "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",
            "maxLength":"150",
            "type":"string",
            "description":"The descriptive flexfield context name for the payment.",
            "nullable":true,
            "default":"Context2",
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"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"
                }
            }
        }
    }
}

Response

Supported Media Types

application/json

Default Response

The following table describes the default response for this task.

Headers

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.

Root Schema : Discriminator: __FLEX_Context

Type: object

Discriminator: __FLEX_Context

Discriminator Values

Context1
Context2

{
    "discriminator":{
        "propertyName":"__FLEX_Context",
        "mapping":{
            "Context1":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext1VO-item-response",
            "Context2":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext2VO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext1VO-item-response"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext2VO-item-response"
        }
    ]
}

Match One Schema

Show Source

Context1 - object oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext1VO-item-response
Context2 - object oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext2VO-item-response

{
    "discriminator":{
        "propertyName":"__FLEX_Context",
        "mapping":{
            "Context1":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext1VO-item-response",
            "Context2":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext2VO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext1VO-item-response"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext2VO-item-response"
        }
    ]
}

Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext1VO-item-response

Type: object

Show Source

__FLEX_Context: string

Title: Context

Maximum Length: 150

Default Value: Context1

The descriptive flexfield context name for the payment.
__FLEX_Context_DisplayValue: string

Title: Context

The descriptive flexfield context display value for the payment.
CheckId: integer (int64)

The unique identifier maintained for every payment made.
links: array Links

Title: Links

The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CheckId":{
            "type":"integer",
            "description":"The unique identifier maintained for every payment made.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context",
            "type":"string",
            "description":"The descriptive flexfield context display value for the payment.",
            "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",
            "maxLength":"150",
            "type":"string",
            "description":"The descriptive flexfield context name for the payment.",
            "nullable":true,
            "default":"Context1",
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"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"
                }
            }
        }
    }
}

Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext2VO-item-response

Type: object

Show Source

__FLEX_Context: string

Title: Context

Maximum Length: 150

Default Value: Context2

The descriptive flexfield context name for the payment.
__FLEX_Context_DisplayValue: string

Title: Context

The descriptive flexfield context display value for the payment.
CheckId: integer (int64)

The unique identifier maintained for every payment made.
links: array Links

Title: Links

The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CheckId":{
            "type":"integer",
            "description":"The unique identifier maintained for every payment made.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context",
            "type":"string",
            "description":"The descriptive flexfield context display value for the payment.",
            "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",
            "maxLength":"150",
            "type":"string",
            "description":"The descriptive flexfield context name for the payment.",
            "nullable":true,
            "default":"Context2",
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"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"
                }
            }
        }
    }
}

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."
        }
    }
}

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"
    }
}

Links

LVVO_V___FLEX_Context

Operation: /fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts

Parameters:

finder: ValidValuesFinder%3BBind_ApplicationId%3D200%2CBind_DescriptiveFlexfieldCode%3DAP_CHECKS

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_CHECKS

The following properties are defined on the LOV link relation:

Source Attribute: __FLEX_Context; Target Attribute: ContextCode
Display Attribute: Name

Examples

The following example shows how to update a descriptive flexfield for a payment by submitting a PATCH request on the REST resource using cURL.

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/payablesPayments/300100155645811/child/paymentDff/300100155645811

Example Request Payload

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

{
    "_Payment__Code__": "E"
}

Example Response Body

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

{
    "CheckId": 300100155645811,
    "__FLEX_Context": "Additional Payment Info",
    "__FLEX_Context_DisplayValue": "Additional Payment Info",
    "_Payment__Code__": "E",
    ...
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100155645811/child/paymentDff/300100155645811",
            "name": "paymentDff",
            "kind": "item",
            "properties": {
                             "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                          }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100155645811/child/paymentDff/300100155645811",
            "name": "paymentDff",
            "kind": "item"
        },
        ...
    ]
}