Jump to

• Request
• Response

Create a Project Budget Change

post

/api/restapi/budgetChange

Send a request to this endpoint to create a project budget change. An application object will be created using the JSON data provided in the request body.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityBudgetChangeInput

Type: object

Title: ApiEntityBudgetChangeInput

This entity represents a BudgetChange object, a unique BudgetChange object can be identified by the following combinations of the fields.

• budgetChangeId
• budgetChangeCode,projectId
• budgetChangeCode,projectCode,workspaceCode
• budgetChangeCode,projectBudgetId

Show Source

• approveByUserId: integer (int64)
  Read Only: true

  Deprecated. As of 23.11.
  The username of the user that approved the item.
• approveByUserName: string
  Read Only: true

  Maximum Length: 255

  Deprecated. As of 23.11.
  The name of the user who approved a project budget change.
• approveDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.11.
  Date the item was approved.
• budgetChangeCode: string
  Minimum Length: 0

  Maximum Length: 60

  The unique identifier of the project budget change request.
• budgetChangeCost: budgetChangeCost
  Read Only: true

  Deprecated. As of 23.11.
  An object containing the cost fields associated with the budget change.
• budgetChangeId: integer (int64)
  The system-generated identifier of a budget change.
• budgetTransactions: array budgetTransactions
  List of all budget transactions for the project budget change.
• configuredFields: array configuredFields
  The list of configured fields for a budget change.
• description: string
  Minimum Length: 0

  Maximum Length: 4000

  Details supporting the change request.
• lastModifiedById: integer (int64)
  Read Only: true

  Deprecated. As of 23.11.
  The username of the user who last made changes to the item.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• projectBudgetId: integer (int64)
  The system-generated identifier of a project budget.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId(required): integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• rejectByUserId: integer (int64)
  Read Only: true

  Deprecated. As of 23.11.
  The username of the user that rejected the item.
• rejectByUserName: string
  Read Only: true

  Maximum Length: 255

  Deprecated. As of 23.11.
  The name of the user who rejected a project budget change.
• rejectDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.11.
  Date the item was rejected.
• status: string
  Allowed Values: [ "DRAFT", "PENDING", "REJECTED", "APPROVED" ]

  The state of the project budget change request. Pending: The change request is awaiting a decision. Approved: The change request was approved. Rejected: The change request was not approved.
• submitByUserId: integer (int64)
  Read Only: true

  Deprecated. As of 23.11.
  The username of the user that submitted the item.
• submitByUserName: string
  Read Only: true

  Maximum Length: 255

  Deprecated. As of 23.11.
  The name of the user who submitted a project budget change.
• submitDate: string (date-time)
  Deprecated. As of 23.11.
  Date the item was submitted.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.
• withdrawApprovalByUserId: integer (int64)
  Read Only: true

  Deprecated. As of 23.11.
  The username of the user that with withdrew approval of the item.
• withdrawApprovalByUserName: string
  Read Only: true

  Maximum Length: 255

  Deprecated. As of 23.11.
  The name of the user who withdrew a project budget change.
• withdrawApprovalDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.11.
  Date the item was withdrawn.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityBudgetChangeInput",
    "required":[
        "projectId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "status":{
            "type":"string",
            "description":"The state of the project budget change request. Pending: The change request is awaiting a decision. Approved: The change request was approved. Rejected: The change request was not approved.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DRAFT",
                "PENDING",
                "REJECTED",
                "APPROVED"
            ]
        },
        "description":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"Details supporting the change request.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a budget change.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityBudgetChangeConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "budgetChangeCost":{
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>An object containing the cost fields associated with the budget change.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityBudgetChangeCost"
                }
            ]
        },
        "approveDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>Date the item was approved.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "approveByUserId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The username of the user that approved the item.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "approveByUserName":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The name of the user who approved a project budget change.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "lastModifiedById":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The username of the user who last made changes to the item.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "rejectByUserId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The username of the user that rejected the item.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "rejectByUserName":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The name of the user who rejected a project budget change.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "rejectDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>Date the item was rejected.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "submitByUserId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The username of the user that submitted the item.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "submitByUserName":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The name of the user who submitted a project budget change.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "submitDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>Date the item was submitted.",
            "format":"date-time",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "withdrawApprovalByUserId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The username of the user that with withdrew approval of the item.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "withdrawApprovalByUserName":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The name of the user who withdrew a project budget change.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "withdrawApprovalDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>Date the item was withdrawn.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "projectBudgetId":{
            "type":"integer",
            "description":"The system-generated identifier of a project budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetTransactions":{
            "type":"array",
            "description":"List of all budget transactions for the project budget change.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityBudgetChangeTransactionInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "budgetChangeId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget change.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetChangeCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The unique identifier of the project budget change request.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a BudgetChange object, a unique BudgetChange object can be identified by the following combinations of the fields.<ul><li>budgetChangeId</li><li>budgetChangeCode,projectId</li><li>budgetChangeCode,projectCode,workspaceCode</li><li>budgetChangeCode,projectBudgetId</li>",
    "exampleSetFlag":false
}

Nested Schema : budgetChangeCost

Read Only: true

Deprecated. As of 23.11.
An object containing the cost fields associated with the budget change.

Match All

Show Source

• object ApiEntityBudgetChangeCost
  Title: ApiEntityBudgetChangeCost

  Read Only: true

{
    "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>An object containing the cost fields associated with the budget change.",
    "readOnly":true,
    "deprecated":true,
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityBudgetChangeCost"
        }
    ]
}

