Jump to

• Request
• Response

Read ActivityExpenses

get

/activityExpense

Reads ActivityExpense objects from the database.

Request

Query Parameters

• Fields(required): string
  Fields to load

  Example:

  Name,ObjectId

• Filter(required): string
  Supported Filter Operators - :gt:, :lt:, :eq:, :gte:, :lte:, :and:, :or:

  Example:

  ObjectId IN(1,2) :and: CreateDate:gte:'2021-04-20' :and: LastUpdateDate:lt:'2022-04-20' :and: Name :like: 'abc%'

• OrderBy(required): string
  OrderBy condition

  Example:

  ObjectId desc

Header Parameters

• Authorization(required):
  OAuth token

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : List<ActivityExpense>

Type: array

Title: List<ActivityExpense>

Show Source

• Array of: object ActivityExpense
  Title: ActivityExpense

  ActivityExpense Entity

{
    "title":"List<ActivityExpense>",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ActivityExpense"
    }
}

Nested Schema : ActivityExpense

Type: object

Title: ActivityExpense

ActivityExpense Entity

Show Source

• AccrualType: string
  The accrual type for the project expense. If the accrual type is 'Start of Activity', the entire expense costs are accrued at the start date of the activity. If the accrual type is 'End of Activity', the entire expense costs are accrued at the finish date of the activity. If the accrual type is 'Uniform over Activity', the expense costs are accrued uniformly over the duration of the activity.
• ActivityId: string
  The short ID that uniquely identifies the activity within the project.
• ActivityName: string
  The name of the activity. The activity name does not have to be unique.
• ActivityObjectId(required): integer (int32)
  The unique ID of the activity to which the project expense is linked. Every project expense is associated with one activity in the project.
• ActualCost: number (double)
  The actual cost for the project expense.
• ActualUnits: number (double)
  The actual units for the project expense.
• AtCompletionCost: number (double)
  The sum of the actual plus remaining costs for the project expense. Computed as actual cost + remaining cost.
• AtCompletionUnits: number (double)
  The at completion units for the project expense.
• AutoComputeActuals: boolean
  The flag that identifies whether the actual and remaining costs for the expense are computed automatically using the planned cost and the activity's schedule percent complete. If this option is selected, the actual/remaining costs are automatically updated when project actuals are applied. This assumes the expenses are made according to plan.
• CBSCode: string
  CBS Code.
• CBSId: integer (int32)
  The unique Id of CBS.
• CostAccountId: string
  The id of associated cost account.
• CostAccountName: string
  The name of the associated cost account.
• CostAccountObjectId: integer (int32)
  The unique ID of the cost account associated with the project expense.
• CreateDate: string (date-time)
  The date this expense was created.
• CreateUser: string
  The name of the user that created this expense.
• DocumentNumber: string
  The document number for the expense. Use this for the purchase order number, invoice number, requisition number, or similar, as needed.
• ExpenseCategoryName: string
  The name of the expense category.
• ExpenseCategoryObjectId: integer (int32)
  The unique ID of the expense category for the project expense.
• ExpenseDescription: string
  The description of the expense.
• ExpenseItem(required): string
  The name of the project expense.
• ExpensePercentComplete: number (double)
  The percent complete of the project expense.
• IsBaseline: boolean
  The boolean value indicating if this business object is related to a Project or Baseline
• IsTemplate: boolean
  The boolean value indicating if this business object is related to a template Project.
• LastUpdateDate: string (date-time)
  The date this expense was last updated.
• LastUpdateUser: string
  The name of the user that last updated this expense.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• OverBudget: boolean
  The indicator that reflects whether the project expense is over budget. An expense is over budget when the actual cost + remaining cost exceeds the planned cost.
• PlannedCost: number (double)
  The planned cost for the project expense. This field is named BudgetedCost in Primavera's Engineering & Construction and Maintenance & Turnaround solutions.
• PlannedUnits: number (double)
  The planned number of units for the project expense. This number is multiplied by the price per unit to compute the planned cost. This field is named BudgetedUnits in Primavera's Engineering & Construction and Maintenance & Turnaround solutions.
• PricePerUnit: number (double)
  The planned price per unit for the project expense. This number is multiplied by the planned number of units to compute the planned cost.
• ProjectId: string
  The short code that uniquely identifies the project.
• ProjectObjectId: integer (int32)
  The unique ID of the associated project.
• RemainingCost: number (double)
  The remaining cost for the project expense. Before actual expenses are made, remaining cost should be the same as planned cost. While the activity is in progress, the remaining cost should be updated to reflect the estimated remaining cost required for the expense. After the expense is completed, the remaining cost should be zero.
• RemainingUnits: number (double)
  The remaining units for the project expense.
• UnitOfMeasure: string
  The unit of measure for the project expense.
• Vendor: string
  The name of the vendor providing the product or service associated with the expense.
• WBSObjectId: integer (int32)
  The unique ID of the WBS for the activity.

