Invoicing overview
The Invoicing APIs let you generate a branded PDF invoice and a hosted payment link for each customer, dispatch them by email/SMS, and then track payment status through to settlement.
A typical flow:
- Create the invoice
Call Create Invoice with the customer's details, line items, and total. You get back a unique
invoice_pay_link. - Send it to the customer
Omniware emails the invoice automatically. Re-send (or send for the first time) any time with Dispatch Invoice.
- Customer pays
Through the hosted link, which uses the same payment page as Payment Request. All payment methods enabled on your merchant account are available.
- Reconcile
Look up status with Get Invoice or list a date range with Get Invoices by Date Range.
All endpoints
| Endpoint | Purpose |
|---|---|
| Create Invoice | Generate a new invoice with one or many line items. |
| Edit Invoice | Update an existing invoice (only before payment). |
| Get Invoice | Fetch one invoice by number. |
| Get Invoices by Date Range | List invoices matching a date / phone / email filter. |
| Dispatch Invoice | (Re)send an invoice email/SMS. |
| Cancel Invoice | Cancel an unpaid invoice. |
Statuses
| Status | Meaning |
|---|---|
created | Invoice exists but not yet dispatched. |
dispatched | Email/SMS sent to the customer. |
paid | Customer paid through the hosted link. |
cancelled | Invoice cancelled before payment. |