Get all global descriptive flexfields for an invoice installment
/fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceInstallments/{invoiceInstallmentsUniqID}/child/invoiceInstallmentGdf
Request
-
invoiceInstallmentsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Invoice Installments resource and used to uniquely identify an instance of Invoice Installments. The client should not generate the hash key value. Instead, the client should query on the Invoice Installments collection resource in order to navigate to a specific instance of Invoice Installments 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.
-
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 invoice installment.
Finder Variables:- InstallmentNumber; integer; The unique invoice installment number for the global descriptive flexfield.
- InvoiceId; integer; The unique invoice identifier for the global descriptive flexfield.
- PrimaryKey: Finds the global descriptive flexfields for the invoice installment.
-
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".
-
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
- application/json
Default Response
-
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.
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.
array
Items
-
Array of:
object Discriminator: __FLEX_Context
Discriminator:
{ "propertyName":"__FLEX_Context", "mapping":{ "JL_BR_APXINWKB_AP_PAY_SCHED":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJL__5FBR__5FAPXINWKB__5FAP__5FPAY__5FSCHEDVO-item-response", "JLxMXPaymentSchedules":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJLxMXPaymentSchedulesVO-item-response" } }
array
Links
object
Discriminator Values
-
JL_BR_APXINWKB_AP_PAY_SCHED -
object
oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJL__5FBR__5FAPXINWKB__5FAP__5FPAY__5FSCHEDVO-item-response
-
JLxMXPaymentSchedules -
object
oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJLxMXPaymentSchedulesVO-item-response
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:JL_BR_APXINWKB_AP_PAY_SCHED
The global descriptive flexfield context name for the invoice installment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The global descriptive flexfield context display value for the invoice installment. -
_Anticipated__Withholding__Amount: number
Title:
Withholding Amount
-
_Interest__Formula: string
Title:
Interest Formula
Maximum Length:150
-
_Interest__Formula_Display: string
Title:
Interest Formula
-
_Interest__Grace__Days: number
Title:
Interest Grace Days
-
_Interest__Penalty__Rate___2F__Amount: number
Title:
Interest Penalty Rate or Amount
-
_Interest__Penalty__Type: string
Title:
Interest Penalty Type
Maximum Length:150
-
_Interest__Penalty__Type_Display: string
Title:
Interest Penalty Type
-
_Interest__Period: number
Title:
Interest Period
-
_Interest__Rate___2F__Amount: number
Title:
Interest Rate or Amount
-
_Interest__Type: string
Title:
Interest Type
Maximum Length:150
-
_Interest__Type_Display: string
Title:
Interest Type
-
InstallmentNumber: integer
(int64)
Title:
Payment Number
The number used to identify an invoice installment to which the global descriptive flexfield is associated. -
InvoiceId: integer
(int64)
The unique identifier for the invoice to which the installment global descriptive flexfield is associated.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
originalInstallmentDueDate: string
(date)
Title:
Original Installment Due Date
-
ValidatedInstallmentGrossAmt: string
Title:
Validated Installment Gross Amount
Maximum Length:150
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:JLxMXPaymentSchedules
The global descriptive flexfield context name for the invoice installment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The global descriptive flexfield context display value for the invoice installment. -
CFDCBBInvoiceNumber: string
Title:
Digital Tax Receipt Invoice Number
Maximum Length:150
-
CFDCBBSerialNumber: string
Title:
Digital Tax Receipt Serial Number
Maximum Length:150
-
CFDIUniqueIdentifier: string
Title:
Digital Tax Receipt using Internet Unique ID
Maximum Length:150
-
InstallmentNumber: integer
(int64)
Title:
Payment Number
The number used to identify an invoice installment to which the global descriptive flexfield is associated. -
InvoiceId: integer
(int64)
The unique identifier for the invoice to which the installment global descriptive flexfield is associated.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
array
Links
Examples
The following example shows how to retrieve all the global descriptive flexfields for an invoice installment.
Get all the invoice installments of an invoice and use the self URI of the specific invoice installment. Then, use the child URI of the specific invoice installment.
Here's the cURL command to retrieve all the invoice installments.
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/invoices/300100174997532/child/invoiceInstallments
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"items": [
{
"InstallmentNumber": 1,
"UnpaidAmount": 5,
"FirstDiscountAmount": null,
"FirstDiscountDate": null,
...
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100174997532/child/invoiceInstallments/00020000000EACED00057708000110F08453E81C0000000EACED000577080000000000000001",
"name": "invoiceInstallments",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100174997532/child/invoiceInstallments/00020000000EACED00057708000110F08453E81C0000000EACED000577080000000000000001",
"name": "invoiceInstallments",
"kind": "item"
},
...
]
},
...
],
"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/300100174997532/child/invoiceInstallments",
"name": "invoiceInstallments",
"kind": "collection"
}
]
}
A hash key of InvoiceId
and InstallmentNumber
identifies an invoice installment.
Here's the cURL command that uses the hash key in the self URI to retrieve the invoice installment.
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/invoices/300100174997532/child/invoiceInstallments/00020000000EACED00057708000110F08453E81C0000000EACED000577080000000000000001
Here's the cURL command that uses the child URI of the invoice installment to retrieve all the global descriptive flexfields.
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/invoices/300100174997532/child/invoiceInstallments/00020000000EACED00057708000110F08453E81C0000000EACED000577080000000000000001/child/invoiceInstallmentGdf
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "InvoiceId": 300100174997532, "InstallmentNumber": 1, "__FLEX_Context": "JL_BR_APXINWKB_AP_PAY_SCHED", "__FLEX_Context_DisplayValue": "Payment Installments for Brazil", ... "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100174997532/child/invoiceInstallments/00020000000EACED00057708000110F08453E81C0000000EACED000577080000000000000001/child/invoiceInstallmentGdf/00020000000EACED00057708000110F08453E81C0000000EACED000577080000000000000001", "name": "invoiceInstallmentGdf", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100174997532/child/invoiceInstallments/00020000000EACED00057708000110F08453E81C0000000EACED000577080000000000000001/child/invoiceInstallmentGdf/00020000000EACED00057708000110F08453E81C0000000EACED000577080000000000000001", "name": "invoiceInstallmentGdf", "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/invoices/300100174997532/child/invoiceInstallments/00020000000EACED00057708000110F08453E81C0000000EACED000577080000000000000001/child/invoiceInstallmentGdf", "name": "invoiceInstallmentGdf", "kind": "collection" } ] }