Create a global descriptive flexfield for an invoice distribution
/fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceDistributions/{InvoiceDistributionId}/child/invoiceDistributionGdf
Request
-
InvoiceDistributionId(required): integer(int64)
The unique identifier for the invoice distribution that is generated while creating an invoice distribution.
-
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.
-
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.
- application/json
object
Discriminator Values
- FVxUSAPInvoiceDistributions
- JExPLInvoiceDistributions
- JExRUInvoiceDistributions
- JLxCOInvoiceDistributions
-
FVxUSAPInvoiceDistributions -
object
oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsGdf_view_DistributionRestGdfFVxUSAPInvoiceDistributionsVO-item-post-request
-
JExPLInvoiceDistributions -
object
oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsGdf_view_DistributionRestGdfJExPLInvoiceDistributionsVO-item-post-request
-
JExRUInvoiceDistributions -
object
oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsGdf_view_DistributionRestGdfJExRUInvoiceDistributionsVO-item-post-request
-
JLxCOInvoiceDistributions -
object
oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsGdf_view_DistributionRestGdfJLxCOInvoiceDistributionsVO-item-post-request
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:FVxUSAPInvoiceDistributions
The global descriptive flexfield context name for the invoice distribution. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The global descriptive flexfield context display value for the invoice distribution. -
BETC: string
Title:
BETC
Maximum Length:150
-
CTAProcessSequence: number
Title:
CTA Process Sequence
-
InvoiceDistributionId: integer
(int64)
The unique identifier for the invoice distribution that is generated while creating an invoice distribution.
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:JExPLInvoiceDistributions
The global descriptive flexfield context name for the invoice distribution. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The global descriptive flexfield context display value for the invoice distribution. -
adjustedTaxPointDate: string
(date)
Title:
Adjusted Tax Point Date
-
InvoiceDistributionId: integer
(int64)
The unique identifier for the invoice distribution that is generated while creating an invoice distribution.
-
taxPointDateHistory: string
Title:
Tax Point Date History
Maximum Length:150
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:JExRUInvoiceDistributions
The global descriptive flexfield context name for the invoice distribution. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The global descriptive flexfield context display value for the invoice distribution. -
InvoiceDistributionId: integer
(int64)
The unique identifier for the invoice distribution that is generated while creating an invoice distribution.
-
TaxPointDate: string
(date)
Title:
Tax Point Date
-
taxPointDateHistory: string
Title:
Tax Point Date History
Maximum Length:150
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:JLxCOInvoiceDistributions
The global descriptive flexfield context name for the invoice distribution. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The global descriptive flexfield context display value for the invoice distribution. -
InvoiceDistributionId: integer
(int64)
The unique identifier for the invoice distribution that is generated while creating an invoice distribution.
-
taxpayerId: string
Title:
Taxpayer ID
Maximum Length:150
-
taxpayerId_Display: string
Title:
Taxpayer ID
Response
- application/json
Default Response
-
Metadata-Context(required):
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(required):
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
Discriminator Values
- FVxUSAPInvoiceDistributions
- JExPLInvoiceDistributions
- JExRUInvoiceDistributions
- JLxCOInvoiceDistributions
-
FVxUSAPInvoiceDistributions -
object
oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsGdf_view_DistributionRestGdfFVxUSAPInvoiceDistributionsVO-item-response
-
JExPLInvoiceDistributions -
object
oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsGdf_view_DistributionRestGdfJExPLInvoiceDistributionsVO-item-response
-
JExRUInvoiceDistributions -
object
oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsGdf_view_DistributionRestGdfJExRUInvoiceDistributionsVO-item-response
-
JLxCOInvoiceDistributions -
object
oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsGdf_view_DistributionRestGdfJLxCOInvoiceDistributionsVO-item-response
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:FVxUSAPInvoiceDistributions
The global descriptive flexfield context name for the invoice distribution. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The global descriptive flexfield context display value for the invoice distribution. -
BETC: string
Title:
BETC
Maximum Length:150
-
CTAProcessSequence: number
Title:
CTA Process Sequence
-
InvoiceDistributionId: integer
(int64)
The unique identifier for the invoice distribution that is generated while creating an invoice distribution.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:JExPLInvoiceDistributions
The global descriptive flexfield context name for the invoice distribution. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The global descriptive flexfield context display value for the invoice distribution. -
adjustedTaxPointDate: string
(date)
Title:
Adjusted Tax Point Date
-
InvoiceDistributionId: integer
(int64)
The unique identifier for the invoice distribution that is generated while creating an invoice distribution.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
taxPointDateHistory: string
Title:
Tax Point Date History
Maximum Length:150
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:JExRUInvoiceDistributions
The global descriptive flexfield context name for the invoice distribution. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The global descriptive flexfield context display value for the invoice distribution. -
InvoiceDistributionId: integer
(int64)
The unique identifier for the invoice distribution that is generated while creating an invoice distribution.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TaxPointDate: string
(date)
Title:
Tax Point Date
-
taxPointDateHistory: string
Title:
Tax Point Date History
Maximum Length:150
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:JLxCOInvoiceDistributions
The global descriptive flexfield context name for the invoice distribution. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The global descriptive flexfield context display value for the invoice distribution. -
InvoiceDistributionId: integer
(int64)
The unique identifier for the invoice distribution that is generated while creating an invoice distribution.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
taxpayerId: string
Title:
Taxpayer ID
Maximum Length:150
-
taxpayerId_Display: string
Title:
Taxpayer ID
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
array
Links
array
Links
- LVVO_V___FLEX_Context
-
Parameters:
- finder:
ValidValuesFinder%3Bflex_vst_bind1%3DJGxAPInvoiceDistributions%2CBind_DataSource%3Doracle.apps.flex.financials.payables.invoices.transactions.restModel.distributionsGdf.view.DistributionRestGdfJG_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%3DJGxAPInvoiceDistributions%2CBind_DataSource%3Doracle.apps.flex.financials.payables.invoices.transactions.restModel.distributionsGdf.view.DistributionRestGdfJG_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
- Get all the invoice lines for an invoice.
- Use the self URI of the specific invoice line.
- Get all the invoice distributions of the invoice line.
- Use the self URI of the specific invoice distribution.
- Submit a POST request on the REST resource using cURL.
Here's the cURL command to retrieve all the invoice lines:
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155673303/child/invoiceLines
Example Response Body
The following example shows the contents of the request body in JSON format:
{
"items": [
{
"LineNumber": 1,
"LineAmount": 100,
"AccountingDate": "2008-02-18",
"UOM": null,
...
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155673303/child/invoiceLines/00020000000EACED00057708000110F0832D0AD70000000AACED0005770400000001",
"name": "invoiceLines",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000978"
}
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155673303/child/invoiceLines/00020000000EACED00057708000110F0832D0AD70000000AACED0005770400000001/child/invoiceLineGdf",
"name": "invoiceLineGdf",
"kind": "collection"
},
...
]
},
...
],
"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/300100155673303/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/vnd.oracle.adf.resourceitem+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155673303/child/invoiceLines/00020000000EACED00057708000110F0832D0AD70000000AACED0005770400000001
Here's the cURL command that uses the child URI of the invoice line to retrieve all the invoice distributions:
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155673303/child/invoiceLines/00020000000EACED00057708000110F0832D0AD70000000AACED0005770400000001/child/invoiceDistributions
Here's the cURL command that uses the self URI to retrieve the invoice distribution:
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155673303/child/invoiceLines/00020000000EACED00057708000110F0832D0AD70000000AACED0005770400000001/child/invoiceDistributions/1865118
Here's the cURL command that uses the hash key in the self URI to create a global descriptive flexfield:
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/invoices/300100155673303/child/invoiceLines/00020000000EACED00057708000110F0832D0AD70000000AACED0005770400000001/child/invoiceDistributions/1865118/child/invoiceDistributionGdf
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "__FLEX_Context": "JExPLInvoiceDistributions", "adjustedTaxPointDate": "2019-02-19" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "InvoiceDistributionId": 1865118, "__FLEX_Context": "JExPLInvoiceDistributions", "__FLEX_Context_DisplayValue": "Invoice Distributions for Poland", "adjustedTaxPointDate": "2019-02-19", "taxPointDateHistory": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155673303/child/invoiceLines/00020000000EACED00057708000110F0832D0AD70000000AACED0005770400000001/child/invoiceDistributions/1865118/child/invoiceDistributionGdf/1865118", "name": "invoiceDistributionGdf", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155673303/child/invoiceLines/00020000000EACED00057708000110F0832D0AD70000000AACED0005770400000001/child/invoiceDistributions/1865118/child/invoiceDistributionGdf/1865118", "name": "invoiceDistributionGdf", "kind": "item" }, ... ] }