getCostTypeObjects

Get costs per object for the given project and cost type.

    GET /project-control/{project_id}/cost-type/{cost_type}/objects

CostTypeObjectSchema properties

objectInfo CostTypeObjectInfoSchema
Info for the object, summed data of chapters.

chapters null array  of  CostTypeChapterSchema
Cost type chapters for the object.

CostTypeChapterSchema properties

chapterInfo CostTypeChapterInfoSchema
Info for the chapter, summed data of security codes.

securityCodes null array  of  CostTypeSecuritySchema
Cost type security codes for the chapter.

CostTypeObjectCollectionSchema properties

count null integer
Total item count.

limit null integer
Given limit for the items.

offset null integer
Given offset for the items.

totals null CostTypeSchema
Totals budget info.

items array  of  CostTypeObjectSchema
A list of costs for a specific cost type pet object.

CostTypeObjectInfoSchema properties

hourInfo null CostTypeHourSchema
Labor info for the security code, only filled if the ProjectSecurityLink has the labor cost type.

code null string
The code of the object.

name null string
The name of the object.

budgetAmount number
The budgeted amount.

prognosisAmount null number
The prognosis amount.

progress null number
The progress.

adjustment null number
The adjustment.

status ProjectSecurityLinkStatusEnum
The status of the ProjectSecurityLink.

costAmount number
The costs in amount (various cost types).

contractCostAmount null number
The contract costs in amount.

termAmount number
The term amount.

allowedAmount null number
The allowed amount.

prognosisPlannedAmount null number
The planned amount.

prognosisToBePlannedAmount null number
The amount still to be planned.

differenceBudgetPrognosisAmount null number
The amount difference between budget and prognosis.

resultBudgetAmount null number
The resulting budget amount.

resultInterimAmount null number
The interim result amount.

resultEndAmount null number
The end result amount.

totalBudgetAmount number
The total budget amount.

totalPrognosisAmount null number
The total prognosis amount.

totalBudgetTermAmount number
The total prognosis term amount.

totalPrognosisTermAmount null number
The total prognosis term amount.

prognosisMovedAmount null number
The moved prognosis amount.

prognosisOtherAmount null number
The amount which is budgeted differently.

prognosisReservedAmount null number
The reserved prognosis amount.

purchaseResultAmount null number
The resulting purchase amount.

additionalWorkAmount null number
The additional work amount.

remarkCount null integer
The amount of comments made on a security code.

id null integer
The ID of the object.

CostTypeSecuritySchema properties

hourInfo null CostTypeHourSchema
Labor info for the security code, only filled if the ProjectSecurityLink has the labor cost type.

code null string
The code of the security code.

name null string
The name of the security code.

budgetAmount number
The budgeted amount.

prognosisAmount null number
The prognosis amount.

progress null number
The progress.

adjustment null number
The adjustment.

status ProjectSecurityLinkStatusEnum
The status of the ProjectSecurityLink.

costAmount number
The costs in amount (various cost types).

contractCostAmount null number
The contract costs in amount.

termAmount number
The term amount.

allowedAmount null number
The allowed amount.

prognosisPlannedAmount null number
The planned amount.

prognosisToBePlannedAmount null number
The amount still to be planned.

differenceBudgetPrognosisAmount null number
The amount difference between budget and prognosis.

resultBudgetAmount null number
The resulting budget amount.

resultInterimAmount null number
The interim result amount.

resultEndAmount null number
The end result amount.

totalBudgetAmount number
The total budget amount.

totalPrognosisAmount null number
The total prognosis amount.

totalBudgetTermAmount number
The total prognosis term amount.

totalPrognosisTermAmount null number
The total prognosis term amount.

prognosisMovedAmount null number
The moved prognosis amount.

prognosisOtherAmount null number
The amount which is budgeted differently.

prognosisReservedAmount null number
The reserved prognosis amount.

purchaseResultAmount null number
The resulting purchase amount.

additionalWorkAmount null number
The additional work amount.

remarkCount null integer
The amount of comments made on a security code.

pslIds null array of integer
The ProjectSecurityLink IDs of security codes with the same (code+name).

CostTypeSchema properties

hourInfo null CostTypeHourSchema
Labor info for the security code, only filled if the ProjectSecurityLink has the labor cost type.