Nested Schema : budgetTransactions

Type: array

List of all budget transactions for the project budget change.

Show Source

• Array of: object ApiEntityBudgetChangeTransactionInput
  Title: ApiEntityBudgetChangeTransactionInput

  This entity represents a BudgetChangeTransaction object, a unique BudgetChangeTransaction object can be identified by the following combinations of the fields.

  • budgetTransactionId

{
    "type":"array",
    "description":"List of all budget transactions for the project budget change.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityBudgetChangeTransactionInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a budget change.

Show Source

• Array of: object ApiEntityBudgetChangeConfiguredFieldValueInput
  Title: ApiEntityBudgetChangeConfiguredFieldValueInput

  This entity represents a BudgetChangeConfiguredFieldValue object, a unique BudgetChangeConfiguredFieldValue object can be identified by the following combinations of the fields.

  • budgetChangeConfiguredFieldValueId
  • columnDefinitionId
  • columnName
  • columnLabel

{
    "type":"array",
    "description":"The list of configured fields for a budget change.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityBudgetChangeConfiguredFieldValueInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityBudgetChangeCost

Type: object

Title: ApiEntityBudgetChangeCost

Read Only: true

Show Source

• budgetChangeId: integer (int64)
  The system-generated identifier of a budget change.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• totalCost: number (double)
  The cost to be added or subtracted from the project budget. This value is based on the base currency.
• totalCostProject: number (double)
  The cost to be added or subtracted from the project budget. This value is based on the project currency.
• totalCostWorkspace1: number (double)
  The cost to be added or subtracted from the project budget. This value is based on the workspace1 currency.
• totalCostWorkspace2: number (double)
  The cost to be added or subtracted from the project budget. This value is based on the workspace2 currency.
• totalCostWorkspace3: number (double)
  The cost to be added or subtracted from the project budget. This value is based on the workspace3 currency.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.

{
    "title":"ApiEntityBudgetChangeCost",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "totalCost":{
            "type":"number",
            "description":"The cost to be added or subtracted from the project budget. This value is based on the base currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalCostWorkspace1":{
            "type":"number",
            "description":"The cost to be added or subtracted from the project budget. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalCostWorkspace2":{
            "type":"number",
            "description":"The cost to be added or subtracted from the project budget. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalCostWorkspace3":{
            "type":"number",
            "description":"The cost to be added or subtracted from the project budget. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalCostProject":{
            "type":"number",
            "description":"The cost to be added or subtracted from the project budget. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "budgetChangeId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget change.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "readOnly":true,
    "exampleSetFlag":false
}

Nested Schema : ApiEntityBudgetChangeTransactionInput

Type: object

Title: ApiEntityBudgetChangeTransactionInput

This entity represents a BudgetChangeTransaction object, a unique BudgetChangeTransaction object can be identified by the following combinations of the fields.

• budgetTransactionId

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• approveDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.11.
  The date the transaction was approved.
• budgetCbsSheetCodeId: integer (int64)
  The name of the CBS Code associated with the budget line item.
• budgetChangeId: integer (int64)
  This is an intermediary field that the system uses to calculate other values. It does not correspond to any field users can see in the user interface.
• budgetCostCategoryId: integer (int64)
  The cost category ID of the budget line item.
• budgetHours: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The number of hours needed to complete the budget details line item. Calculated as Production Rate multiplied by Quantity.
• budgetItemId: integer (int64)
  A unique identifier for the budget item (Change Budget Line).
• budgetItemName: string
  Maximum Length: 255

  The name of the budget item.
• budgetTransactionCost: budgetTransactionCost
  The cost of a budget transaction.
• budgetTransactionId: integer (int64)
  The system-generated identifier of a budget transaction.
• changeMode: string
  Read Only: true

  Allowed Values: [ "AUTO", "MANUAL", "CHANGE" ]

  Deprecated. As of 23.11.
  The detailed budget change line item.
• configuredFields: array configuredFields
  The list of configured fields for a budget change transaction.
• desiredCode: string
  Minimum Length: 0

  Maximum Length: 60

  A unique identifier for the budget item (Add Budget Line).
• itemCode: string
  Maximum Length: 60

  The unique identifier for the budget line item.
• itemCodeSuffix: integer (int64)
  Read Only: true

  Deprecated. As of 23.11.
  The suffix of a budget transaction code.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• productionRate: number (double)
  Minimum Value: 0.000010

  The number of hours per unit of measure needed to complete the budget line item.
• quantity: number (double)
  The number of each budget line item needed to complete the work.
• status: string
  Allowed Values: [ "DRAFT", "PENDING", "REJECTED", "APPROVED" ]

  The status of the transaction. Indicates whether the transaction is approved, pending, draft, or rejected.
• transactionType: string
  Read Only: true

  Allowed Values: [ "ORIGINAL", "CHANGE", "TRANSFER" ]

  Deprecated. As of 23.11.
  Specifies whether the budget row is an original, change, or transfer value.
• unitOfMeasureId: integer (int64)
  The Unit of Measure used for the budget line item detail.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.

{
    "title":"ApiEntityBudgetChangeTransactionInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "status":{
            "type":"string",
            "description":"The status of the transaction. Indicates whether the transaction is approved, pending, draft, or rejected.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DRAFT",
                "PENDING",
                "REJECTED",
                "APPROVED"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a budget change transaction.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityBudgetTransactionConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "budgetTransactionId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget transaction.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "itemCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the budget line item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "itemCodeSuffix":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The suffix of a budget transaction code.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "transactionType":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>Specifies whether the budget row is an original, change, or transfer value.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ORIGINAL",
                "CHANGE",
                "TRANSFER"
            ]
        },
        "unitOfMeasureId":{
            "type":"integer",
            "description":"The Unit of Measure used for the budget line item detail.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetItemId":{
            "type":"integer",
            "description":"A unique identifier for the budget item (Change Budget Line).",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetItemName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the budget item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "quantity":{
            "type":"number",
            "description":"The number of each budget line item needed to complete the work.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "productionRate":{
            "minimum":"0.000010",
            "type":"number",
            "description":"The number of hours per unit of measure needed to complete the budget line item.",
            "format":"double",
            "exampleSetFlag":false
        },
        "budgetHours":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The number of hours needed to complete the budget details line item. Calculated as Production Rate multiplied by Quantity.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "budgetCbsSheetCodeId":{
            "type":"integer",
            "description":"The name of the CBS Code associated with the budget line item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetCostCategoryId":{
            "type":"integer",
            "description":"The cost category ID of the budget line item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "approveDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The date the transaction was approved.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "changeMode":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The detailed budget change line item.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "AUTO",
                "MANUAL",
                "CHANGE"
            ]
        },
        "desiredCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"A unique identifier for the budget item (Add Budget Line).",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "budgetChangeId":{
            "type":"integer",
            "description":"This is an intermediary field that the system uses to calculate other values. It does not correspond to any field users can see in the user interface.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetTransactionCost":{
            "description":"The cost of a budget transaction.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityBudgetTransactionCostInput"
                }
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a BudgetChangeTransaction object, a unique BudgetChangeTransaction object can be identified by the following combinations of the fields.<ul><li>budgetTransactionId</li>",
    "exampleSetFlag":false
}

Nested Schema : budgetTransactionCost

The cost of a budget transaction.

Match All

Show Source

• object ApiEntityBudgetTransactionCostInput
  Title: ApiEntityBudgetTransactionCostInput

  This entity represents a BudgetTransactionCost object, a unique BudgetTransactionCost object can be identified by the following combinations of the fields.

  • budgetTransactionId

{
    "description":"The cost of a budget transaction.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityBudgetTransactionCostInput"
        }
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a budget change transaction.

Show Source

• Array of: object ApiEntityBudgetTransactionConfiguredFieldValueInput
  Title: ApiEntityBudgetTransactionConfiguredFieldValueInput

  This entity represents a BudgetTransactionConfiguredFieldValue object, a unique BudgetTransactionConfiguredFieldValue object can be identified by the following combinations of the fields.

  • budgetTransactionConfiguredFieldValueId
  • columnDefinitionId
  • columnName
  • columnLabel

{
    "type":"array",
    "description":"The list of configured fields for a budget change transaction.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityBudgetTransactionConfiguredFieldValueInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityBudgetTransactionCostInput

Type: object

Title: ApiEntityBudgetTransactionCostInput

This entity represents a BudgetTransactionCost object, a unique BudgetTransactionCost object can be identified by the following combinations of the fields.

• budgetTransactionId

Show Source

• amountCost: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The amount that the budget row has changed as the result of transactions. This value is based on the base currency.
• amountCostProject: number (double)
  The amount that the budget row has changed as the result of transactions. This value is based on the project currency.
• amountCostWorkspace1: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The amount that the budget row has changed as the result of transactions. This value is based on the workspace1 currency.
• amountCostWorkspace2: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The amount that the budget row has changed as the result of transactions. This value is based on the workspace2 currency.
• amountCostWorkspace3: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The amount that the budget row has changed as the result of transactions. This value is based on the workspace3 currency.
• budgetTransactionId: integer (int64)
  The system-generated identifier of a budget transaction.
• currentCost: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The current cost of the associated budget line item. This value is based on the base currency.
• currentCostProject: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The current cost of the associated budget line item. This value is based on the project currency.
• currentCostWorkspace1: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The current cost of the associated budget line item. This value is based on the workspace1 currency.
• currentCostWorkspace2: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The current cost of the associated budget line item. This value is based on the workspace2 currency.
• currentCostWorkspace3: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The current cost of the associated budget line item. This value is based on the workspace3 currency.
• laborRate: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The cost per labor hour of the budget line item detail. This value is based on the base currency.
• laborRateProject: number (double)
  The cost per labor hour of the budget line item detail. This value is based on the project currency.
• laborRateWorkspace1: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The cost per labor hour of the budget line item detail. This value is based on the workspace1 currency.
• laborRateWorkspace2: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The cost per labor hour of the budget line item detail. This value is based on the workspace2 currency.
• laborRateWorkspace3: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The cost per labor hour of the budget line item detail. This value is based on the workspace3 currency.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• unitRate: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The cost per Unit of Measure for the budget line item detail. This value is based on the base currency.
• unitRateProject: number (double)
  The cost per Unit of Measure for the budget line item detail. This value is based on the project currency.
• unitRateWorkspace1: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The cost per Unit of Measure for the budget line item detail. This value is based on the workspace1 currency.
• unitRateWorkspace2: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The cost per Unit of Measure for the budget line item detail. This value is based on the workspace2 currency.
• unitRateWorkspace3: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The cost per Unit of Measure for the budget line item detail. This value is based on the workspace3 currency.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.

{
    "title":"ApiEntityBudgetTransactionCostInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "currentCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The current cost of the associated budget line item. This value is based on the base currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "budgetTransactionId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget transaction.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "unitRate":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The cost per Unit of Measure for the budget line item detail. This value is based on the base currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "unitRateWorkspace1":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The cost per Unit of Measure for the budget line item detail. This value is based on the workspace1 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "unitRateWorkspace2":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The cost per Unit of Measure for the budget line item detail. This value is based on the workspace2 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "unitRateWorkspace3":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The cost per Unit of Measure for the budget line item detail. This value is based on the workspace3 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "unitRateProject":{
            "type":"number",
            "description":"The cost per Unit of Measure for the budget line item detail. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "laborRate":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The cost per labor hour of the budget line item detail. This value is based on the base currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "laborRateWorkspace1":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The cost per labor hour of the budget line item detail. This value is based on the workspace1 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "laborRateWorkspace2":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The cost per labor hour of the budget line item detail. This value is based on the workspace2 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "laborRateWorkspace3":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The cost per labor hour of the budget line item detail. This value is based on the workspace3 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "laborRateProject":{
            "type":"number",
            "description":"The cost per labor hour of the budget line item detail. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "currentCostWorkspace1":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The current cost of the associated budget line item. This value is based on the workspace1 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "currentCostWorkspace2":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The current cost of the associated budget line item. This value is based on the workspace2 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "currentCostWorkspace3":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The current cost of the associated budget line item. This value is based on the workspace3 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "currentCostProject":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The current cost of the associated budget line item. This value is based on the project currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "amountCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The amount that the budget row has changed as the result of transactions. This value is based on the base currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "amountCostWorkspace1":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The amount that the budget row has changed as the result of transactions. This value is based on the workspace1 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "amountCostWorkspace2":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The amount that the budget row has changed as the result of transactions. This value is based on the workspace2 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "amountCostWorkspace3":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The amount that the budget row has changed as the result of transactions. This value is based on the workspace3 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "amountCostProject":{
            "type":"number",
            "description":"The amount that the budget row has changed as the result of transactions. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a BudgetTransactionCost object, a unique BudgetTransactionCost object can be identified by the following combinations of the fields.<ul><li>budgetTransactionId</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityBudgetTransactionConfiguredFieldValueInput

Type: object

Title: ApiEntityBudgetTransactionConfiguredFieldValueInput

This entity represents a BudgetTransactionConfiguredFieldValue object, a unique BudgetTransactionConfiguredFieldValue object can be identified by the following combinations of the fields.

• budgetTransactionConfiguredFieldValueId
• columnDefinitionId
• columnName
• columnLabel

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• budgetTransactionConfiguredFieldValueId: integer (int64)
  The unique identifier for the Transaction Configured Field.
• budgetTransactionId: integer (int64)
  Read Only: true

  Deprecated. As of 23.11.
  The system-generated identifier for a transaction.
• columnDefinitionId: integer (int64)
  Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
• columnLabel: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column label.
• columnName: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column name.
• costValue: number
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
• costValueWorkspace1: number (double)
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the workspace1 currency conversion.
• costValueWorkspace2: number (double)
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the workspace2 currency conversion.
• costValueWorkspace3: number (double)
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the workspace3 currency conversion.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• exceptionMessage: string
  Read Only: true

  Maximum Length: 4000

  Deprecated. As of 23.10.
  Provides the error message for why the formula calculation resulted in an error.
• hasException: boolean
  Read Only: true

  Deprecated. As of 23.10.
  Determines if formula calculation hit an error calculating a value for this field.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• numberValue: number
  This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
• textValue: string
  Maximum Length: 4000

  This holds values for Boolean, List and Text type configured fields.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.

{
    "title":"ApiEntityBudgetTransactionConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "budgetTransactionConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the Transaction Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetTransactionId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The system-generated identifier for a transaction.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "columnName":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "numberValue":{
            "type":"number",
            "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "columnLabel":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column label.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnDefinitionId":{
            "type":"integer",
            "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "textValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "hasException":{
            "type":"boolean",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Determines if formula calculation hit an error calculating a value for this field.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "exceptionMessage":{
            "maxLength":"4000",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Provides the error message for why the formula calculation resulted in an error.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValueWorkspace1":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace1 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "costValueWorkspace2":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace2 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "costValueWorkspace3":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace3 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        }
    },
    "description":"This entity represents a BudgetTransactionConfiguredFieldValue object, a unique BudgetTransactionConfiguredFieldValue object can be identified by the following combinations of the fields.<ul><li>budgetTransactionConfiguredFieldValueId</li><li>columnDefinitionId</li><li>columnName</li><li>columnLabel</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityBudgetChangeConfiguredFieldValueInput

Type: object

Title: ApiEntityBudgetChangeConfiguredFieldValueInput

This entity represents a BudgetChangeConfiguredFieldValue object, a unique BudgetChangeConfiguredFieldValue object can be identified by the following combinations of the fields.

• budgetChangeConfiguredFieldValueId
• columnDefinitionId
• columnName
• columnLabel

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• budgetChangeConfiguredFieldValueId: integer (int64)
  The unique identifier for the Budget Change Configured Field.
• budgetChangeId: integer (int64)
• columnDefinitionId: integer (int64)
  Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
• columnLabel: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column label.
• columnName: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column name.
• costValue: number
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
• costValueWorkspace1: number (double)
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the workspace1 currency conversion.
• costValueWorkspace2: number (double)
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the workspace2 currency conversion.
• costValueWorkspace3: number (double)
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the workspace3 currency conversion.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• exceptionMessage: string
  Read Only: true

  Maximum Length: 4000

  Deprecated. As of 23.10.
  Provides the error message for why the formula calculation resulted in an error.
• hasException: boolean
  Read Only: true

  Deprecated. As of 23.10.
  Determines if formula calculation hit an error calculating a value for this field.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• numberValue: number
  This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
• textValue: string
  Maximum Length: 4000

  This holds values for Boolean, List and Text type configured fields.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.

{
    "title":"ApiEntityBudgetChangeConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "budgetChangeConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the Budget Change Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetChangeId":{
            "type":"integer",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "columnName":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "numberValue":{
            "type":"number",
            "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "columnLabel":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column label.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnDefinitionId":{
            "type":"integer",
            "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "textValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "hasException":{
            "type":"boolean",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Determines if formula calculation hit an error calculating a value for this field.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "exceptionMessage":{
            "maxLength":"4000",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Provides the error message for why the formula calculation resulted in an error.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValueWorkspace1":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace1 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "costValueWorkspace2":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace2 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "costValueWorkspace3":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace3 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        }
    },
    "description":"This entity represents a BudgetChangeConfiguredFieldValue object, a unique BudgetChangeConfiguredFieldValue object can be identified by the following combinations of the fields.<ul><li>budgetChangeConfiguredFieldValueId</li><li>columnDefinitionId</li><li>columnName</li><li>columnLabel</li>",
    "exampleSetFlag":false
}

Examples

Select an example Create a Project Budget Change Using an Existing Budget Item Create a Project Budget Change Using a New Budget Item

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : ApiEntityBudgetChange

Type: object

Title: ApiEntityBudgetChange

Show Source

• approveByUserId: integer (int64)
  The username of the user that approved the item.
• approveByUserName: string
  Maximum Length: 255

  The name of the user who approved a project budget change.
• approveDate: string (date-time)
  Date the item was approved.
• budgetChangeCode: string
  Minimum Length: 0

  Maximum Length: 60

  The unique identifier of the project budget change request.
• budgetChangeCost: budgetChangeCost
  An object containing the cost fields associated with the budget change.
• budgetChangeId: integer (int64)
  The system-generated identifier of a budget change.
• budgetTransactions: array budgetTransactions
  List of all budget transactions for the project budget change.
• configuredFields: array configuredFields
  The list of configured fields for a budget change.
• description: string
  Minimum Length: 0

  Maximum Length: 4000

  Details supporting the change request.
• lastModifiedById: integer (int64)
  The username of the user who last made changes to the item.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• projectBudgetId: integer (int64)
  The system-generated identifier of a project budget.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• rejectByUserId: integer (int64)
  The username of the user that rejected the item.
• rejectByUserName: string
  Maximum Length: 255

  The name of the user who rejected a project budget change.
• rejectDate: string (date-time)
  Date the item was rejected.
• status: string
  Allowed Values: [ "DRAFT", "PENDING", "REJECTED", "APPROVED" ]

  The state of the project budget change request. Pending: The change request is awaiting a decision. Approved: The change request was approved. Rejected: The change request was not approved.
• submitByUserId: integer (int64)
  The username of the user that submitted the item.
• submitByUserName: string
  Maximum Length: 255

  The name of the user who submitted a project budget change.
• submitDate: string (date-time)
  Date the item was submitted.
• updateDate: string (date-time)
  Date when the record was last updated.
• withdrawApprovalByUserId: integer (int64)
  The username of the user that with withdrew approval of the item.
• withdrawApprovalByUserName: string
  Maximum Length: 255

  The name of the user who withdrew a project budget change.
• withdrawApprovalDate: string (date-time)
  Date the item was withdrawn.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityBudgetChange",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "status":{
            "type":"string",
            "description":"The state of the project budget change request. Pending: The change request is awaiting a decision. Approved: The change request was approved. Rejected: The change request was not approved.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DRAFT",
                "PENDING",
                "REJECTED",
                "APPROVED"
            ]
        },
        "description":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"Details supporting the change request.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a budget change.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityBudgetChangeConfiguredFieldValue",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "budgetChangeCost":{
            "description":"An object containing the cost fields associated with the budget change.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityBudgetChangeCost"
                }
            ]
        },
        "approveDate":{
            "type":"string",
            "description":"Date the item was approved.",
            "format":"date-time",
            "exampleSetFlag":false
        },
        "approveByUserId":{
            "type":"integer",
            "description":"The username of the user that approved the item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "approveByUserName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the user who approved a project budget change.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "lastModifiedById":{
            "type":"integer",
            "description":"The username of the user who last made changes to the item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "rejectByUserId":{
            "type":"integer",
            "description":"The username of the user that rejected the item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "rejectByUserName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the user who rejected a project budget change.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "rejectDate":{
            "type":"string",
            "description":"Date the item was rejected.",
            "format":"date-time",
            "exampleSetFlag":false
        },
        "submitByUserId":{
            "type":"integer",
            "description":"The username of the user that submitted the item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "submitByUserName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the user who submitted a project budget change.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "submitDate":{
            "type":"string",
            "description":"Date the item was submitted.",
            "format":"date-time",
            "exampleSetFlag":false
        },
        "withdrawApprovalByUserId":{
            "type":"integer",
            "description":"The username of the user that with withdrew approval of the item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "withdrawApprovalByUserName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the user who withdrew a project budget change.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "withdrawApprovalDate":{
            "type":"string",
            "description":"Date the item was withdrawn.",
            "format":"date-time",
            "exampleSetFlag":false
        },
        "projectBudgetId":{
            "type":"integer",
            "description":"The system-generated identifier of a project budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetTransactions":{
            "type":"array",
            "description":"List of all budget transactions for the project budget change.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityBudgetChangeTransaction",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "budgetChangeId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget change.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetChangeCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The unique identifier of the project budget change request.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : budgetChangeCost

An object containing the cost fields associated with the budget change.

Match All

Show Source

• object ApiEntityBudgetChangeCost
  Title: ApiEntityBudgetChangeCost

  Read Only: true

{
    "description":"An object containing the cost fields associated with the budget change.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityBudgetChangeCost"
        }
    ]
}

Nested Schema : budgetTransactions

Type: array

List of all budget transactions for the project budget change.

Show Source

• Array of: object ApiEntityBudgetChangeTransaction
  Title: ApiEntityBudgetChangeTransaction

{
    "type":"array",
    "description":"List of all budget transactions for the project budget change.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityBudgetChangeTransaction",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a budget change.

Show Source

• Array of: object ApiEntityBudgetChangeConfiguredFieldValue
  Title: ApiEntityBudgetChangeConfiguredFieldValue

{
    "type":"array",
    "description":"The list of configured fields for a budget change.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityBudgetChangeConfiguredFieldValue",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityBudgetChangeCost

Type: object

Title: ApiEntityBudgetChangeCost

Read Only: true

Show Source

• budgetChangeId: integer (int64)
  The system-generated identifier of a budget change.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• totalCost: number (double)
  The cost to be added or subtracted from the project budget. This value is based on the base currency.
• totalCostProject: number (double)
  The cost to be added or subtracted from the project budget. This value is based on the project currency.
• totalCostWorkspace1: number (double)
  The cost to be added or subtracted from the project budget. This value is based on the workspace1 currency.
• totalCostWorkspace2: number (double)
  The cost to be added or subtracted from the project budget. This value is based on the workspace2 currency.
• totalCostWorkspace3: number (double)
  The cost to be added or subtracted from the project budget. This value is based on the workspace3 currency.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.

{
    "title":"ApiEntityBudgetChangeCost",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "totalCost":{
            "type":"number",
            "description":"The cost to be added or subtracted from the project budget. This value is based on the base currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalCostWorkspace1":{
            "type":"number",
            "description":"The cost to be added or subtracted from the project budget. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalCostWorkspace2":{
            "type":"number",
            "description":"The cost to be added or subtracted from the project budget. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalCostWorkspace3":{
            "type":"number",
            "description":"The cost to be added or subtracted from the project budget. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalCostProject":{
            "type":"number",
            "description":"The cost to be added or subtracted from the project budget. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "budgetChangeId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget change.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "readOnly":true,
    "exampleSetFlag":false
}

Nested Schema : ApiEntityBudgetChangeTransaction

Type: object

Title: ApiEntityBudgetChangeTransaction

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• approveDate: string (date-time)
  The date the transaction was approved.
• budgetCbsSheetCodeId: integer (int64)
  The name of the CBS Code associated with the budget line item.
• budgetChangeId: integer (int64)
  This is an intermediary field that the system uses to calculate other values. It does not correspond to any field users can see in the user interface.
• budgetCostCategoryId: integer (int64)
  The cost category ID of the budget line item.
• budgetHours: number (double)
  The number of hours needed to complete the budget details line item. Calculated as Production Rate multiplied by Quantity.
• budgetItemId: integer (int64)
  A unique identifier for the budget item (Change Budget Line).
• budgetItemName: string
  Maximum Length: 255

  The name of the budget item.
• budgetTransactionCost: budgetTransactionCost
  The cost of a budget transaction.
• budgetTransactionId: integer (int64)
  The system-generated identifier of a budget transaction.
• changeMode: string
  Allowed Values: [ "AUTO", "MANUAL", "CHANGE" ]

  The detailed budget change line item.
• configuredFields: array configuredFields
  The list of configured fields for a budget change transaction.
• desiredCode: string
  Minimum Length: 0

  Maximum Length: 60

  A unique identifier for the budget item (Add Budget Line).
• itemCode: string
  Maximum Length: 60

  The unique identifier for the budget line item.
• itemCodeSuffix: integer (int64)
  The suffix of a budget transaction code.
• productionRate: number (double)
  Minimum Value: 0.000010

  The number of hours per unit of measure needed to complete the budget line item.
• quantity: number (double)
  The number of each budget line item needed to complete the work.
• status: string
  Allowed Values: [ "DRAFT", "PENDING", "REJECTED", "APPROVED" ]

  The status of the transaction. Indicates whether the transaction is approved, pending, draft, or rejected.
• transactionType: string
  Allowed Values: [ "ORIGINAL", "CHANGE", "TRANSFER" ]

  Specifies whether the budget row is an original, change, or transfer value.
• unitOfMeasureId: integer (int64)
  The Unit of Measure used for the budget line item detail.

{
    "title":"ApiEntityBudgetChangeTransaction",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"The status of the transaction. Indicates whether the transaction is approved, pending, draft, or rejected.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DRAFT",
                "PENDING",
                "REJECTED",
                "APPROVED"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a budget change transaction.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityBudgetTransactionConfiguredFieldValue",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "budgetTransactionId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget transaction.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "itemCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the budget line item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "itemCodeSuffix":{
            "type":"integer",
            "description":"The suffix of a budget transaction code.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "transactionType":{
            "type":"string",
            "description":"Specifies whether the budget row is an original, change, or transfer value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ORIGINAL",
                "CHANGE",
                "TRANSFER"
            ]
        },
        "unitOfMeasureId":{
            "type":"integer",
            "description":"The Unit of Measure used for the budget line item detail.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetItemId":{
            "type":"integer",
            "description":"A unique identifier for the budget item (Change Budget Line).",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetItemName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the budget item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "quantity":{
            "type":"number",
            "description":"The number of each budget line item needed to complete the work.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "productionRate":{
            "minimum":"0.000010",
            "type":"number",
            "description":"The number of hours per unit of measure needed to complete the budget line item.",
            "format":"double",
            "exampleSetFlag":false
        },
        "budgetHours":{
            "type":"number",
            "description":"The number of hours needed to complete the budget details line item. Calculated as Production Rate multiplied by Quantity.",
            "format":"double",
            "exampleSetFlag":false
        },
        "budgetCbsSheetCodeId":{
            "type":"integer",
            "description":"The name of the CBS Code associated with the budget line item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetCostCategoryId":{
            "type":"integer",
            "description":"The cost category ID of the budget line item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "approveDate":{
            "type":"string",
            "description":"The date the transaction was approved.",
            "format":"date-time",
            "exampleSetFlag":false
        },
        "changeMode":{
            "type":"string",
            "description":"The detailed budget change line item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "AUTO",
                "MANUAL",
                "CHANGE"
            ]
        },
        "desiredCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"A unique identifier for the budget item (Add Budget Line).",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "budgetChangeId":{
            "type":"integer",
            "description":"This is an intermediary field that the system uses to calculate other values. It does not correspond to any field users can see in the user interface.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetTransactionCost":{
            "description":"The cost of a budget transaction.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityBudgetTransactionCost"
                }
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : budgetTransactionCost

The cost of a budget transaction.

Match All

Show Source

• object ApiEntityBudgetTransactionCost
  Title: ApiEntityBudgetTransactionCost

{
    "description":"The cost of a budget transaction.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityBudgetTransactionCost"
        }
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a budget change transaction.

Show Source

• Array of: object ApiEntityBudgetTransactionConfiguredFieldValue
  Title: ApiEntityBudgetTransactionConfiguredFieldValue

{
    "type":"array",
    "description":"The list of configured fields for a budget change transaction.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityBudgetTransactionConfiguredFieldValue",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityBudgetTransactionCost

Type: object

Title: ApiEntityBudgetTransactionCost

Show Source

• amountCost: number (double)
  The amount that the budget row has changed as the result of transactions. This value is based on the base currency.
• amountCostProject: number (double)
  The amount that the budget row has changed as the result of transactions. This value is based on the project currency.
• amountCostWorkspace1: number (double)
  The amount that the budget row has changed as the result of transactions. This value is based on the workspace1 currency.
• amountCostWorkspace2: number (double)
  The amount that the budget row has changed as the result of transactions. This value is based on the workspace2 currency.
• amountCostWorkspace3: number (double)
  The amount that the budget row has changed as the result of transactions. This value is based on the workspace3 currency.
• budgetTransactionId: integer (int64)
  The system-generated identifier of a budget transaction.
• currentCost: number (double)
  The current cost of the associated budget line item. This value is based on the base currency.
• currentCostProject: number (double)
  The current cost of the associated budget line item. This value is based on the project currency.
• currentCostWorkspace1: number (double)
  The current cost of the associated budget line item. This value is based on the workspace1 currency.
• currentCostWorkspace2: number (double)
  The current cost of the associated budget line item. This value is based on the workspace2 currency.
• currentCostWorkspace3: number (double)
  The current cost of the associated budget line item. This value is based on the workspace3 currency.
• laborRate: number (double)
  The cost per labor hour of the budget line item detail. This value is based on the base currency.
• laborRateProject: number (double)
  The cost per labor hour of the budget line item detail. This value is based on the project currency.
• laborRateWorkspace1: number (double)
  The cost per labor hour of the budget line item detail. This value is based on the workspace1 currency.
• laborRateWorkspace2: number (double)
  The cost per labor hour of the budget line item detail. This value is based on the workspace2 currency.
• laborRateWorkspace3: number (double)
  The cost per labor hour of the budget line item detail. This value is based on the workspace3 currency.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• unitRate: number (double)
  The cost per Unit of Measure for the budget line item detail. This value is based on the base currency.
• unitRateProject: number (double)
  The cost per Unit of Measure for the budget line item detail. This value is based on the project currency.
• unitRateWorkspace1: number (double)
  The cost per Unit of Measure for the budget line item detail. This value is based on the workspace1 currency.
• unitRateWorkspace2: number (double)
  The cost per Unit of Measure for the budget line item detail. This value is based on the workspace2 currency.
• unitRateWorkspace3: number (double)
  The cost per Unit of Measure for the budget line item detail. This value is based on the workspace3 currency.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityBudgetTransactionCost",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "currentCost":{
            "type":"number",
            "description":"The current cost of the associated budget line item. This value is based on the base currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "budgetTransactionId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget transaction.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "unitRate":{
            "type":"number",
            "description":"The cost per Unit of Measure for the budget line item detail. This value is based on the base currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unitRateWorkspace1":{
            "type":"number",
            "description":"The cost per Unit of Measure for the budget line item detail. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unitRateWorkspace2":{
            "type":"number",
            "description":"The cost per Unit of Measure for the budget line item detail. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unitRateWorkspace3":{
            "type":"number",
            "description":"The cost per Unit of Measure for the budget line item detail. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unitRateProject":{
            "type":"number",
            "description":"The cost per Unit of Measure for the budget line item detail. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "laborRate":{
            "type":"number",
            "description":"The cost per labor hour of the budget line item detail. This value is based on the base currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "laborRateWorkspace1":{
            "type":"number",
            "description":"The cost per labor hour of the budget line item detail. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "laborRateWorkspace2":{
            "type":"number",
            "description":"The cost per labor hour of the budget line item detail. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "laborRateWorkspace3":{
            "type":"number",
            "description":"The cost per labor hour of the budget line item detail. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "laborRateProject":{
            "type":"number",
            "description":"The cost per labor hour of the budget line item detail. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "currentCostWorkspace1":{
            "type":"number",
            "description":"The current cost of the associated budget line item. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "currentCostWorkspace2":{
            "type":"number",
            "description":"The current cost of the associated budget line item. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "currentCostWorkspace3":{
            "type":"number",
            "description":"The current cost of the associated budget line item. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "currentCostProject":{
            "type":"number",
            "description":"The current cost of the associated budget line item. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "amountCost":{
            "type":"number",
            "description":"The amount that the budget row has changed as the result of transactions. This value is based on the base currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "amountCostWorkspace1":{
            "type":"number",
            "description":"The amount that the budget row has changed as the result of transactions. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "amountCostWorkspace2":{
            "type":"number",
            "description":"The amount that the budget row has changed as the result of transactions. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "amountCostWorkspace3":{
            "type":"number",
            "description":"The amount that the budget row has changed as the result of transactions. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "amountCostProject":{
            "type":"number",
            "description":"The amount that the budget row has changed as the result of transactions. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityBudgetTransactionConfiguredFieldValue

Type: object

Title: ApiEntityBudgetTransactionConfiguredFieldValue

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• budgetTransactionConfiguredFieldValueId: integer (int64)
  The unique identifier for the Transaction Configured Field.
• budgetTransactionId: integer (int64)
  The system-generated identifier for a transaction.
• columnDefinitionId: integer (int64)
  Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
• columnLabel: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column label.
• columnName: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column name.
• costValue: number
  This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
• costValueWorkspace1: number (double)
  This holds values for Cost type configured fields in the workspace1 currency conversion.
• costValueWorkspace2: number (double)
  This holds values for Cost type configured fields in the workspace2 currency conversion.
• costValueWorkspace3: number (double)
  This holds values for Cost type configured fields in the workspace3 currency conversion.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• exceptionMessage: string
  Maximum Length: 4000

  Provides the error message for why the formula calculation resulted in an error.
• hasException: boolean
  Determines if formula calculation hit an error calculating a value for this field.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• numberValue: number
  This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
• textValue: string
  Maximum Length: 4000

  This holds values for Boolean, List and Text type configured fields.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityBudgetTransactionConfiguredFieldValue",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "budgetTransactionConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the Transaction Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetTransactionId":{
            "type":"integer",
            "description":"The system-generated identifier for a transaction.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "columnName":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "numberValue":{
            "type":"number",
            "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "columnLabel":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column label.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnDefinitionId":{
            "type":"integer",
            "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "textValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValue":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "hasException":{
            "type":"boolean",
            "description":"Determines if formula calculation hit an error calculating a value for this field.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "exceptionMessage":{
            "maxLength":"4000",
            "type":"string",
            "description":"Provides the error message for why the formula calculation resulted in an error.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValueWorkspace1":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace2":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace3":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityBudgetChangeConfiguredFieldValue

Type: object

Title: ApiEntityBudgetChangeConfiguredFieldValue

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• budgetChangeConfiguredFieldValueId: integer (int64)
  The unique identifier for the Budget Change Configured Field.
• budgetChangeId: integer (int64)
• columnDefinitionId: integer (int64)
  Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
• columnLabel: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column label.
• columnName: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column name.
• costValue: number
  This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
• costValueWorkspace1: number (double)
  This holds values for Cost type configured fields in the workspace1 currency conversion.
• costValueWorkspace2: number (double)
  This holds values for Cost type configured fields in the workspace2 currency conversion.
• costValueWorkspace3: number (double)
  This holds values for Cost type configured fields in the workspace3 currency conversion.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• exceptionMessage: string
  Maximum Length: 4000

  Provides the error message for why the formula calculation resulted in an error.
• hasException: boolean
  Determines if formula calculation hit an error calculating a value for this field.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• numberValue: number
  This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
• textValue: string
  Maximum Length: 4000

  This holds values for Boolean, List and Text type configured fields.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityBudgetChangeConfiguredFieldValue",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "budgetChangeConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the Budget Change Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetChangeId":{
            "type":"integer",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "columnName":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "numberValue":{
            "type":"number",
            "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "columnLabel":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column label.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnDefinitionId":{
            "type":"integer",
            "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "textValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValue":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "hasException":{
            "type":"boolean",
            "description":"Determines if formula calculation hit an error calculating a value for this field.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "exceptionMessage":{
            "maxLength":"4000",
            "type":"string",
            "description":"Provides the error message for why the formula calculation resulted in an error.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValueWorkspace1":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace2":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace3":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid input for the Project Budget Change service. Verify the request contains valid data, then resubmit the request.

Back to Top