{
    "title":"ActivityExpense",
    "required":[
        "ActivityObjectId",
        "ExpenseItem"
    ],
    "type":"object",
    "properties":{
        "AccrualType":{
            "type":"string",
            "description":"The accrual type for the project expense. If the accrual type is 'Start of Activity', the entire expense costs are accrued at the start date of the activity. If the accrual type is 'End of Activity', the entire expense costs are accrued at the finish date of the activity. If the accrual type is 'Uniform over Activity', the expense costs are accrued uniformly over the duration of the activity."
        },
        "ActivityId":{
            "type":"string",
            "description":"The short ID that uniquely identifies the activity within the project."
        },
        "ActivityName":{
            "type":"string",
            "description":"The name of the activity. The activity name does not have to be unique."
        },
        "ActivityObjectId":{
            "type":"integer",
            "description":"The unique ID of the activity to which the project expense is linked. Every project expense is associated with one activity in the project.",
            "format":"int32"
        },
        "ActualCost":{
            "type":"number",
            "description":"The actual cost for the project expense.",
            "format":"double"
        },
        "ActualUnits":{
            "type":"number",
            "description":"The actual units for the project expense.",
            "format":"double"
        },
        "AtCompletionCost":{
            "type":"number",
            "description":"The sum of the actual plus remaining costs for the project expense. Computed as actual cost + remaining cost.",
            "format":"double"
        },
        "AtCompletionUnits":{
            "type":"number",
            "description":"The at completion units for the project expense.",
            "format":"double"
        },
        "AutoComputeActuals":{
            "type":"boolean",
            "description":"The flag that identifies whether the actual and remaining costs for the expense are computed automatically using the planned cost and the activity's schedule percent complete. If this option is selected, the actual/remaining costs are automatically updated when project actuals are applied. This assumes the expenses are made according to plan."
        },
        "CBSCode":{
            "type":"string",
            "description":"CBS Code."
        },
        "CBSId":{
            "type":"integer",
            "description":"The unique Id of CBS.",
            "format":"int32"
        },
        "CostAccountId":{
            "type":"string",
            "description":"The id of associated cost account."
        },
        "CostAccountName":{
            "type":"string",
            "description":"The name of the associated cost account."
        },
        "CostAccountObjectId":{
            "type":"integer",
            "description":"The unique ID of the cost account associated with the project expense.",
            "format":"int32"
        },
        "CreateDate":{
            "type":"string",
            "description":"The date this expense was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this expense."
        },
        "DocumentNumber":{
            "type":"string",
            "description":"The document number for the expense. Use this for the purchase order number, invoice number, requisition number, or similar, as needed."
        },
        "ExpenseCategoryName":{
            "type":"string",
            "description":"The name of the expense category."
        },
        "ExpenseCategoryObjectId":{
            "type":"integer",
            "description":"The unique ID of the expense category for the project expense.",
            "format":"int32"
        },
        "ExpenseDescription":{
            "type":"string",
            "description":"The description of the expense."
        },
        "ExpenseItem":{
            "type":"string",
            "description":"The name of the project expense."
        },
        "ExpensePercentComplete":{
            "type":"number",
            "description":"The percent complete of the project expense.",
            "format":"double"
        },
        "IsBaseline":{
            "type":"boolean",
            "description":"The boolean value indicating if this business object is related to a Project or Baseline"
        },
        "IsTemplate":{
            "type":"boolean",
            "description":"The boolean value indicating if this business object is related to a template Project."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this expense was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this expense."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "OverBudget":{
            "type":"boolean",
            "description":"The indicator that reflects whether the project expense is over budget. An expense is over budget when the actual cost + remaining cost exceeds the planned cost."
        },
        "PlannedCost":{
            "type":"number",
            "description":"The planned cost for the project expense. This field is named BudgetedCost in Primavera's Engineering & Construction and Maintenance & Turnaround solutions.",
            "format":"double"
        },
        "PlannedUnits":{
            "type":"number",
            "description":"The planned number of units for the project expense. This number is multiplied by the price per unit to compute the planned cost. This field is named BudgetedUnits in Primavera's Engineering & Construction and Maintenance & Turnaround solutions.",
            "format":"double"
        },
        "PricePerUnit":{
            "type":"number",
            "description":"The planned price per unit for the project expense. This number is multiplied by the planned number of units to compute the planned cost.",
            "format":"double"
        },
        "ProjectId":{
            "type":"string",
            "description":"The short code that uniquely identifies the project."
        },
        "ProjectObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated project.",
            "format":"int32"
        },
        "RemainingCost":{
            "type":"number",
            "description":"The remaining cost for the project expense. Before actual expenses are made, remaining cost should be the same as planned cost. While the activity is in progress, the remaining cost should be updated to reflect the estimated remaining cost required for the expense. After the expense is completed, the remaining cost should be zero.",
            "format":"double"
        },
        "RemainingUnits":{
            "type":"number",
            "description":"The remaining units for the project expense.",
            "format":"double"
        },
        "UnitOfMeasure":{
            "type":"string",
            "description":"The unit of measure for the project expense."
        },
        "Vendor":{
            "type":"string",
            "description":"The name of the vendor providing the product or service associated with the expense."
        },
        "WBSObjectId":{
            "type":"integer",
            "description":"The unique ID of the WBS for the activity.",
            "format":"int32"
        }
    },
    "description":"ActivityExpense Entity"
}

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.

Back to Top