ProjectBudget

A ceiling on what a project may consume — money or hours — and how often it resets.

  • amount
    Type: string
    required

    The budget ceiling as a decimal string — an amount in the project currency when calculation_mode is fee, a number of hours when it is time.

  • calculation_base
    Type: string enum
    required

    What counts against the budget: logged time (billable_time, non_billable_time, billable_and_non_billable_time), billable time plus expenses (billable_time_and_expenses), or expenses alone (expenses).

    values
    • billable_time
    • non_billable_time
    • billable_and_non_billable_time
    • billable_time_and_expenses
    • expenses
  • calculation_mode
    Type: string enum
    required

    What the budget is measured in: fee for money, time for hours.

    values
    • fee
    • time
  • current_cycle
    Type: object · ProjectBudgetCyclenullable
    required

    The cycle running today. A project that has not started yet reports a zeroed cycle over its first window, and one that has ended keeps reporting its last. null only when the project has no start date.

    • closing_date
      Type: string | null Format: date
      required

      Last day the cycle counts, or null when the budget never resets and the project is open-ended.

    • consumed_amount
      Type: string
      required

      How much of the budget this cycle has used, as a decimal string, in the same unit as the budget amount.

    • consumed_percentage
      Type: integer
      required

      How much of the budget this cycle has used, as a whole percentage. Exceeds 100 once the budget is over.

    • opening_date
      Type: string Format: date
      required

      First day the cycle counts.

  • expenses_calculation_base
    Type: string enum
    required

    Which expenses count, when calculation_base includes them: billable, non_billable or all.

    values
    • billable
    • non_billable
    • all
  • id
    Type: integer
    required

    Unique identifier for the budget.

  • over_budget_notification
    Type: string enum
    required

    Whether Bonsai alerts the project team when spending passes over_budget_notification_threshold.

    values
    • enabled
    • disabled
  • over_budget_notification_threshold
    Type: string
    required

    Percentage of the budget that triggers the alert, as a decimal string.

  • reset_frequency
    Type: string enum
    required

    How often the budget starts over. never runs one cycle for the life of the project; the rest open a fresh cycle every weekly, monthly or quarterly period from the project start date.

    values
    • never
    • weekly
    • monthly
    • quarterly