Show Source

• [0]: object ApiEntityCommitmentLineItem

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

Show Source

• commitmentId: integer(int64)
  The unique identifier of the commitment.
• commitmentLineItemCost(optional): object ApiEntityCommitmentLineItemCost
• costCategoryId(optional): integer(int64)
  The system-generated identifier of a cost category.
• costSheetItem(optional): integer(int64)
  The ID of the cost breakdown structure code. The CBS code is a code that is concatenated with its parent and child according to the segment definition.
• currencyId(optional): integer(int64)
  The unique identifier of a currency.
• description(optional): string
  Allowed Values: [ "Length[0-4000]" ]

  Additional details for the commitment.
• itemCode: string
  Allowed Values: [ "Length[0-60]" ]

  The user-specified identifier of a line item.
• 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 type of a line item.
• link(optional): string(url)
  Read Only: true
• name: string
  Allowed Values: [ "Length[0-255]" ]

  The name of a line item.
• pegRate(optional): number
  Read Only: true

  The peg rate of a line item.
• quantity(optional): object Quantity
• sourceId(optional): string
  The unique identifier of a commitment line item in an external source.
• unitsOfMeasureId(optional): integer(int64)
  The unique identifier for the unit of measure.
• 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":[
        "commitmentId",
        "itemCode",
        "lineItemType",
        "name"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"The name of a line item.",
            "enum":[
                "Length[0-255]"
            ]
        },
        "description":{
            "type":"string",
            "description":"Additional details for the commitment.",
            "enum":[
                "Length[0-4000]"
            ]
        },
        "itemCode":{
            "type":"string",
            "description":"The user-specified identifier of a line item.",
            "enum":[
                "Length[0-60]"
            ]
        },
        "commitmentId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the commitment."
        },
        "pegRate":{
            "type":"number",
            "description":"The peg rate of a line item.",
            "readOnly":true
        },
        "sourceId":{
            "type":"string",
            "description":"The unique identifier of a commitment line item in an external source."
        },
        "currencyId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a currency."
        },
        "costSheetItem":{
            "type":"integer",
            "format":"int64",
            "description":"The ID of the cost breakdown structure code. The CBS code is a code that is concatenated with its parent and child according to the segment definition."
        },
        "quantity":{
            "description":"The quantity of a line item.",
            "$ref":"#/definitions/Quantity"
        },
        "commitmentLineItemCost":{
            "$ref":"#/definitions/ApiEntityCommitmentLineItemCost"
        },
        "costCategoryId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a cost category."
        },
        "unitsOfMeasureId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the unit of measure."
        },
        "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 type of a 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

• lineItemId(optional): integer(int64)
• link(optional): string(url)
  Read Only: true
• total(optional): object Cost
• totalCommitment(optional): object Cost
• totalContract(optional): object Cost
• totalLineItem(optional): object Cost
• totalProject(optional): object Cost
• unitPrice(optional): object Cost
• unitPriceCommitment(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 commitment line item cost.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "unitPriceCommitment":{
            "description":"The unit price of a commitment.",
            "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"
        },
        "totalCommitment":{
            "description":"The total cost of a commitment.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "lineItemId":{
            "type":"integer",
            "format":"int64",
            "description":""
        },
        "unitPrice":{
            "description":"The price of each unit represented by the commitment 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
        }
    }
}