Jump to

• Request
• Response

View a Project Budget Transfer by Code and Parent Codes

get

/api/restapi/budgetTransfer/byItemCode

Send a request to this endpoint to view a project budget transfer with codes matching the code fields in query parameters.

Request

Query Parameters

• budgetTransferCode(required): string
  The user-specified identifier of a budget transfer.
  This is a required field.
• projectCode(required): string
  Project code of the budget transfer to be found.
  This is a required field.
• workspaceCode(required): string
  Workspace code of the budget transfer to be found.
  This is a required field.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityBudgetTransfer

Type: object

Title: ApiEntityBudgetTransfer

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 transfer.
• approveDate: string (date-time)
  Date the item was approved.
• budgetItemId: integer (int64)
  The system-generated identifier of a budget item.
• budgetTransactions: array budgetTransactions
  List of all budget transactions for the project budget transfer.
• budgetTransferCode: string
  Minimum Length: 0

  Maximum Length: 60

  The unique identifier of the project budget transfer request.
• budgetTransferId: integer (int64)
  The system-generated identifier of a budget transfer.
• configuredFields: array configuredFields
  The list of configured fields for a budget transfer.
• description: string
  Minimum Length: 0

  Maximum Length: 4000

  Additional information about the transaction.
• itemPrefix: string
  Maximum Length: 60

  The prefix of a budget transfer code.
• itemSuffix: integer (int64)
  The suffix of a budget transfer code.
• 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 transfer.
• rejectDate: string (date-time)
  Date the item was rejected.
• status: string
  Allowed Values: [ "DRAFT", "PENDING", "REJECTED", "APPROVED" ]

  The state of the project budget transfer 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 transfer.
• 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 transfer.
• 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":"ApiEntityBudgetTransfer",
    "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 transfer 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":"Additional information about the transaction.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a budget transfer.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityBudgetTransferConfiguredFieldValue",
                "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"
            ]
        },
        "budgetItemId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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 transfer.",
            "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 transfer.",
            "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 transfer.",
            "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 transfer.",
            "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 transfer.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityBudgetTransferTransaction",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "budgetTransferId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget transfer.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetTransferCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The unique identifier of the project budget transfer request.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "itemPrefix":{
            "maxLength":"60",
            "type":"string",
            "description":"The prefix of a budget transfer code.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "itemSuffix":{
            "type":"integer",
            "description":"The suffix of a budget transfer 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 : budgetTransactions

Type: array

List of all budget transactions for the project budget transfer.

Show Source

• Array of: object ApiEntityBudgetTransferTransaction
  Title: ApiEntityBudgetTransferTransaction

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

Nested Schema : configuredFields

Type: array

The list of configured fields for a budget transfer.

Show Source

• Array of: object ApiEntityBudgetTransferConfiguredFieldValue
  Title: ApiEntityBudgetTransferConfiguredFieldValue

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

Nested Schema : ApiEntityBudgetTransferTransaction

Type: object

Title: ApiEntityBudgetTransferTransaction

Show Source

• action: string
  Allowed Values: [ "DELETE" ]
• 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.
• 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.
• budgetTransferId: 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.
• budgetTransferType: string
  Allowed Values: [ "TO", "FROM" ]

  Specifies whether the budget row is transfer from budget record or transfer to budget record.
• configuredFields: array configuredFields
  The list of configured fields for a budget transfer transaction.
• crossEntityBudgetTransactionId: integer (int64)
  The system-generated identifier of a source budget transaction which has cross entity budget item involved.
• crossEntityBudgetTransferId: integer (int64)
  The system-generated identifier of a project budget transfer of an object to which the project budget item is added in a destination transaction of a cross entity transfer.
• crossEntityTransferFromId: integer (int64)
  The system-generated identifier of a budget item added in a cross object transfer. This field is required to be provided in a destination transaction of a cross entity transfer to identify the source budget item. For example, In a program to project Project Budget Transfer, the program budget item ID has to be given in a destination transaction.
