1. REST API for Oracle Procurement Cloud
  2. Tasks
  3. List of Values
  4. Purchasing Line Types List of Values

Get all line types

get

/fscmRestApi/resources/11.13.18.05/purchasingLineTypesLOV

Request

Query Parameters
  • 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).
  • 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
  • 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 purchasing line types according to their primary key.
      Finder Variables
      • LineTypeId; integer; Value that uniquely identifies the line type.
  • 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.
  • 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
  • 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 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
  • 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:
    • Description; string; Description of the purchasing line type.
    • EndDate; string; Date after which the line type is no longer valid.
    • LineType; string; Type that indicates whether the line type references an item or a service.
    • LineTypeCode; string; Abbreviation that identifies the purchasing line type.
    • LineTypeId; integer; Value that uniquely identifies whether the line type line references an item or a service.
    • ProductType; string; Product type associated with the purchasing line type.
    • ProductTypeCode; string; Abbreviation that identifies the product type associated with the line type.
    • PurchaseBasis; string; Purchase basis of the line type.
    • PurchaseBasisCode; string; Abbreviation that identifies the purchase basis type associated with the line type.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : purchasingLineTypesLOV
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : purchasingLineTypesLOV-item-response
Type: object
Show Source
  • Title: Credit Flag
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the credit line type is enabled for this document style. If false, then the credit line type isn't enabled for this document style. This attribute doesn't have a default value.
  • Title: Default Category
    Read Only: true
    Maximum Length: 2400
    Default purchasing category associated with the purchasing line type.
  • Title: Default Category Code
    Read Only: true
    Maximum Length: 820
    Abbreviation for the default purchasing category associated with the purchasing line type.
  • Title: Default Category ID
    Read Only: true
    Value that uniquely identifies the default purchasing category associated with the purchasing line type.
  • Title: Default Invoice Match Option
    Read Only: true
    Maximum Length: 80
    Default invoice match option associated with the purchasing line type.
  • Title: Default Invoice Match Option Code
    Read Only: true
    Maximum Length: 25
    Abbreviation that identifies the default invoice match option associated with the purchasing line type.
  • Title: Default Match Approval Level
    Read Only: true
    Maximum Length: 255
    Default match approval level associated with the purchasing line type.
  • Title: Default Match Approval Level Code
    Read Only: true
    Maximum Length: 255
    Abbreviation that identifies the default match approval level associated with the purchasing line type.
  • Title: Default Receipt Close Tolerance Percent
    Read Only: true
    Default receipt close tolerance percentage associated with the purchasing line type.
  • Title: Default UOM
    Read Only: true
    Maximum Length: 25
    Default unit of measure associated with the purchasing line type.
  • Title: Default UOM Code
    Read Only: true
    Maximum Length: 3
    Abbreviation that identifies that default unit of measure associated with the purchasing line type.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the purchasing line type.
  • Title: End Date
    Read Only: true
    Date after which the line type is no longer valid.
  • Title: Line Type
    Read Only: true
    Maximum Length: 30
    Type that indicates whether the line type references an item or a service.
  • Title: Line Type Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the purchasing line type.
  • Title: Line Type ID
    Read Only: true
    Value that uniquely identifies whether the line type line references an item or a service.
  • Links
  • Title: Product Type
    Read Only: true
    Maximum Length: 80
    Product type associated with the purchasing line type.
  • Title: Product Type Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the product type associated with the line type.
  • Title: Purchase Basis
    Read Only: true
    Maximum Length: 80
    Purchase basis of the line type.
  • Title: Purchase Basis Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the purchase basis type associated with the line type.
Back to Top

Examples

This example describes how to get all purchasing line types.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/purchasingLineTypesLOV"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "LineTypeId": "300100206485542",
    "LineTypeCode": "2WAYR",
    "LineType": "2WAYR",
    "Description": "2-Way match to receipt",
    "CreditFlag": false,
    "ProductTypeCode": "GOODS",
    "ProductType": "Goods",
    "PurchaseBasisCode": "GOODS",
    "PurchaseBasis": "Quantity",
    "EndDate": null,
    "DefaultMatchApprovalLevelCode": "2-Way",
    "DefaultMatchApprovalLevel": "2 Way",
    "DefaultInvoiceMatchOptionCode": "R",
    "DefaultInvoiceMatchOption": "Receipt",
    "DefaultReceiptCloseTolerancePercent": null,
    "DefaultCategoryId": "1",
    "DefaultCategoryCode": "MISC.MISC",
    "DefaultCategory": "Miscellaneous_1",
    "DefaultUOMCode": "Ea",
    "DefaultUOM": "Each",
    "@context": {
        "key": "300100206485542,Ea,1,R,PO%20INVOICE%20MATCH%20OPTION,GOODS,PURCHASE%20BASIS,GOODS,ZX_PRODUCT_TYPE",
        "links": [
            {
                "rel": "self",
                "href": "https://servername/fscmRestApi/resources/version/purchasingLineTypesLOV/300100206485542%2CEa%2C1%2CR%2CPO%2520INVOICE%2520MATCH%2520OPTION%2CGOODS%2CPURCHASE%2520BASIS%2CGOODS%2CZX_PRODUCT_TYPE",
                "name": "purchasingLineTypesLOV",
                "kind": "item"
            },
            {
                "rel": "canonical",
                "href": "https://servername/fscmRestApi/resources/version/purchasingLineTypesLOV/300100206485542%2CEa%2C1%2CR%2CPO%2520INVOICE%2520MATCH%2520OPTION%2CGOODS%2CPURCHASE%2520BASIS%2CGOODS%2CZX_PRODUCT_TYPE",
                "name": "purchasingLineTypesLOV",
                "kind": "item"
            }
        ]
    }
}
Back to Top