Creates a new project in Avaza, linked to a customer company. Optionally creates a new company if CompanyName is provided and not matched.
Request body
An ID of a company in Avaza to create the Project under. You must provide either a CompanyID, or a CompanyName
The name for a Company to create the project under. Will create company unless it matches an existing company name
The ISO 3 letter currency code to use when creating a new Company. If not provided, the account's default currency will be used.
The title of the new project. (255 characters max)
Used when Manual Project Codes are enabled
Any descriptive notes about the project. (2000 characters max)
Whether timesheet approval should be required by default for newly added project members.
Defaults to true.
Whether users must select a task when logging time to this project.
Planned start date for the project.
Planned end date for the project.
Monetary budget allocated to the project.
Hours budget allocated to the project.
Project status code. Per-account configurable; default codes are NotStarted, InProgress, Complete, OnHold (seeded for every account); admins may add custom codes. If omitted, the account's default-for-new-projects status is used.
The project category ID, if categorised.
The billing method for the new project. (string, optional) Possible values: CategoryHourly (bill timesheets at per-category hourly rates), NoRate (billable, but no hourly rate is applied), NotBillable (project is not billable), PersonHourly (bill timesheets at per-person hourly rates), ProjectHourly (bill all timesheets at a single project hourly rate). Values are matched case-insensitively; the canonical casing is stored. If omitted, the account's default billing method for new projects is applied (current behaviour). Supplying it requires the Edit Project Configuration permission. When set to ProjectHourly the project is created with its Project Hourly Rate unset — set the rate afterwards via Project Settings or PUT /api/Project; per-person and per-category rates are managed via Project Members and Project Timesheet Categories. Must be NotBillable (or omitted) when the project is created under the account's internal company.
The budget method for the new project. (string, optional) Possible values: CategoryHours (hours budget per timesheet category), NoBudget (no budget), PersonHours (hours budget per person), ProjectFees (total project fee budget, paired with BudgetAmount), ProjectHours (total project hours budget, paired with BudgetHours). Values are matched case-insensitively; the canonical casing is stored. If omitted, the account's default budget method for new projects is applied and BudgetAmount / BudgetHours are stored as provided (current behaviour). Supplying it requires the Edit Project Configuration permission. When supplied, the budget fields are cross-validated: NoBudget rejects a non-zero BudgetAmount or BudgetHours; ProjectFees rejects a non-zero BudgetHours; ProjectHours, PersonHours and CategoryHours reject a non-zero BudgetAmount. Per-person and per-category hour budgets are managed via Project Members and Project Timesheet Categories.
If true, fires the project_created webhook event to any subscribed endpoints. Defaults to false to preserve existing integration behaviour.
Response
Returns the created project with assigned Project ID.
Unique identifier for the project.
Project title/name.
Short reference code for the project.
Project description or notes.
Name of the customer company this project belongs to.
The customer company ID this project is linked to.
User ID of the project owner/manager.
Project status code. Per-account configurable. Default codes (NotStarted, InProgress, Complete, OnHold) are seeded for every account; admins may add custom codes via the Project Statuses settings panel. Codes are unique within an account and stable once created.
Display name of the project status (e.g. "In Progress", "At Risk").
Hex colour assigned to the project status (e.g. "#F0AD4E").
True if this is the account's default-for-new-projects status (one row per account).
True if this status marks the project as complete (one row per account).
Whether the project is archived. Archived projects are hidden from default views.
Possible values: CategoryHourly, NoRate, NotBillable, PersonHourly, ProjectHourly
Possible Values: CategoryHours, NoBudget, PersonHours, ProjectFees, ProjectHours
Monetary budget allocated to the project.
Hours budget allocated to the project.
The project-level hourly rate (when billing type is ProjectHourly).
The project category ID, if categorised.
Name of the project category.
Whether users must select a task when logging time to this project.
The default task type ID used for new tasks in this project.
Name of the default task type.
Html Hex Color Code starting with #
Planned start date for the project.
Planned end date for the project.
Date the project was created.
Date the project was last updated.
URL to view this project in the Avaza web application.