联系我们客户
客户端对象
| 属性 | 类型 | 描述 |
|---|---|---|
id |
整数 | 为客户机惟一的ID。 |
的名字 |
字符串 | 的文本描述客户端。 |
is_active |
布尔 | 客户端是否活跃或存档。 |
地址 |
字符串 | 物理地址的客户端。 |
statement_key |
字符串 | 用于构建一个URL仪表板客户的发票:https:// {ACCOUNT_SUBDOMAIN}bob客服端下载.harvestapp.com/client/statements/ {STATEMENT_KEY} |
货币 |
字符串 | 与此客户端相关的货币代码。 |
created_at |
datetime | 客户端创建日期和时间。 |
updated_at |
datetime | 客户最后一次更新的日期和时间。 |
需要的权限
你必须管理员或经理允许创建和编辑客户为了相互作用/ v2 /客户端点。权限不足将导致403年被禁止的状态码。
列出所有客户
返回一个列表,你的客户。客户端返回按创建日期排序,与最近创建的客户首先出现。
响应包含一个对象客户属性包含一个数组per_page客户。数组中的每一项都是一个独立的客户端对象。如果没有更多的客户,由此产生的数组将是空的。几个额外的分页属性包含在响应简化方法你的客户。
获得/ v2 /客户| 参数 | 类型 | 描述 |
|---|---|---|
is_active |
布尔 | 通过真正的只返回客户和活跃假返回不活跃客户。 |
updated_since |
datetime | 只返回以来,已更新客户给定的日期和时间。 |
页面 |
整数 | 使用分页的页号。例如,如果您列出请求和收到2000条记录,后续调用可以包括页面= 2检索列表的下一个页面。(默认值:1) |
per_page |
整数 | 每个页面返回的记录数量。介于1和2000之间。(默认:2000) |
示例请求:
旋度" https://api.habob客服端下载rvestapp.com/v2/clients " \ - h“授权:无记名ACCESS_TOKEN美元”\ - h”Harvest-Account-Id: $ ACCOUNT_ID \ - h“用户代理:MyApp (yourname@example.com)”示例响应:
{“客户”:【{“id”:5735776,“名称”:“123”产业,“is_active”:真正的,“地址”:“123主圣。\ r \ n任何城镇,拉71223”,“statement_key”:“0 a39d3e33c8058cf7c3f8097d854c64e”,“created_at”:“2017 - 06 - 26 t21:02:12z”,“updated_at”:“2017 - 06 - 26 t21:34:11z”,“货币”:“欧元”},{“id”:5735774,“名称”:“ABC集团”,“is_active”:真正的,“地址”:“456主圣。\ r \ n任何城镇,CT 06467”,“statement_key”:“e42aa2cb60e85925ffe5d13ee7ee8706”,“created_at”:“2017 - 06 - 26 t21:01:52z”,“updated_at”:“2017 - 06 - 26 t21:27:07z”,“货币”:“美元”}),“per_page”:2000年,“total_pages”:1,“total_entries”:2,“next_page”:零,“previous_page”:零,“页面”:1,“链接”:{“第一”:“https://api.bob客服端下载harvestapp.com/v2/clients?page=1&per_page=2000”,“下一个”:零,“以前”:零,“最后一次”:“https://api.bob客服端下载harvestapp.com/v2/clients?page=1&per_page=2000”}}检索客户端
检索客户端与给定ID。返回一个客户对象和一个200好了响应代码提供了一个有效的标识符。
GET / v2 /客户/ {CLIENT_ID}示例请求:
旋度" https://api.habob客服端下载rvestapp.com/v2/clients/5735776 " \ - h“授权:无记名ACCESS_TOKEN美元”\ - h”Harvest-Account-Id: $ ACCOUNT_ID \ - h“用户代理:MyApp (yourname@example.com)”示例响应:
{“id”:5735776,“名称”:“123”产业,“is_active”:真正的,“地址”:“123主圣。\ r \ n任何城镇,拉71223”,“statement_key”:“0 a39d3e33c8058cf7c3f8097d854c64e”,“created_at”:“2017 - 06 - 26 t21:02:12z”,“updated_at”:“2017 - 06 - 26 t21:34:11z”,“货币”:“欧元”}创建一个客户端
创建一个新的客户端对象。返回客户端对象和一个201年创建响应代码如果调用成功。
POST / v2 /客户| 参数 | 类型 | 要求 | 描述 |
|---|---|---|---|
的名字 |
字符串 | 要求 | 的文本描述客户端。 |
is_active |
布尔 | 可选 | 客户端是否活跃,存档。默认为真正的。 |
地址 |
字符串 | 可选 | 客户的物理地址的文本表示。可能包括新行字符。 |
货币 |
字符串 | 可选 | 客户端所使用的货币。如果不提供,将使用该公司的货币。看到一列支持的货币 |
示例请求:
旋度" https://api.habob客服端下载rvestapp.com/v2/clients " \ - h“授权:无记名ACCESS_TOKEN美元”\ - h”Harvest-Account-Id: $ ACCOUNT_ID \ - h“用户代理:MyApp (yourname@example.com)”\ -X POST \ -H "Content-Type: application/json" \ -d '{"name":"Your New Client","currency":"EUR"}'示例响应:
{“id”:5737336,“名称”:“你的新客户端”,“is_active”:真正的,“地址”:零,“statement_key”:“82455699 ad085d8cffc3e9a4e43ff7b8”,“created_at”:“2017 - 06 - 26 t21:39:35z”,“updated_at”:“2017 - 06 - 26 t21:39:35z”,“货币”:“欧元”}更新客户端
更新特定的客户端设置的值传递的参数。没有提供任何参数将保持不变。返回客户端对象和一个200好了响应代码如果调用成功。
补丁/ v2 /客户/ {CLIENT_ID}| 参数 | 类型 | 描述 |
|---|---|---|
的名字 |
字符串 | 的文本描述客户端。 |
is_active |
布尔 | 客户端是否活跃,存档。 |
地址 |
字符串 | 客户的物理地址的文本表示。可能包括新行字符。 |
货币 |
字符串 | 客户端所使用的货币。看到一列支持的货币 |
示例请求:
旋度" https://api.habob客服端下载rvestapp.com/v2/clients/5737336 " \ - h“授权:无记名ACCESS_TOKEN美元”\ - h”Harvest-Account-Id: $ ACCOUNT_ID \ - h“用户代理:MyApp (yourname@example.com)”\ -X PATCH \ -H "Content-Type: application/json" \ -d '{"is_active":false}'示例响应:
{“id”:5737336,“名称”:“你的新客户端”,“is_active”:假,“地址”:零,“statement_key”:“82455699 ad085d8cffc3e9a4e43ff7b8”,“created_at”:“2017 - 06 - 26 t21:39:35z”,“updated_at”:“2017 - 06 - 26 t21:41:18z”,“货币”:“欧元”}删除一个客户
删除一个客户端。删除客户端是唯一可能的,如果没有项目,发票,或与之相关的估计。返回一个200好了响应代码如果调用成功。
删除/ v2 /客户/ {CLIENT_ID}示例请求:
旋度" https://api.habob客服端下载rvestapp.com/v2/clients/5737336 " \ - h“授权:无记名ACCESS_TOKEN美元”\ - h”Harvest-Account-Id: $ ACCOUNT_ID \ - h“用户代理:MyApp (yourname@example.com)”\ -X DELETE