v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
ProjectManagement > Project

Creates a Project

What does it do?

This creates a new project. By default, the project will be created with the status active.

What body params do you need?
  • name: is mandatory to pass a name of the project.
  • code: optional unique code for the project to be identifiable and searchable.
  • start_date: optional start date for the project. If given must be in iso-8601 format (YYYY-MM-DD).
  • due_date: optional due date for the project. If given must be in iso-8601 format (YYYY-MM-DD).
  • status: a project can have the status active or closed. By default, the project will be created with the status active.
  • employees_assignment: optional param to define the kind of assignation the project has. Its possible values are: [manual, company]. A project can have manual assignation or can be defined to be assigned to the whole company. Defaults to manual.
Who can use it?

Only companies who have enabled the projects_management feature and users with the permission of create projects.

post/api/2026-07-01/resources/project_management/projects

Request body

namestring required

Mandatory to pass a name of the project.

codestring

Optional unique code for the project to be identifiable and searchable.

descriptionstring

Description of the project.

start_datestring

Optional start date for the project. If given must be in iso-8601 format (YYYY-MM-DD).

due_datestring

Optional due date for the project. If given must be in iso-8601 format (YYYY-MM-DD).

statusstring

Project status. Can be active or closed

employees_assignmentstring

Optional param to define the kind of assignation the project has. Can be manual or company

project_adminsstring[]

Array of employee IDs who are project administrators

project_managersstring[]

Array of employee IDs who are project managers

is_billableboolean

Whether the project is billable to clients

fixed_cost_centsinteger

Fixed cost of the project in cents

budget_allocationinteger

Budget allocation in minutes for the project, it's exclusive of the budget_allocation_cents

legal_entity_idstring

The legal entity ID associated with the project

budget_allocation_centsinteger

Budget allocation amount in cents, it's exclusive of the budget_allocation

fee_amount_centsinteger

Fee amount in cents for the project

client_idstring

Client associated to the project, refers to finance/contacts.

Example request

{
  "name": "Project Name",
  "code": "PRO",
  "description": "A comprehensive project to develop and implement a new customer relationship management system",
  "start_date": "2024-10-30",
  "due_date": "2026-01-01",
  "status": "active",
  "employees_assignment": "company",
  "project_admins": [
    "314159"
  ],
  "project_managers": [
    "271828"
  ],
  "is_billable": true,
  "fixed_cost_cents": 50000,
  "budget_allocation": 1200,
  "legal_entity_id": "123",
  "budget_allocation_cents": 100000,
  "fee_amount_cents": 25000,
  "client_id": "1"
}

Response

CREATED

idstring required

The id of the project

namestring required

The name of the project

codestring

The code of the project

descriptionstring

The description of the project

start_datestring

The start date of the project

due_datestring

The end date of the project

status'active' | 'closed' | 'draft' | 'processing' required

The lifecycle status of the project (whether it is still running and can take new charges)

employees_assignment'manual' | 'company' required

How employees get access to the project — manual (hand-picked members) or company (everyone in the company)

inputed_minutesinteger

The total minutes tracked in the project (if requested)

is_billableboolean required

Whether the project's costs can be billed (recharged) to a client

fixed_cost_centsinteger

Total fixed costs in cents

labor_cost_centsinteger

Total labor costs in cents

legal_entity_idstring required

The legal entity id of the project

spending_cost_centsinteger

Total spending costs in cents

client_idstring

The client of the project, refers to finance/contacts.

total_cost_centsinteger

Total Cost in cents

Example response

{
  "id": "314159",
  "name": "Project name",
  "code": "PRO",
  "description": "A comprehensive project to develop and implement a new customer relationship management system",
  "start_date": "2025-01-01",
  "due_date": "2026-01-01",
  "status": "active",
  "employees_assignment": "manual",
  "inputed_minutes": 123,
  "is_billable": true,
  "fixed_cost_cents": 123,
  "labor_cost_cents": 123,
  "legal_entity_id": "123",
  "spending_cost_cents": 123,
  "client_id": "123",
  "total_cost_cents": 123
}