• [0]: object ApiEntityChangeOrder

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

• approveByUserName(optional): string
  Read Only: true

  The name of the user that approved the change order.
• associatedAgreementCode(optional): string
  The code of the aggrement associated with the change order.
• associatedAgreementLinkId: integer(int64)
  The contract associated with the change order.
• cancelByUser(optional): string
  Read Only: true

  The name of the user that canceled the change order.
• changeEstimateCode(optional): string
  The user-specified identifier of a change estimate.
• changeEstimateId(optional): integer(int64)
  The change estimate of the change order.
• changeEventCode(optional): string
  The user-specified identifier of a change event.
• changeEventId(optional): integer(int64)
  Read Only: true

  The change event of the change order.
• changeOrderConfiguredFields(optional): object ApiEntityChangeOrderConfiguredFields
• changeOrderCost(optional): object ApiEntityChangeOrderCost
• changeOrderId(optional): integer(int64)
  The system-generated identifier of the change order. This value should not be provided in create operation request data, however, it is required for update requests.
• closeByUserName(optional): string
  Read Only: true

  The name of the user that closed the change order.
• collectedToChangeOrderCode(optional): string
  The user-specified identifier of a change order
• collectedToChangeOrderId(optional): integer(int64)
  Read Only: true

  The name and ID of the change order into which the commitment change order was collected.
• currencyCode(optional): string
  Read Only: true

  The user-specified identifier of a currency.
• currencyId(optional): integer(int64)
  Read Only: true

  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.
• fromCompanyId(optional): integer(int64)
  Read Only: true

  The company that awarded the change order.
• fromCompanyName(optional): string
  Read Only: true

  The name of the company the change order is sent by.
• fromCompanySourceId(optional): string
  The unique identifier of company data in an external source.
• fromContactId(optional): integer(int64)
  The person in the Awarded From company who is officially responsible for communications about the associated agreement.
• fromContactUserName(optional): string
  The name of the user associated with the change order's from company.
• itemCode: string
  The unique identifier for the change order.
• itemPrefix(optional): string
  The prefix of a change order code.
• itemSuffix(optional): integer(int64)
  The suffix of a change order code.
• link(optional): string(url)
  Read Only: true
• name: string
  The change event of the change order.
• periodAppliedDate(optional): string(date-time)
  Read Only: true

  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.
• projectId: integer(int64)
  The project that corresponds to the change order.
• projectSourceId(optional): string
  The unique identifier of project data in an external source.
• rejectByUserName(optional): string
  Read Only: true

  The name of the user that rejected the change order.
• reopenByUserName(optional): string
  Read Only: true

  The name of the user that reopened the change order.
• sourceId(optional): string
  Change order data from an external source.
• status(optional): string
  Read Only: true

  Allowed Values: [ "DRAFT", "PENDING", "APPROVED", "REJECTED", "CLOSED" ]

  The status of the change order.
• statusTransitionData(optional): object ApiEntityCmStatusTransitionData
• submitByUserName(optional): string
  Read Only: true

  The name of the user that submitted the change order.
• timeChange(optional): integer(int32)
  The amount of time added to or subtracted from the commitment as a result of the change order.
• toCompanyId(optional): integer(int64)
  Read Only: true

  The company to which the change order was awarded.
• toCompanyName(optional): string
  Read Only: true

  The name of the company the change order is addressed to.
• toCompanySourceId(optional): string
  The unique identifier of company data in an external source.
• toContactId(optional): integer(int64)
  The person in the Awarded To company who is officially responsible for communications about the change order.
• toContactUserName(optional): string
  The name of the user associated with the change order's to company.
• type(optional): string
  Allowed Values: [ "CONTRACT", "COMMITMENT" ]

  Specifies the nature of the link.
• 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.
• voidByUser(optional): string
  Read Only: true

  The name of the user that voided the change order.
• withdrawApprovalByUserName(optional): string
  Read Only: true

  The name of the user that withdrew approval of the change order.
• workspaceCode(optional): string
  The user-specified identifier of a workspace.

