电子邮件＂class=联系我们
  1. bob客服端下载获取API V2文档
  2. 发票API
  3. 发票信息

发票信息

发票消息对象

属性 类型 描述
id 整数 消息的唯一ID。
sent_by 字符串 创建消息的用户名。
sent_by_email 字符串 创建消息的用户的电子邮件。
sent_from 字符串 发送消息的用户名。
sent_from_email 字符串 发送该消息的用户的电子邮件。
收件人 数组 的数组发票邮件收件人．
主题 字符串 消息主题。
身体 字符串 消息体。
include_link_to_client_invoice 布尔 是否在邮件正文中包含到客户端发票的链接。不用于thank_you是真正的．
attach_pdf 布尔 是否将发票PDF附在邮件中
send_me_a_copy 布尔 是否将邮件副本通过电子邮件发送给当前用户。
thank_you 布尔 这是不是一个感谢的信息。
event_type 字符串 与消息一起发生的发票事件类型:发送、关闭、起草、重新打开或查看。
提醒 布尔 这是否是一个提醒信息。
send_reminder_on 日期 提醒邮件发送的日期。
created_at datetime 创建消息的日期和时间。
updated_at datetime 最后更新消息的日期和时间。

发票消息接收者对象

属性 类型 描述
的名字 字符串 消息接收者的名称。
电子邮件 字符串 邮件收件人的电子邮件。

需要的权限

您必须是具有创建和编辑发票权限的管理员或经理，才能与/ v2 /发票/ {INVOICE_ID} /消息端点。权限不足将导致403年被禁止的状态码。

列出发票的所有消息

返回与给定发票关联的消息列表。发票消息按创建日期排序返回，最近创建的消息出现在前面。

响应包含一个对象invoice_messages属性，该属性包含最多到的数组per_page消息。数组中的每个条目都是一个单独的消息对象。如果没有更多可用的消息，则生成的数组将为空。响应中包含了几个额外的分页属性，以简化对消息的分页。

GET / v2 /发票/ {INVOICE_ID} /消息
参数 类型 描述
updated_since datetime 只返回自给定日期和时间以来更新过的发票消息。
页面 整数 在分页中使用的页码。例如，如果您提出一个列表请求并收到2000条记录，您的后续呼叫可以包括页面= 2检索列表的下一页。(默认值:1)
per_page 整数 每页要返回的记录数。取值范围为1 ~ 2000。(默认:2000)

示例请求:

curl "https://api.bob客服端下载harvestapp.com/v2/invoices/13150403/messages" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"

示例响应:

｛“invoice_messages”：［｛“id”：27835209，“sent_by”：“鲍勃·鲍威尔”，“sent_by_email”：“bobpowell@example.com”，“sent_from”：“鲍勃·鲍威尔”，“sent_from_email”：“bobpowell@example.com”，“include_link_to_client_invoice”：假，“send_me_a_copy”：假，“thank_you”：假，“提醒”：假，“send_reminder_on”：零，“created_at”：“2017 - 08 - 23 - t22:15:06z”，“updated_at”：“2017 - 08 - 23 - t22:15:06z”，“attach_pdf”：真正的，“event_type”：零，“收件人”：［｛“名称”：“某乙”，“电子邮件”：“richardroe@example.com”｝]，“主题”：“过期发票提醒:API示例中的#1001”，“身体”：“亲爱的顾客,\ r \ n \ r \ n这是一个友好的提醒，让您知道发票1001已逾期144天。如果您已经付款，请忽略此消息。如果没有，我们将感激你迅速关注此事。\ r \ n \ r \ n谢谢您的惠顾。\ r \ n \ r \ n欢呼,\ r \ nAPI的例子”}，｛“id”：27835207，“sent_by”：“鲍勃·鲍威尔”，“sent_by_email”：“bobpowell@example.com”，“sent_from”：“鲍勃·鲍威尔”，“sent_from_email”：“bobpowell@example.com”，“include_link_to_client_invoice”：假，“send_me_a_copy”：真正的，“thank_you”：假，“提醒”：假，“send_reminder_on”：零，“created_at”：“2017 - 08 - 23 - t22:14:49z”，“updated_at”：“2017 - 08 - 23 - t22:14:49z”，“attach_pdf”：真正的，“event_type”：零，“收件人”：［｛“名称”：“某乙”，“电子邮件”：“richardroe@example.com”}，｛“名称”：“鲍勃·鲍威尔”，“电子邮件”：“bobpowell@example.com”｝]，“主题”：“API示例中的1001号发票”，“身体”："---------------------------------------------\ r \ n发票汇总\ r \ n---------------------------------------------\ r \ n发票编号:1001\ r \ n发行日期:2017年4月1日\ r \ n客户:123 Industries\ r \ n汇票号码:\ r \ n数量:€288.90\ r \ n截止日期:2017年4月1日(收到后)\ r \ n \ r \ n详细发票以PDF格式附在附件中。\ r \ n \ r \ n谢谢你！\ r \ n---------------------------------------------"｝]，“per_page”：2000，“total_pages”：1，“total_entries”：2，“next_page”：零，“previous_page”：零，“页面”：1，“链接”: {“第一”：“https://api.bob客服端下载harvestapp.com/api/v2/invoices/13150403/messages?page=1&per_page=2000”，“下一个”：零，“以前”：零，“最后一次”：“https://api.bob客服端下载harvestapp.com/v2/invoices/13150403/messages?page=1&per_page=2000”｝｝

