Create a project

curl --request POST \
  --url https://{your-workspace}.neetoinvoice.com/api/external/v1/projects \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "project": {
    "name": "Website Redesign Initiative",
    "client_id": "5a2de667-243b-4da3-b090-b698a03d98da",
    "billing_method": "hourly_project_rate",
    "tasks_attributes": [
      {
        "name": "UI Design Phase",
        "billable": true,
        "hourly_rate": 85,
        "checklists_attributes": [
          {
            "description": "Review wireframe mockups"
          }
        ]
      }
    ],
    "hourly_rate": 75.5,
    "currency": "USD",
    "flat_amount": 5000,
    "internal_notes": "This is a priority project with tight deadlines",
    "time_round_upto": 15,
    "autolock_enabled": true,
    "reply_to": "[email protected]",
    "enable_approvals": true,
    "notify_timesheet_approval_request_instantly": false,
    "notify_timesheet_approval_request_weekly": true,
    "timesheet_approval_email_notification_day": "friday",
    "timesheet_approval_email_notification_time": "17:00",
    "autolock_settings": {
      "end_of_the_day": true,
      "end_of_the_week": false,
      "end_of_the_month": false
    },
    "project_users_attributes": [
      {
        "user_id": "f448f61d-0834-455c-b9f2-8a69fe159c16",
        "role": "project_manager",
        "hourly_rate": 75.5,
        "approval_type": "manual_approval"
      }
    ]
  },
  "email": "[email protected]"
}
'

{
  "notice_code": "<string>",
  "project": {
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "identifier": "<string>",
    "billing_method": "<string>",
    "hourly_rate": 123,
    "flat_amount": "<string>",
    "status": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "last_invoice_id": "<string>",
    "internal_notes": "<string>",
    "time_round_upto": 123,
    "autolock_enabled": true,
    "autolock_settings": {
      "end_of_the_day": "<string>",
      "end_of_the_week": "<string>",
      "end_of_the_month": "<string>"
    },
    "currency": "<string>",
    "reply_to": "[email protected]",
    "enable_approvals": true,
    "notify_timesheet_approval_request_instantly": true,
    "timesheet_approval_email_notification_day": "<string>",
    "timesheet_approval_email_notification_time": "<string>"
  }
}

POST

projects

Create a project

curl --request POST \
  --url https://{your-workspace}.neetoinvoice.com/api/external/v1/projects \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "project": {
    "name": "Website Redesign Initiative",
    "client_id": "5a2de667-243b-4da3-b090-b698a03d98da",
    "billing_method": "hourly_project_rate",
    "tasks_attributes": [
      {
        "name": "UI Design Phase",
        "billable": true,
        "hourly_rate": 85,
        "checklists_attributes": [
          {
            "description": "Review wireframe mockups"
          }
        ]
      }
    ],
    "hourly_rate": 75.5,
    "currency": "USD",
    "flat_amount": 5000,
    "internal_notes": "This is a priority project with tight deadlines",
    "time_round_upto": 15,
    "autolock_enabled": true,
    "reply_to": "[email protected]",
    "enable_approvals": true,
    "notify_timesheet_approval_request_instantly": false,
    "notify_timesheet_approval_request_weekly": true,
    "timesheet_approval_email_notification_day": "friday",
    "timesheet_approval_email_notification_time": "17:00",
    "autolock_settings": {
      "end_of_the_day": true,
      "end_of_the_week": false,
      "end_of_the_month": false
    },
    "project_users_attributes": [
      {
        "user_id": "f448f61d-0834-455c-b9f2-8a69fe159c16",
        "role": "project_manager",
        "hourly_rate": 75.5,
        "approval_type": "manual_approval"
      }
    ]
  },
  "email": "[email protected]"
}
'

{
  "notice_code": "<string>",
  "project": {
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "identifier": "<string>",
    "billing_method": "<string>",
    "hourly_rate": 123,
    "flat_amount": "<string>",
    "status": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "last_invoice_id": "<string>",
    "internal_notes": "<string>",
    "time_round_upto": 123,
    "autolock_enabled": true,
    "autolock_settings": {
      "end_of_the_day": "<string>",
      "end_of_the_week": "<string>",
      "end_of_the_month": "<string>"
    },
    "currency": "<string>",
    "reply_to": "[email protected]",
    "enable_approvals": true,
    "notify_timesheet_approval_request_instantly": true,
    "timesheet_approval_email_notification_day": "<string>",
    "timesheet_approval_email_notification_time": "<string>"
  }
}

Replace {your-workspace} with your workspace’s subdomain.
Learn how to find your subdomain in Identifying your subdomain.

Headers

X-Api-Key

string

default:your-api-key

required

X-Api-Key is used to authenticate requests using an API key. Provide your API key in this header to access protected endpoints. Refer to Authentication for more information.