• itemCode: string
  Maximum Length: 60

  The system-generated unique identifier for the budget transaction 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.
• transferFromCBSId: integer (int64)
  The CBS code of the source budget line item. This identifies the CBS code of the budget line item you are transferring money from through the transfer.
• transferFromCostCategoryId: integer (int64)
  The cost category ID of the destination budget line item.
• transferFromId: integer (int64)
  The unique identifier for the source budget line item. This identifies the ID of the budget item item you are transferring money from through the transfer.
• transferToCBSId: integer (int64)
  The CBS code of the destination budget line item. This identifies the CBS code of the budget line item you are transferring money to through the transfer.
• transferToCostCategoryId: integer (int64)
  The cost category ID of the source budget line item.
• transferToId: integer (int64)
  The unique identifier for the destination budget line item. This identifies the ID of the budget item you are transferring money to through the transfer.
• unitOfMeasureId: integer (int64)
  The Unit of Measure used for the budget line item detail.

{
    "title":"ApiEntityBudgetTransferTransaction",
    "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",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a budget transfer 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 system-generated unique identifier for the budget transaction 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
        },
        "budgetTransferType":{
            "type":"string",
            "description":"Specifies whether the budget row is transfer from budget record or transfer to budget record.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "TO",
                "FROM"
            ]
        },
        "crossEntityBudgetTransactionId":{
            "type":"integer",
            "description":"The system-generated identifier of a source budget transaction which has cross entity budget item involved.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "crossEntityBudgetTransferId":{
            "type":"integer",
            "description":"The system-generated identifier of a project budget transfer of an object to which the project budget item is added in a destination transaction of a cross entity transfer.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "crossEntityTransferFromId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget item added in a cross object transfer. This field is required to be provided in a destination transaction of a cross entity transfer to identify the source budget item. For example, In a program to project Project Budget Transfer, the program budget item ID has to be given in a destination transaction.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "transferFromCBSId":{
            "type":"integer",
            "description":"The CBS code of the source budget line item. This identifies the CBS code of the budget line item you are transferring money from through the transfer. ",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "transferFromCostCategoryId":{
            "type":"integer",
            "description":"The cost category ID of the destination budget line item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "transferToCBSId":{
            "type":"integer",
            "description":"The CBS code of the destination budget line item. This identifies the CBS code of the budget line item you are transferring money to through the transfer. ",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "transferToCostCategoryId":{
            "type":"integer",
            "description":"The cost category ID of the source budget line item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "transferToId":{
            "type":"integer",
            "description":"The unique identifier for the destination budget line item. This identifies the ID of the budget item you are transferring money to through the transfer.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "transferFromId":{
            "type":"integer",
            "description":"The unique identifier for the source budget line item. This identifies the ID of the budget item item you are transferring money from through the transfer. ",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetTransferId":{
            "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 transfer transaction.

Show Source

• Array of: object ApiEntityBudgetTransactionConfiguredFieldValue
  Title: ApiEntityBudgetTransactionConfiguredFieldValue

{
    "type":"array",
    "description":"The list of configured fields for a budget transfer 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 : ApiEntityBudgetTransferConfiguredFieldValue

Type: object

Title: ApiEntityBudgetTransferConfiguredFieldValue

Show Source

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

  Provide value for this field during object update to delete the assigned configured field value.
• budgetTransferConfiguredFieldValueId: integer (int64)
  The unique identifier for the Project Budget Transfer Configured Field.
• budgetTransferId: integer (int64)
  The system-generated identifier of a budget transfer.
• 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":"ApiEntityBudgetTransferConfiguredFieldValue",
    "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"
            ]
        },
        "budgetTransferId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget transfer.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetTransferConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the Project Budget Transfer Configured Field.",
            "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 object does not exist, or you do not have access to it.

Back to Top