创建发票消息

创建一个新的发票消息对象。返回一个发票消息对象和一个201年创建调用成功时的响应代码。

POST / v2 /发票/ {INVOICE_ID} /消息
参数 类型 要求 描述
收件人 数组 要求 接收方参数数组。详情见下文。
主题 字符串 可选 消息主题。
身体 字符串 可选 消息体。
include_link_to_client_invoice 布尔 可选 如果设置为真正的，到客户发票URL的链接将包含在消息电子邮件中。默认为假．忽略时thank_you设置为真正的．
attach_pdf 布尔 可选 如果设置为真正的，发票的PDF文件将附在邮件中。默认为假．
send_me_a_copy 布尔 可选 如果设置为真正的时，消息电子邮件的副本将发送给当前用户。默认为假．
thank_you 布尔 可选 如果设置为真正的，将会发送一封感谢邮件。默认为假．
event_type 字符串 可选 如果提供，则针对发票运行事件。选项:关闭、起草、重新打开或发送。
接收参数 类型 要求 描述
的名字 字符串 可选 消息接收者的名称。
电子邮件 字符串 要求 邮件收件人的电子邮件。

示例请求:

curl "https://api.bob客服端下载harvestapp.com/v2/invoices/13150403/messages" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -X POST \ -H "Content-Type: application/json" \ -d '{"subject":"Invoice #1001"，"body":" Invoice is attached ."，"attach_pdf":true，"send_me_a_copy":true，"收件人":[{"name":"Richard Roe"，"email":"richardroe@example.com"}]}'

示例响应:

｛“id”：27835324，“sent_by”：“鲍勃·鲍威尔”，“sent_by_email”：“bobpowell@example.com”，“sent_from”：“鲍勃·鲍威尔”，“sent_from_email”：“bobpowell@example.com”，“include_link_to_client_invoice”：假，“send_me_a_copy”：真正的，“thank_you”：假，“提醒”：假，“send_reminder_on”：零，“created_at”：“2017 - 08 - 23 - t22:25:59z”，“updated_at”：“2017 - 08 - 23 - t22:25:59z”，“attach_pdf”：真正的，“event_type”：零，“收件人”：［｛“名称”：“某乙”，“电子邮件”：“richardroe@example.com”}，｛“名称”：“鲍勃·鲍威尔”，“电子邮件”：“bobpowell@example.com”｝]，“主题”：“发票# 1001”，“身体”：“发票随函附上。”｝

检索特定发票的发票信息主题和正文

项的发票消息的“收获”中配置的主题和正文文本bob客服端下载200好了调用成功时的响应代码。不创建发票消息。如果没有传递参数，则将返回特定发票的一般发票消息的主题和正文。

GET / v2 /发票/ {INVOICE_ID} / /新消息
参数 类型 要求 描述
thank_you 布尔 可选 设置为真正的返回特定发票的感谢发票信息的主题和正文。
提醒 布尔 可选 设置为真正的返回特定发票的提醒发票消息的主题和正文。

示例请求:

curl "https://api.bob客服端下载harvestapp.com/v2/invoices/13150403/messages/new?reminder=true" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"

示例响应:

｛“invoice_id”：13150403，“主题”：“过期发票提醒:API示例中的#1002”，“身体”：“亲爱的顾客,\ n \ n这是一个友好的提醒，让你知道发票1002已逾期20天。如果您已经付款，请忽略此消息。如果没有，我们将感激你迅速关注此事。\ n \ n谢谢您的惠顾。\ n \ n欢呼,\ nAPI的例子\ n＂，“提醒”：假，“thank_you”：假｝

删除发票消息

删除发票消息。返回一个200好了调用成功时的响应代码。

删除/ v2 /发票/ {INVOICE_ID} /信息/ {message_ID}

示例请求:

curl "https://api.bob客服端下载harvestapp.com/v2/invoices/13150403/messages/27835324" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -x删除

将发票草稿标记为已寄出

创建一个新的发票消息对象，并将发票标记为已发送。返回一个发票消息对象和一个201年创建调用成功时的响应代码。

