Show Source

• [0]: object ApiEntityChangeOrderSOV

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

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
  Read Only: true

  The user-specified identifier of a CBS.
• changeOrderCode(optional): string
  The user-specified identifier of a change order
• changeOrderId(optional): integer(int64)
  The system-generated identifier of a change order.
• changeOrderLineItemCode(optional): string
  The user-specified identifier of a line item.
• changeOrderLineItemId: integer(int64)
  The system-generated identifier of a line item.
• changeOrderSovCost: object ApiEntityChangeOrderSOVCost
• changeOrderType(optional): string
  Allowed Values: [ "CONTRACT", "COMMITMENT" ]

  The type of a change order.
• costCategoryId(optional): integer(int64)
  The type of expense described by the line item. Typical categories include Material, Other, Equipment, and Labor.
• costCategoryName(optional): string
  The name of a cost category.
• costSheetItemId(optional): integer(int64)
  The CBS code assigned to the schedule of values line item.
• description(optional): string
  A brief explanation of the line item.
• isSummarySOV(optional): boolean
  Indicates whether the schedule of values is a summary schedule of values.
• itemCode(optional): string
  A unique identifier for the line item.
• itemSuffix(optional): integer(int64)
  The suffix of a schedule of values code.
• link(optional): string(url)
  Read Only: true
• name: string
  The name of the line item.
• parentChangeOrderSovCode(optional): string
  The user-specified identifier of the parent object.
• parentChangeOrderSovId(optional): integer(int64)
  The system-generated identifier of a schedule of values.
• percentComplete(optional): object Percent
• periodAppliedDate(optional): string(date-time)
  The billing period of the payment application to which the change order schedule of values is applied.
• projectCode(optional): string
  The user-specified identifier of a project.
• quantity(optional): object Quantity
• sovId(optional): integer(int64)
  The system-generated identifier of a schedule of values. This value should not be provided in create operation request data, however, it is required for update requests.
• sovType: string
  Allowed Values: [ "LUMP_SUM", "UNIT_PRICE" ]

  Describes how the line item is billed, either as a Lump Sum or Unit Price.
• 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":[
        "changeOrderLineItemId",
        "changeOrderSovCost",
        "name",
        "sovType"
    ],
    "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":"A unique identifier for the line item."
        },
        "itemSuffix":{
            "type":"integer",
            "format":"int64",
            "description":"The suffix of a schedule of values code."
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace."
        },
        "changeOrderId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a change order."
        },
        "abbreviation":{
            "type":"string",
            "description":"The abbreviated name of a cost category."
        },
        "projectCode":{
            "type":"string",
            "description":"The user-specified identifier of a project."
        },
        "cbsCode":{
            "type":"string",
            "description":"The user-specified identifier of a CBS.",
            "readOnly":true
        },
        "percentComplete":{
            "description":"The schedule of values percent complete.",
            "readOnly":true,
            "$ref":"#/definitions/Percent"
        },
        "quantity":{
            "description":"The number of units represented by the line item.",
            "readOnly":true,
            "$ref":"#/definitions/Quantity"
        },
        "periodAppliedDate":{
            "type":"string",
            "format":"date-time",
            "description":"The billing period of the payment application to which the change order schedule of values is applied."
        },
        "costCategoryId":{
            "type":"integer",
            "format":"int64",
            "description":"The type of expense described by the line item. Typical categories include Material, Other, Equipment, and Labor."
        },
        "costCategoryName":{
            "type":"string",
            "description":"The name of a cost category."
        },
        "unitsOfMeasureId":{
            "type":"integer",
            "format":"int64",
            "description":"The units in which the line item is measured."
        },
        "costSheetItemId":{
            "type":"integer",
            "format":"int64",
            "description":"The CBS code assigned to the schedule of values line item."
        },
        "changeOrderLineItemId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a line item."
        },
        "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"
            ]
        },
        "changeOrderLineItemCode":{
            "type":"string",
            "description":"The user-specified identifier of a line item."
        },
        "associatedAgreementCode":{
            "type":"string",
            "description":"The user-specified identifier of an agreement."
        },
        "parentChangeOrderSovCode":{
            "type":"string",
            "description":"The user-specified identifier of the parent object."
        },
        "unitsOfMeasureCode":{
            "type":"string",
            "description":"The user-specified identifier of a project."
        },
        "parentChangeOrderSovId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a schedule of values."
        },
        "changeOrderSovCost":{
            "description":"An object containing cost fields in the form of key-value pairs.",
            "$ref":"#/definitions/ApiEntityChangeOrderSOVCost"
        },
        "sovType":{
            "type":"string",
            "description":"Describes how the line item is billed, either as a Lump Sum or Unit Price.",
            "enum":[
                "LUMP_SUM",
                "UNIT_PRICE"
            ]
        },
        "isSummarySOV":{
            "type":"boolean",
            "description":"Indicates whether the schedule of values is a summary schedule of values."
        },
        "sovId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a schedule of values. This value should not be provided in create operation request data, however, it is required for update requests."
        },
        "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

