Create a project

post https://www.ruddr.io/api/workspace/projects

Body Params

key

string

The slug for the project, will be autogenerated from the name property if not provided.

name

string

required

The name of the project (max 255 chars).

clientId

string

required

The client ID (uuid) for this project.

billingTypeId

string

required

The billing type for the project. Can be either "tm" (Time & Materials), "fixed" (Fixed Fee), "fixed_recurring" (Fixed Monthly), or "non_billable" (Non-Billable).

projectAdminId

string

required

The initial project admin for this project. Should be a member ID (uuid). All projects are required to have at least one project admin.

notes

string

Any notes about the project (max 5000 chars).

statusId

string

The project status. Can be: "tentative" (Tentative), "not_started" (Not Started), "in_progress" (In Progress), "paused" (Paused), or "completed" (Completed).

recordStatusId

string

The status of the project. Possible values are: "active" (Active) or "archived" (Archived).

start

date

The start date (YYYY-MM-DD) of the task, must come on or before end date if set.

end

date

The end date (YYYY-MM-DD) of the task, must come on or after the start date if set.

code

string

The project code (max 255 chars).

poNumber

string

The purchase order number (max 255 chars).

currency

string

The 3-letter currency code associated with the project. Will default to the client or workspace setting if not supplied.

revenueRecognitionMethod

string

The revenue recognition method. Will only be used if the billingTypeId is set to "fixed" or "fixed_recurring". Possible values are "invoiced" (As Invoiced) or "manual" (Manual).

useRoles

boolean

Flag to determine if the project should use roles.

requiresNotes

boolean

Flag to determine if time entries recorded against the project are required to enter notes.

requiresTasks

boolean

Flag to determine if time entries recorded against the project are required to select a task.

practiceId

string

The practice ID (uuid) for this project.

projectTypeId

string

The project type ID (uuid) as defined in the custom data.

tagIds

array of strings

A list of project tag IDs (uuid) associated with this project.

tagIds

useBudget

boolean

Flag to determine if the project should have a budget.

budgetMode

string

The budget mode. Only used if useBudget is set to true. Possible values are "summary" (Summary budget), "detailed" (Detailed budget), or "aggregated" (Detailed budget aggregated from tasks).

budgetServiceRevenue

float

The amount of services revenue in the budget. Only used if useBudget is set to true.

budgetBillableHours

float

The number of billable hours to budget. This will only get used if useBudget is true and budgetMode is "summary".

budgetNonBillableHours

float

The number of non-billable hours to budget. This will only get used if useBudget is true and budgetMode is "summary".

budgetExpensesBillableAmount

float

The amount of billable expenses to budget. This will only get used if useBudget is true and budgetMode is "summary".

budgetExpensesNonBillableAmount

float

The amount of non-billable expenses to budget. This will only get used if useBudget is true and budgetMode is "summary".

budgetOtherItemsAmount

float

The amount of "other items" to budget for. This will only get used if useBudget is true and budgetMode is "summary".

useMonthlyBudget

boolean

Flag to determine if the project should have a monthly budget.

monthlyBudgetMode

string

The monthly budget mode. Only available if useMonthlyBudget is set to true. Possible values are "summary" (Summary budget) or "detailed" (Detailed budget).

monthlyBudgetServiceRevenue

float

The amount of services revenue in the monthly budget. Only used if useMonthlyBudget is set to true.

monthlyBudgetBillableHours

float

The number of billable hours in the monthly budget. This will only get used if useMonthlyBudget is true and monthlyBudgetMode is "summary".

monthlyBudgetNonBillableHours

float

The number of non-billable hours in the monthly budget. This will only get used if useMonthlyBudget is true and monthlyBudgetMode is "summary".

monthlyBudgetExpensesBillableAmount

float

The amount of billable expenses in the monthly budget. This will only get used if useMonthlyBudget is true and monthlyBudgetMode is "summary".

monthlyBudgetExpensesNonBillableAmount

float

The amount of non-billable expenses in the monthly budget. This will only get used if useMonthlyBudget is true and monthlyBudgetMode is "summary".

monthlyBudgetOtherItemsAmount

float

The amount of "other items" in the monthly budget. This will only get used if useMonthlyBudget is true and monthlyBudgetMode is "summary".

Responses

200200

400400