跳到主要内容

发票 Webhooks

注意！

QI Tech 的 webhooks 不应以严格方式映射。 我们 API 返回的 webhook 载荷中可能包含额外字段。

重发 Webhooks

您可以按照文档中的详细说明查询和重发 webhooks：重发 Webhooks。

简介​

在我们系统中发票（invoice）关账后，将发送包含发票状态变更的 webhook：

枚举值翻译描述
processing_closing正在处理关账发票正在处理关账
processing_expiration正在处理到期发票正在处理到期
closed已关账发票已关账，不再接受新条目，付款已处理
processing_payment等待付款发票等待付款（仅适用于有剩余应付金额的 payroll 类型钱包）
paid已付款发票已付款
说明

我们 webhooks 的响应超时时间为 10 秒。

示例​

发票关账确认​

Webhook Body
{
	"webhook_type": "baas.invoice.invoice_status_change",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"invoice_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
		"total_amount": 350.00,
		"paid_amount": 0.00,
		"closing_date": "2024-01-31",
		"due_date": "2024-02-15",
		"invoice_status": "closed"
	}
}

发票等待付款（payroll 钱包）​

Webhook Body
{
	"webhook_type": "baas.invoice.invoice_status_change",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"invoice_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
		"total_amount": 350.00,
		"paid_amount": 0.00,
		"closing_date": "2024-01-31",
		"due_date": "2024-02-15",
		"invoice_status": "processing_payment"
	}
}

Webhook 字段​

字段类型描述字符数
invoice_keystringuuid v4 格式的发票唯一识别密钥36
total_amountnumber发票总金额-
paid_amountnumber发票已付金额-
closing_datestring发票关账日期（YYYY-MM-DD 格式）10
due_datestring发票到期日期（YYYY-MM-DD 格式）10
invoice_statusstring发票状态invoice_status 枚举值

invoice_status 枚举值​

枚举值描述
processing_closing发票正在处理关账
processing_expiration发票正在处理到期
closed发票已关账，不再接受新条目，付款已处理
processing_payment发票等待付款（仅适用于有剩余应付金额的 payroll 类型钱包）
paid发票已付款