• balanceRemaining(optional): object Cost
• balanceRemainingAssociatedAgreement(optional): object Cost
• balanceRemainingCommitment(optional): object Cost
• balanceRemainingContract(optional): object Cost
• balanceRemainingLineItem(optional): object Cost
• balanceRemainingProject(optional): object Cost
• balanceRemainingWorkspace1(optional): object Cost
• balanceRemainingWorkspace2(optional): object Cost
• balanceRemainingWorkspace3(optional): object Cost
• changeOrderSovId(optional): integer(int64)
  The system-generated identifier of a schedule of values. 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
• retainage(optional): object Cost
• retainageAssociatedAgreement(optional): object Cost
• retainageCommitment(optional): object Cost
• retainageContract(optional): object Cost
• retainageLineItem(optional): object Cost
• retainageProject(optional): object Cost
• retainageWorkspace1(optional): object Cost
• retainageWorkspace2(optional): object Cost
• retainageWorkspace3(optional): object Cost
• 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 current value of the line item.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "balanceRemainingAssociatedAgreement":{
            "description":"The amount of money your expect to spend to complete work on this item.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "changeOrderSovId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a schedule of values. This value should not be provided in create operation request data, however, it is required for update requests."
        },
        "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 the commitment.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "unitPriceProject":{
            "description":"The unit price of the project.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "unitPriceLineItem":{
            "description":"The unit price of the line item.",
            "$ref":"#/definitions/Cost"
        },
        "unitPriceAssociatedAgreement":{
            "description":"The unit price of actvity assignments.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "unitPriceContract":{
            "description":"The unit price of the contract.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "totalAssociatedAgreement":{
            "description":"The total value of the activity assignments.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "balanceRemainingCommitment":{
            "description":"The amount of money your expect to spend to complete work on this item.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "balanceRemainingProject":{
            "description":"The amount of money your expect to spend to complete work on this item.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "balanceRemainingContract":{
            "description":"The amount of money your expect to spend to complete work on this item.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "retainageAssociatedAgreement":{
            "description":"A percentage of each payment to the contractor withheld until all work is completed.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "balanceRemainingWorkspace3":{
            "description":"The amount of money your expect to spend to complete work on this item.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "totalWorkspace1":{
            "description":"The total value of the workspace costs.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "balanceRemainingWorkspace2":{
            "description":"The amount of money your expect to spend to complete work on this item.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "balanceRemainingWorkspace1":{
            "description":"The amount of money your expect to spend to complete work on this item.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "retainageProject":{
            "description":"A percentage of each payment to the contractor withheld until all work is completed.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "balanceRemainingLineItem":{
            "description":"The amount of money your expect to spend to complete work on this item.",
            "$ref":"#/definitions/Cost"
        },
        "balanceRemaining":{
            "description":"The amount of money you expect to spend to complete work on this item.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "retainageWorkspace3":{
            "description":"A percentage of each payment to the contractor withheld until all work is completed.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "totalWorkspace2":{
            "description":"The total value of the workspace costs.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "retainageWorkspace2":{
            "description":"A percentage of each payment to the contractor withheld until all work is completed.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "retainageCommitment":{
            "description":"A percentage of each payment to the contractor withheld until all work is completed.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "retainageWorkspace1":{
            "description":"A percentage of each payment to the contractor withheld until all work is completed.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "retainageContract":{
            "description":"A percentage of each payment to the contractor withheld until all work is completed.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "totalCommitment":{
            "description":"The total value of the commitment costs.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "retainageLineItem":{
            "description":"A percentage of each payment to the contractor withheld until all work is completed.",
            "$ref":"#/definitions/Cost"
        },
        "totalWorkspace3":{
            "description":"The total value of the workspace costs.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "unitPrice":{
            "description":"The price of each unit of the line item.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "totalProject":{
            "description":"The total value of the project costs.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "retainage":{
            "description":"The amount of money retained by the payer for the work completed.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "totalLineItem":{
            "description":"The total value of the line item costs.",
            "$ref":"#/definitions/Cost"
        },
        "totalContract":{
            "description":"The total value of the 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
        }
    }
}

Show Source

• bigDecimal(optional): number
• double(optional): number(double)

{
    "type":"object",
    "properties":{
        "double":{
            "type":"number",
            "format":"double"
        },
        "bigDecimal":{
            "type":"number"
        }
    }
}