Show Source

• [0]: object ApiEntityChangeOrderLineItem

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

Show Source

• abbreviation(optional): string
  The abbreviated name of a cost category.
• associatedAgreementCode(optional): string
  The user-specified identifier of an agreement.
• cbsCode(optional): string
  The user-specified identifier of a CBS.
• cbsSourceId(optional): string
  The unique identifier of CBS data in an external source.
• changeOrderCode(optional): string
  The user-specified identifier of a change order
• changeOrderCollectedCode(optional): string
  Read Only: true

  The user-specified identifier of collected change order line items.
• changeOrderCollectedId(optional): integer(int64)
  Read Only: true

  The system-generated identifier of a change order.
• changeOrderId: integer(int64)
  The change order associated with the line item.
• changeOrderLineItemCost(optional): object ApiEntityChangeOrderLineItemCost
• changeOrderSourceId(optional): string
  The unique identifier of change order data in an external source.
• changeOrderType(optional): string
  Allowed Values: [ "CONTRACT", "COMMITMENT" ]

  The type of a change order.
• collectedFromLineItemCode(optional): string
  Read Only: true

  The user-specified identifier of a line item.
• collectedFromLineItemId(optional): integer(int64)
  The system-generated identifier of a change order line item.
• costCategoryId(optional): integer(int64)
  The type of cost represented by the line item.
• costCategoryName(optional): string
  The name of a cost category.
• costSheetItemId(optional): integer(int64)
  The cost breakdown structure associated with the line item.
• currencyCode(optional): string
  The user-specified identifier of a currency.
• currencyId(optional): integer(int64)
  The currency in which the change order line item is written.
• description(optional): string
  A brief explanation of the change order line item.
• fixedExchangeRate(optional): number
  Read Only: true

  The rate of exchange between the currency of the change order line item and the base currency, if the currencies are different. If the currencies are the same, this field is disabled.
• itemCode: string
  The unique identifier for the change order line item.
• itemSuffix(optional): integer(int64)
  The suffix of a line item code.
• lineItemId(optional): integer(int64)
  The system-generated identifier of a change order 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" ]

  Specifies how the total cost of the line item is calculated.
• link(optional): string(url)
  Read Only: true
• name: string
  The name of the change order line item.
• projectCode(optional): string
  The user-specified identifier of a project.
• quantity(optional): object Quantity
• sourceId(optional): string
  Change order data from an external source.
• unitsOfMeasureCode(optional): string
  The user-specified identifier of a project.
• unitsOfMeasureId(optional): integer(int64)
  The units in which the line item 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.
• workspaceCode(optional): string
  The user-specified identifier of a workspace.

