Get all global descriptive flexfields for a payment
get
/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.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds the global descriptive flexfields for the payment.
Finder Variables:- CheckId; integer; The unique identifier maintained for every payment made.
- PrimaryKey: Finds the global descriptive flexfields for the payment.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2 -
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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 : payablesPayments-paymentGdf
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Items
Type:
array
Title:
Items
The items in the collection.
Show Source
-
Array of:
object Discriminator: __FLEX_Context
Discriminator:
{ "propertyName":"__FLEX_Context", "mapping":{ "FVxUSAPCHECKS":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfFVxUSAPCHECKSVO-item-response", "JA_CN_REMIT_BILL_NUM":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJA__5FCN__5FREMIT__5FBILL__5FNUMVO-item-response", "JAxINChallanInfo":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxINChallanInfoVO-item-response", "JAxTHPayments":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxTHPaymentsVO-item-response", "JE_IL_PAYMENT_CHECKS":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJE__5FIL__5FPAYMENT__5FCHECKSVO-item-response", "JLxMXPaymentChecks":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJLxMXPaymentChecksVO-item-response" } }
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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
Examples
The following example shows how to retrieve all the global descriptive flexfields for a payment by submitting a GET request on the REST resource using cURL.
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/payablesPayments/300100174976407/child/paymentGdf
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "CheckId": 300100174976407, "__FLEX_Context": "JAxINChallanInfo", "__FLEX_Context_DisplayValue": "Payments for India", "DateOfDeposit": "2019-02-01", ... "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100174976407/child/paymentGdf/300100174976407", "name": "paymentGdf", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100174976407/child/paymentGdf/300100174976407", "name": "paymentGdf", "kind": "item" }, ... ] }, ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100174976407/child/paymentGdf", "name": "paymentGdf", "kind": "collection" } ] }