Get descriptive flexfields for an invoice line
/fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceLineDff/{invoiceLineDffUniqID}
Request
-
invoiceLineDffUniqID(required): string
This is the hash key of the attributes which make up the composite key--- InvoiceId and LineNumber ---for the Invoice Lines Descriptive Flexfields resource and used to uniquely identify an instance of Invoice Lines Descriptive Flexfields. The client should not generate the hash key value. Instead, the client should query on the Invoice Lines Descriptive Flexfields collection resource with a filter on the primary key values in order to navigate to a specific instance of Invoice Lines Descriptive Flexfields.
For example: invoiceLineDff?q=InvoiceId=<value1>;LineNumber=<value2> -
invoiceLinesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Invoice Lines resource and used to uniquely identify an instance of Invoice Lines. The client should not generate the hash key value. Instead, the client should query on the Invoice Lines collection resource in order to navigate to a specific instance of Invoice Lines 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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
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
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:150
The descriptive flexfield context name for the invoice line. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
The descriptive flexfield context display value for the invoice line. -
InvoiceId: integer
(int64)
The unique identifier for the invoice to which the line descriptive flexfield is associated.
-
LineNumber: integer
(int64)
Title:
Line Number
The number used to identify an invoice line to which the 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.
- LVVO_V___FLEX_Context
-
Parameters:
- finder:
ValidValuesFinder%3BBind_ApplicationId%3D200%2CBind_DescriptiveFlexfieldCode%3DAP_INVOICE_LINES
The following properties are defined on the LOV link relation:- Source Attribute: __FLEX_Context_DisplayValue; Target Attribute: Name
- Display Attribute: Name, Description
- finder:
- LVVO___FLEX_Context
-
Parameters:
- finder:
ValidValuesFinder%3BBind_ApplicationId%3D200%2CBind_DescriptiveFlexfieldCode%3DAP_INVOICE_LINES
The following properties are defined on the LOV link relation:- Source Attribute: __FLEX_Context; Target Attribute: ContextCode
- Display Attribute: Name
- finder:
Examples
- Get all the invoice lines for an invoice.
- Use the self URI of the invoice line for which you want to retrieve the descriptive flexfield.
- Get all the descriptive flexfileds for the invoice line.
- Use the self URI of the descriptive flexfield you want to retrieve.
Here's the cURL command to retrieve all the invoice lines of an invoice:
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100171730224/child/invoiceLines
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"items": [
{
"LineNumber": 1,
"LineAmount": 2500,
"AccountingDate": "2018-11-01",
"UOM": "Each",
...
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100171730224/child/invoiceLines/00020000000EACED00057708000110F084220D300000000AACED0005770400000001",
"name": "invoiceLines",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100171730224/child/invoiceLines/00020000000EACED00057708000110F084220D300000000AACED0005770400000001/child/invoiceLineDff",
"name": "invoiceLineDff",
"kind": "collection"
},
...
]
},
...
],
"count": 3,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100171730224/child/invoiceLines",
"name": "invoiceLines",
"kind": "collection"
}
]
}
A
hash key of InvoiceId
and LineNumber
identifies an invoice
line.
Here's the cURL command that uses the hash key in the self URI to retrieve the invoice line:
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100171730224/child/invoiceLines/00020000000EACED00057708000110F084220D300000000AACED0005770400000001
Here's the cURL command that uses the child URI of the invoice line to retrieve all the descriptive flexfields:
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100171730224/child/invoiceLines/00020000000EACED00057708000110F084220D300000000AACED0005770400000001/child/invoiceLineDff
A
hash key of InvoiceId
and LineNumber
identifies a descriptive
flexfield.
Here's the cURL command that uses the hash key in the self URI to retrieve the descriptive flexfield:
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100171730224/child/invoiceLines/00020000000EACED00057708000110F084220D300000000AACED0005770400000001/child/invoiceLineDff/00020000000EACED00057708000110F084220D300000000AACED0005770400000001
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "InvoiceId": 300100171730224, "LineNumber": 1, "rkTb": null, "additionalLineInfo": null, "__FLEX_Context": null, "__FLEX_Context_DisplayValue": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100171730224/child/invoiceLines/00020000000EACED00057708000110F084220D300000000AACED0005770400000001/child/invoiceLineDff/00020000000EACED00057708000110F084220D300000000AACED0005770400000001", "name": "invoiceLineDff", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100171730224/child/invoiceLines/00020000000EACED00057708000110F084220D300000000AACED0005770400000001/child/invoiceLineDff/00020000000EACED00057708000110F084220D300000000AACED0005770400000001", "name": "invoiceLineDff", "kind": "item" }, ... ] }