Update project

Update a project

curl --request PATCH \
  --url https://{your-subdomain}.neetoinvoice.com/api/external/v1/projects/{project_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "project": {
    "name": "Updated Website Redesign Initiative",
    "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": "project-manager@example.com",
    "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
    },
    "tasks_attributes": [
      {
        "id": "65603092-9418-4f55-9d54-e0fe4b8b1c79",
        "name": "Updated UI Design Phase",
        "billable": true,
        "hourly_rate": 85,
        "checklists_attributes": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "description": "Review wireframe mockups"
          }
        ]
      }
    ]
  },
  "email": "john@example.com"
}
'

const options = {
  method: 'PATCH',
  headers: {'X-Api-Key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    project: {
      name: 'Updated Website Redesign Initiative',
      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: 'project-manager@example.com',
      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},
      tasks_attributes: [
        {
          id: '65603092-9418-4f55-9d54-e0fe4b8b1c79',
          name: 'Updated UI Design Phase',
          billable: true,
          hourly_rate: 85,
          checklists_attributes: [
            {
              id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
              description: 'Review wireframe mockups'
            }
          ]
        }
      ]
    },
    email: 'john@example.com'
  })
};

fetch('https://{your-subdomain}.neetoinvoice.com/api/external/v1/projects/{project_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{your-subdomain}.neetoinvoice.com/api/external/v1/projects/{project_id}"

payload = {
    "project": {
        "name": "Updated Website Redesign Initiative",
        "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": "project-manager@example.com",
        "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
        },
        "tasks_attributes": [
            {
                "id": "65603092-9418-4f55-9d54-e0fe4b8b1c79",
                "name": "Updated UI Design Phase",
                "billable": True,
                "hourly_rate": 85,
                "checklists_attributes": [
                    {
                        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                        "description": "Review wireframe mockups"
                    }
                ]
            }
        ]
    },
    "email": "john@example.com"
}
headers = {
    "X-Api-Key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "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": "jsmith@example.com",
    "enable_approvals": true,
    "notify_timesheet_approval_request_instantly": true,
    "timesheet_approval_email_notification_day": "<string>",
    "timesheet_approval_email_notification_time": "<string>"
  }
}

PATCH

projects

{project_id}

Update a project

curl --request PATCH \
  --url https://{your-subdomain}.neetoinvoice.com/api/external/v1/projects/{project_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "project": {
    "name": "Updated Website Redesign Initiative",
    "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": "project-manager@example.com",
    "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
    },
    "tasks_attributes": [
      {
        "id": "65603092-9418-4f55-9d54-e0fe4b8b1c79",
        "name": "Updated UI Design Phase",
        "billable": true,
        "hourly_rate": 85,
        "checklists_attributes": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "description": "Review wireframe mockups"
          }
        ]
      }
    ]
  },
  "email": "john@example.com"
}
'

const options = {
  method: 'PATCH',
  headers: {'X-Api-Key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    project: {
      name: 'Updated Website Redesign Initiative',
      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: 'project-manager@example.com',
      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},
      tasks_attributes: [
        {
          id: '65603092-9418-4f55-9d54-e0fe4b8b1c79',
          name: 'Updated UI Design Phase',
          billable: true,
          hourly_rate: 85,
          checklists_attributes: [
            {
              id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
              description: 'Review wireframe mockups'
            }
          ]
        }
      ]
    },
    email: 'john@example.com'
  })
};

fetch('https://{your-subdomain}.neetoinvoice.com/api/external/v1/projects/{project_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{your-subdomain}.neetoinvoice.com/api/external/v1/projects/{project_id}"

payload = {
    "project": {
        "name": "Updated Website Redesign Initiative",
        "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": "project-manager@example.com",
        "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
        },
        "tasks_attributes": [
            {
                "id": "65603092-9418-4f55-9d54-e0fe4b8b1c79",
                "name": "Updated UI Design Phase",
                "billable": True,
                "hourly_rate": 85,
                "checklists_attributes": [
                    {
                        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                        "description": "Review wireframe mockups"
                    }
                ]
            }
        ]
    },
    "email": "john@example.com"
}
headers = {
    "X-Api-Key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "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": "jsmith@example.com",
    "enable_approvals": true,
    "notify_timesheet_approval_request_instantly": true,
    "timesheet_approval_email_notification_day": "<string>",
    "timesheet_approval_email_notification_time": "<string>"
  }
}

Deprecated: This is a v1 endpoint and is deprecated. Please use the v2 API instead. v1 endpoints will be removed in a future release.

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

Headers

X-Api-Key

string

default:your-api-key

required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Path Parameters

project_id

string

required

Unique ID of the project for which you want to retrieve or update details. Refer to Getting the Project ID section for detailed instructions.

Body

application/json

project

object

required

Hide child attributes

project.name

string

Name of the project.

Example:

"Updated Website Redesign Initiative"

project.hourly_rate

number | null

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

Example:

75.5

project.billing_method

enum<string>

The billing strategy used for the project.

Available options:

hourly_project_rate,

hourly_person_rate,

hourly_task_rate,

fixed_price_project

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:

"project-manager@example.com"

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.tasks_attributes

object[]

List of tasks to update in the project.

Hide child attributes

project.tasks_attributes.id

string<uuid>

Existing task ID for updates.

Example:

"65603092-9418-4f55-9d54-e0fe4b8b1c79"

project.tasks_attributes.name

string

Name of the task.

Example:

"Updated 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.id

string<uuid>

Existing checklist item ID for updates.

project.tasks_attributes.checklists_attributes.description

string

Description of the checklist item.

Example:

"Review wireframe mockups"

string<email>

required

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

Example:

"john@example.com"

Response

200 - application/json

OK - Project updated 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

Getting started

Clients

Recipients

Projects

Project users

Team members

Time entries

Invoices

Monthly PTO

Reports

API v1 (deprecated)

Headers

Path Parameters

Body

Response