{
    "type":"object",
    "required":[
        "changeOrderId",
        "itemCode",
        "lineItemType",
        "name"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace."
        },
        "abbreviation":{
            "type":"string",
            "description":"The abbreviated name of a cost category."
        },
        "projectCode":{
            "type":"string",
            "description":"The user-specified identifier of a project."
        },
        "currencyCode":{
            "type":"string",
            "description":"The user-specified identifier of a currency."
        },
        "changeOrderCollectedCode":{
            "type":"string",
            "description":"The user-specified identifier of collected change order line items.",
            "readOnly":true
        },
        "changeOrderSourceId":{
            "type":"string",
            "description":"The unique identifier of change order data in an external source."
        },
        "collectedFromLineItemCode":{
            "type":"string",
            "description":"The user-specified identifier of a line item.",
            "readOnly":true
        },
        "cbsCode":{
            "type":"string",
            "description":"The user-specified identifier of a CBS."
        },
        "costCategoryName":{
            "type":"string",
            "description":"The name of a cost category."
        },
        "cbsSourceId":{
            "type":"string",
            "description":"The unique identifier of CBS data in an external source."
        },
        "changeOrderCode":{
            "type":"string",
            "description":"The user-specified identifier of a change order"
        },
        "changeOrderType":{
            "type":"string",
            "description":"The type of a change order.",
            "enum":[
                "CONTRACT",
                "COMMITMENT"
            ]
        },
        "associatedAgreementCode":{
            "type":"string",
            "description":"The user-specified identifier of an agreement."
        },
        "unitsOfMeasureCode":{
            "type":"string",
            "description":"The user-specified identifier of a project."
        },
        "name":{
            "type":"string",
            "description":"The name of the change order line item."
        },
        "description":{
            "type":"string",
            "description":"A brief explanation of the change order line item."
        },
        "itemCode":{
            "type":"string",
            "description":"The unique identifier for the change order line item."
        },
        "itemSuffix":{
            "type":"integer",
            "format":"int64",
            "description":"The suffix of a line item code."
        },
        "changeOrderId":{
            "type":"integer",
            "format":"int64",
            "description":"The change order associated with the line item."
        },
        "sourceId":{
            "type":"string",
            "description":"Change order data from an external source."
        },
        "changeOrderCollectedId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a change order.",
            "readOnly":true
        },
        "collectedFromLineItemId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a change order line item."
        },
        "currencyId":{
            "type":"integer",
            "format":"int64",
            "description":"The currency in which the change order line item is written."
        },
        "quantity":{
            "description":"The number of units represented by the change order line item.",
            "$ref":"#/definitions/Quantity"
        },
        "changeOrderLineItemCost":{
            "description":"An object containing cost fields in the form of key-value pairs.",
            "$ref":"#/definitions/ApiEntityChangeOrderLineItemCost"
        },
        "fixedExchangeRate":{
            "type":"number",
            "description":"The rate of exchange between the currency of the change order 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 units in which the line item is measured."
        },
        "costSheetItemId":{
            "type":"integer",
            "format":"int64",
            "description":"The cost breakdown structure associated with the line item."
        },
        "lineItemId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a change order line item. This value should not be provided in create operation request data, however, it is required for update requests."
        },
        "lineItemType":{
            "type":"string",
            "description":"Specifies how the total cost of the line item is calculated.",
            "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)
  The system-generated identifier of a change order line item.
• link(optional): string(url)
  Read Only: true
• total(optional): object Cost
• totalAssociatedAgreement(optional): object Cost
• totalCommitment(optional): object Cost
• totalContract(optional): object Cost
• totalLineItem(optional): object Cost
• totalProject(optional): object Cost
• totalWorkspace1(optional): object Cost
• totalWorkspace2(optional): object Cost
• totalWorkspace3(optional): object Cost
• unitPrice(optional): object Cost
• unitPriceAssociatedAgreement(optional): object Cost
• unitPriceCommitment(optional): object Cost
• unitPriceContract(optional): object Cost
• unitPriceLineItem(optional): object Cost
• unitPriceProject(optional): object Cost
• unitPriceWorkspace1(optional): object Cost
• unitPriceWorkspace2(optional): object Cost
• unitPriceWorkspace3(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 change order line item cost.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "unitPriceWorkspace1":{
            "description":"The unit price of the workspace.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "unitPriceWorkspace2":{
            "description":"The unit price of the workspace.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "unitPriceWorkspace3":{
            "description":"The unit price of the workspace.",
            "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"
        },
        "unitPriceAssociatedAgreement":{
            "description":"The unit price of activity assignments.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "unitPriceContract":{
            "description":"The unit price of a contract.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "totalAssociatedAgreement":{
            "description":"The total value of activity assignment costs.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "totalWorkspace1":{
            "description":"The total value of workspace costs.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "totalWorkspace2":{
            "description":"The total value of workspace costs.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "totalCommitment":{
            "description":"The total value of commitment costs.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "totalWorkspace3":{
            "description":"The total value of workspace costs.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "lineItemId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a change order line item."
        },
        "unitPrice":{
            "description":"The price per unit per line item.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "totalProject":{
            "description":"The total value of project costs.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "totalLineItem":{
            "description":"The total value of line item costs.",
            "$ref":"#/definitions/Cost"
        },
        "totalContract":{
            "description":"The total value of contract costs.",
            "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
        }
    }
}