Skip to content

invoice.status_changed

The status of an invoice changed: when BIRP sends this event, what its data holds and an example of its body.

Version v1.2, updated

On this page

BIRP sends invoice.status_changed to the webhook endpoints that receive it. This page says when it is sent and what data holds, with an example of the body.

When it is sent

The status of the invoice changed: from draft to issued only invoice.issued is sent, from draft to cancelled only this event, and from draft to any other status both. previous_status holds the status before the change, the first one when it changed twice within a few seconds. data.status is the status when the event is sent.

Data

data holds an invoice, with the fields of Invoices, and previous_status.

Example

Body of invoice.status_changedJSON
{
  "api_version": "v1",
  "data": {
    "amount_due": "66.80",
    "amount_paid": "60.00",
    "buyer": {
      "address": "12 rue des Exemples",
      "city": "Paris",
      "country": "France",
      "name": "Epicerie Exemple SARL",
      "postal_code": "00000",
      "registration_number": "EXAMPLE-0002",
      "vat_number": "EXAMPLE-VAT-0002"
    },
    "created_at": "2026-09-28T09:12:40.000Z",
    "currency": "EUR",
    "customer_id": "00000000-0000-4000-8000-000000000031",
    "due_at": "2026-10-28T00:00:00.000Z",
    "external_ids": [],
    "id": "00000000-0000-4000-8000-000000000061",
    "issued_at": "2026-09-28T00:00:00.000Z",
    "legal_footer": null,
    "lines": [
      {
        "description": "White bread 500 g",
        "details": null,
        "discount": "0.00",
        "id": "00000000-0000-4000-8000-000000000071",
        "line_total": "64.00",
        "lot_number": "EXAMPLE-LOT-0001",
        "position": 0,
        "product_id": "00000000-0000-4000-8000-000000000012",
        "product_kind": "finished_product",
        "quantity": "20.0000",
        "unit": "pcs",
        "unit_price": "3.2000",
        "vat_amount": "12.80",
        "vat_rate": "20.00"
      },
      {
        "description": "Wheat flour 25 kg",
        "details": null,
        "discount": "0.00",
        "id": "00000000-0000-4000-8000-000000000072",
        "line_total": "50.00",
        "lot_number": null,
        "position": 1,
        "product_id": "00000000-0000-4000-8000-000000000011",
        "product_kind": "goods",
        "quantity": "4.0000",
        "unit": "kg",
        "unit_price": "12.5000",
        "vat_amount": "0.00",
        "vat_rate": "0.00"
      }
    ],
    "notes": null,
    "number": "EXAMPLE-INV-0098",
    "order_id": "00000000-0000-4000-8000-000000000051",
    "paid_at": null,
    "payment": {
      "bank_account": "EXAMPLE-IBAN-0001",
      "method": "bank_transfer",
      "reference": "EXAMPLE-INV-0098",
      "terms_days": 30
    },
    "payment_status": "partially_paid",
    "previous_status": "issued",
    "related_invoice_id": null,
    "seller": {
      "address": "Str. Exemplului 4",
      "city": "Chisinau",
      "country": "Moldova",
      "name": "Brutaria Exemplu SRL",
      "postal_code": "MD-0000",
      "registration_number": "EXAMPLE-0001",
      "vat_number": "EXAMPLE-VAT-0001"
    },
    "status": "sent",
    "subtotal": "114.00",
    "supplied_at": "2026-09-28T00:00:00.000Z",
    "total": "126.80",
    "total_discount": "0.00",
    "total_vat": "12.80",
    "type": "invoice",
    "updated_at": "2026-09-28T14:05:12.417Z",
    "vat_breakdown": [
      {
        "tax_code": "ZERO",
        "taxable_amount": "50.00",
        "vat_amount": "0.00",
        "vat_rate": "0.00"
      },
      {
        "tax_code": "STANDARD",
        "taxable_amount": "64.00",
        "vat_amount": "12.80",
        "vat_rate": "20.00"
      }
    ],
    "vat_exemption_reason": null,
    "vat_exemption_text": null
  },
  "id": "00000000-0000-4000-8000-000000000115",
  "occurred_at": "2026-09-28T14:05:12.417Z",
  "type": "invoice.status_changed"
}

Related

  • webhook-events
  • invoices-resource
  • verify-webhook-signatures