POST / v2 /发票/ {INVOICE_ID} /消息
参数 类型 要求 描述
event_type 字符串 要求 通过“send”标记发票已发送。

示例请求:

curl "https://api.bob客服端下载harvestapp.com/v2/invoices/13150403/messages" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -X POST \ -H "Content-Type: application/json" \ -d '{"event_type":"send"}'

示例响应:

｛“id”：27835325，“sent_by”：“鲍勃·鲍威尔”，“sent_by_email”：“bobpowell@example.com”，“sent_from”：“鲍勃·鲍威尔”，“sent_from_email”：“bobpowell@example.com”，“include_link_to_client_invoice”：假，“send_me_a_copy”：假，“thank_you”：假，“提醒”：假，“send_reminder_on”：零，“created_at”：“2017 - 08 - 23 - t22:25:59z”，“updated_at”：“2017 - 08 - 23 - t22:25:59z”，“attach_pdf”：假，“event_type”：“发送”，“收件人”: [],“主题”：零，“身体”：零｝

将未开发票标记为关闭发票

创建一个新的发票消息对象，并将发票标记为已关闭。返回一个发票消息对象和一个201年创建调用成功时的响应代码。

POST / v2 /发票/ {INVOICE_ID} /消息
参数 类型 要求 描述
event_type 字符串 要求 传递“close”以标记发票已关闭。

示例请求:

curl "https://api.bob客服端下载harvestapp.com/v2/invoices/13150403/messages" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -X POST \ -H "Content-Type: application/json" \ -d '{"event_type":"close"}'

示例响应:

｛“id”：27835326，“sent_by”：“鲍勃·鲍威尔”，“sent_by_email”：“bobpowell@example.com”，“sent_from”：“鲍勃·鲍威尔”，“sent_from_email”：“bobpowell@example.com”，“include_link_to_client_invoice”：假，“send_me_a_copy”：假，“thank_you”：假，“提醒”：假，“send_reminder_on”：零，“created_at”：“2017 - 08 - 23 - t22:25:59z”，“updated_at”：“2017 - 08 - 23 - t22:25:59z”，“attach_pdf”：假，“event_type”：“关闭”，“收件人”: [],“主题”：零，“身体”：零｝

重新打开已关闭的发票

创建新的发票消息对象并重新打开已关闭的发票。返回一个发票消息对象和一个201年创建调用成功时的响应代码。

POST / v2 /发票/ {INVOICE_ID} /消息
参数 类型 要求 描述
event_type 字符串 要求 通过“重新打开”来重新打开发票。

示例请求:

curl "https://api.bob客服端下载harvestapp.com/v2/invoices/13150403/messages" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -X POST \ -H "Content-Type: application/json" \ -d '{"event_type":"re-open"}'

示例响应:

｛“id”：27835327，“sent_by”：“鲍勃·鲍威尔”，“sent_by_email”：“bobpowell@example.com”，“sent_from”：“鲍勃·鲍威尔”，“sent_from_email”：“bobpowell@example.com”，“include_link_to_client_invoice”：假，“send_me_a_copy”：假，“thank_you”：假，“提醒”：假，“send_reminder_on”：零，“created_at”：“2017 - 08 - 23 - t22:25:59z”，“updated_at”：“2017 - 08 - 23 - t22:25:59z”，“attach_pdf”：假，“event_type”：“重新打开”，“收件人”: [],“主题”：零，“身体”：零｝

将开票发票标记为汇票

创建一个新的发票消息对象，并将打开的发票标记为草稿。返回一个发票消息对象和一个201年创建调用成功时的响应代码。

POST / v2 /发票/ {INVOICE_ID} /消息
参数 类型 要求 描述
event_type 字符串 要求 通过“汇票”将发票标记为汇票。

示例请求:

curl "https://api.bob客服端下载harvestapp.com/v2/invoices/13150403/messages" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -X POST \ -H "Content-Type: application/json" \ -d '{"event_type":"draft"}'

示例响应:

｛“id”：27835328，“sent_by”：“鲍勃·鲍威尔”，“sent_by_email”：“bobpowell@example.com”，“sent_from”：“鲍勃·鲍威尔”，“sent_from_email”：“bobpowell@example.com”，“include_link_to_client_invoice”：假，“send_me_a_copy”：假，“thank_you”：假，“提醒”：假，“send_reminder_on”：零，“created_at”：“2017 - 08 - 23 - t22:25:59z”，“updated_at”：“2017 - 08 - 23 - t22:25:59z”，“attach_pdf”：假，“event_type”：“草案”，“收件人”: [],“主题”：零，“身体”：零｝

还有问题吗?我们很乐意帮忙!

联系我们
Baidu
map