code null string
The code of the security code.

name null string
The name of the security code.

budgetAmount number
The budgeted amount.

prognosisAmount null number
The prognosis amount.

progress null number
The progress.

adjustment null number
The adjustment.

status ProjectSecurityLinkStatusEnum
The status of the ProjectSecurityLink.

costAmount number
The costs in amount (various cost types).

contractCostAmount null number
The contract costs in amount.

termAmount number
The term amount.

allowedAmount null number
The allowed amount.

prognosisPlannedAmount null number
The planned amount.

prognosisToBePlannedAmount null number
The amount still to be planned.

differenceBudgetPrognosisAmount null number
The amount difference between budget and prognosis.

resultBudgetAmount null number
The resulting budget amount.

resultInterimAmount null number
The interim result amount.

resultEndAmount null number
The end result amount.

totalBudgetAmount number
The total budget amount.

totalPrognosisAmount null number
The total prognosis amount.

totalBudgetTermAmount number
The total prognosis term amount.

totalPrognosisTermAmount null number
The total prognosis term amount.

prognosisMovedAmount null number
The moved prognosis amount.

prognosisOtherAmount null number
The amount which is budgeted differently.

prognosisReservedAmount null number
The reserved prognosis amount.

purchaseResultAmount null number
The resulting purchase amount.

additionalWorkAmount null number
The additional work amount.

remarkCount null integer
The amount of comments made on a security code.

CostTypeChapterInfoSchema properties

hourInfo null CostTypeHourSchema
Labor info for the security code, only filled if the ProjectSecurityLink has the labor cost type.

code null string
The code of the chapter.

name null string
The name of the chapter.

budgetAmount number
The budgeted amount.

prognosisAmount null number
The prognosis amount.

progress null number
The progress.

adjustment null number
The adjustment.

status ProjectSecurityLinkStatusEnum
The status of the ProjectSecurityLink.

costAmount number
The costs in amount (various cost types).

contractCostAmount null number
The contract costs in amount.

termAmount number
The term amount.

allowedAmount null number
The allowed amount.

prognosisPlannedAmount null number
The planned amount.

prognosisToBePlannedAmount null number
The amount still to be planned.

differenceBudgetPrognosisAmount null number
The amount difference between budget and prognosis.

resultBudgetAmount null number
The resulting budget amount.

resultInterimAmount null number
The interim result amount.

resultEndAmount null number
The end result amount.

totalBudgetAmount number
The total budget amount.

totalPrognosisAmount null number
The total prognosis amount.

totalBudgetTermAmount number
The total prognosis term amount.

totalPrognosisTermAmount null number
The total prognosis term amount.

prognosisMovedAmount null number
The moved prognosis amount.

prognosisOtherAmount null number
The amount which is budgeted differently.

prognosisReservedAmount null number
The reserved prognosis amount.

purchaseResultAmount null number
The resulting purchase amount.

additionalWorkAmount null number
The additional work amount.

remarkCount null integer
The amount of comments made on a security code.

id null integer
The ID of the chapter.

CostTypeHourSchema properties

budgetHours number
The budgeted hours.

prognosisHours number
The prognosis hours.

costHours number
The costs in hours (labor hours).

contractCostHours number
The contract costs in hours.

allowedHours number
The allowed hours.

prognosisPlannedHours number
The planned hours.

prognosisToBePlannedHours number
The hours still to be planned.

differenceBudgetPrognosisHours number
The hours difference between budget and prognosis.

resultBudgetHours number
The resulting budget hours.

resultInterimHours number
The interim result hours.

resultEndHours number
The end result hours.

totalPrognosisHours number
The total prognosis hours.

prognosisMovedHours number
The moved prognosis hours.

prognosisOtherHours number
The hours that are budgeted differently.

prognosisReservedHours null number
The reserved prognosis hours.

additionalWorkHours null number
The additional work hours.

Parameters

project_id integer
The parameter 'Project Id' is required in the path.

cost_type CostTypeEnum
The parameter '' is required in the path.

include_subprojects boolean
The parameter 'Include Subprojects' is not required in the query.

q string
The parameter 'Q' is not required in the query.

Sample JSON (output)

