View a Contract Line Item
get
/primeapi/restapi/contractLineItem/{id}
This endpoint returns contract line items that meet the following requirements:
- The object has an ID that matches the value of the {id} path parameter.
Request
Path Parameters
-
id: integer(int64)
The system-generated identifier of a line item.
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Root Schema : ApiEntityContractLineItem
Type:
Show Source
object
-
cbssheetCodeId(optional):
integer(int64)
The cost breakdown structure associated with the line item.
-
changeOrderId(optional):
integer(int64)
The system-generated identifier of a GC.
-
contractCode(optional):
string
-
contractId(optional):
integer(int64)
The contract associated with the line item.
-
contractLineItemCost(optional):
object ApiEntityContractLineItemCost
-
contractLineItemCost1(optional):
object ApiEntityContractLineItemCost
-
costCategoryId(optional):
integer(int64)
The type of cost represented by the line item.
-
currencyId(optional):
integer(int64)
The currency in which the contract line item is written.
-
description(optional):
string
A brief explanation of the line item.
-
fixedExchangeRate(optional):
number
Read Only:
true
The rate of exchange between the currency of the contract line item and the base currency, if the currencies are different. If the currencies are the same, this field is disabled. -
getcBSSheetCodeId(optional):
integer(int64)
The cost breakdown structure associated with the line item.
-
itemCode:
string
The unique identifier for the line item.
-
itemSuffix(optional):
integer(int64)
The suffix of a contract code.
-
lineItemId(optional):
integer(int64)
The unique identifier for the line item. This value should not be provided in create operation request data, however, it is required for update requests.
-
lineItemType:
string
Allowed Values:
[ "LUMP_SUM", "UNIT_PRICE" ]
The nature of the line item. -
link(optional):
string(url)
Read Only:
true
-
name:
string
The name of the line item.
-
quantity(optional):
object Quantity
-
unitsOfMeasureId(optional):
integer(int64)
The unit by which the line item quantity is measured.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityContractLineItemCost
Type:
Show Source
object
-
contractLineItemId(optional):
integer(int64)
Read Only:
true
The unique identifier for the line item cost. This value should not be provided in create operation request data, however, it is required for update requests. -
link(optional):
string(url)
Read Only:
true
-
total(optional):
object Cost
-
totalContract(optional):
object Cost
-
totalLineItem(optional):
object Cost
-
totalProject(optional):
object Cost
-
unitPrice(optional):
object Cost
-
unitPriceContract(optional):
object Cost
-
unitPriceLineItem(optional):
object Cost
-
unitPriceProject(optional):
object Cost
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : Quantity
Type:
object
Nested Schema : Cost
Type:
object
404 Response
The requested contract line item does not exist, or you do not have access to it.