Show Source

• [0]: object ApiEntityContractLineItem

{
    "title":"List<ApiEntityContractLineItem>",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApiEntityContractLineItem"
    }
}

Show Source

• 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.

{
    "type":"object",
    "required":[
        "itemCode",
        "lineItemType",
        "name"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"The name of the line item."
        },
        "description":{
            "type":"string",
            "description":"A brief explanation of the line item."
        },
        "itemCode":{
            "type":"string",
            "description":"The unique identifier for the line item."
        },
        "itemSuffix":{
            "type":"integer",
            "format":"int64",
            "description":"The suffix of a contract code."
        },
        "contractId":{
            "type":"integer",
            "format":"int64",
            "description":"The contract associated with the line item."
        },
        "changeOrderId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a GC."
        },
        "currencyId":{
            "type":"integer",
            "format":"int64",
            "description":"The currency in which the contract line item is written."
        },
        "quantity":{
            "description":"The number of units represented by the line item.",
            "readOnly":true,
            "$ref":"#/definitions/Quantity"
        },
        "contractLineItemCost":{
            "description":"The cost of a contract line item.",
            "$ref":"#/definitions/ApiEntityContractLineItemCost"
        },
        "cbssheetCodeId":{
            "type":"integer",
            "format":"int64",
            "description":"The cost breakdown structure associated with the line item."
        },
        "contractLineItemCost1":{
            "description":"The cost of a contract line item.",
            "$ref":"#/definitions/ApiEntityContractLineItemCost"
        },
        "getcBSSheetCodeId":{
            "type":"integer",
            "format":"int64",
            "description":"The cost breakdown structure associated with the line item."
        },
        "fixedExchangeRate":{
            "type":"number",
            "description":"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.",
            "readOnly":true
        },
        "costCategoryId":{
            "type":"integer",
            "format":"int64",
            "description":"The type of cost represented by the line item."
        },
        "unitsOfMeasureId":{
            "type":"integer",
            "format":"int64",
            "description":"The unit by which the line item quantity is measured."
        },
        "contractCode":{
            "type":"string"
        },
        "lineItemId":{
            "type":"integer",
            "format":"int64",
            "description":"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":{
            "type":"string",
            "description":"The nature of the line item.",
            "enum":[
                "LUMP_SUM",
                "UNIT_PRICE"
            ]
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"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.",
            "readOnly":true
        }
    }
}

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "total":{
            "description":"The total value of the line item cost.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "unitPriceProject":{
            "description":"The unit price of a project.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "unitPriceLineItem":{
            "description":"The unit price of a line item.",
            "$ref":"#/definitions/Cost"
        },
        "unitPriceContract":{
            "description":"The unit price of a contract.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "contractLineItemId":{
            "type":"integer",
            "format":"int64",
            "description":"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.",
            "readOnly":true
        },
        "unitPrice":{
            "description":"The price per unit of items represented by the line item.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "totalProject":{
            "description":"The total cost of a project.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "totalLineItem":{
            "description":"The total cost of a line item.",
            "$ref":"#/definitions/Cost"
        },
        "totalContract":{
            "description":"The total cost of a contract.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"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.",
            "readOnly":true
        }
    }
}