Get Pricing Lookup Types

get

/rest/v16/pricingSetup/pricingLookups

Us this endpoint to retrieve all pricing lookup types.

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). More than one child can be specified using comma as a separator. Example: ?expand=lookupValues. To include all the children and grandchildren, specify the value of this query parameter to be "all".
  • This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, all attributes are returned.
  • Used as a predefined finder to search the collection.
    Format: ?finder=<finderName>;<VarName>=<variableValue>
    The following are the available finder names and corresponding finder variables:
    • findByKeyword: Find pricing lookup types using lookup type and display name.
      Finder Variable:
      • keyword;string: The search text.
    • findLookupItems: Find active or inactive pricing lookup types using the active field.
      Finder Variable:
      • isActive;string: The active field of the lookup type when true will return only active lookup types and false will return only inactive lookup types.
  • 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.
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified attributes. 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.
  • Filter (a 'where' clause) to restrict the items returned in the collection. By default, no filtering is applied.
  • The resource collection representation will include the total row count when "?totalResults=true", otherwise the count is not included. The default value is "false".
Back to Top

Response

Supported Media Types

200 Response

Success
Body ()
Root Schema : PricingResourceCollection_PricingLookupType
Type: object
Show Source
  • Title: Count
    Read Only: true
    The number of resource instances returned in the current range.
  • Created By
    Title: Created By
    Read Only: true
    The details of the user who created the record.
  • Title: HasMore
    Read Only: true
    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
  • Last Modified By
    Title: Last Modified By
    Read Only: true
    The details of the user who modified the record.
  • Title: Limit
    Read Only: true
    The actual paging size used by the server.
  • Links
  • Title: OffSet
    Read Only: true
    The offset value used in the current page.
  • Title: Total Results
    Read Only: true
    Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : Created By
Title: Created By
Read Only: true
The details of the user who created the record.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Last Modified By
Title: Last Modified By
Read Only: true
The details of the user who modified the record.
Match All
Show Source
Nested Schema : UserDetails
Type: object
Show Source
Nested Schema : PricingLookupType
Type: object
Show Source
Nested Schema : Created By
Title: Created By
Read Only: true
The details of the user who created the record.
Match All
Show Source
Nested Schema : Last Modified By
Title: Last Modified By
Read Only: true
The details of the user who modified the record.
Match All
Show Source
Nested Schema : Pricing Lookup Values
Title: Pricing Lookup Values
Read Only: true
The collection of pricing lookup values for the Pricing Lookup Type. Note this is a child resource.
Match All
Show Source
Nested Schema : PricingResourceCollection_PricingLookupValue
Type: object
Show Source
  • Title: Count
    Read Only: true
    The number of resource instances returned in the current range.
  • Created By
    Title: Created By
    Read Only: true
    The details of the user who created the record.
  • Title: HasMore
    Read Only: true
    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
  • Last Modified By
    Title: Last Modified By
    Read Only: true
    The details of the user who modified the record.
  • Title: Limit
    Read Only: true
    The actual paging size used by the server.
  • Links
  • Title: OffSet
    Read Only: true
    The offset value used in the current page.
  • Title: Total Results
    Read Only: true
    Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : Created By
Title: Created By
Read Only: true
The details of the user who created the record.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Last Modified By
Title: Last Modified By
Read Only: true
The details of the user who modified the record.
Match All
Show Source
Nested Schema : PricingLookupValue
Type: object
Show Source
Nested Schema : Created By
Title: Created By
Read Only: true
The details of the user who created the record.
Match All
Show Source
Nested Schema : Last Modified By
Title: Last Modified By
Read Only: true
The details of the user who modified the record.
Match All
Show Source
Back to Top

Examples

The following example shows how to retrieve all pricing lookup types by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
http://sitename.oracle.com/rest/v16/pricingSetup/pricingLookups

Response Body