{
    "count": 1,
    "limit": 1,
    "offset": 1,
    "totals": {
        "hourInfo": {
            "budgetHours": 1234.56,
            "prognosisHours": 1234.56,
            "costHours": 1234.56,
            "contractCostHours": 1234.56,
            "allowedHours": 1234.56,
            "prognosisPlannedHours": 1234.56,
            "prognosisToBePlannedHours": 1234.56,
            "differenceBudgetPrognosisHours": 1234.56,
            "resultBudgetHours": 1234.56,
            "resultInterimHours": 1234.56,
            "resultEndHours": 1234.56,
            "totalPrognosisHours": 1234.56,
            "prognosisMovedHours": 1234.56,
            "prognosisOtherHours": 1234.56,
            "prognosisReservedHours": 1234.56,
            "additionalWorkHours": 1234.56
        },
        "code": "test",
        "name": "test",
        "budgetAmount": 1234.56,
        "prognosisAmount": 1234.56,
        "progress": 1234.56,
        "adjustment": 1234.56,
        "status": 0,
        "costAmount": 1234.56,
        "contractCostAmount": 1234.56,
        "termAmount": 1234.56,
        "allowedAmount": 1234.56,
        "prognosisPlannedAmount": 1234.56,
        "prognosisToBePlannedAmount": 1234.56,
        "differenceBudgetPrognosisAmount": 1234.56,
        "resultBudgetAmount": 1234.56,
        "resultInterimAmount": 1234.56,
        "resultEndAmount": 1234.56,
        "totalBudgetAmount": 1234.56,
        "totalPrognosisAmount": 1234.56,
        "totalBudgetTermAmount": 1234.56,
        "totalPrognosisTermAmount": 1234.56,
        "prognosisMovedAmount": 1234.56,
        "prognosisOtherAmount": 1234.56,
        "prognosisReservedAmount": 1234.56,
        "purchaseResultAmount": 1234.56,
        "additionalWorkAmount": 1234.56,
        "remarkCount": 1
    },
    "items": [
        {
            "objectInfo": {
                "hourInfo": {
                    "budgetHours": 1234.56,
                    "prognosisHours": 1234.56,
                    "costHours": 1234.56,
                    "contractCostHours": 1234.56,
                    "allowedHours": 1234.56,
                    "prognosisPlannedHours": 1234.56,
                    "prognosisToBePlannedHours": 1234.56,
                    "differenceBudgetPrognosisHours": 1234.56,
                    "resultBudgetHours": 1234.56,
                    "resultInterimHours": 1234.56,
                    "resultEndHours": 1234.56,
                    "totalPrognosisHours": 1234.56,
                    "prognosisMovedHours": 1234.56,
                    "prognosisOtherHours": 1234.56,
                    "prognosisReservedHours": 1234.56,
                    "additionalWorkHours": 1234.56
                },
                "code": "test",
                "name": "test",
                "budgetAmount": 1234.56,
                "prognosisAmount": 1234.56,
                "progress": 1234.56,
                "adjustment": 1234.56,
                "status": 0,
                "costAmount": 1234.56,
                "contractCostAmount": 1234.56,
                "termAmount": 1234.56,
                "allowedAmount": 1234.56,
                "prognosisPlannedAmount": 1234.56,
                "prognosisToBePlannedAmount": 1234.56,
                "differenceBudgetPrognosisAmount": 1234.56,
                "resultBudgetAmount": 1234.56,
                "resultInterimAmount": 1234.56,
                "resultEndAmount": 1234.56,
                "totalBudgetAmount": 1234.56,
                "totalPrognosisAmount": 1234.56,
                "totalBudgetTermAmount": 1234.56,
                "totalPrognosisTermAmount": 1234.56,
                "prognosisMovedAmount": 1234.56,
                "prognosisOtherAmount": 1234.56,
                "prognosisReservedAmount": 1234.56,
                "purchaseResultAmount": 1234.56,
                "additionalWorkAmount": 1234.56,
                "remarkCount": 1,
                "id": 1
            },
            "chapters": [
                {
                    "chapterInfo": {
                        "hourInfo": {
                            "budgetHours": 1234.56,
                            "prognosisHours": 1234.56,
                            "costHours": 1234.56,
                            "contractCostHours": 1234.56,
                            "allowedHours": 1234.56,
                            "prognosisPlannedHours": 1234.56,
                            "prognosisToBePlannedHours": 1234.56,
                            "differenceBudgetPrognosisHours": 1234.56,
                            "resultBudgetHours": 1234.56,
                            "resultInterimHours": 1234.56,
                            "resultEndHours": 1234.56,
                            "totalPrognosisHours": 1234.56,
                            "prognosisMovedHours": 1234.56,
                            "prognosisOtherHours": 1234.56,
                            "prognosisReservedHours": 1234.56,
                            "additionalWorkHours": 1234.56
                        },
                        "code": "test",
                        "name": "test",
                        "budgetAmount": 1234.56,
                        "prognosisAmount": 1234.56,
                        "progress": 1234.56,
                        "adjustment": 1234.56,
                        "status": 0,
                        "costAmount": 1234.56,
                        "contractCostAmount": 1234.56,
                        "termAmount": 1234.56,
                        "allowedAmount": 1234.56,
                        "prognosisPlannedAmount": 1234.56,
                        "prognosisToBePlannedAmount": 1234.56,
                        "differenceBudgetPrognosisAmount": 1234.56,
                        "resultBudgetAmount": 1234.56,
                        "resultInterimAmount": 1234.56,
                        "resultEndAmount": 1234.56,
                        "totalBudgetAmount": 1234.56,
                        "totalPrognosisAmount": 1234.56,
                        "totalBudgetTermAmount": 1234.56,
                        "totalPrognosisTermAmount": 1234.56,
                        "prognosisMovedAmount": 1234.56,
                        "prognosisOtherAmount": 1234.56,
                        "prognosisReservedAmount": 1234.56,
                        "purchaseResultAmount": 1234.56,
                        "additionalWorkAmount": 1234.56,
                        "remarkCount": 1,
                        "id": 1
                    },
                    "securityCodes": [
                        {
                            "hourInfo": {
                                "budgetHours": 1234.56,
                                "prognosisHours": 1234.56,
                                "costHours": 1234.56,
                                "contractCostHours": 1234.56,
                                "allowedHours": 1234.56,
                                "prognosisPlannedHours": 1234.56,
                                "prognosisToBePlannedHours": 1234.56,
                                "differenceBudgetPrognosisHours": 1234.56,
                                "resultBudgetHours": 1234.56,
                                "resultInterimHours": 1234.56,
                                "resultEndHours": 1234.56,
                                "totalPrognosisHours": 1234.56,
                                "prognosisMovedHours": 1234.56,
                                "prognosisOtherHours": 1234.56,
                                "prognosisReservedHours": 1234.56,
                                "additionalWorkHours": 1234.56
                            },
                            "code": "test",
                            "name": "test",
                            "budgetAmount": 1234.56,
                            "prognosisAmount": 1234.56,
                            "progress": 1234.56,
                            "adjustment": 1234.56,
                            "status": 0,
                            "costAmount": 1234.56,
                            "contractCostAmount": 1234.56,
                            "termAmount": 1234.56,
                            "allowedAmount": 1234.56,
                            "prognosisPlannedAmount": 1234.56,
                            "prognosisToBePlannedAmount": 1234.56,
                            "differenceBudgetPrognosisAmount": 1234.56,
                            "resultBudgetAmount": 1234.56,
                            "resultInterimAmount": 1234.56,
                            "resultEndAmount": 1234.56,
                            "totalBudgetAmount": 1234.56,
                            "totalPrognosisAmount": 1234.56,
                            "totalBudgetTermAmount": 1234.56,
                            "totalPrognosisTermAmount": 1234.56,
                            "prognosisMovedAmount": 1234.56,
                            "prognosisOtherAmount": 1234.56,
                            "prognosisReservedAmount": 1234.56,
                            "purchaseResultAmount": 1234.56,
                            "additionalWorkAmount": 1234.56,
                            "remarkCount": 1,
                            "pslIds": [
                                1
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}

Enums

ProjectSecurityLinkStatusEnum

Describes the status of a ProjectSecurityLink

0 to_do
1 in_progress
2 complete
3 in_house
4 year_contract
5 free_to_spend

CostTypeEnum

Describes the standard cost types.

1 labor
2 purchase_order
3 subcontracting
4 equipment
5 material
6 garbage
7 remaining