Invoice Events
Invoice notifications enable seamless integration between OpenMeter and external systems by providing real-time updates on invoice state changes. Key applications include:
- Automated response handling for overdue or uncollectible invoices
- Immediate notification of invoice validation exceptions
- Enterprise integration with third-party invoicing and payment solutions through the Custom Invoicing App
Please note that notifications for Gathering Invoices are currently not supported. If this functionality is critical for your implementation, we encourage you to reach out to our support team to discuss your requirements.
Invoice notifications
To receive invoice notifications, follow these steps:
Create a Notification Channel
Configure an Invoice Notification Rule
Rules
OpenMeter supports two types of invoice notification rules:
invoice.created
: Triggered when a new invoice is generatedinvoice.updated
: Triggered when an existing invoice's state changes
These rules are configured without additional parameters and will capture all invoice-related events in the system.
Note: As mentioned previously, notifications for Gathering Invoices are not currently supported.
Events
The structure of invoice events aligns with the Get Invoices API endpoint response, encapsulated within a standardized event envelope.
Example event:
An invoice event is generated for each state transition of the invoice (e.g.
draft.created
-> draft.sync
). Please check the relevant documentation on
Invoice Lifecycle on interpreting
the invoice states.