{
    "type":"object",
    "required":[
        "associatedAgreementLinkId",
        "itemCode",
        "name",
        "projectId"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace."
        },
        "projectCode":{
            "type":"string",
            "description":"The user-specified identifier of a project."
        },
        "currencyCode":{
            "type":"string",
            "description":"The user-specified identifier of a currency.",
            "readOnly":true
        },
        "reopenByUserName":{
            "type":"string",
            "description":"The name of the user that reopened the change order.",
            "readOnly":true
        },
        "fromCompanySourceId":{
            "type":"string",
            "description":"The unique identifier of company data in an external source."
        },
        "collectedToChangeOrderCode":{
            "type":"string",
            "description":"The user-specified identifier of a change order"
        },
        "changeEstimateCode":{
            "type":"string",
            "description":"The user-specified identifier of a change estimate."
        },
        "fromContactUserName":{
            "type":"string",
            "description":"The name of the user associated with the change order's from company."
        },
        "toContactUserName":{
            "type":"string",
            "description":"The name of the user associated with the change order's to company."
        },
        "projectSourceId":{
            "type":"string",
            "description":"The unique identifier of project data in an external source."
        },
        "toCompanySourceId":{
            "type":"string",
            "description":"The unique identifier of company data in an external source."
        },
        "fromCompanyName":{
            "type":"string",
            "description":"The name of the company the change order is sent by.",
            "readOnly":true
        },
        "closeByUserName":{
            "type":"string",
            "description":"The name of the user that closed the change order.",
            "readOnly":true
        },
        "changeEventCode":{
            "type":"string",
            "description":"The user-specified identifier of a change event."
        },
        "rejectByUserName":{
            "type":"string",
            "description":"The name of the user that rejected the change order.",
            "readOnly":true
        },
        "approveByUserName":{
            "type":"string",
            "description":"The name of the user that approved the change order.",
            "readOnly":true
        },
        "submitByUserName":{
            "type":"string",
            "description":"The name of the user that submitted the change order.",
            "readOnly":true
        },
        "withdrawApprovalByUserName":{
            "type":"string",
            "description":"The name of the user that withdrew approval of the change order.",
            "readOnly":true
        },
        "associatedAgreementCode":{
            "type":"string",
            "description":"The code of the aggrement associated with the change order."
        },
        "voidByUser":{
            "type":"string",
            "description":"The name of the user that voided the change order.",
            "readOnly":true
        },
        "cancelByUser":{
            "type":"string",
            "description":"The name of the user that canceled the change order.",
            "readOnly":true
        },
        "toCompanyName":{
            "type":"string",
            "description":"The name of the company the change order is addressed to.",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"The change event of the change order."
        },
        "type":{
            "type":"string",
            "description":"Specifies the nature of the link.",
            "enum":[
                "CONTRACT",
                "COMMITMENT"
            ]
        },
        "description":{
            "type":"string",
            "description":"A brief explanation of the change order line item."
        },
        "status":{
            "type":"string",
            "description":"The status of the change order.",
            "readOnly":true,
            "enum":[
                "DRAFT",
                "PENDING",
                "APPROVED",
                "REJECTED",
                "CLOSED"
            ]
        },
        "itemCode":{
            "type":"string",
            "description":"The unique identifier for the change order."
        },
        "itemSuffix":{
            "type":"integer",
            "format":"int64",
            "description":"The suffix of a change order code."
        },
        "itemPrefix":{
            "type":"string",
            "description":"The prefix of a change order code."
        },
        "timeChange":{
            "type":"integer",
            "format":"int32",
            "description":"The amount of time added to or subtracted from the commitment as a result of the change order."
        },
        "changeOrderId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of the change order. This value should not be provided in create operation request data, however, it is required for update requests."
        },
        "changeEventId":{
            "type":"integer",
            "format":"int64",
            "description":"The change event of the change order.",
            "readOnly":true
        },
        "sourceId":{
            "type":"string",
            "description":"Change order data from an external source."
        },
        "currencyId":{
            "type":"integer",
            "format":"int64",
            "description":"The currency in which the change order line item is written.",
            "readOnly":true
        },
        "projectId":{
            "type":"integer",
            "format":"int64",
            "description":"The project that corresponds to the change order."
        },
        "collectedToChangeOrderId":{
            "type":"integer",
            "format":"int64",
            "description":"The name and ID of the change order into which the commitment change order was collected.",
            "readOnly":true
        },
        "changeOrderConfiguredFields":{
            "description":"An object containing configured fields in the form of key-value pairs.",
            "$ref":"#/definitions/ApiEntityChangeOrderConfiguredFields"
        },
        "associatedAgreementLinkId":{
            "type":"integer",
            "format":"int64",
            "description":"The contract associated with the change order."
        },
        "statusTransitionData":{
            "description":"The system-generated identifier of a status transition.",
            "readOnly":true,
            "$ref":"#/definitions/ApiEntityCmStatusTransitionData"
        },
        "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
        },
        "changeOrderCost":{
            "description":"An object containing configured fields in the form of key-value pairs.",
            "$ref":"#/definitions/ApiEntityChangeOrderCost"
        },
        "periodAppliedDate":{
            "type":"string",
            "format":"date-time",
            "description":"The billing period of the payment application to which the change order schedule of values is applied.",
            "readOnly":true
        },
        "changeEstimateId":{
            "type":"integer",
            "format":"int64",
            "description":"The change estimate of the change order."
        },
        "fromCompanyId":{
            "type":"integer",
            "format":"int64",
            "description":"The company that awarded the change order.",
            "readOnly":true
        },
        "fromContactId":{
            "type":"integer",
            "format":"int64",
            "description":"The person in the Awarded From company who is officially responsible for communications about the associated agreement."
        },
        "toContactId":{
            "type":"integer",
            "format":"int64",
            "description":"The person in the Awarded To company who is officially responsible for communications about the change order."
        },
        "toCompanyId":{
            "type":"integer",
            "format":"int64",
            "description":"The company to which the change order was awarded.",
            "readOnly":true
        },
        "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
        }
    }
}

