Project

An engagement you deliver for a client. Tasks, logged time and invoices all hang off a project.

  • billing_cycle
    Type: string | nullenum
    required

    How often a retainer bills. null for every other billing type.

    values
    weeklymonthlyquarterlybiannuallyyearlynull
  • billing_fee
    Type: string | null
    required

    The agreed fee as a decimal string, in currency. Set on fixed_fee and retainer projects, null otherwise.

  • billing_type
    Type: string | nullenum
    required

    How the project bills: time (hourly), fixed_fee (a single agreed fee), retainer (a recurring fee) or not_billable.

    values
    timefixed_feeretainernot_billablenull
  • board_group_id
    Type: string | nullFormat: uuid
    required

    Id of the pipeline stage the project's board card sits in, or null when the project is not on a board. Send it to PATCH /public-api/v1/projects/{id} to move the project to another stage.

  • client_or_company_name
    Type: string
    deprecated
    required

    Deprecated — read company_name instead, which carries the same value. This field will be removed in a future release.

  • company_id
    Type: integer | null
    required

    Id of the client company the project is for, or null when the client is not a company record.

  • company_name
    Type: string | null
    required

    Name of the client the project is for, or null.

  • currency
    Type: string
    required

    Three-letter ISO 4217 currency code the project bills in.

  • finish_date
    Type: string | nullFormat: date
    required

    Date work on the project ends, or null when it is open-ended.

  • id
    Type: integer
    required

    Unique identifier for the project.

  • number
    Type: string | null
    required

    Human-readable project reference. null until one has been assigned.

  • public_url_token
    Type: string | null
    required

    Token in the project's client-facing URL. The list endpoint accepts it as filter[public_url_token].

  • sequence
    Type: integer | null
    required

    Counter behind number, incrementing per client. null until a number has been assigned.

  • start_date
    Type: string | nullFormat: date
    required

    Date work on the project starts.

  • title
    Type: string | null
    required

    Project title.

  • url
    Type: string
    required

    Absolute link to the project in the Bonsai app. Share it to send someone straight to the record.

  • budget
    Type: nullable

    The budget tracked against this project, or null when it has none. Omitted entirely when your token cannot see budgets.

    Properties: 9