Create a global descriptive flexfield for a payment
post
/fscmRestApi/resources/11.13.18.05/payablesPayments/{CheckId}/child/paymentGdf
Request
Path Parameters
-
CheckId(required): integer(int64)
The unique identifier assigned to every payment made.
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.
-
Upsert-Mode:
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
- application/json
Root Schema : Discriminator: __FLEX_Context
Type:
object
Discriminator: __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-post-request
-
JA_CN_REMIT_BILL_NUM -
object
oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJA__5FCN__5FREMIT__5FBILL__5FNUMVO-item-post-request
-
JAxINChallanInfo -
object
oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxINChallanInfoVO-item-post-request
-
JAxTHPayments -
object
oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxTHPaymentsVO-item-post-request
-
JE_IL_PAYMENT_CHECKS -
object
oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJE__5FIL__5FPAYMENT__5FCHECKSVO-item-post-request
-
JLxMXPaymentChecks -
object
oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJLxMXPaymentChecksVO-item-post-request
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfFVxUSAPCHECKSVO-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:FVxUSAPCHECKS
The global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The global descriptive flexfield context display value for the payment. -
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
-
VoidedPaymentID: number
Title:
Voided Payment
-
VoidedPaymentID_Display: string
Title:
Voided Payment
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJA__5FCN__5FREMIT__5FBILL__5FNUMVO-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:JA_CN_REMIT_BILL_NUM
The global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The global descriptive flexfield context display value for the payment. -
_Remittance__Bill__Number: string
Title:
Remittance Bill Number
Maximum Length:150
-
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxINChallanInfoVO-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:JAxINChallanInfo
The global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The global descriptive flexfield context display value for the payment. -
BankName: string
Title:
Bank Name
Maximum Length:150
-
BSRCode: string
Title:
BSR Code
Maximum Length:150
-
ChallanSerialNumber: string
Title:
Challan Serial Number
Maximum Length:150
-
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
-
DateOfDeposit: string
(date)
Title:
Date of Deposit
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxTHPaymentsVO-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:JAxTHPayments
The global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The 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 Number
Maximum Length:150
-
PaymentCondition: string
Title:
Payment Condition
Maximum Length:150
-
PaymentCondition_Display: string
Title:
Payment Condition
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJE__5FIL__5FPAYMENT__5FCHECKSVO-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:JE_IL_PAYMENT_CHECKS
The global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The global descriptive flexfield context display value for the payment. -
_Withholding__Amount__Paid__by__Ban: number
Title:
Withholding Amount Paid by Bank
-
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJLxMXPaymentChecksVO-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:JLxMXPaymentChecks
The global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The 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 ID
Maximum Length:150
-
paymentMethod: string
Title:
Payment Method
Maximum Length:150
-
paymentMethod_Display: string
Title:
Payment 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:
object
Discriminator: __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 Information
Maximum Length:150
Default Value:FVxUSAPCHECKS
The global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The global 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. -
VoidedPaymentID: number
Title:
Voided Payment
-
VoidedPaymentID_Display: string
Title:
Voided 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 Information
Maximum Length:150
Default Value:JA_CN_REMIT_BILL_NUM
The global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The global descriptive flexfield context display value for the payment. -
_Remittance__Bill__Number: string
Title:
Remittance Bill Number
Maximum Length:150
-
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
-
links: array
Links
Title:
Links
The 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 Information
Maximum Length:150
Default Value:JAxINChallanInfo
The global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The global descriptive flexfield context display value for the payment. -
BankName: string
Title:
Bank Name
Maximum Length:150
-
BSRCode: string
Title:
BSR Code
Maximum Length:150
-
ChallanSerialNumber: string
Title:
Challan Serial Number
Maximum Length:150
-
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
-
DateOfDeposit: string
(date)
Title:
Date of Deposit
-
links: array
Links
Title:
Links
The 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 Information
Maximum Length:150
Default Value:JAxTHPayments
The global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The 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 Number
Maximum Length:150
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PaymentCondition: string
Title:
Payment Condition
Maximum Length:150
-
PaymentCondition_Display: string
Title:
Payment 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 Information
Maximum Length:150
Default Value:JE_IL_PAYMENT_CHECKS
The global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The global descriptive flexfield context display value for the payment. -
_Withholding__Amount__Paid__by__Ban: number
Title:
Withholding Amount Paid by Bank
-
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
-
links: array
Links
Title:
Links
The 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 Information
Maximum Length:150
Default Value:JLxMXPaymentChecks
The global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The 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 ID
Maximum Length:150
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
paymentMethod: string
Title:
Payment Method
Maximum Length:150
-
paymentMethod_Display: string
Title:
Payment Method
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
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
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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_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 create a global descriptive flexfield for a payment by submitting a POST request on the REST resource using cURL.
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/payablesPayments/300100155922487/child/paymentGdf
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "__FLEX_Context": "JAxINChallanInfo", "DateOfDeposit": "2019-02-01", "ChallanSerialNumber": "1", "BankName": "IDFC First Bank", "BSRCode": "1234" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "__FLEX_Context": "JAxINChallanInfo", "DateOfDeposit": "2019-02-01", "ChallanSerialNumber": "1", "BankName": "IDFC First Bank", "BSRCode": "1234", ... "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100155922487/child/paymentGdf/300100155922487", "name": "paymentGdf", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100155922487/child/paymentGdf/300100155922487", "name": "paymentGdf", "kind": "item" }, ... ] }