• changeOrder(optional): object ApiEntityChangeOrder
• changeOrderId(optional): integer(int64)
  The system-generated identifier of the change order.
• costFlexMap(optional): object costFlexMap
  Additional Properties Allowed: additionalProperties

  An object containing cost fields in the form of key-value pairs.
• link(optional): string(url)
  Read Only: true
• otherFlexMap(optional): object otherFlexMap
  Additional Properties Allowed: additionalProperties

  An object containing non-cost and non-text fields in the form of key-value pairs.
• textFlexMap(optional): object textFlexMap
  Additional Properties Allowed: additionalProperties

  An object containing text fields in the form of key-value pairs.
• 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
        },
        "costFlexMap":{
            "type":"object",
            "description":"An object containing cost fields in the form of key-value pairs.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "otherFlexMap":{
            "type":"object",
            "description":"An object containing non-cost and non-text fields in the form of key-value pairs.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "textFlexMap":{
            "type":"object",
            "description":"An object containing text fields in the form of key-value pairs.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "changeOrderId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of the change order."
        },
        "changeOrder":{
            "description":"A change order object.",
            "$ref":"#/definitions/ApiEntityChangeOrder"
        },
        "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
        }
    }
}

• changeOrderId(optional): integer(int64)
  Read Only: true

  The system-generated identifier of a change order.
• changeValue(optional): object Cost
• changeValueAssociatedAgreement(optional): object Cost
• changeValueCommitment(optional): object Cost
• changeValueContract(optional): object Cost
• changeValueProject(optional): object Cost
• changeValueWorkspace1(optional): object Cost
• changeValueWorkspace2(optional): object Cost
• changeValueWorkspace3(optional): object Cost
• link(optional): string(url)
  Read Only: true
• 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
        },
        "changeOrderId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a change order.",
            "readOnly":true
        },
        "changeValueAssociatedAgreement":{
            "description":"The changed cost for activity assignements.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "changeValueContract":{
            "description":"The changed cost for a contract.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "changeValueWorkspace3":{
            "description":"The changed costs for a workspace.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "changeValueCommitment":{
            "description":"The changed cost for a commitment.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "changeValueWorkspace2":{
            "description":"The changed costs for a workspace.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "changeValueWorkspace1":{
            "description":"The changed costs for a workspace.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "changeValueProject":{
            "description":"The changed cost for projects captured in the change order.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "changeValue":{
            "description":"The difference between the original value of the cost and its current value.",
            "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
        }
    }
}

• approveByUserId(optional): integer(int64)
  The user who approved the agreement, change, or payment application.
• approveDate(optional): string(date-time)
  The date the agreement, change, or payment application was approved.
• cancelByUserId(optional): integer(int64)
  The user who cancelled the agreement, change, or payment application.
• cancelDate(optional): string(date-time)
  The date the agreement, change, or payment application was cancelled.
