Project health report object

Allows to score a project's health with respect to the budget, schedule, client satisfaction, and team satisfaction.

Example

{
      "id": "caecbed5-064c-4e4a-a2dc-125051a82b93",
      "date": "2024-06-07",
      "createdAt": "2024-06-13T13:16:08.352Z",
      "useBudget": true,
      "budgetHealthId": "fair",
      "budgetHealthNotes": "As of now, we are projecting to miss our gross margin goal by 3.5%. We will make efforts to increase efficiency in the final months of this project.",
      "clientSatisfactionId": "excellent",
      "clientSatisfactionNotes": "The client is extremely happy with both our effort and our work product. We have received numerous compliments on the pace of delivery and overall quality of service.",
      "scheduleHealthId": "excellent",
      "scheduleHealthNotes": "The team has been working an average of 15 additional hours per week in order to catch up on our work plan. We are now predicting that we will deliver the project two weeks earlier than plan.",
      "teamSatisfactionId": "poor",
      "teamSatisfactionNotes": "Working the team 10 hours per day.",
      "score": 9,
      "billableHours": 1777.83,
      "budgetBillableHours": 2475,
      "budgetExpensesCost": 8500,
      "budgetExpensesRevenue": 6500,
      "budgetInternalHours": null,
      "budgetNonBillableHours": 120,
      "budgetServicesCost": 210665,
      "budgetServicesGrossMargin": 0.48,
      "budgetServicesGrossProfit": 194460,
      "budgetServicesRevenue": 405125,
      "budgetTotalCost": 219165,
      "budgetTotalGrossMargin": 0.498,
      "budgetTotalGrossProfit": 217460,
      "budgetTotalHours": 2595,
      "budgetTotalRevenue": 436625,
      "expensesCost": 14756.48,
      "expensesRevenue": 13836.9,
      "internalHours": null,
      "nonBillableHours": 49,
      "servicesCost": 156547.96,
      "servicesGrossMargin": 0.4742,
      "servicesGrossProfit": 141205.64,
      "servicesRevenue": 297753.6,
      "totalCost": 171304.44,
      "totalGrossMargin": 0.4985,
      "totalGrossProfit": 170286.06,
      "totalHours": 1826.83,
      "totalRevenue": 341590.5,
      "notes": null,
      "createdBy": {
        "id": "db010cff-a6f6-4c4e-8160-b6b7562865ff",
        "name": "Cameron Howe"
      },
      "modifiedBy": {
        "id": "db010cff-a6f6-4c4e-8160-b6b7562865ff",
        "name": "Cameron Howe"
      },
      "project": {
        "id": "fb0f9e5e-487e-406e-8d14-344c7bec70ad",
        "name": "Shopify Store Development",
        "client": {
          "id": "d5afaffe-09e5-4d73-b02c-905b40fc6c22",
          "name": "Acme Company"
        }
      }
}

Attributes

NameTypeDescription
iduuidThe unique identifier for the object.
datedateThe date of the item. Will be in the form YYYY-MM-DD.
createdAttimestampThe timestamp when the object was created.
useBudgetbooleanFlag to indicate if the budget is being used.
budgetHealthIdstringThe health status of the budget. Can be either "excellent", "fair" or "poor".
budgetHealthNotesstringNotes providing details about the budget health.
clientSatisfactionIdstringThe client's satisfaction status. Can be either "excellent", "fair" or "poor".
clientSatisfactionNotesstringNotes providing details about client satisfaction.
scheduleHealthIdstringThe health status of the schedule. Can be either "excellent", "fair" or "poor".
scheduleHealthNotesstringNotes providing details about the schedule health.
teamSatisfactionIdstringThe team's satisfaction status. Can be either "excellent", "fair" or "poor".
teamSatisfactionNotesstringNotes providing details about the team's satisfaction.
scorenumberThe overall score for the object.
billableHoursnumberThe total number of billable hours.
budgetBillableHoursnumberThe budgeted number of billable hours.
budgetExpensesCostnumberThe budgeted cost of expenses.
budgetExpensesRevenuenumberThe budgeted revenue from expenses.
budgetInternalHoursnumberThe budgeted internal hours.
budgetNonBillableHoursnumberThe budgeted number of non-billable hours.
budgetServicesCostnumberThe budgeted cost of services.
budgetServicesGrossMarginnumberThe budgeted gross margin for services.
budgetServicesGrossProfitnumberThe budgeted gross profit from services.
budgetServicesRevenuenumberThe budgeted revenue from services.
budgetTotalCostnumberThe total budgeted cost.
budgetTotalGrossMarginnumberThe total budgeted gross margin.
budgetTotalGrossProfitnumberThe total budgeted gross profit.
budgetTotalHoursnumberThe total budgeted hours.
budgetTotalRevenuenumberThe total budgeted revenue.
expensesCostnumberThe cost of expenses.
expensesRevenuenumberThe revenue from expenses.
internalHoursnumberThe number of internal hours.
nonBillableHoursnumberThe number of non-billable hours.
servicesCostnumberThe cost of services.
servicesGrossMarginnumberThe gross margin for services.
servicesGrossProfitnumberThe gross profit from services.
servicesRevenuenumberThe revenue from services.
totalCostnumberThe total cost.
totalGrossMarginnumberThe total gross margin.
totalGrossProfitnumberThe total gross profit.
totalHoursnumberThe total hours.
totalRevenuenumberThe total revenue.
notesstringA general commentary for the health report.
createdByobjectThe member who created the health report, including id and name attributes. See attributes.
modifiedByobjectThe member who last modified the health report, including id and name attributes. See attributes.
projectobjectThe related project, including id, name, and a client object with id and name attributes. See attributes.

Member attributes

NameTypeDescription
iduuidThe unique identifier for the object.
namestringThe name of the member.

Project attributes

NameTypeDescription
iduuidThe unique identifier for the object.
namestringThe name of the project.
clientobjectA simple object to the related client. See attributes.

Client attributes

NameTypeDescription
iduuidThe unique identifier for the object.
namestringThe name of the client.