invoice-finalised

An invoice was issued

WEBHOOK invoice-finalised

default

{
  "event": {
    "id": "3f1c9a52-7b4e-4d21-9c6a-0e5d8b2f4a17",
    "type": "invoice-finalised",
    "timestamp": 1793610900
  },
  "payload": {
    "id": 19017,
    "resource": "invoice",
    "number": "VP-R-2026-000042",
    "kind": "periodic",
    "status": "sent",
    "serviceMonth": "2026-10",
    "servicePeriodStart": "2026-10-01",
    "servicePeriodEnd": "2026-10-31",
    "cancelsInvoiceId": null,
    "cancelledByInvoiceId": null,
    "issueDate": "2026-11-02",
    "dueDate": "2026-11-16",
    "collectionMethod": "sepa-debit",
    "collectionDate": "2026-11-16",
    "netAmount": {
      "value": 128000,
      "label": "€1,280.00"
    },
    "taxAmount": {
      "value": 24320,
      "label": "€243.20"
    },
    "grossAmount": {
      "value": 152320,
      "label": "€1,523.20"
    },
    "amountPaid": {
      "value": 0,
      "label": "€0.00"
    },
    "amountCancelled": {
      "value": 0,
      "label": "€0.00"
    },
    "amountDue": {
      "value": 152320,
      "label": "€1,523.20"
    },
    "taxTreatment": "domestic",
    "taxBreakdown": [
      {
        "category": "standard",
        "rate": "19.00",
        "netAmount": {
          "value": 128000,
          "label": "€1,280.00"
        },
        "taxAmount": {
          "value": 24320,
          "label": "€243.20"
        }
      }
    ],
    "paymentInstructions": {
      "type": "sepa-debit",
      "mandateReference": "EXAMPLE-MANDATE-REF",
      "creditorId": "DE00ZZZ00000000000",
      "ibanLast4": "3000",
      "collectionDate": "2026-11-16"
    },
    "lineCount": 6,
    "eInvoiceFormat": "zugferd-en16931",
    "language": "de",
    "dunningLevel": "none",
    "sentAt": "2026-11-02T07:05:12Z",
    "paidAt": null,
    "_links": {
      "self": {
        "href": "https://api.voucher.allride.io/consumer/v1/billing/invoices/19017",
        "type": "application/json"
      },
      "lines": {
        "href": "https://api.voucher.allride.io/consumer/v1/billing/invoices/19017/lines",
        "type": "application/json"
      },
      "document": {
        "href": "https://api.voucher.allride.io/consumer/v1/billing/invoices/19017/document?format=pdf",
        "type": "application/json"
      }
    }
  }
}

Audience: consumer · Trigger: the invoice (also a Stornorechnung) is finalised and its document rendered · Payload: Invoice (consumer view) · Permission: subscribing needs view-consumer-billing

Billing event. Requires a webhook endpoint subscribed by a consumer partner; payloads never include payment-provider messages. See Billing webhooks.

Verify the x-signing-signature header before you trust the body (Verifying signatures). Deliveries are at least once and unordered; deduplicate on event.id.

Authorizations

Authorization · string · header · required

Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.

Headers

x-signing-signature · string · required

t=<unix seconds>,s1=<hex HMAC-SHA256 of "<raw body>.<t>" with your first secret>,s2=<the same with your second secret>. Accept the delivery when either signature matches. See Verifying signatures.

Body

application/json

Body of a invoice-finalised webhook.

event · object · required

The event.

Show child attributes

payload · object · required

The resource the event is about, starting with resource and id: the consumer view of the resource, or the fields this event type defines.

Show child attributes

Response

2XX

Acknowledge receipt within 15 seconds.