NewProvince is only required for addresses in Spain
BeeL
Get startedMulti-NIFVeriFactuRulesStripeAPI referenceChangelog
Webhook Events

Scheduled invoice not issued

Delivered when an invoice you scheduled could not be issued on its date and BeeL. gave up retrying. The invoice is not lost: it stays in drafts, untouched, and can be issued by hand once the cause is fixed.

Why this matters: nothing else tells you. Unlike recurring_invoice.paused, there is no schedule to pause here — a scheduled invoice is a one-off, so without this event the work simply stops and no one finds out.

Trigger: the daily batch retried the scheduled emission and hit a failure that waiting will not fix. A transient failure does not produce this event; the next run retries it.

Recommended actions:

  • Fix the blocker (it is the same vocabulary the emission API returns in a 422 EMISSION_NOT_READY) and issue the draft.
  • Note that it will then be issued with the date of the day it is issued: backdating a fiscal document is not allowed.

Also delivered in Test. Sandbox is a faithful rehearsal of the mechanism, so you can see this failure mode before it happens in Live.

Always verify BeeL-Signature before processing.


Header Parameters

BeeL-Signaturestring

HMAC-SHA256 signature. Format: t=<unix_timestamp>,v1=<hex_signature>

Verify this before processing any event (see spec description for algorithm).

Match^t=\d+,v1=[0-9a-f]{64}$
BeeL-Eventstring

Canonical event type identifier (matches the type field of the payload).

Value in"verifactu.status.updated" | "invoice.issued" | "invoice.email.sent" | "invoice.pdf.generated" | "invoice.voided" | "recurring_invoice.paused" | "invoice.schedule_failed" | "account.claimed" | "company.created" | "representation.signed"
BeeL-Event-Idstring

UUID of the logical webhook event. Identical across all retry attempts. Matches the id field in the payload. Use this for idempotency deduplication.

Formatuuid
BeeL-Delivery-Idstring

UUID of this specific delivery attempt. Unique per HTTP call, even for retries of the same event. Use this to correlate with delivery logs in the BeeL. dashboard.

Formatuuid
Idempotency-Keystring

Same value as BeeL-Event-Id. Standard idempotency header for deduplication.

Formatuuid
idstring

Unique identifier of this webhook event delivery.

Formatuuid
typestring
Value in"invoice.schedule_failed"
created_atstring

ISO-8601 timestamp when the event was created.

Formatdate-time
api_versionstring

BeeL. API version that generated this event.

livemodebooleanDeprecated

Deprecated in favour of the TEST/PROD environment vocabulary: livemode: true is equivalent to environment PROD.

test?boolean|null

true only for test deliveries triggered manually from the BeeL. dashboard.

company_id?string|null

Unique identifier (UUID) of the company the event is about, or null when not scoped to a specific company. A single endpoint receives events for every company it manages (multi-NIF / accounting firms); route on this field.

Formatuuid
nif?string|null

NIF of the company the event is about (human-readable identifier).

account_id?string|null

Account the event happened in. For your own events this is your account; for events of accounts you manage it identifies which one. Route on this field together with account_external_ref.

Formatuuid
account_external_ref?string|null

Your own identifier for that account, as supplied when you provisioned it (external_ref). Lets you map the event onto your internal record without an extra lookup. null for accounts you did not provision.

account_relationship?string|null

How account_id relates to you: own when the event happened in your own account, managed when it happened in an account you manage. Same field name and vocabulary as the account_relationship you set on POST /v1/webhooks to choose which of these you receive (own by default; all there means both).

Value in"own" | "managed" | null
data

Payload for invoice.schedule_failed events.

Response Body

Invoice PDF generated

Delivered when BeeL. stores the PDF of an invoice. **Trigger:** - **Issued invoice:** once. The PDF of an issued invoice is generated a single time — with its VeriFactu QR when the issuer uses VeriFactu, at issuance otherwise — and is never modified afterwards. Voiding the invoice or issuing a corrective for it does **not** produce a new PDF and does not deliver this event: the status is reported by the API and by `invoice.voided`, not by the document. - **Proforma:** each time its PDF is generated (created, or regenerated after an edit). - **Exceptional regeneration:** BeeL. staff may regenerate the PDF of an issued invoice to fix a rendering defect. That is recorded and delivers the event again, with the next `data.generation`. It never sends an email to the customer. `data.generation` numbers the stored PDF of that invoice (`1`, `2`, …). Each generation is delivered once: a redelivery of the same generation is a retry, not a new PDF, and carries the same `BeeL-Event-Id`. **Recommended actions:** - Re-fetch the PDF with `GET /v1/companies/{company_id}/invoices/{invoice_id}/pdf`, which returns a fresh pre-signed URL. That call now waits for the PDF instead of making you poll, so a `200` is the normal answer. - Drop any copy you cached from an earlier delivery of this same invoice. **No URL travels in the payload** — on purpose. A download URL expires in five minutes and webhooks are retried for longer than that, so a delivered URL would often be dead on arrival and, until then, sitting in your logs. **Always verify `BeeL-Signature` before processing.**

Invoice voided

Delivered when an invoice is voided. **Trigger:** Invoice transitions to a voided state (e.g. the issuer voids it via the dashboard or Public API). **Recommended actions:** - Reverse downstream automations triggered by `invoice.issued`. - Notify the customer if appropriate. **Always verify `BeeL-Signature` before processing.**