{
  "items": [{
      "dateModified": "2023-01-18T17:50:22Z",
      "dateAdded": "2023-01-18T17:50:22Z",
      "lookupType": "chargeTypes",
      "displayLabel": "Charge Types",
      "description": "Identifies the value that will be received by the customer for a charge price. For example, the sale of a network device may have both a one time purchase price (with charge type of 'Purchase Price') and a one time installation price (with charge type of 'Installation Fee'.",
      "type": "Standard Lookup",
      "active": true,
      "links": [{
          "rel": "self",
          "href": "http://sitename.oracle.com/rest/v16/pricingSetup/pricingLookups/chargeTypes"
        }, {
          "rel": "parent",
          "href": "http://sitename.oracle.com/rest/v16/pricingSetup/pricingLookups"
        }, {
          "rel": "child",
          "href": "http://sitename.oracle.com/rest/v16/pricingSetup/pricingLookups/chargeTypes/lookupValues"
        }
      ]
    }, {
      "dateModified": "2023-01-18T17:50:23Z",
      "dateAdded": "2023-01-18T17:50:23Z",
      "lookupType": "priceTypes",
      "displayLabel": "Price Types",
      "description": "Indicates the basis on which the pricing will be levied, whether one time, on a periodic basis or on usage. When pricing is rolled up for a model or system the pricing may contain a mixture of price types and is indicated by the value 'mixed'.",
      "type": "Standard Lookup",
      "active": true,
      "links": [{
          "rel": "self",
          "href": "http://sitename.oracle.com/rest/v16/pricingSetup/pricingLookups/priceTypes"
        }, {
          "rel": "parent",
          "href": "http://sitename.oracle.com/rest/v16/pricingSetup/pricingLookups"
        }, {
          "rel": "child",
          "href": "http://sitename.oracle.com/rest/v16/pricingSetup/pricingLookups/priceTypes/lookupValues"
        }
      ]
    }, {
      "dateModified": "2023-01-18T17:50:23Z",
      "dateAdded": "2023-01-18T17:50:23Z",
      "lookupType": "pricePeriods",
      "displayLabel": "Price Periods",
      "description": "The time frequency, periodicity or recurrence with which the price is levied or charged. For example, usage prices may be charged to the customer monthly or weekly.",
      "type": "Standard Lookup",
      "active": true,
      "links": [{
          "rel": "self",
          "href": "http://sitename.oracle.com/rest/v16/pricingSetup/pricingLookups/pricePeriods"
        }, {
          "rel": "parent",
          "href": "http://sitename.oracle.com/rest/v16/pricingSetup/pricingLookups"
        }, {
          "rel": "child",
          "href": "http://sitename.oracle.com/rest/v16/pricingSetup/pricingLookups/pricePeriods/lookupValues"
        }
      ]
    }, {
      "dateModified": "2023-01-18T17:50:23Z",
      "dateAdded": "2023-01-18T17:50:23Z",
      "lookupType": "priceUOMs",
      "displayLabel": "Price Units of Measure",
      "description": "A standardized quantity in which products and services may be quoted and sold.",
      "type": "Standard Lookup",
      "active": true,
      "links": [{
          "rel": "self",
          "href": "http://sitename.oracle.com/rest/v16/pricingSetup/pricingLookups/priceUOMs"
        }, {
          "rel": "parent",
          "href": "http://sitename.oracle.com/rest/v16/pricingSetup/pricingLookups"
        }, {
          "rel": "child",
          "href": "http://sitename.oracle.com/rest/v16/pricingSetup/pricingLookups/priceUOMs/lookupValues"
        }
      ]
    }
  ],
  "offset": 0,
  "limit": 1000,
  "count": 4,
  "hasMore": false,
  "links": [{
      "rel": "canonical",
      "href": "http://sitename.oracle.com/rest/v16/pricingSetup/pricingLookups"
    }, {
      "rel": "self",
      "href": "http://sitename.oracle.com/rest/v16/pricingSetup/pricingLookups?offset=0&limit=1000"
    }
  ]
}

URI Endpoint Sample with Query Parameters

Retrieve active lookup values of a single lookup.

curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/pricingSetup/pricingLookups/priceTypes/lookupValues?onlyData=true&finder=findLookupItems;isActive=true

Response Body with Query Parameters

{
  "items": [{
      "dateModified": "2023-02-08T23:26:57Z",
      "dateAdded": "2023-02-08T23:26:57Z",
      "lookupType": "priceTypes",
      "lookupCode": "oneTime",
      "displayLabel": "One Time",
      "description": "",
      "active": "active",
      "type": "Standard Value",
      "orderNumber": 1
    }, {
      "dateModified": "2023-02-08T23:26:57Z",
      "dateAdded": "2023-02-08T23:26:57Z",
      "lookupType": "priceTypes",
      "lookupCode": "recurring",
      "displayLabel": "Recurring",
      "description": "",
      "active": "active",
      "type": "Standard Value",
      "orderNumber": 2
    }, {
      "dateModified": "2023-02-08T23:26:58Z",
      "dateAdded": "2023-02-08T23:26:58Z",
      "lookupType": "priceTypes",
      "lookupCode": "usage",
      "displayLabel": "Usage",
      "description": "",
      "active": "active",
      "type": "Standard Value",
      "orderNumber": 3
    }
  ],
  "offset": 0,
  "limit": 1000,
  "count": 3,
  "hasMore": false
}
Back to Top