Jump to

• Request
• Response
• Examples

Get all joint venture invoicing partners

get

/fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartnersLOV

Request

Query Parameters

• 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 joint venture invoicing partner that matches the specified invoicing partner primary key.
    Finder Variables
    • invoicingPartnerId; integer; The unique identifier of the joint venture invoicing partner.
  • findByDescription Finds all joint venture invoicing partners that include the specified description.
    Finder Variables
    • invoicingPartnerDescription; string; The description of the invoicing partner.
  • findByShortName Finds the joint venture invoicing partner that matches the specified invoicing partner short name.
    Finder Variables
    • invoicingPartnerShortName; string; The invoicing partner short name.
  • findByStatus Finds all joint venture invoicing partners that match the invoicing partner status.
    Finder Variables
    • invoicingPartnerStatus; string; The status of the invoicing partner.
  • invoicingPartnerFinder Finds all joint venture invoicing partners that match the specified criteria.
    Finder Variables
    • businessUnitName; string; The name of the business unit associated with the invoicing partner.
    • currencyCode; string; The currency code used when creating invoices for the partner. If the currency code isn't populated, the stakeholder's currency will be used.
    • invoicingPartnerDescription; string; The description of the invoicing partner.
    • invoicingPartnerShortName; string; The invoicing partner short name.
    • invoicingPartnerStatus; string; The status of the invoicing partner.
    • searchAllText; string; A search value to identify invoicing partners that contain the specified text in any of the string attributes.
• 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
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • businessUnitName; string; A field that identifies the display name of the business unit associated with the invoicing partner.
  • currencyCode; string; The currency code used when creating invoices for the partner. If the currency code isn't populated, the stakeholder's currency will be used.
  • invoicingPartnerDescription; string; The description of the invoicing partner.
  • invoicingPartnerId; integer; The unique identifier of the joint venture invoicing partner.
  • invoicingPartnerShortName; string; The unique invoicing partner name, which is stored as the short name.
  • invoicingPartnerStatus; string; The status of the joint venture invoicing partner.
  • jibOutputFormat; string; The format of the Joint Interest Billing report output that will default on stakeholders associated with this invoicing partner.
  • jibTemplateName; string; The name of the Joint Interest Billing report template that will default on stakeholders associated with this invoicing partner.
• 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 Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : jointVentureInvoicingPartnersLOV

Type: object

Show Source

• 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/jointVentureInvoicingPartnersLOV-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"LOV"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object jointVentureInvoicingPartnersLOV-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/jointVentureInvoicingPartnersLOV-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : jointVentureInvoicingPartnersLOV-item-response

Type: object

Show Source

• businessUnitName: string
  Title: Business Unit Name

  Read Only: true

  Maximum Length: 255

  A field that identifies the display name of the business unit associated with the invoicing partner.
• currencyCode: string
  Title: Preferred Currency

  Read Only: true

  Maximum Length: 15

  The currency code used when creating invoices for the partner. If the currency code isn't populated, the stakeholder's currency will be used.
• invoicingPartnerDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  The description of the invoicing partner.
• invoicingPartnerId: integer (int64)
  Title: Invoicing Partner ID

  Read Only: true

  The unique identifier of the joint venture invoicing partner.
• invoicingPartnerShortName: string
  Title: Invoicing Partner

  Read Only: true

  Maximum Length: 30

  The unique invoicing partner name, which is stored as the short name.
• invoicingPartnerStatus: string
  Title: Status

  Maximum Length: 80

  The status of the joint venture invoicing partner.
