Jump to

• Request
• Response

View Project Budget Item by Code and Project Budget

get

/api/restapi/budgetItem/projectBudget/{projectBudgetId}/code/{budgetItemCode}

This endpoint returns project budget items that meet the following requirements:

• The object has a code that matches the value of the {budgetItemCode} path parameter.
• The object is associated with a project budget with an ID value that matches the value of the {projectBudgetId} path parameter.

Budget items represent costs associated with labor or other project expenses.

Request

Path Parameters

• budgetItemCode(required): string
  The item code of a budget item.
• projectBudgetId(required): integer(int64)
  The system-generated identifier of a project budget.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityBudgetItem>

Type: array

Title: List<ApiEntityBudgetItem>

Show Source

• Array of: object ApiEntityBudgetItem
  Title: ApiEntityBudgetItem

{
    "title":"List<ApiEntityBudgetItem>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityBudgetItem",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityBudgetItem

Type: object

Title: ApiEntityBudgetItem

Show Source

• abbreviation: string
  Minimum Length: 1

  Maximum Length: 10

  The abbreviated name of a cost category.
• budgetChangeId: integer (int64)
  Indicates whether the budget item originated in a budget change.
• budgetHours: number (double)
  The number of hours needed to complete the budget item. Calculated as Production Rate multiplied by Quantity.
• budgetItemCode: string
  Minimum Length: 0

  Maximum Length: 60

  The unique identifier of the project budget item.
• budgetItemCost: budgetItemCost
  Contains Budget Item cost related fields.
• budgetItemId: integer (int64)
  The system-generated identifier of a budget item.
• cbsCodes: array cbsCodes
  List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.
• cbsSheetCodeId: integer (int64)
  The unique identifier of the CBS Code.
• configuredFields: array configuredFields
  The list of configured fields for a budget item.
• costCategoryId: integer (int64)
  The type of cost associated with the budget item.
• costCategoryName: string
  Minimum Length: 1

  Maximum Length: 255

  The cost category assigned to this budget item.
• itemName: string
  Minimum Length: 0

  Maximum Length: 255

  The name of the budget item.
• itemSuffix: integer (int64)
  The suffix of a budget item code.
• link: string (url)
  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 item.
• projectBudgetId: integer (int64)
  The system-generated identifier of a project budget.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The project associated with this budget item.
• projectId: integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• quantity: number (double)
  The number of each budget item needed to complete the work.
• sourceId: string
  Maximum Length: 255

  The unique identifier of budget item data in an external source.
• unitsOfMeasureId: integer (int64)
  The Unit of Measure used for the budget item.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityBudgetItem",
    "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"
            ]
        },
        "cbsCodes":{
            "type":"array",
            "description":"List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.",
            "writeOnly":true,
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "writeOnly":true,
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a budget item.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityBudgetItemConfiguredFieldValue",
                "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 project associated with this budget item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "budgetItemCost":{
            "description":"Contains Budget Item cost related fields.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityBudgetItemCost"
                }
            ]
        },
        "budgetItemId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "quantity":{
            "type":"number",
            "description":"The number of each budget 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 item.",
            "format":"double",
            "exampleSetFlag":false
        },
        "budgetHours":{
            "type":"number",
            "description":"The number of hours needed to complete the budget item. Calculated as Production Rate multiplied by Quantity.",
            "format":"double",
            "exampleSetFlag":false
        },
        "cbsSheetCodeId":{
            "type":"integer",
            "description":"The unique identifier of the CBS Code.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sourceId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of budget item data in an external source.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costCategoryId":{
            "type":"integer",
            "description":"The type of cost associated with the budget item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "costCategoryName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The cost category assigned to this budget item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "abbreviation":{
            "maxLength":"10",
            "minLength":"1",
            "type":"string",
            "description":"The abbreviated name of a cost category.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "unitsOfMeasureId":{
            "type":"integer",
            "description":"The Unit of Measure used for the budget item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectBudgetId":{
            "type":"integer",
            "description":"The system-generated identifier of a project budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetChangeId":{
            "type":"integer",
            "description":"Indicates whether the budget item originated in a budget change.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetItemCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The unique identifier of the project budget item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "itemName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"The name of the budget item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "itemSuffix":{
            "type":"integer",
            "description":"The suffix of a budget item code.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : budgetItemCost

Contains Budget Item cost related fields.

Match All

Show Source

• object ApiEntityBudgetItemCost
  Title: ApiEntityBudgetItemCost

{
    "description":"Contains Budget Item cost related fields.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityBudgetItemCost"
        }
    ]
}

Nested Schema : cbsCodes

Type: array

List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.",
    "writeOnly":true,
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "writeOnly":true,
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a budget item.

Show Source

• Array of: object ApiEntityBudgetItemConfiguredFieldValue
  Title: ApiEntityBudgetItemConfiguredFieldValue

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

Nested Schema : ApiEntityBudgetItemCost

Type: object

Title: ApiEntityBudgetItemCost

Show Source

• budgetItemId: integer (int64)
  The system-generated identifier of a budget item.
• currentCost: number (double)
  The current cost of the budget line item. This value is based on the base currency.
• currentCostProject: number (double)
  The current cost of the budget line item. This value is based on the project currency.
• currentCostWorkspace1: number (double)
  The current cost of the budget line item. This value is based on the workspace1 currency.
• currentCostWorkspace2: number (double)
  The current cost of the budget line item. This value is based on the workspace2 currency.
• currentCostWorkspace3: number (double)
  The current cost of the budget line item. This value is based on the workspace3 currency.
• laborRate: number (double)
  The cost per labor hour of the budget line item. This value is based on the base currency.
• laborRateProject: number (double)
  The cost per labor hour of the budget line item. This value is based on the project currency.
• laborRateWorkspace1: number (double)
  The cost per labor hour of the budget line item. This value is based on the workspace1 currency.
• laborRateWorkspace2: number (double)
  The cost per labor hour of the budget line item. This value is based on the workspace2 currency.
• laborRateWorkspace3: number (double)
  The cost per labor hour of the budget line item. 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.
• originalCost: number (double)
  Minimum Value: 0

  The original cost of the budget line item. This value is based on the base currency.
• originalCostProject: number (double)
  The original cost of the budget line item. This value is based on the project currency.
• originalCostWorkspace1: number (double)
  The original cost of the budget line item. This value is based on the workspace1 currency.
• originalCostWorkspace2: number (double)
  The original cost of the budget line item. This value is based on the workspace2 currency.
• originalCostWorkspace3: number (double)
  The original cost of the budget line item. This value is based on the workspace3 currency.
• unitRate: number (double)
  The cost per Unit of Measure for the budget line item. This value is based on the base currency.
• unitRateProject: number (double)
  The cost per Unit of Measure for the budget line item. This value is based on the project currency.
• unitRateWorkspace1: number (double)
  The cost per Unit of Measure for the budget line item. This value is based on the workspace1 currency.
• unitRateWorkspace2: number (double)
  The cost per Unit of Measure for the budget line item. This value is based on the workspace2 currency.
• unitRateWorkspace3: number (double)
  The cost per Unit of Measure for the budget line item. This value is based on the workspace3 currency.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityBudgetItemCost",
    "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 budget line item. This value is based on the base currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "budgetItemId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "unitRate":{
            "type":"number",
            "description":"The cost per Unit of Measure for the budget line item. 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. 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. 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. 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. 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. 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. 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. 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. 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. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "currentCostWorkspace1":{
            "type":"number",
            "description":"The current cost of the budget line item. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "currentCostWorkspace2":{
            "type":"number",
            "description":"The current cost of the budget line item. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "currentCostWorkspace3":{
            "type":"number",
            "description":"The current cost of the budget line item. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "currentCostProject":{
            "type":"number",
            "description":"The current cost of the budget line item. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "originalCost":{
            "minimum":"0",
            "type":"number",
            "description":"The original cost of the budget line item. This value is based on the base currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "originalCostWorkspace1":{
            "type":"number",
            "description":"The original cost of the budget line item. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "originalCostWorkspace2":{
            "type":"number",
            "description":"The original cost of the budget line item. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "originalCostWorkspace3":{
            "type":"number",
            "description":"The original cost of the budget line item. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "originalCostProject":{
            "type":"number",
            "description":"The original cost of the budget line item. 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 : ApiEntityBudgetItemConfiguredFieldValue

Type: object

Title: ApiEntityBudgetItemConfiguredFieldValue

Show Source

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

  Provide value for this field during object update to delete the assigned configured field value.
• budgetItemConfiguredFieldValueId: integer (int64)
  The unique identifier for the Budget Item Configured Field.
• budgetItemId: integer (int64)
  The system-generated identifier for an Budget.
• 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":"ApiEntityBudgetItemConfiguredFieldValue",
    "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"
            ]
        },
        "budgetItemConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the Budget Item Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetItemId":{
            "type":"integer",
            "description":"The system-generated identifier for an Budget.",
            "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
}

404 Response

The requested project budget item does not exist, or you do not have access to it.

Back to Top