Body

application/json

project

object

required

Hide child attributes

project.name

string

required

Name of the project.

Example:

"Website Redesign Initiative"

project.client_id

string<uuid>

required

Unique identifier for the client.

Example:

"5a2de667-243b-4da3-b090-b698a03d98da"

project.billing_method

enum<string>

required

The billing strategy used for the project.

Available options:

hourly_project_rate,

hourly_person_rate,

hourly_task_rate,

fixed_price_project

project.tasks_attributes

object[]

required

List of tasks to create in the project.

Hide child attributes

project.tasks_attributes.name

string

Name of the task.

Example:

"UI Design Phase"

project.tasks_attributes.billable

boolean

Whether the task is billable.

Example:

true

project.tasks_attributes.hourly_rate

number | null

Hourly rate for the task.

Example:

85

project.tasks_attributes.checklists_attributes

object[]

Checklist items for the task.

Hide child attributes

project.tasks_attributes.checklists_attributes.description

string

Description of the checklist item.

Example:

"Review wireframe mockups"

project.hourly_rate

number | null

Hourly rate for the project. Required if billing_method is 'hourly_project_rate'.

Example:

75.5

project.currency

string

Currency used for billing.

Example:

"USD"

project.flat_amount

number | null

Fixed amount for the project. Required if billing_method is 'fixed_price_project'.

Example:

5000

project.internal_notes

string

Internal notes about the project.

Example:

"This is a priority project with tight deadlines"

project.time_round_upto

enum<integer>

Time rounding configuration in minutes.

Available options:

0,

6,

15,

30

Example:

15

project.autolock_enabled

boolean

Whether automatic time entry locking is enabled.

Example:

true

project.reply_to

string<email>

Reply-to email address for project communications.

Example:

"[email protected]"

project.enable_approvals

boolean

Whether timesheet approvals are required.

Example:

true

project.notify_timesheet_approval_request_instantly

boolean

Send instant notifications for approval requests.

Example:

false

project.notify_timesheet_approval_request_weekly

boolean

Send weekly notifications for approval requests.

Example:

true

project.timesheet_approval_email_notification_day

enum<string>

Day of the week for weekly approval notifications.

Available options:

sunday,

monday,

tuesday,

wednesday,

thursday,

friday,

saturday

Example:

"friday"

project.timesheet_approval_email_notification_time

string

Time of day for weekly approval notifications (24-hour format).

Example:

"17:00"

project.autolock_settings

object

Configuration to automatically lock time entries.

Hide child attributes

project.autolock_settings.end_of_the_day

boolean

Lock time entries at the end of each day.

Example:

true

project.autolock_settings.end_of_the_week

boolean

Lock time entries at the end of each week.

Example:

false

project.autolock_settings.end_of_the_month

boolean

Lock time entries at the end of each month.

Example:

false

project.project_users_attributes

object[]

Users assigned to the project along with their roles.

Hide child attributes

project.project_users_attributes.user_id

string<uuid>

Unique ID of the user. Refer to Getting the User ID section for detailed instructions.

Example:

"f448f61d-0834-455c-b9f2-8a69fe159c16"

project.project_users_attributes.role

enum<string>

Role of the user in the project.

Available options:

project_manager,

regular_user

Example:

"project_manager"

project.project_users_attributes.hourly_rate

number | null

Hourly rate for user.

Example:

75.5

project.project_users_attributes.approval_type

enum<string>

Approval type for timesheet submissions.

Available options:

manual_approval,

auto_approval

Example:

"manual_approval"

string<email>

required

Email of the user creating the project. Required for authentication and user identification.

Example:

"[email protected]"

Response

200 - application/json

OK - Project created successfully

notice_code

string

project

object

Hide child attributes

project.name

string

project.created_at

string<date-time>

project.updated_at

string<date-time>

project.identifier

string

project.billing_method

string

project.hourly_rate

number<float> | null

project.flat_amount

string

project.status

string

project.id

string<uuid>

project.client_id

string<uuid>

project.last_invoice_id

string | null

project.internal_notes

string

project.time_round_upto

integer

project.autolock_enabled

boolean

project.autolock_settings

object

Hide child attributes

project.autolock_settings.end_of_the_day

string

project.autolock_settings.end_of_the_week

string

project.autolock_settings.end_of_the_month

string

project.currency

string

project.reply_to

string<email>

project.enable_approvals

boolean

project.notify_timesheet_approval_request_instantly

boolean

project.timesheet_approval_email_notification_day

string

project.timesheet_approval_email_notification_time

string

Delete recipient Get project details

⌘I

Getting Started

Clients API

Recipients API

Projects API

Project Users API

Team Members API

Time Entry API

Invoices API

Create a project

Headers

Body

Response