• jibOutputFormat: string
  Title: Joint Interest Billing Report Output Format

  Read Only: true

  The 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 Template

  Read Only: true

  Maximum Length: 100

  The name of the Joint Interest Billing report template that will default on stakeholders associated with this invoicing partner.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "businessUnitName":{
            "title":"Business Unit Name",
            "maxLength":255,
            "type":"string",
            "description":"A field that identifies the display name of the business unit associated with the invoicing partner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "jibOutputFormat":{
            "title":"Joint Interest Billing Report Output Format",
            "type":"string",
            "description":"The format of the Joint Interest Billing report output that will default on stakeholders associated with this invoicing partner.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "reportOutputFormatLookupCode"
                ]
            },
            "x-queryable":true
        },
        "invoicingPartnerStatus":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"The status of the joint venture invoicing partner.",
            "nullable":true,
            "x-queryable":true
        },
        "invoicingPartnerShortName":{
            "title":"Invoicing Partner",
            "maxLength":30,
            "type":"string",
            "description":"The unique invoicing partner name, which is stored as the short name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "invoicingPartnerId":{
            "title":"Invoicing Partner ID",
            "type":"integer",
            "description":"The unique identifier of the joint venture invoicing partner.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "invoicingPartnerDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the invoicing partner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "currencyCode":{
            "title":"Preferred Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code used when creating invoices for the partner. If the currency code isn't populated, the stakeholder's currency will be used.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "jibTemplateName":{
            "title":"Joint Interest Billing Report Template",
            "maxLength":100,
            "type":"string",
            "description":"The name of the Joint Interest Billing report template that will default on stakeholders associated with this invoicing partner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve all invoicing partners 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/jointVentureInvoicingPartnersLOV

Response Body Example

The following shows an example of the response body in JSON format.

{
  "items": [
    {
      "invoicingPartnerId": 300100184855951,
      "invoicingPartnerShortName": "GREENCORP",
      "invoicingPartnerDescription": "Green Corp JV Invoicing Partner - External",
      "businessUnitName": "Vision Operations",
      "invoicingPartnerStatus": "Active",
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartnersLOV/300100184855951",
          "name": "jointVentureInvoicingPartnersLOV",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartnersLOV/300100184855951",
          "name": "jointVentureInvoicingPartnersLOV",
          "kind": "item"
        }
      ]
    },
    {
      "invoicingPartnerId": 300100184880786,
      "invoicingPartnerShortName": "VISIONCORPORATION",
      "invoicingPartnerDescription": "Vision Corporation IP 101",
      "businessUnitName": "Vision Operations",
      "invoicingPartnerStatus": "Pending",
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartnersLOV/300100184880786",
          "name": "jointVentureInvoicingPartnersLOV",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartnersLOV/300100184880786",
          "name": "jointVentureInvoicingPartnersLOV",
          "kind": "item"
        }
      ]
    },
    {
      "invoicingPartnerId": 300100184875972,
      "invoicingPartnerShortName": "SEVENCORPORATION",
      "invoicingPartnerDescription": "Seven Corporation IP",
      "businessUnitName": "Petroleum BU1",
      "invoicingPartnerStatus": "Active",
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartnersLOV/300100184875972",
          "name": "jointVentureInvoicingPartnersLOV",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartnersLOV/300100184875972",
          "name": "jointVentureInvoicingPartnersLOV",
          "kind": "item"
        }
      ]
    },
    {
      "invoicingPartnerId": 300100185751779,
      "invoicingPartnerShortName": "TALLMANUFACTURING",
      "invoicingPartnerDescription": "Tall Manufacturing IP",
      "businessUnitName": "Petroleum BU1",
      "invoicingPartnerStatus": "Active",
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartnersLOV/300100185751779",
          "name": "jointVentureInvoicingPartnersLOV",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartnersLOV/300100185751779",
          "name": "jointVentureInvoicingPartnersLOV",
          "kind": "item"
        }
      ]
    },
    {
      "invoicingPartnerId": 300100185751743,
      "invoicingPartnerShortName": "APOLLOBASIN",
      "invoicingPartnerDescription": "Apollo Basin JV Invoicing Partner - External",
      "businessUnitName": "Petroleum BU1",
      "invoicingPartnerStatus": "Active",
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartnersLOV/300100185751743",
          "name": "jointVentureInvoicingPartnersLOV",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartnersLOV/300100185751743",
          "name": "jointVentureInvoicingPartnersLOV",
          "kind": "item"
        }
      ]
    },
    {
      "invoicingPartnerId": 300100186354563,
      "invoicingPartnerShortName": "PENNYPACKSYSTEMS",
      "invoicingPartnerDescription": "PennyPack Systems JV Invoicing Partner - External",
      "businessUnitName": "Vision Operations",
      "invoicingPartnerStatus": "Active",
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartnersLOV/300100186354563",
          "name": "jointVentureInvoicingPartnersLOV",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartnersLOV/300100186354563",
          "name": "jointVentureInvoicingPartnersLOV",
          "kind": "item"
        }
      ]
    },
    {
      "invoicingPartnerId": 300100184855952,
      "invoicingPartnerShortName": "LARGEANDASSOCIATES",
      "invoicingPartnerDescription": "Large and Associates JV Invoicing Partner - External",
      "businessUnitName": "Vision Operations",
      "invoicingPartnerStatus": "Active",
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartnersLOV/300100184855952",
          "name": "jointVentureInvoicingPartnersLOV",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartnersLOV/300100184855952",
          "name": "jointVentureInvoicingPartnersLOV",
          "kind": "item"
        }
      ]
    },
    {
      "invoicingPartnerId": 300100184875973,
      "invoicingPartnerShortName": "SMALLINC",
      "invoicingPartnerDescription": "Small Inc JV Invoicing Partner - External",
      "businessUnitName": "Petroleum BU1",
      "invoicingPartnerStatus": "Active",
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartnersLOV/300100184875973",
          "name": "jointVentureInvoicingPartnersLOV",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartnersLOV/300100184875973",
          "name": "jointVentureInvoicingPartnersLOV",
          "kind": "item"
        }
    }
  ],
  "count": 8,
  "hasMore": true,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartnersLOV",
      "name": "jointVentureInvoicingPartnersLOV",
      "kind": "collection"
    }
  ]
}

Back to Top