Invoice Webhooks

Attention!

QI Tech webhooks should not be mapped in a restrictive way. Additional fields may be included in the webhook payloads returned by our APIs.

Webhook Resending

You can check and resend webhooks by following the detailed instructions in the documentation: Webhook Resending.

Introduction

After closing an invoice (invoice) within our system, a webhook will be sent with the invoice status change:

Enumerator	Translation	Description
processing_closing	processing closure	Invoice being processed for closure
processing_expiration	processing expiration	Invoice being processed for expiration
closed	closed	Invoice closed, no longer receives items and payments have been processed
processing_payment	awaiting payment	Invoice awaiting payment (applicable only for payroll type wallets when there is remaining amount to be paid)
paid	paid	Invoice paid

Information

The timeout for our webhook response is 10 seconds.

Examples

Invoice closure confirmation

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"
	}
}

Invoice awaiting payment (payroll wallet)

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 Fields

Field	Type	Description	Characters
invoice_key	string	Unique invoice identification key in uuid v4 format	36
total_amount	number	Total invoice amount	-
paid_amount	number	Paid invoice amount	-
closing_date	string	Invoice closing date (YYYY-MM-DD format)	10
due_date	string	Invoice due date (YYYY-MM-DD format)	10
invoice_status	string	Invoice status	invoice_status Enumerators

invoice_status Enumerators

Enumerator	Description
processing_closing	Invoice being processed for closure
processing_expiration	Invoice being processed for expiration
closed	Invoice closed, no longer receives items and payments have been processed
processing_payment	Invoice awaiting payment (applicable only for payroll type wallets when there is remaining amount to be paid)
paid	Invoice paid