项目
项目对象
属性 | 类型 | 描述 |
---|---|---|
id |
整数 | 为项目惟一的ID。 |
客户端 |
对象 | 一个对象包含项目的客户机id,名称,和货币。 |
的名字 |
字符串 | 独特的项目的名称。 |
代码 |
字符串 | 与项目相关的代码。 |
is_active |
布尔 | 项目是否活跃或存档。 |
is_billable |
布尔 | 是否项目计费。 |
is_fixed_fee |
布尔 | 是否这个项目是一个固定费的项目。 |
bill_by |
字符串 | 该方法的项目发票。 |
hourly_rate |
小数 | 每小时工资率率为项目宣传项目。 |
预算 |
小数 | 小时的预算项目预算的时候。 |
budget_by |
字符串 | 项目预算的方法。 |
budget_is_monthly |
布尔 | 每月预算选项重置。 |
notify_when_over_budget |
布尔 | 项目经理是否应该通知当项目超出预算。 |
over_budget_notification_percentage |
小数 | 百分比值用于触发超过预算的电子邮件警报。 |
over_budget_notification_date |
日期 | 去年超过预算日期通知。如果没有发送,这将是null。 |
show_budget_to_all |
布尔 | 选择显示所有员工的项目预算。并不适用于项目总费用的项目。 |
cost_budget |
小数 | 货币为项目预算由资金预算。 |
cost_budget_include_expenses |
布尔 | 选择预算项目总费用项目包括跟踪费用。 |
费 |
小数 | 你计划项目的发票。只使用固定费的项目。 |
笔记 |
字符串 | 项目记录。 |
starts_on |
日期 | 项目开始日期。 |
ends_on |
日期 | 项目将结束日期。 |
created_at |
datetime | 项目创建日期和时间。 |
updated_at |
datetime | 项目最后一次更新的日期和时间。 |
需要的权限
你必须管理员或经理管理项目来与之交互/ v2 /项目
端点。权限不足将导致403年被禁止的
状态码。
列出所有的项目
返回一个项目的列表。返回的项目是按创建日期排序,最近创建的项目首先出现。
响应包含一个对象项目
属性包含一个数组per_page
项目。数组中的每一项都是一个单独的项目对象。如果没有更多的项目,结果数组将是空的。几个额外的分页属性包含在响应简化方法您的项目。
GET / v2 /项目
参数 | 类型 | 描述 |
---|---|---|
is_active |
布尔 | 通过真正的 只返回活动和项目假 返回活动项目。 |
client_id |
整数 | 只返回与给定的项目属于客户ID。 |
updated_since |
datetime | 只返回项目以来,已更新给定的日期和时间。 |
页面 |
整数 | 使用分页的页号。例如,如果您列出请求和收到2000条记录,后续调用可以包括页面= 2 检索列表的下一个页面。(默认值:1) |
per_page |
整数 | 每个页面返回的记录数量。介于1和2000之间。(默认:2000) |
示例请求:
旋度" https://api.habob客服端下载rvestapp.com/v2/projects " \ - h“授权:无记名ACCESS_TOKEN美元”\ - h”Harvest-Account-Id: $ ACCOUNT_ID \ - h“用户代理:MyApp (yourname@example.com)”
示例响应:
检索一个项目
与给定ID检索项目。返回一个对象和一个项目200好了
响应代码提供了一个有效的标识符。
GET / v2 /项目/ {PROJECT_ID}
示例请求:
旋度" https://api.habob客服端下载rvestapp.com/v2/projects/14308069 " \ - h“授权:无记名ACCESS_TOKEN美元”\ - h”Harvest-Account-Id: $ ACCOUNT_ID \ - h“用户代理:MyApp (yourname@example.com)”
示例响应:
创建一个项目
创建一个新项目对象。返回一个对象和一个项目201年创建
响应代码如果调用成功。
POST / v2 /项目
参数 | 类型 | 要求 | 描述 |
---|---|---|---|
client_id |
整数 | 要求 | 客户把这个项目的ID。 |
的名字 |
字符串 | 要求 | 这个项目的名称。 |
代码 |
字符串 | 可选 | 与项目相关的代码。 |
is_active |
布尔 | 可选 | 项目是否活跃或存档。默认为真正的 。 |
is_billable |
布尔 | 要求 | 是否项目计费。 |
is_fixed_fee |
布尔 | 可选 | 是否这个项目是一个固定费的项目。 |
bill_by |
字符串 | 要求 | 该方法的项目发票。选项:项目 ,任务 ,人 ,或没有一个 。 |
hourly_rate |
小数 | 可选 | 每小时工资率率为项目宣传项目。 |
预算 |
小数 | 可选 | 小时的预算项目预算的时候。 |
budget_by |
字符串 | 要求 | 项目预算的方法。选项:项目 (小时/项目),project_cost (项目总费用),任务 (小时/任务),task_fees (每个任务的费用),人 (小时/人),没有一个 (无预算)。 |
budget_is_monthly |
布尔 | 可选 | 每月预算选项重置。默认为假 。 |
notify_when_over_budget |
布尔 | 可选 | 项目经理是否应该通知当项目超出预算。默认为假 。 |
over_budget_notification_percentage |
小数 | 可选 | 百分比值用于触发超过预算的电子邮件警报。示例:使用10.0 10.0%。 |
show_budget_to_all |
布尔 | 可选 | 选择显示所有员工的项目预算。并不适用于项目总费用的项目。默认为假 。 |
cost_budget |
小数 | 可选 | 货币为项目预算由资金预算。 |
cost_budget_include_expenses |
布尔 | 可选 | 选择预算项目总费用项目包括跟踪费用。默认为假 。 |
费 |
小数 | 可选 | 你计划项目的发票。只使用固定费的项目。 |
笔记 |
字符串 | 可选 | 项目记录。 |
starts_on |
日期 | 可选 | 项目开始日期。 |
ends_on |
日期 | 可选 | 项目将结束日期。 |
示例请求:
旋度" https://api.habob客服端下载rvestapp.com/v2/projects " \ - h“授权:无记名ACCESS_TOKEN美元”\ - h”Harvest-Account-Id: $ ACCOUNT_ID \ - h“用户代理:MyApp (yourname@example.com)”\ -X POST \ -H "Content-Type: application/json" \ -d '{"client_id":5735776,"name":"Your New Project","is_billable":true,"bill_by":"Project","hourly_rate":100.0,"budget_by":"project","budget":10000}'
示例响应:
更新一个项目
更新特定的项目通过设置的值传递的参数。没有提供任何参数将保持不变。返回一个对象和一个项目200好了
响应代码如果调用成功。
补丁/ v2 /项目/ {PROJECT_ID}
参数 | 类型 | 描述 |
---|---|---|
client_id |
整数 | 客户把这个项目的ID。 |
的名字 |
字符串 | 这个项目的名称。 |
代码 |
字符串 | 与项目相关的代码。 |
is_active |
布尔 | 项目是否活跃或存档。默认为真正的 。 |
is_billable |
布尔 | 是否项目计费。 |
is_fixed_fee |
布尔 | 是否这个项目是一个固定费的项目。 |
bill_by |
字符串 | 该方法的项目发票。选项:项目 ,任务 ,人 ,或没有一个 。 |
hourly_rate |
小数 | 每小时工资率率为项目宣传项目。 |
预算 |
小数 | 小时的预算项目预算的时候。 |
budget_by |
字符串 | 项目预算的方法。选项:项目 (小时/项目),project_cost (项目总费用),任务 (小时/任务),task_fees (每个任务的费用),人 (小时/人),没有一个 (无预算)。 |
budget_is_monthly |
布尔 | 每月预算选项重置。默认为假 。 |
notify_when_over_budget |
布尔 | 项目经理是否应该通知当项目超出预算。默认为假 。 |
over_budget_notification_percentage |
小数 | 百分比值用于触发超过预算的电子邮件警报。示例:使用10.0 10.0%。 |
show_budget_to_all |
布尔 | 选择显示所有员工的项目预算。并不适用于项目总费用的项目。默认为假 。 |
cost_budget |
小数 | 货币为项目预算由资金预算。 |
cost_budget_include_expenses |
布尔 | 选择预算项目总费用项目包括跟踪费用。默认为假 。 |
费 |
小数 | 你计划项目的发票。只使用固定费的项目。 |
笔记 |
字符串 | 项目记录。 |
starts_on |
日期 | 项目开始日期。 |
ends_on |
日期 | 项目将结束日期。 |
示例请求:
旋度" https://api.habob客服端下载rvestapp.com/v2/projects/14308112 " \ - h“授权:无记名ACCESS_TOKEN美元”\ - h”Harvest-Account-Id: $ ACCOUNT_ID \ - h“用户代理:MyApp (yourname@example.com)”\ -X PATCH \ -H "Content-Type: application/json" \ -d '{"name":"New project name"}'
示例响应:
删除一个项目
删除一个项目和任何时间或费用跟踪条目。然而,与项目相关的发票将不会被删除。如果你不想要这个项目的时间和费用条目删除,你应该归档项目代替。
删除/ v2 /项目/ {PROJECT_ID}
示例请求:
旋度" https://api.habob客服端下载rvestapp.com/v2/projects/14308112 " \ - h“授权:无记名ACCESS_TOKEN美元”\ - h”Harvest-Account-Id: $ ACCOUNT_ID \ - h“用户代理:MyApp (yourname@example.com)”\ -X DELETE