Get all expenditure types

get

/fscmRestApi/resources/11.13.18.05/expenditureTypesLOV

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:

    • KeywordFinder: Finds all project expenditure types with the specified search terms.
      Finder Variables:
      • SearchTerm; string; Keyword that identifies project expenditure types.
    • PrimaryKey: Finds the expenditure type with the specified expenditure type ID.
      Finder Variables:
      • ExpenditureTypeId; integer; Unique identifier of the expenditure type.
    • TypeClassAndCategoryAndDatesFinder: Allow the user to be able to find expenditure types by type class, category, or date.
      Finder Variables:
      • ExpTypeClassDate; string; Date on which the expenditure type classes are active.
      • ExpTypeClassName; string; The expenditure type class name that classifies the expenditure type in order to drive expenditure processing for the items classified by the expenditure type.
      • ExpTypeDate; string; Date on which expenditure types are active.
      • ExpenditureCategory; string; Name of the expenditure category.
    • TypeClassCodeAndCategoryIdAndDatesFinder: Allow the user to be able to find expenditure types by type class code, category id, or date.
      Finder Variables:
      • ExpTypeClassCode; string; The expenditure type class code classifies the expenditure type in order to drive expenditure processing for the items classified by the expenditure type.
      • ExpTypeClassDate; string; Date on which the expenditure type classes are active.
      • ExpTypeDate; string; Date on which expenditure types are active.
      • ExpenditureCategoryId; integer; Unique identifier of the expenditure category.
  • 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:
    • ExpenditureCategory; string; Name of the expenditure category.
    • ExpenditureCategoryId; integer; Unique identifier of the expenditure category.
    • ExpenditureTypeDescription; string; Description of the expenditure type.
    • ExpenditureTypeEndDate; string; End date of an expenditure type.
    • ExpenditureTypeId; integer; Unique identifier of the expenditure type.
    • ExpenditureTypeName; string; Name of the expenditure type.
    • ExpenditureTypeStartDate; string; Start date of an expenditure type.
    • RevenueCategory; string; A category grouping of expenditure types by type of revenue.
    • RevenueCategoryCode; string; Code of a category grouping of expenditure types by type of revenue.
    • UnitOfMeasure; string; The default value of units on costing or planning transactions.
    • UnitOfMeasureCode; string; Code of the default value of units on costing or planning transactions.
  • 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 : expenditureTypesLOV
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : expenditureTypesLOV-item-response
Type: object
Show Source
Nested Schema : LOV for Expenditure Type Classes
Type: array
Title: LOV for Expenditure Type Classes
The Expenditure Type Classes LOV resource is used to view an expenditure type class. This object includes attributes which are used to store values of an expenditure type class.
Show Source
Nested Schema : expenditureTypesLOV-ExpenditureTypeClassesLOV-item-response
Type: object
Show Source
  • Title: Expenditure Type Class ID
    Read Only: true
    Unique id identifier for expenditure type class.
  • Title: Expenditure Type ID
    Read Only: true
    Unique identifier of parent resource expenditure type.
  • Title: Expenditure Type Class Code
    Read Only: true
    Maximum Length: 3
    The expenditure type class code classifies the expenditure type in order to drive expenditure processing for the items classified by the expenditure type.
  • Title: Expenditure Type Class End Date
    Read Only: true
    End date of an expenditure type class.
  • Title: Expenditure Type Class
    Read Only: true
    Maximum Length: 80
    The expenditure type class name that classifies the expenditure type in order to drive expenditure processing for the items classified by the expenditure type.
  • Title: Expenditure Type Class Start Date
    Read Only: true
    Start date of an expenditure type class.
  • Links
Back to Top

Examples

The following example shows how to get all expenditure types by submitting a GET request on the REST resource using cURL.

curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/expenditureTypesLOV

Response Body Example

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

{
  "items" : [ {
    "ExpenditureTypeId" : 10018,
    "ExpenditureTypeName" : "Communications Equipment",
    "RevenueCategory" : "Other",
    "RevenueCategoryCode" : "Other",
    "UnitOfMeasure" : "Currency",
    "UnitOfMeasureCode" : "DOLLARS",
    "ExpenditureCategoryId" : 10003,
    "ExpenditureCategory" : "Material",
    "ExpenditureTypeStartDate" : "1987-01-01",
    "ExpenditureTypeEndDate" : null,
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername/fscmRestApi/resources/11.13.18.05/expenditureTypesLOV/10018",
      "name" : "expenditureTypesLOV",
      "kind" : "item"
    }, {
      "rel" : "canonical",
      "href" : "https://servername/fscmRestApi/resources/11.13.18.05/expenditureTypesLOV/10018",
      "name" : "expenditureTypesLOV",
      "kind" : "item"
    }, {
      "rel" : "child",
      "href" : "https://servername/fscmRestApi/resources/11.13.18.05/expenditureTypesLOV/10018/child/ExpenditureTypeClassesLOV",
      "name" : "ExpenditureTypeClassesLOV",
      "kind" : "collection"
    } ]
  }
...
  ]
}
Back to Top