Get a joint venture invoicing partner
get
/fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartners/{invoicingPartnerId}
Request
Path Parameters
-
invoicingPartnerId(required): integer(int64)
The unique identifier of the joint venture invoicing partner.
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 -
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).
Header Parameters
-
Metadata-Context: string
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: string
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 : jointVentureInvoicingPartners-item-response
Type:
Show Source
object-
activeFlag: boolean
Title:
Invoicing Partner ActiveRead Only:trueIndicates whether the joint venture invoicing partner is active or not. -
businessUnitName: string
Title:
Business UnitA field that identifies the display name of the business unit associated with the invoicing partner. -
createdBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the joint venture invoicing partner. -
creationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe data and time the joint venture invoicing partner was created. -
currencyCode: string
Title:
Preferred CurrencyMaximum Length:15The currency code used when creating invoices for the partner. If the currency code isn't populated, the stakeholder's currency will be used. -
customerAccountName: string
Title:
CustomerRead Only:trueMaximum Length:240The account name of the customer. -
customerAccountNumber: string
Title:
Customer Account NumberMaximum Length:255The account number of the customer. -
customerAddress: string
Title:
Customer AddressMaximum Length:290The formatted address of the customer. -
customerEmailAddress: string
Title:
Customer EmailRead Only:trueMaximum Length:320The email address of the customer. -
customerPartyName: string
Title:
CustomerRead Only:trueMaximum Length:360The name of the customer. -
customerPhone: string
Title:
Customer PhoneRead Only:trueThe formatted phone number of the customer. -
customerSetName: string
Title:
Customer Set NameMaximum Length:255A field for identifying the customer set name in the customer information for an invoicing partner.The customer set name is associated with the customer site ID. -
customerSiteLocation: string
Title:
Customer SiteMaximum Length:255The location of the customer site. -
customerTaxNumber: string
Title:
Customer Tax Registration NumberRead Only:trueThe tax registration number of the customer. -
invoicingPartnerDescription: string
Title:
DescriptionMaximum Length:240The description of the joint venture invoicing partner. -
invoicingPartnerDFF: array
Invoicing Partner Descriptive Flexfields
Title:
Invoicing Partner Descriptive FlexfieldsThe joint venture invoicing partner descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture. -
invoicingPartnerId: integer
(int64)
Title:
Invoicing Partner IDRead Only:trueThe unique identifier of the joint venture invoicing partner. -
invoicingPartnerName: string
Title:
Invoicing PartnerRead Only:trueMaximum Length:30The name of the joint venture invoicing partner. -
invoicingPartnerShortName: string
Title:
Invoicing PartnerMaximum Length:30The unique name of the joint venture invoicing partner. -
invoicingPartnerStatus: string
Title:
StatusMaximum Length:80The status of the joint venture invoicing partner. -
jibOutputFormat: string
Title:
Joint Interest Billing Report Output FormatThe format of the Joint Interest Billing report output that will default on stakeholders associated with this invoicing partner. -
jibTemplateName: string
Title:
Joint Interest Billing Report TemplateMaximum Length:100The name of the Joint Interest Billing report template that will default on stakeholders associated with this invoicing partner. -
lastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time the joint venture invoicing partner was last updated. -
lastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the joint venture invoicing partner. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
supplierAddress: string
Title:
Supplier AddressMaximum Length:290The formatted address of the supplier. -
supplierBU: integer
Title:
Supplier BUThe business unit of the supplier site. -
supplierEmailAddress: string
Title:
Supplier EmailRead Only:trueMaximum Length:320The email address of the supplier. -
supplierName: string
Title:
SupplierMaximum Length:360The name of the supplier. -
supplierPartyName: string
Title:
SupplierRead Only:trueMaximum Length:360The name of the party corresponding to the supplier. -
supplierPhone: string
Title:
Supplier PhoneRead Only:trueThe formatted phone number of the supplier. -
supplierSiteCode: string
Title:
Supplier SiteMaximum Length:255The site code of the supplier. -
supplierTaxNumber: string
Title:
Supplier Tax Registration NumberRead Only:trueThe tax registration number of the supplier. -
warningMessage: string
Title:
Warning MessageIndicates if there are any warning messages when creating a joint venture invoicing partner.
Nested Schema : Invoicing Partner Descriptive Flexfields
Type:
arrayTitle:
Invoicing Partner Descriptive FlexfieldsThe joint venture invoicing partner descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureInvoicingPartners-invoicingPartnerDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150The descriptive flexfield context name for the joint venture invoicing partner. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentThe descriptive flexfield context display value for the joint venture invoicing partner. -
InvoicingPartnerId: integer
(int64)
The unique identifier of the joint venture invoicing partner.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Links
- invoicingPartnerDFF
-
Parameters:
- invoicingPartnerId:
$request.path.invoicingPartnerId
The joint venture invoicing partner descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture. - invoicingPartnerId:
Examples
The following example shows how to get an invoicing partner by submitting a GET request on the REST resource using cURL.
curl -u username:password -i -X GET https://servername.fa.us2.oraclecloud.com/ledgerApi/resources/11.13.18.05/jointVentureInvoicingPartners/300100186133327
Response Body Example
The following shows an example of the response body in JSON format.
{
"invoicingPartnerDescription" : "Refinery and Oil Corporation",
"invoicingPartnerId" : 300100186133327,
"invoicingPartnerName" : "GOILBASINPROM",
"invoicingPartnerShortName" : "GOILBASINPROM",
"supplierPartyName" : "Green Corp",
"customerPartyName" : Green Corporation",
"supplierBU" : null,
"supplierSiteCode" : "POZ14170",
"supplierName" : "Green Corp",
"invoicingPartnerStatus" : "Active",
"customerTaxNumber" : null,
"supplierTaxNumber" : null,
"customerAccountNumber" : "3560",
"customerSetName" : null,
"customerSiteLocation" : null,
"warningMessage" : null,
"customerAccountName" : "Green, Inc.",
"createdBy" : "username",
"creationDate" : "2020-02-12T10:33:00+00:00",
"lastUpdatedBy" : "username",
"lastUpdateDate" : "2020-02-12T10:33:00.159+00:00",
"supplierAddress" : "900 Long Ridge Road,Stamford,CT,US,06902",
"customerAddress" : "900 Long Ridge Road,Stamford,CT,US,06902",
"supplierEmailAddress" : null,
"customerEmailAddress" : null,
"supplierPhone" : null,
"customerPhone" : null,
"activeFlag" : true
}