v1

Swagger 2.02026-07-13107162315.5 KB
Project

Creates a new project in Avaza, linked to a customer company. Optionally creates a new company if CompanyName is provided and not matched.

post/api/Project

Request body

CompanyIDFKinteger

An ID of a company in Avaza to create the Project under. You must provide either a CompanyID, or a CompanyName

CompanyNamestring

The name for a Company to create the project under. Will create company unless it matches an existing company name

CurrencyCodestring

The ISO 3 letter currency code to use when creating a new Company. If not provided, the account's default currency will be used.

ProjectTitlestring required

The title of the new project. (255 characters max)

ProjectCodestring

Used when Manual Project Codes are enabled

ProjectNotesstring

Any descriptive notes about the project. (2000 characters max)

TimesheetApprovalRequiredbyDefaultboolean

Whether timesheet approval should be required by default for newly added project members.

PopulateDefaultProjectMembersboolean

Defaults to true.

isTaskRequiredOnTimesheetboolean

Whether users must select a task when logging time to this project.

StartDatestring date-time

Planned start date for the project.

EndDatestring date-time

Planned end date for the project.

BudgetAmountnumber double

Monetary budget allocated to the project.

BudgetHoursnumber double

Hours budget allocated to the project.

ProjectStatusCodestring

Project status. Values: Active, Completed, Pending, Cancelled.

ProjectCategoryIDFKinteger

The project category ID, if categorised.

SendWebhooksboolean

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.

ProjectIDinteger

Unique identifier for the project.

Titlestring

Project title/name.

ProjectCodestring

Short reference code for the project.

Notesstring

Project description or notes.

CompanyNamestring

Name of the customer company this project belongs to.

CompanyIDFKinteger

The customer company ID this project is linked to.

ProjectOwnerUserIDFKinteger

User ID of the project owner/manager.

ProjectStatusCodestring

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.

ProjectStatusNamestring

Display name of the project status (e.g. "In Progress", "At Risk").

ProjectStatusColorstring

Hex colour assigned to the project status (e.g. "#F0AD4E").

ProjectStatusIsNotStartedboolean

True if this is the account's default-for-new-projects status (one row per account).

ProjectStatusIsCompleteboolean

True if this status marks the project as complete (one row per account).

isArchivedboolean

Whether the project is archived. Archived projects are hidden from default views.

ProjectBillableTypeCodestring

Possible values: CategoryHourly, NoRate, NotBillable, PersonHourly, ProjectHourly

ProjectBudgetTypeCodestring

Possible Values: CategoryHours, NoBudget, PersonHours, ProjectFees, ProjectHours

BudgetAmountnumber double

Monetary budget allocated to the project.

BudgetHoursnumber double

Hours budget allocated to the project.

ProjectHourlyRatenumber double

The project-level hourly rate (when billing type is ProjectHourly).

ProjectCategoryIDFKinteger

The project category ID, if categorised.

ProjectCategoryNamestring

Name of the project category.

isTaskRequiredOnTimesheetboolean

Whether users must select a task when logging time to this project.

DefaultAccountTaskTypeIDFKinteger

The default task type ID used for new tasks in this project.

DefaultAccountTaskTypeNamestring

Name of the default task type.

ProjectCategoryColorstring

Html Hex Color Code starting with #

StartDatestring date-time

Planned start date for the project.

EndDatestring date-time

Planned end date for the project.

DateCreatedstring date-time

Date the project was created.

DateUpdatedstring date-time

Date the project was last updated.

ViewProjectURLstring

URL to view this project in the Avaza web application.