Update a global descriptive flexfield for a payment
patch
/fscmRestApi/resources/11.13.18.05/payablesPayments/{CheckId}/child/paymentGdf/{CheckId3}
Request
Path Parameters
-
CheckId(required): integer(int64)
The unique identifier assigned to every payment made.
-
CheckId3(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: string
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: string
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:
objectDiscriminator: __FLEX_Context
Discriminator Values
- FVxUSAPCHECKS
- JA_CN_REMIT_BILL_NUM
- JAxINChallanInfo
- JAxTHPayments
- JE_IL_PAYMENT_CHECKS
- JLxMXPaymentChecks
Match One Schema
Show Source
-
FVxUSAPCHECKS -
object
oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfFVxUSAPCHECKSVO-item-patch-request
-
JA_CN_REMIT_BILL_NUM -
object
oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJA__5FCN__5FREMIT__5FBILL__5FNUMVO-item-patch-request
-
JAxINChallanInfo -
object
oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxINChallanInfoVO-item-patch-request
-
JAxTHPayments -
object
oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxTHPaymentsVO-item-patch-request
-
JE_IL_PAYMENT_CHECKS -
object
oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJE__5FIL__5FPAYMENT__5FCHECKSVO-item-patch-request
-
JLxMXPaymentChecks -
object
oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJLxMXPaymentChecksVO-item-patch-request
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfFVxUSAPCHECKSVO-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Regional InformationMaximum Length:150Default Value:FVxUSAPCHECKSThe global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional InformationThe global descriptive flexfield context display value for the payment. -
VoidedPaymentID: number
Title:
Voided PaymentVoided Payment -
VoidedPaymentID_Display: string
Title:
Voided PaymentVoided Payment
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJA__5FCN__5FREMIT__5FBILL__5FNUMVO-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Regional InformationMaximum Length:150Default Value:JA_CN_REMIT_BILL_NUMThe global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional InformationThe global descriptive flexfield context display value for the payment. -
_Remittance__Bill__Number: string
Title:
Remittance Bill NumberMaximum Length:150Remittance Bill Number
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxINChallanInfoVO-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Regional InformationMaximum Length:150Default Value:JAxINChallanInfoThe global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional InformationThe global descriptive flexfield context display value for the payment. -
BankName: string
Title:
Bank NameMaximum Length:150Bank Name -
BSRCode: string
Title:
BSR CodeMaximum Length:150BSR Code -
ChallanSerialNumber: string
Title:
Challan Serial NumberMaximum Length:150Challan Serial Number -
DateOfDeposit: string
(date)
Title:
Date of DepositDate of Deposit
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxTHPaymentsVO-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Regional InformationMaximum Length:150Default Value:JAxTHPaymentsThe global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional InformationThe global descriptive flexfield context display value for the payment. -
ExchangeRateDocumentNumber: string
Title:
Exchange Rate Document NumberMaximum Length:150Exchange Rate Document Number -
PaymentCondition: string
Title:
Payment ConditionMaximum Length:150Payment Condition -
PaymentCondition_Display: string
Title:
Payment ConditionPayment Condition
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJE__5FIL__5FPAYMENT__5FCHECKSVO-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Regional InformationMaximum Length:150Default Value:JE_IL_PAYMENT_CHECKSThe global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional InformationThe global descriptive flexfield context display value for the payment. -
_Withholding__Amount__Paid__by__Ban: number
Title:
Withholding Amount Paid by BankWithholding Amount Paid by Bank
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJLxMXPaymentChecksVO-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Regional InformationMaximum Length:150Default Value:JLxMXPaymentChecksThe global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional InformationThe global descriptive flexfield context display value for the payment. -
digitalTaxReceiptUsingInternet: string
Title:
Digital Tax Receipt using Internet Unique IDMaximum Length:150Digital Tax Receipt using Internet Unique ID -
paymentMethod: string
Title:
Payment MethodMaximum Length:150Payment Method -
paymentMethod_Display: string
Title:
Payment MethodPayment Method
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:
objectDiscriminator: __FLEX_Context
Discriminator Values
- FVxUSAPCHECKS
- JA_CN_REMIT_BILL_NUM
- JAxINChallanInfo
- JAxTHPayments
- JE_IL_PAYMENT_CHECKS
- JLxMXPaymentChecks
Match One Schema
Show Source
-
FVxUSAPCHECKS -
object
oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfFVxUSAPCHECKSVO-item-response
-
JA_CN_REMIT_BILL_NUM -
object
oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJA__5FCN__5FREMIT__5FBILL__5FNUMVO-item-response
-
JAxINChallanInfo -
object
oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxINChallanInfoVO-item-response
-
JAxTHPayments -
object
oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxTHPaymentsVO-item-response
-
JE_IL_PAYMENT_CHECKS -
object
oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJE__5FIL__5FPAYMENT__5FCHECKSVO-item-response
-
JLxMXPaymentChecks -
object
oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJLxMXPaymentChecksVO-item-response
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfFVxUSAPCHECKSVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Regional InformationMaximum Length:150Default Value:FVxUSAPCHECKSThe global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional InformationThe global descriptive flexfield context display value for the payment. -
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
VoidedPaymentID: number
Title:
Voided PaymentVoided Payment -
VoidedPaymentID_Display: string
Title:
Voided PaymentVoided Payment
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJA__5FCN__5FREMIT__5FBILL__5FNUMVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Regional InformationMaximum Length:150Default Value:JA_CN_REMIT_BILL_NUMThe global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional InformationThe global descriptive flexfield context display value for the payment. -
_Remittance__Bill__Number: string
Title:
Remittance Bill NumberMaximum Length:150Remittance Bill Number -
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxINChallanInfoVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Regional InformationMaximum Length:150Default Value:JAxINChallanInfoThe global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional InformationThe global descriptive flexfield context display value for the payment. -
BankName: string
Title:
Bank NameMaximum Length:150Bank Name -
BSRCode: string
Title:
BSR CodeMaximum Length:150BSR Code -
ChallanSerialNumber: string
Title:
Challan Serial NumberMaximum Length:150Challan Serial Number -
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
-
DateOfDeposit: string
(date)
Title:
Date of DepositDate of Deposit -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxTHPaymentsVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Regional InformationMaximum Length:150Default Value:JAxTHPaymentsThe global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional InformationThe global descriptive flexfield context display value for the payment. -
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
-
ExchangeRateDocumentNumber: string
Title:
Exchange Rate Document NumberMaximum Length:150Exchange Rate Document Number -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PaymentCondition: string
Title:
Payment ConditionMaximum Length:150Payment Condition -
PaymentCondition_Display: string
Title:
Payment ConditionPayment Condition
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJE__5FIL__5FPAYMENT__5FCHECKSVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Regional InformationMaximum Length:150Default Value:JE_IL_PAYMENT_CHECKSThe global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional InformationThe global descriptive flexfield context display value for the payment. -
_Withholding__Amount__Paid__by__Ban: number
Title:
Withholding Amount Paid by BankWithholding Amount Paid by Bank -
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJLxMXPaymentChecksVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Regional InformationMaximum Length:150Default Value:JLxMXPaymentChecksThe global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional InformationThe global descriptive flexfield context display value for the payment. -
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
-
digitalTaxReceiptUsingInternet: string
Title:
Digital Tax Receipt using Internet Unique IDMaximum Length:150Digital Tax Receipt using Internet Unique ID -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
paymentMethod: string
Title:
Payment MethodMaximum Length:150Payment Method -
paymentMethod_Display: string
Title:
Payment MethodPayment Method
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- LVVO_V___FLEX_Context
-
Parameters:
- finder:
ValidValuesFinder%3Bflex_vst_bind1%3DJG_AP_CHECKS%2CBind_DataSource%3Doracle.apps.flex.financials.payables.payments.core.restModel.paymentsGdf.view.PaymentRestGdfJG_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
- finder:
- LVVO___FLEX_Context
-
Parameters:
- finder:
ValidValuesFinder%3Bflex_vst_bind1%3DJG_AP_CHECKS%2CBind_DataSource%3Doracle.apps.flex.financials.payables.payments.core.restModel.paymentsGdf.view.PaymentRestGdfJG_5FGDF_5FCONTEXTS_5FBY_5FCOUNTRYVSO
The following properties are defined on the LOV link relation:- Source Attribute: __FLEX_Context; Target Attribute: Id
- Display Attribute: Value
- finder:
Examples
The following example shows how to update a global 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/paymentGdf/300100155645811
Example Request Payload
The following example shows the contents of the request body in JSON format:
{
"BankName": "IDFC First Bank"
}Example Response Body
The following example shows the contents of the response body in JSON format:
{
"CheckId": 300100155645811,
"__FLEX_Context": "JAxINChallanInfo",
"BankName": "IDFC First Bank",
"BSRCode": "1234",
...
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100155645811/child/paymentGdf/300100155645811",
"name": "paymentGdf",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100155645811/child/paymentGdf/300100155645811",
"name": "paymentGdf",
"kind": "item"
},
...
]
}