联系我们发票付款
发票支付对象
| 属性 | 类型 | 描述 |
|---|---|---|
id |
整数 | 付款的唯一ID。 |
量 |
小数 | 付款金额。 |
paid_at |
datetime | 付款日期和时间。 |
paid_date |
日期 | 付款日期。 |
recorded_by |
字符串 | 记录付款的人的名字。 |
recorded_by_email |
字符串 | 记录付款人的电子邮件。 |
笔记 |
字符串 | 任何与付款有关的票据。 |
transaction_id |
字符串 | 信用卡授权或PayPal交易ID。 |
payment_gateway |
对象 | 用于处理支付的支付网关id和名称。 |
created_at |
datetime | 付款记录的日期和时间。 |
updated_at |
datetime | 最后更新付款的日期和时间。 |
需要的权限
您必须是具有创建和编辑发票权限的管理员或经理，才能与/ v2 /发票/ {INVOICE_ID} /支付端点。权限不足将导致403年被禁止的状态码。
列出发票的所有付款
返回与给定发票关联的付款列表。付款按创建日期排序返回，最近创建的付款出现在前面。
响应包含一个对象invoice_payments属性，该属性包含最多到的数组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/13150378/payments" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"示例响应:
｛“invoice_payments”：［｛“id”：10112854，“数量”：10700，“paid_at”：“2017 - 02 - 21 - t00:00:00z”，“paid_date”：“2017-02-21”，“recorded_by”：”爱丽丝Doe”，“recorded_by_email”：“alice@example.com”，“笔记”：“通过4321号支票支付”，“transaction_id”：零，“created_at”：“2017 - 06 - 27 t16:24:57z”，“updated_at”：“2017 - 06 - 27 t16:24:57z”，“payment_gateway”：｛“id”：1234，“名称”：“Linkpoint国际”｝｝]，“per_page”：2000，“total_pages”：1，“total_entries”：1，“next_page”：零，“previous_page”：零，“页面”：1，“链接”：｛“第一”：“https://api.bob客服端下载harvestapp.com/v2/invoices/13150378/payments?page=1&per_page=2000”，“下一个”：零，“以前”：零，“最后一次”：“https://api.bob客服端下载harvestapp.com/v2/invoices/13150378/payments?page=1&per_page=2000”｝｝创建发票付款
创建一个新的发票支付对象。返回发票付款对象和201年创建调用成功时的响应代码。
POST / v2 /发票/ {INVOICE_ID} /支付| 参数 | 类型 | 要求 | 描述 |
|---|---|---|---|
量 |
小数 | 要求 | 付款金额。 |
paid_at |
datetime | 可选 | 付款日期和时间。要么通过paid_at或paid_date，但不是两者都有。 |
paid_date |
日期 | 可选 | 付款日期。要么通过paid_at或paid_date，但不是两者都有。 |
笔记 |
字符串 | 可选 | 任何与付款相关的票据。 |
示例请求:
curl "https://api.bob客服端下载harvestapp.com/v2/invoices/13150378/payments" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -X POST \ -H "Content-Type: application/json" \ -d '{"amount":1575.86，"paid_at":"2017-07-24T13:32:18Z"，"notes":"通过电话支付"}'示例响应:
｛“id”：10336386，“数量”：1575.86，“paid_at”：“2017 - 07 - 24 t13:32:18z”，“paid_date”：“2017-07-24”，“recorded_by”：“简吧”，“recorded_by_email”：“jane@example.com”，“笔记”：“电话付款”，“transaction_id”：零，“created_at”：“2017 - 07 - 28 - t14:42:44z”，“updated_at”：“2017 - 07 - 28 - t14:42:44z”，“payment_gateway”：｛“id”：零，“名称”：零｝｝删除发票付款
删除发票付款。返回一个200好了调用成功时的响应代码。
删除/ v2 /发票/ {INVOICE_ID} /付款/ {PAYMENT_ID}示例请求:
curl "https://api.bob客服端下载harvestapp.com/v2/invoices/13150378/payments/10336386" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -x删除