时间输入对象
属性 |
类型 |
描述 |
id |
整数 |
时间条目的唯一ID。 |
spent_date |
日期 |
时间输入日期。 |
用户 |
对象 |
包含关联用户的id和名称的对象。 |
user_assignment |
对象 |
一个用户分配对象关联用户的。 |
客户端 |
对象 |
包含关联客户端的id和名称的对象。 |
项目 |
对象 |
包含关联项目的id和名称的对象。 |
任务 |
对象 |
包含关联任务的id和名称的对象。 |
task_assignment |
对象 |
一个任务分配对象关联任务的。 |
external_reference |
对象 |
对象,该对象包含id ,group_id ,account_id ,永久链接 ,服务 ,service_icon_url 关联的外部引用的。 |
发票 |
对象 |
一旦时间条目被开具发票,这个字段将包括相关发票的id和编号。 |
小时 |
小数 |
在此时间条目中跟踪的(十进制时间)小时数。 |
hours_without_timer |
小数 |
在计时器最后一次启动之前,该时间条目中已经跟踪的(十进制时间)小时数。 |
rounded_hours |
小数 |
在汇总报告和发票中使用的时间条目中跟踪的(十进制时间)小时数。属性将此值四舍五入时间排在您的首选项. |
笔记 |
字符串 |
附在时间分录上的注释。 |
is_locked |
布尔 |
时间条目是否被锁定。 |
locked_reason |
字符串 |
为什么时间条目被锁定了。 |
is_closed |
布尔 |
工时输入是否已通过工时表审批批准。 |
is_billed |
布尔 |
工时分录是否已标记为发票。 |
timer_started_at |
datetime |
定时器启动的日期和时间(如果按持续时间跟踪)。bob手机下载使用ISO 8601格式. |
started_time |
时间 |
时间条目开始的时间(如果按开始/结束时间跟踪)。bob手机下载 |
ended_time |
时间 |
时间条目结束的时间(如果按开始/结束时间跟踪)。bob手机下载 |
is_running |
布尔 |
时间条目当前是否正在运行。 |
计费 |
布尔 |
工时录入是否计费。 |
预算 |
布尔 |
时间分录是否计入项目预算。 |
billable_rate |
小数 |
时间录入的计费费率。 |
cost_rate |
小数 |
时间录入的成本率。 |
created_at |
datetime |
创建时间条目的日期和时间。使用ISO 8601格式. |
updated_at |
datetime |
最后更新时间条目的日期和时间。使用ISO 8601格式. |
需要的权限
管理员可以查看该帐户的所有时间条目。
管理人员可以看到自己的时间条目,分配的队友,以及跟踪到他们管理的项目的时间。此外,有权编辑指定队友的时间条目的经理可以代表他们创建、编辑和销毁时间条目。
成员只能看到自己跟踪的时间。
列出所有时间条目
返回时间条目的列表。时间条目按顺序返回spent_date
日期。此时,排序选项不能自定义。
响应包含一个对象time_entries
属性,该属性包含最多到的数组per_page
时间条目。数组中的每个条目都是一个单独的时间条目对象。如果没有更多可用的时间项,则结果数组将为空。响应中还包括几个额外的分页属性,以简化对时间条目的分页。
参数 |
类型 |
描述 |
user_id |
整数 |
只返回属于具有给定ID的用户的时间条目。 |
client_id |
整数 |
只返回属于具有给定ID的客户端的时间条目。 |
project_id |
整数 |
只返回属于具有给定ID的项目的时间条目。 |
task_id |
整数 |
只返回属于具有给定ID的任务的时间项。 |
external_reference_id |
字符串 |
只返回给定的时间项external_reference ID。 |
is_billed |
布尔 |
通过真正的 仅返回已开具发票的时间条目假 返回未开票的工时分项。 |
is_running |
布尔 |
通过真正的 仅返回运行时项和假 返回非运行时项。 |
updated_since |
datetime |
只返回自给定日期和时间以来更新过的时间项。使用ISO 8601格式. |
从 |
日期 |
只返回时间项spent_date 在给定日期或之后 |
来 |
日期 |
只返回时间项spent_date 在给定日期或之前。 |
页面 |
整数 |
在分页中使用的页码。例如,如果您提出一个列表请求并收到2000条记录,您的后续呼叫可以包括页面= 2 检索列表的下一页。(默认值:1) |
per_page |
整数 |
每页要返回的记录数。取值范围为1 ~ 2000。(默认:2000) |
示例请求:
curl "https://api.bob客服端下载harvestapp.com/v2/time_entries" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"
示例响应:
检索时间条目
检索具有给定ID的时间条目。返回一个时间条目对象和200好了
提供有效标识符时的响应代码。
GET / v2 / time_entries / {TIME_ENTRY_ID}
示例请求:
curl "https://api.bob客服端下载harvestapp.com/v2/time_entries/636708723" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"
示例响应:
通过持续时间创建一个时间条目
创建一个新的时间条目对象。返回一个时间条目对象和201年创建
调用成功时的响应代码。
当帐户配置为时,应仅使用此方法创建时间条目通过持续时间跟踪时间.可以通过访问设置页面在您的Harvest帐bob客服端下载户或通过检查是否wants_timestamp_timers
是假的公司的API.
参数 |
类型 |
要求 |
描述 |
user_id |
整数 |
可选 |
要与时间条目关联的用户ID。默认为当前通过身份验证的用户的ID。 |
project_id |
整数 |
要求 |
要与时间条目关联的项目的ID。 |
task_id |
整数 |
要求 |
要与时间条目关联的任务的ID。 |
spent_date |
日期 |
要求 |
ISO 8601格式的日期条目花费的时间。 |
小时 |
小数 |
可选 |
跟踪的当前时间量。如果提供了,将使用指定的小时和创建时间条目is_running 将被设置为false。如果没有提供,时间将设置为0.0 而且is_running 将设置为true。 |
笔记 |
字符串 |
可选 |
任何与时间条目相关联的注释。 |
external_reference |
对象 |
可选 |
对象,该对象包含id ,group_id ,account_id ,永久链接 外部引用的。 |
示例请求:
curl "https://api.bob客服端下载harvestapp.com/v2/time_entries" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -X POST \ -H "Content-Type: application/json" \ -d '{"user_id":1782959,"project_id":14307913,"task_id":8083365,"spent_date":"2017-03-21","hours":1.0}'
示例响应:
通过开始时间和结束时间创建一个时间条目
创建一个新的时间条目对象。返回一个时间条目对象和201年创建
调用成功时的响应代码。
当帐户配置为时,应仅使用此方法创建时间条目通过开始和结束时间跟踪时间.可以通过访问设置页面在您的Harvest帐bob客服端下载户或通过检查是否wants_timestamp_timers
是正确的公司的API.
参数 |
类型 |
要求 |
描述 |
user_id |
整数 |
可选 |
要与时间条目关联的用户ID。默认为当前通过身份验证的用户的ID。 |
project_id |
整数 |
要求 |
要与时间条目关联的项目的ID。 |
task_id |
整数 |
要求 |
要与时间条目关联的任务的ID。 |
spent_date |
日期 |
要求 |
ISO 8601格式的日期条目花费的时间。 |
started_time |
时间 |
可选 |
输入开始的时间。默认为当前时间。例如:“上午8:00”。 |
ended_time |
时间 |
可选 |
输入结束的时间。如果提供,is_running 将被设置为false。如未提供,is_running 将设置为true。 |
笔记 |
字符串 |
可选 |
任何与时间条目相关联的注释。 |
external_reference |
对象 |
可选 |
对象,该对象包含id ,group_id ,account_id ,永久链接 外部引用的。 |
示例请求:
curl "https://api.bob客服端下载harvestapp.com/v2/time_entries" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -X POST \ -H "Content-Type: application/json" \ -d '{"user_id":1782959,"project_id":14307913,"task_id":8083365,"spent_date":"2017-03-21"," start_time ":"8:00am"," endd_time ":"9:00am"}'
示例响应:
更新时间条目
通过设置传递的参数值更新特定的时间条目。任何未提供的参数将保持不变。返回一个时间条目对象和200好了
调用成功时的响应代码。
补丁/ v2 / time_entries / {TIME_ENTRY_ID}
参数 |
类型 |
描述 |
project_id |
整数 |
要与时间条目关联的项目的ID。 |
task_id |
整数 |
要与时间条目关联的任务的ID。 |
spent_date |
日期 |
ISO 8601格式的日期条目花费的时间。 |
started_time |
时间 |
输入开始的时间。默认为当前时间。例如:“上午8:00”。 |
ended_time |
时间 |
输入结束的时间。 |
小时 |
小数 |
跟踪的当前时间量。 |
笔记 |
字符串 |
任何与时间条目相关联的注释。 |
external_reference |
对象 |
对象,该对象包含id ,group_id ,account_id ,永久链接 外部引用的。 |
示例请求:
curl "https://api.bob客服端下载harvestapp.com/v2/time_entries/636718192" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -X PATCH \ -H "Content-Type: application/json" \ -d '{"notes":"已更新的notes"}'
示例响应:
删除时间条目的外部引用
删除时间条目的外部引用。返回一个200好了
调用成功时的响应代码。
删除/ v2 / time_entries / {TIME_ENTRY_ID} / external_reference
示例请求:
curl "https://api.bob客服端下载harvestapp.com/v2/time_entries/636718192/external_reference" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -x删除
删除时间条目
删除时间表项。只有当时间条目未关闭且关联的项目和任务尚未存档时,才可以删除它。但是,管理员可以删除关闭的条目。返回一个200好了
调用成功时的响应代码。
删除/ v2 / time_entries / {TIME_ENTRY_ID}
示例请求:
curl "https://api.bob客服端下载harvestapp.com/v2/time_entries/636718192" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -x删除
重新启动已停止的时间条目
只有在时间条目当前未运行时才有可能重新启动它。返回一个200好了
调用成功时的响应代码。
补丁/ v2 / time_entries / {TIME_ENTRY_ID} /重新启动
示例请求:
curl "https://api.bob客服端下载harvestapp.com/v2/time_entries/662202797/restart" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -x补丁
示例响应:
停止运行时条目
只有当时间条目正在运行时才有可能停止它。返回一个200好了
调用成功时的响应代码。
补丁/ v2 / time_entries / {TIME_ENTRY_ID} /停止
示例请求:
curl "https://api.bob客服端下载harvestapp.com/v2/time_entries/662202797/stop" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -x补丁
示例响应: