Webhooks de Fatura

Atenção!

Os webhooks da QI Tech não devem ser mapeadas de forma restrita. Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs.

Reenvio de Webhooks

Você pode consultar e reenviar webhooks seguindo as instruções detalhadas na documentação: Reenvio de Webhooks.

Introdução

Após o fechamento de uma fatura (invoice) dentro do nosso sistema, será enviado um webhook com a mudança de status da fatura:

Enumerador	Tradução	Descrição
processing_closing	processando fechamento	Fatura em processamento de fechamento
processing_expiration	processando expiração	Fatura em processamento de expiração
closed	fechada	Fatura fechada, não recebe mais itens e os pagamentos foram processados
waiting_payment	aguardando pagamento	Fatura aguardando pagamento (aplicável apenas para carteiras do tipo payroll quando há valor restante a ser pago)
paid	paga	Fatura paga

Informação

O timeout para resposta de nosso webhooks é de 10 segundos.

Exemplos

Confirmação de fechamento de fatura

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

Fatura aguardando pagamento (carteira 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": "waiting_payment"
	}
}

Campos do Webhook

Campo	Tipo	Descrição	Caracteres
invoice_key	string	Chave única de identificação da fatura no formato uuid v4	36
total_amount	number	Valor total da fatura	-
paid_amount	number	Valor pago da fatura	-
closing_date	string	Data de fechamento da fatura (formato YYYY-MM-DD)	10
due_date	string	Data de vencimento da fatura (formato YYYY-MM-DD)	10
invoice_status	string	Status da fatura	Enumeradores invoice_status

Enumeradores invoice_status

Enumerador	Descrição
processing_closing	Fatura em processamento de fechamento
processing_expiration	Fatura em processamento de expiração
closed	Fatura fechada, não recebe mais itens e os pagamentos foram processados
waiting_payment	Fatura aguardando pagamento (aplicável apenas para carteiras do tipo payroll quando há valor restante a ser pago)
paid	Fatura paga