Task guides
Step by step for the most common tasks, each with the call, the response and how to confirm it worked.
- Import customersMove a customer register into the API as customers, properties and service accounts, in the order the API needs, with idempotency keys that make a second run safe.
- Record meter readingsSend readings through the API without duplicates on retry, read the plausibility check's verdict, and accept or reject each reading before it reaches billing.
- Issue invoices and credit notesIssue a manual invoice on a service account outside a billing run, then lower or raise what it charges with a credit or debit note, and watch the invoice.issued and invoice.adjusted events.
- Receive paymentsRecord payments confirmed outside the platform against an invoice, and learn about every payment, wherever it came from, through the payment.received and invoice.paid events.
- Sell prepaid creditEnroll a meter as prepaid, price an amount in litres and sell credit at the counter, with the STS token and the receipt number in one response.
- Listen to webhook eventsReceive signed events on your server, check the Standard Webhooks headers, test locally with the CLI and register the permanent endpoint through the API.
- Build a resident appSign residents in with OAuth 2.0 and PKCE, show the accounts and invoices each one may see through the Consumer API, and open an M-Pesa payment.
- Connect a payment connectorBuild a payment connector against the Connector API, from the enrollment code to registration, leasing collection jobs, heartbeats, reporting the outcome and posting payments seen outside a job.
- Automate with the CLIWrite a nightly job that submits meter readings from a CSV file and exports open invoices, passing the key on standard input, reading JSON output and branching on the CLI's exit codes.