跳到主要内容

发票付款 Webhooks

注意！

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

重发 Webhooks

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

简介​

在我们系统中发票付款（invoice_payment）状态发生变更后，将发送包含付款状态变更的 webhook：

枚举值翻译描述
processing_payment等待付款发票付款等待支付
paid已付款发票付款已支付
说明

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

示例​

发票付款（payroll_discount）​

Webhook Body
{
	"webhook_type": "baas.invoice.invoice_payment_status_change",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"wallet_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
		"invoice_payment_key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
		"total_amount": 350.00,
		"paid_amount": 0.00,
		"payment_date": "2024-02-15",
		"invoice_payment_type": "payroll_discount",
		"invoice_payment_status": "processing_payment"
	}
}

发票付款（bank_slip）​

Webhook Body
{
	"webhook_type": "baas.invoice.invoice_payment_status_change",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"wallet_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
		"invoice_payment_key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
		"total_amount": 350.00,
		"paid_amount": 0.00,
		"payment_date": "2024-02-15",
		"invoice_payment_type": "bank_slip",
		"invoice_payment_status": "processing_payment"
	}
}

Webhook 字段​

字段类型描述字符数
wallet_keystringuuid v4 格式的钱包唯一识别密钥36
invoice_payment_keystringuuid v4 格式的发票付款唯一识别密钥36
total_amountnumber发票付款总金额-
paid_amountnumber发票已付金额-
payment_datestring付款日期（YYYY-MM-DD 格式）10
invoice_payment_typestring发票付款类型invoice_payment_type 枚举值
invoice_payment_statusstring发票付款状态invoice_payment_status 枚举值

invoice_payment_type 枚举值​

枚举值描述
bank_slip银行票据
payroll_discount薪资扣款

invoice_payment_status 枚举值​

枚举值描述
processing_payment发票付款等待支付
paid发票付款已支付
说明
  • 对于 payroll_discount 类型的付款：发票关账时以 processing_payment 状态创建付款，并向 INSS 申请扣款。扣款完成后，状态变更为 paid。
  • 对于 bank_slip 类型的付款：收到银行票据付款通知时，以 processing_payment 状态创建付款。银行票据结清时，状态变更为 paid。如果未收到付款通知，也可能直接以 paid 状态创建付款。