联系我们估计
估计对象
| 属性 | 类型 | 描述 |
|---|---|---|
id |
整数 | 评估的唯一ID。 |
客户端 |
对象 | 包含估计的客户端id和名称的对象。 |
line_items |
数组 | 的数组预估行项目． |
创造者 |
对象 | 包含创建评估人员的id和姓名的对象。 |
client_key |
字符串 | 用于为您的客户构建公共web发票的URL:https:// {ACCOUNT_SUBDOMAIN}bob客服端下载 .harvestapp.com/client/estimates/abc123456 |
数量 |
字符串 | 如果没有设置，则自动生成号码。 |
purchase_order |
字符串 | 采购订单号。 |
量 |
小数 | 估价的总额，包括任何折扣和税。 |
税 |
小数 | 这个百分比适用于小计，包括项目和折扣。 |
tax_amount |
小数 | 包括的第一项税额，从税．如果没有税定义时，此值将为空。 |
tax2 |
小数 | 这个百分比适用于小计，包括项目和折扣。 |
tax2_amount |
小数 | 从tax2． |
折扣 |
小数 | 这个百分比从小计中减去。 |
discount_amount |
小数 | 从折扣． |
主题 |
字符串 | 评估主体。 |
笔记 |
字符串 | 估价中包括的任何附加说明。 |
货币 |
字符串 | 与此估算相关联的货币代码。 |
状态 |
字符串 | 估算的当前状态:草案，发送，接受,或拒绝． |
issue_date |
日期 | 发布估算的日期。 |
sent_at |
datetime | 发送评估的日期和时间。 |
accepted_at |
datetime | 接受估价的日期和时间。 |
declined_at |
datetime | 拒绝估计的日期和时间。 |
created_at |
datetime | 创建评估的日期和时间。 |
updated_at |
datetime | 上次更新估算的日期和时间。 |
估算行项目对象
| 属性 | 类型 | 描述 |
|---|---|---|
id |
整数 | 行项目的唯一ID。 |
种类 |
字符串 | 的名称估算项目类别． |
描述 |
字符串 | 行项目的文本说明。 |
数量 |
整数 | 商品的单位数量。 |
unit_price |
小数 | 每件商品的价格。 |
量 |
小数 | 行项小计(数量＊unit_price）. |
征税 |
布尔 | 估算值是否税百分比适用于此项目。 |
taxed2 |
布尔 | 估算值是否tax2百分比适用于此项目。 |
需要的权限
您必须是具有创建和编辑估算权限的管理员或经理，才能与/ v2 /估计端点。权限不足将导致403年被禁止的状态码。
列出所有估算
返回估计值的列表。根据发布日期排序返回估算值，最近发布的估算值出现在前面。
响应包含一个对象估计属性，该属性包含最多到的数组per_page估计。数组中的每个条目都是一个单独的估计对象。如果没有更多可用的估计值，则结果数组将为空。响应中包含了几个额外的分页属性，以简化估算的分页。
获得/ v2 /估计| 参数 | 类型 | 描述 |
|---|---|---|
client_id |
整数 | 只返回属于具有给定ID的客户端的估计。 |
updated_since |
datetime | 只返回自给定日期和时间以来更新过的估计。 |
从 |
日期 | 只返回估计值issue_date在给定日期或之后 |
来 |
日期 | 只返回估计值issue_date在给定日期或之前。 |
状态 |
字符串 | 只返回估计值状态匹配所提供的值。选项:草案，发送，接受,或拒绝． |
页面 |
整数 | 在分页中使用的页码。例如，如果您提出一个列表请求并收到2000条记录，您的后续呼叫可以包括页面= 2检索列表的下一页。(默认值:1) |
per_page |
整数 | 每页要返回的记录数。取值范围为1 ~ 2000。(默认:2000) |
示例请求:
curl "https://api.bob客服端下载harvestapp.com/v2/estimates" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"示例响应:
｛“估计”:【｛“id”：1439818，“client_key”：“13 dc088aa7d51ec687f186b146730c3c75dc7423”，“数量”：“1001”，“purchase_order”：“5678”，“数量”：9630.0，“税”：5．0，“tax_amount”：450.0，“tax2”：2．0，“tax2_amount”：180.0，“折扣”：10．0，“discount_amount”：1000.0，“主题”：“网上商店-第二期”，“笔记”：“关于估算的一些注释”，“状态”：“发送”，“issue_date”：“2017-06-01”，“sent_at”：“2017 - 06 - 27 t16:11:33z”，“created_at”：“2017 - 06 - 27 t16:11:24z”，“updated_at”：“2017 - 06 - 27 t16:13:56z”，“accepted_at”：零，“declined_at”：零，“货币”：“美元”，“客户端”: {“id”：5735776，“名称”：“123”产业}，“创造者”: {“id”：1782884，“名称”：“鲍勃·鲍威尔”}，“line_items”:【｛“id”：53334195，“类型”：“服务”，“描述”：“网上商店第二阶段”，“数量”：One hundred.，“unit_price”：One hundred.，“数量”：10000，“征税”：真正的，“taxed2”：真正的｝］}，｛“id”：1439814，“client_key”：“a5ffaeb30c55776270fcd3992b70332d769f97e7”，“数量”：“1000”，“purchase_order”：“1234”，“数量”：21000.0，“税”：5．0，“tax_amount”：1000.0，“tax2”：零，“tax2_amount”：0．0，“折扣”：零，“discount_amount”：0．0，“主题”：“网上商店-第一期”，“笔记”：“关于估算的一些注释”，“状态”：“接受”，“issue_date”：“2017-01-01”，“sent_at”：“2017 - 06 - 27 t16:10:30z”，“created_at”：“2017 - 06 - 27 t16:09:33z”，“updated_at”：“2017 - 06 - 27 t16:12:00z”，“accepted_at”：“2017 - 06 - 27 t16:10:32z”，“declined_at”：零，“货币”：“美元”，“客户端”: {“id”：5735776，“名称”：“123”产业}，“创造者”: {“id”：1782884，“名称”：“鲍勃·鲍威尔”}，“line_items”:【｛“id”：57531966，“类型”：“服务”，“描述”：“网上商店第一阶段”，“数量”：1，“unit_price”：20000，“数量”：20000，“征税”：真正的，“taxed2”：假｝］｝),“per_page”：2000，“total_pages”：1，“total_entries”：2，“next_page”：零，“previous_page”：零，“页面”：1，“链接”: {“第一”：“https://api.bob客服端下载harvestapp.com/v2/estimates?page=1&per_page=2000”，“下一个”：零，“以前”：零，“最后一次”：“https://api.bob客服端下载harvestapp.com/v2/estimates?page=1&per_page=2000”｝｝检索估算值
检索具有给定ID的估算。返回一个估计对象和200好了提供有效标识符时的响应代码。
GET / v2 /评估/ {ESTIMATE_ID}示例请求:
curl "https://api.bob客服端下载harvestapp.com/v2/estimates/1439818" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"示例响应:
｛“id”：1439818，“client_key”：“13 dc088aa7d51ec687f186b146730c3c75dc7423”，“数量”：“1001”，“purchase_order”：“5678”，“数量”：9630.0，“税”：5．0，“tax_amount”：450.0，“tax2”：2．0，“tax2_amount”：180.0，“折扣”：10．0，“discount_amount”：1000.0，“主题”：“网上商店-第二期”，“笔记”：“关于估算的一些注释”，“状态”：“发送”，“issue_date”：“2017-06-01”，“sent_at”：“2017 - 06 - 27 t16:11:33z”，“created_at”：“2017 - 06 - 27 t16:11:24z”，“updated_at”：“2017 - 06 - 27 t16:13:56z”，“accepted_at”：零，“declined_at”：零，“货币”：“美元”，“客户端”: {“id”：5735776，“名称”：“123”产业}，“创造者”: {“id”：1782884，“名称”：“鲍勃·鲍威尔”}，“line_items”:【｛“id”：53334195，“类型”：“服务”，“描述”：“网上商店第二阶段”，“数量”：100.0，“unit_price”：100.0，“数量”：10000.0，“征税”：真正的，“taxed2”：真正的｝］｝进行评估
创建一个新的评估对象。返回一个估计对象和201年创建调用成功时的响应代码。
POST / v2 /估计| 参数 | 类型 | 要求 | 描述 |
|---|---|---|---|
client_id |
整数 | 要求 | 此评估所属的客户端的ID。 |
数量 |
字符串 | 可选 | 如果没有设置，则自动生成号码。 |
purchase_order |
字符串 | 可选 | 采购订单号。 |
税 |
小数 | 可选 | 这个百分比适用于小计，包括项目和折扣。例如:10.0%用10.0表示。 |
tax2 |
小数 | 可选 | 这个百分比适用于小计，包括项目和折扣。例如:10.0%用10.0表示。 |
折扣 |
小数 | 可选 | 这个百分比从小计中减去。例如:10.0%用10.0表示。 |
主题 |
字符串 | 可选 | 评估主体。 |
笔记 |
字符串 | 可选 | 评估中需要包括的任何其他注意事项。 |
货币 |
字符串 | 可选 | 估算所使用的货币。如果没有提供，将使用客户的货币。参见以下列表支持的货币 |
issue_date |
日期 | 可选 | 发布估算的日期。默认为今天的日期。 |
line_items |
数组 | 可选 | 行项参数数组 |
| 行项参数 | 类型 | 要求 | 描述 |
|---|---|---|---|
种类 |
字符串 | 要求 | 的名称估算项目类别． |
描述 |
字符串 | 可选 | 行项目的文本说明。 |
数量 |
整数 | 可选 | 商品的单位数量。默认为1． |
unit_price |
小数 | 要求 | 每件商品的价格。 |
征税 |
布尔 | 可选 | 估算值是否税百分比适用于此项目。默认为假． |
taxed2 |
布尔 | 可选 | 估算值是否tax2百分比适用于此项目。默认为假． |
示例请求:
curl "https://api.bob客服端下载harvestapp.com/v2/estimates" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -X POST \ -H "Content-Type: application/json" \ -d '{"client_id":5735774，"subject":"ABC项目报价"，"line_items":[{"kind":"Service"，"description":"ABC项目报价"，"unit_price":5000.0}]}'示例响应:
｛“id”：1439827，“client_key”：“ddd4504a68fb7339138d0c2ea89ba05a3cf12aa8”，“数量”：“1002”，“purchase_order”：零，“数量”：5000.0，“税”：零，“tax_amount”：0．0，“tax2”：零，“tax2_amount”：0．0，“折扣”：零，“discount_amount”：0．0，“主题”：“项目报价”，“笔记”：零，“状态”：“草案”，“issue_date”：零，“sent_at”：零，“created_at”：“2017 - 06 - 27 t16:16:24z”，“updated_at”：“2017 - 06 - 27 t16:16:24z”，“accepted_at”：零，“declined_at”：零，“货币”：“美元”，“客户端”: {“id”：5735774，“名称”：“ABC集团”}，“创造者”: {“id”：1782884，“名称”：“鲍勃·鲍威尔”}，“line_items”:【｛“id”：53339199，“类型”：“服务”，“描述”：“项目描述”，“数量”：1．0，“unit_price”：5000.0，“数量”：5000.0，“征税”：假，“taxed2”：假｝］｝更新估算
通过设置传递的参数值更新特定的估算值。任何未提供的参数将保持不变。返回一个估计对象和200好了调用成功时的响应代码。
补丁/ v2 /估计/ {ESTIMATE_ID}| 参数 | 类型 | 描述 |
|---|---|---|
client_id |
整数 | 此评估所属的客户端的ID。 |
数量 |
字符串 | 如果没有设置，则自动生成号码。 |
purchase_order |
字符串 | 采购订单号。 |
税 |
小数 | 这个百分比适用于小计，包括项目和折扣。例如:10.0%用10.0表示。 |
tax2 |
小数 | 这个百分比适用于小计，包括项目和折扣。例如:10.0%用10.0表示。 |
折扣 |
小数 | 这个百分比从小计中减去。例如:10.0%用10.0表示。 |
主题 |
字符串 | 评估主体。 |
笔记 |
字符串 | 评估中需要包括的任何其他注意事项。 |
货币 |
字符串 | 估算所使用的货币。如果没有提供，将使用客户的货币。参见以下列表支持的货币 |
issue_date |
日期 | 发布估算的日期。 |
line_items |
数组 | 行项参数数组 |
| 行项参数 | 类型 | 描述 |
|---|---|---|
id |
整数 | 行项目的唯一ID。 |
种类 |
字符串 | 的名称估算项目类别． |
描述 |
字符串 | 行项目的文本说明。 |
数量 |
整数 | 商品的单位数量。默认为1． |
unit_price |
小数 | 每件商品的价格。 |
征税 |
布尔 | 估算值是否税百分比适用于此项目。默认为假． |
taxed2 |
布尔 | 估算值是否tax2百分比适用于此项目。默认为假． |
示例请求:
curl "https://api.bob客服端下载harvestapp.com/v2/estimates/1439827" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -X PATCH \ -H "Content-Type: application/json" \ -d '{"purchase_order":"2345"}'示例响应:
｛“id”：1439827，“client_key”：“ddd4504a68fb7339138d0c2ea89ba05a3cf12aa8”，“数量”：“1002”，“purchase_order”：“2345”，“数量”：5000.0，“税”：零，“tax_amount”：0．0，“tax2”：零，“tax2_amount”：0．0，“折扣”：零，“discount_amount”：0．0，“主题”：“项目报价”，“笔记”：零，“状态”：“草案”，“issue_date”：零，“sent_at”：零，“created_at”：“2017 - 06 - 27 t16:16:24z”，“updated_at”：“2017 - 06 - 27 t16:17:06z”，“accepted_at”：零，“declined_at”：零，“货币”：“美元”，“客户端”: {“id”：5735774，“名称”：“ABC集团”}，“创造者”: {“id”：1782884，“名称”：“鲍勃·鲍威尔”}，“line_items”:【｛“id”：53339199，“类型”：“服务”，“描述”：“项目描述”，“数量”：1．0，“unit_price”：5000.0，“数量”：5000.0，“征税”：假，“taxed2”：假｝］｝创建一个评估行项目
在评估中创建一个新的行项目。返回一个200好了调用成功时的响应代码。
示例请求:
curl "https://api.bob客服端下载harvestapp.com/api/v2/estimates/1439827" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "用户代理:MyApp (yourname@example.com)"\ -X PATCH \ -H "Content-Type: application/json" \ -d '{"line_items":[{"kind":"Service"，"description":"Another Project"，"unit_price":1000.0}]}'示例响应:
｛“id”：1439827，“client_key”：“ddd4504a68fb7339138d0c2ea89ba05a3cf12aa8”，“数量”：“1002”，“purchase_order”：“2345”，“数量”：6000.0，“税”：零，“tax_amount”：0．0，“tax2”：零，“tax2_amount”：0．0，“折扣”：零，“discount_amount”：0．0，“主题”：“项目报价”，“笔记”：零，“状态”：“草案”，“issue_date”：零，“sent_at”：零，“created_at”：“2017 - 06 - 27 t16:16:24z”，“updated_at”：“2017 - 06 - 27 t16:17:06z”，“accepted_at”：零，“declined_at”：零，“货币”：“美元”，“客户端”: {“id”：5735774，“名称”：“ABC集团”}，“创造者”: {“id”：1782884，“名称”：“鲍勃·鲍威尔”}，“line_items”:【｛“id”：53339199，“类型”：“服务”，“描述”：“项目描述”，“数量”：1．0，“unit_price”：5000.0，“数量”：5000.0，“征税”：假，“taxed2”：假}，｛“id”：53339200，“类型”：“服务”，“描述”：另一个“项目”，“数量”：1．0，“unit_price”：1000.0，“数量”：1000.0，“征税”：假，“taxed2”：假｝］｝更新一个评估行项目
更新评估上现有的行项目。返回一个200好了调用成功时的响应代码。
示例请求:
curl "https://api.bob客服端下载harvestapp.com/api/v2/estimates/1439827" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "用户代理:MyApp (yourname@example.com)"\ -X PATCH \ -H "Content-Type: application/json" \ -d '{"line_items":[{"id":53339199，"description":"Project Phase 2"，"unit_price":5000.0}]}'示例响应:
｛“id”：1439827，“client_key”：“ddd4504a68fb7339138d0c2ea89ba05a3cf12aa8”，“数量”：“1002”，“purchase_order”：“2345”，“数量”：6000.0，“税”：零，“tax_amount”：0．0，“tax2”：零，“tax2_amount”：0．0，“折扣”：零，“discount_amount”：0．0，“主题”：“项目报价”，“笔记”：零，“状态”：“草案”，“issue_date”：零，“sent_at”：零，“created_at”：“2017 - 06 - 27 t16:16:24z”，“updated_at”：“2017 - 06 - 27 t16:17:06z”，“accepted_at”：零，“declined_at”：零，“货币”：“美元”，“客户端”: {“id”：5735774，“名称”：“ABC集团”}，“创造者”: {“id”：1782884，“名称”：“鲍勃·鲍威尔”}，“line_items”:【｛“id”：53339199，“类型”：“服务”，“描述”：“计划第二期”，“数量”：1．0，“unit_price”：5000.0，“数量”：5000.0，“征税”：假，“taxed2”：假}，｛“id”：53339200，“类型”：“服务”，“描述”：另一个“项目”，“数量”：1．0，“unit_price”：1000.0，“数量”：1000.0，“征税”：假，“taxed2”：假｝］｝删除一个评估行项目
从评估中删除一行项目。返回一个200好了调用成功时的响应代码。
示例请求:
curl "https://api.bob客服端下载harvestapp.com/api/v2/estimates/1439827" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "用户代理:MyApp (yourname@example.com)"\ -X PATCH \ -H "Content-Type: application/json" \ -d '{"line_items":[{"id":53339199，"_destroy":true}]}'示例响应:
｛“id”：1439827，“client_key”：“ddd4504a68fb7339138d0c2ea89ba05a3cf12aa8”，“数量”：“1002”，“purchase_order”：“2345”，“数量”：1000.0，“税”：零，“tax_amount”：0．0，“tax2”：零，“tax2_amount”：0．0，“折扣”：零，“discount_amount”：0．0，“主题”：“项目报价”，“笔记”：零，“状态”：“草案”，“issue_date”：零，“sent_at”：零，“created_at”：“2017 - 06 - 27 t16:16:24z”，“updated_at”：“2017 - 06 - 27 t16:17:06z”，“accepted_at”：零，“declined_at”：零，“货币”：“美元”，“客户端”: {“id”：5735774，“名称”：“ABC集团”}，“创造者”: {“id”：1782884，“名称”：“鲍勃·鲍威尔”}，“line_items”:【｛“id”：53339200，“类型”：“服务”，“描述”：另一个“项目”，“数量”：1．0，“unit_price”：1000.0，“数量”：1000.0，“征税”：假，“taxed2”：假｝］｝删除估算
删除估算。返回一个200好了调用成功时的响应代码。
删除/ v2 /估计/ {ESTIMATE_ID}示例请求:
curl "https://api.bob客服端下载harvestapp.com/v2/estimates/1439827" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -x删除