Get an expenditure type
get
/fscmRestApi/resources/11.13.18.05/expenditureTypesLOV/{ExpenditureTypeId}
Request
Path Parameters
-
ExpenditureTypeId(required): integer(int64)
Unique identifier of the expenditure type.
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:
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 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 : expenditureTypesLOV-item-response
Type:
Show Source
object
-
ExpenditureCategory: string
Title:
Expenditure Category
Read Only:true
Maximum Length:240
Name of the expenditure category. -
ExpenditureCategoryId: integer
(int64)
Title:
Expenditure Category ID
Read Only:true
Unique identifier of the expenditure category. -
ExpenditureTypeClassesLOV: array
LOV for Expenditure Type Classes
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. -
ExpenditureTypeDescription: string
Title:
Expenditure Type Description
Read Only:true
Maximum Length:2000
Description of the expenditure type. -
ExpenditureTypeEndDate: string
(date)
Title:
Expenditure Type End Date
Read Only:true
End date of an expenditure type. -
ExpenditureTypeId: integer
(int64)
Title:
Expenditure Type ID
Read Only:true
Unique identifier of the expenditure type. -
ExpenditureTypeName: string
Title:
Expenditure Type
Read Only:true
Maximum Length:240
Name of the expenditure type. -
ExpenditureTypeStartDate: string
(date)
Title:
Expenditure Type Start Date
Read Only:true
Start date of an expenditure type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RevenueCategory: string
Title:
Revenue Category
Read Only:true
Maximum Length:80
A category grouping of expenditure types by type of revenue. -
RevenueCategoryCode: string
Title:
Revenue Category Code
Read Only:true
Maximum Length:30
Code of a category grouping of expenditure types by type of revenue. -
UnitOfMeasure: string
Title:
Unit of Measure
Read Only:true
Maximum Length:80
The default value of units on costing or planning transactions. -
UnitOfMeasureCode: string
Title:
Unit of Measure Code
Read Only:true
Maximum Length:30
Code of the default value of units on costing or planning transactions.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : expenditureTypesLOV-ExpenditureTypeClassesLOV-item-response
Type:
Show Source
object
-
ExpenditureTypeClassId: integer
(int64)
Title:
Expenditure Type Class ID
Read Only:true
Unique id identifier for expenditure type class. -
ExpenditureTypeId: integer
(int64)
Title:
Expenditure Type ID
Read Only:true
Unique identifier of parent resource expenditure type. -
ExpTypeClassCode: string
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. -
ExpTypeClassEndDate: string
(date)
Title:
Expenditure Type Class End Date
Read Only:true
End date of an expenditure type class. -
ExpTypeClassName: string
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. -
ExpTypeClassStartDate: string
(date)
Title:
Expenditure Type Class Start Date
Read Only:true
Start date of an expenditure type class. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- ExpenditureTypeClassesLOV
-
Parameters:
- ExpenditureTypeId:
$request.path.ExpenditureTypeId
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. - ExpenditureTypeId:
Examples
The following example shows how to get an expenditure type 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/10003
Response Body Example
The following shows an example of the response body in JSON format.
{ "ExpenditureTypeId" : 10003, "ExpenditureTypeName" : "Computers", "RevenueCategory" : "Other", "RevenueCategoryCode" : "Other", "UnitOfMeasure" : "Hours", "UnitOfMeasureCode" : "HOURS", "ExpenditureCategoryId" : 10002, "ExpenditureCategory" : "Chargebacks", "ExpenditureTypeStartDate" : "1987-01-01", "ExpenditureTypeEndDate" : null, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/11.13.18.05/expenditureTypesLOV/10003", "name" : "expenditureTypesLOV", "kind" : "item" }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/11.13.18.05/expenditureTypesLOV/10003", "name" : "expenditureTypesLOV", "kind" : "item" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/11.13.18.05/expenditureTypesLOV/10003/child/ExpenditureTypeClassesLOV", "name" : "ExpenditureTypeClassesLOV", "kind" : "collection" } ] }