• closeByUserId(optional): integer(int64)
  The user who closed the agreement, change order, or payment application.
• closeDate(optional): string(date-time)
  The date the agreement, change, or payment application was closed.
• lastStatusTransitionType(optional): string
  Allowed Values: [ "SUBMIT", "APPROVE", "WITHDRAW_APPROVAL", "CLOSE", "REOPEN", "REJECT", "VOID", "WITHDRAW", "ANSWERED", "NONE" ]

  The last status of the agreement, change, or payment application.
• link(optional): string(url)
  Read Only: true
• rejectByUserId(optional): integer(int64)
  The user who rejected the agreement, change, or payment application.
• rejectDate(optional): string(date-time)
  The date when the agreement, change, or payment application was rejected.
• reopenDate(optional): string(date-time)
  The date when the agreement, change, or payment application was reopened.
• rreopenByUserId(optional): integer(int64)
  The user who reopened the agreement.
• statusTransitionId(optional): integer(int64)
  The system-generated identifier of a status transition. This value should not be provided in create operation request data, however, it is required for update requests.
• submitByUserId(optional): integer(int64)
  The user who submitted the agreement, change, or payment application for approval.
• submitDate(optional): string(date-time)
  The date the agreement, change, or payment application was submitted for approval.
• 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.
• voidByUserId(optional): integer(int64)
  The user who voided the agreement, change, or payment application.
• voidDate(optional): string(date-time)
  The date the agreement, change, or payment application was voided.
• withdrawApprovalByUserId(optional): integer(int64)
  The user who withdrew approval of the agreement, change, or payment application.
• withdrawApprovalDate(optional): string(date-time)
  The date when approval for the agreement, change, or payment application was withdrawn.
• withdrawByUserId(optional): integer(int64)
  The user who withdrew the agreement, change, or payment application.
• withdrawDate(optional): string(date-time)
  The date the agreement, change, or payment application was withdrawn.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "rejectDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date when the agreement, change, or payment application was rejected."
        },
        "approveDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date the agreement, change, or payment application was approved."
        },
        "submitDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date the agreement, change, or payment application was submitted for approval."
        },
        "withdrawDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date the agreement, change, or payment application was withdrawn."
        },
        "rreopenByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who reopened the agreement."
        },
        "withdrawByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who withdrew the agreement, change, or payment application."
        },
        "cancelByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who cancelled the agreement, change, or payment application."
        },
        "lastStatusTransitionType":{
            "type":"string",
            "description":"The last status of the agreement, change, or payment application.",
            "enum":[
                "SUBMIT",
                "APPROVE",
                "WITHDRAW_APPROVAL",
                "CLOSE",
                "REOPEN",
                "REJECT",
                "VOID",
                "WITHDRAW",
                "ANSWERED",
                "NONE"
            ]
        },
        "statusTransitionId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a status transition. This value should not be provided in create operation request data, however, it is required for update requests."
        },
        "withdrawApprovalDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date when approval for the agreement, change, or payment application was withdrawn."
        },
        "submitByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who submitted the agreement, change, or payment application for approval."
        },
        "withdrawApprovalByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who withdrew approval of the agreement, change, or payment application."
        },
        "approveByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who approved the agreement, change, or payment application."
        },
        "rejectByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who rejected the agreement, change, or payment application."
        },
        "voidByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who voided the agreement, change, or payment application."
        },
        "reopenDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date when the agreement, change, or payment application was reopened."
        },
        "closeDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date the agreement, change, or payment application was closed."
        },
        "voidDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date the agreement, change, or payment application was voided."
        },
        "cancelDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date the agreement, change, or payment application was cancelled."
        },
        "closeByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who closed the agreement, change order, or payment application."
        },
        "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
        }
    }
}

• object additionalProperties

{
    "type":"object",
    "description":"An object containing cost fields in the form of key-value pairs.",
    "additionalProperties":{
        "type":"object"
    }
}

• object additionalProperties

{
    "type":"object",
    "description":"An object containing non-cost and non-text fields in the form of key-value pairs.",
    "additionalProperties":{
        "type":"object"
    }
}

• object additionalProperties

{
    "type":"object",
    "description":"An object containing text fields in the form of key-value pairs.",
    "additionalProperties":{
        "type":"object"
    }
}