getProjectFinancial

Get the financial data for a project.

    GET /project-financial/{project_id}

ProjectFinancialSchema properties

costs ProjectFinancialCostsSchema
The costs per cost type.

tailCosts ProjectFinancialTailCostsSchema
The tail costs.

fixedPrice ProjectFinancialPostsSchema
The fixed price amount.

additionalWork ProjectFinancialPostsSchema
The additional work amount.

provisionalCosts ProjectFinancialPostsSchema
The estimate amount.

revenue ProjectFinancialPostsSchema
The total revenue.

result ProjectFinancialPostsSchema
The result amount.

generalCostsProfit ProjectFinancialPostsSchema
The general costs profit amount.

ProjectFinancialCostsSchema properties

labor ProjectFinancialPostsSchema
The labor amount.

purchaseOrder ProjectFinancialPostsSchema
The purchase order amount.

subcontracting ProjectFinancialPostsSchema
The subcontracting amount.

equipment ProjectFinancialPostsSchema
The equipment amount.

material ProjectFinancialPostsSchema
The material amount.

waste ProjectFinancialPostsSchema
The waste amount.

total ProjectFinancialPostsSchema
The total amount.

ProjectFinancialTailCostsSchema properties

profitOrLoss ProjectFinancialPostsSchema
The profit or loss amount.

general ProjectFinancialPostsSchema
The general costs.

total ProjectFinancialPostsSchema
The total costs including tail costs.

ProjectFinancialPostsSchema properties

budgeted number
The budgeted amount.

prognosis number
The prognosis amount.

realised number
The realised amount.

unprocessed number
The unprocessed amount.

openTerms number
The open terms amount.

expected number
The expected amount.

Parameters

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

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

Sample JSON (output)

{
    "costs": {
        "labor": {
            "budgeted": 1234.56,
            "prognosis": 1234.56,
            "realised": 1234.56,
            "unprocessed": 1234.56,
            "openTerms": 1234.56,
            "expected": 1234.56
        },
        "purchaseOrder": {
            "budgeted": 1234.56,
            "prognosis": 1234.56,
            "realised": 1234.56,
            "unprocessed": 1234.56,
            "openTerms": 1234.56,
            "expected": 1234.56
        },
        "subcontracting": {
            "budgeted": 1234.56,
            "prognosis": 1234.56,
            "realised": 1234.56,
            "unprocessed": 1234.56,
            "openTerms": 1234.56,
            "expected": 1234.56
        },
        "equipment": {
            "budgeted": 1234.56,
            "prognosis": 1234.56,
            "realised": 1234.56,
            "unprocessed": 1234.56,
            "openTerms": 1234.56,
            "expected": 1234.56
        },
        "material": {
            "budgeted": 1234.56,
            "prognosis": 1234.56,
            "realised": 1234.56,
            "unprocessed": 1234.56,
            "openTerms": 1234.56,
            "expected": 1234.56
        },
        "waste": {
            "budgeted": 1234.56,
            "prognosis": 1234.56,
            "realised": 1234.56,
            "unprocessed": 1234.56,
            "openTerms": 1234.56,
            "expected": 1234.56
        },
        "total": {
            "budgeted": 1234.56,
            "prognosis": 1234.56,
            "realised": 1234.56,
            "unprocessed": 1234.56,
            "openTerms": 1234.56,
            "expected": 1234.56
        }
    },
    "tailCosts": {
        "profitOrLoss": {
            "budgeted": 1234.56,
            "prognosis": 1234.56,
            "realised": 1234.56,
            "unprocessed": 1234.56,
            "openTerms": 1234.56,
            "expected": 1234.56
        },
        "general": {
            "budgeted": 1234.56,
            "prognosis": 1234.56,
            "realised": 1234.56,
            "unprocessed": 1234.56,
            "openTerms": 1234.56,
            "expected": 1234.56
        },
        "total": {
            "budgeted": 1234.56,
            "prognosis": 1234.56,
            "realised": 1234.56,
            "unprocessed": 1234.56,
            "openTerms": 1234.56,
            "expected": 1234.56
        }
    },
    "fixedPrice": {
        "budgeted": 1234.56,
        "prognosis": 1234.56,
        "realised": 1234.56,
        "unprocessed": 1234.56,
        "openTerms": 1234.56,
        "expected": 1234.56
    },
    "additionalWork": {
        "budgeted": 1234.56,
        "prognosis": 1234.56,
        "realised": 1234.56,
        "unprocessed": 1234.56,
        "openTerms": 1234.56,
        "expected": 1234.56
    },
    "provisionalCosts": {
        "budgeted": 1234.56,
        "prognosis": 1234.56,
        "realised": 1234.56,
        "unprocessed": 1234.56,
        "openTerms": 1234.56,
        "expected": 1234.56
    },
    "revenue": {
        "budgeted": 1234.56,
        "prognosis": 1234.56,
        "realised": 1234.56,
        "unprocessed": 1234.56,
        "openTerms": 1234.56,
        "expected": 1234.56
    },
    "result": {
        "budgeted": 1234.56,
        "prognosis": 1234.56,
        "realised": 1234.56,
        "unprocessed": 1234.56,
        "openTerms": 1234.56,
        "expected": 1234.56
    },
    "generalCostsProfit": {
        "budgeted": 1234.56,
        "prognosis": 1234.56,
        "realised": 1234.56,
        "unprocessed": 1234.56,
        "openTerms": 1234.56,
        "expected": 1234.56
    }
}

Enums