Business API
626 operations across 117 resources. Choose a resource to see its requests, responses and who may call them.
Base URL: $BUSINESS_API
Billing and payments
- InvoicesList utility invoices · Price consumption against a tariff and issue an invoice · Reconcile finalized invoice when a reading was superseded · Issue a manual invoice with free lines for one account · Post a credit or debit adjustment to an invoice …13 operations
- ReceivablesList utility receivables1 operation
- PaymentsList recorded payment confirmations · Record payment · Record a payment against a specific invoice · Get the metadata of a payment · Merge metadata …9 operations
- Payment allocationsList allocations of confirmed payments to invoices1 operation
- Payment methodsList the payment methods staff can record for this utility1 operation
- ReceiptsList receipts issued for recorded payments · Download a payment receipt as a PDF recibo · Get a payment receipt by its number3 operations
- TariffsList utility billing tariffs · Create a new tariff schedule · Get a utility tariff schedule · Activate a tariff schedule · Get the metadata of a tariff …6 operations
- Billing runsList billing execution runs · Trigger a periodic billing run · Get a billing execution run · Report what a billing run would issue · Re-run unresolved accounts for an existing billing run …10 operations
- AdjustmentsList invoice billing adjustments1 operation
- Payment plansList customer payment installment plans · Agree on a payment plan · Get a payment installment plan with its installments · Declare a payment plan in default4 operations
- Disconnection noticesList issued disconnection notices1 operation
- Billing policyRead the utility billing policy · Update the utility billing policy · Apply late payment penalties to overdue invoices now3 operations
- Credit grantsList credit grants · Grant promotional or manual account credit · Approve a pending credit grant · Reject a pending credit grant · Bulk grant promotional credits to multiple accounts …6 operations
- Billing schedulesList billing schedules · Create billing schedule · Read a billing schedule · Update or pause a billing schedule4 operations
- PlansList the plans a utility may choose from1 operation
- LedgerList the tenant's chart of accounts · Add a tenant-specific account to the chart · Trial balance · Get ledger reconciliation · List journal entries with their lines …7 operations
- CashierList cashier shifts · Open a shift for the authenticated cashier and counter · Count the drawer and close the shift · The caller's open shift · Get a shift …6 operations
- Bank statementsList bank statements · Import a bank statement · Unmatched bank lines review queue · Get a bank statement · List a statement's lines, optionally by status …9 operations
- CollectionsList eligible cutoffs · Create disconnect field orders for eligible accounts · Debt ageing buckets · Get the tenant cutoff policy · Update the tenant cutoff policy …10 operations
- Payment connectorsCreate payment enrollment token · List payment connectors · Remove a payment connector3 operations
- Payment proofsList proofs of payment, such as those waiting for review · Get a proof of payment · Download the proof file · Approve a proof · Reject a proof with a reason the payer will read5 operations
- PrepaidList prepaid meters · Flag a meter as prepaid · Get a prepaid meter with its wallet balance · Suspend or resume a prepaid meter · List wallet ledger entries …10 operations
- Price revisionsList proposed and applied price revisions · Preview and propose an effective-dated price revision · Get a price revision and its impact preview · Create effective-dated price versions · Reject a proposed price revision5 operations
Meter readings
- MetersList tenant-owned meters · Register a meter against a utility account · Install meter · Replace an installed meter atomically · Installation history of one meter …17 operations
- Meter installationsInstallation history filtered by connection or meter1 operation
- ReadingsList plausibility review · List utility readings with filters · Submit a manual field reading for review · Get a tenant-owned reading · Accept a submitted or review-required reading …7 operations
- Reading cyclesList reading cycles · Create a reading cycle · Get a reading cycle · Update a reading cycle4 operations
- Reading routesAssign a reader and cycle and resequence the walk order · List meter routes in the authenticated utility tenant · Create a service-area route containing active utility meters · Get a route and its ordered meter stops · Enable or disable a reading route …7 operations
- Reading estimatesRecord an estimated meter reading for explicit review1 operation
- Reading importsImport a retry-safe batch of normalized utility readings1 operation
- Reading roundsList route reading rounds · Schedule a reading round for a route and cycle · Get a reading round · Advance or cancel a reading round4 operations
- Reading assignmentsList field-reader assignments · Assign route meters in a round to a utility reader · Get a field-reader assignment · Start, complete, or cancel an assignment4 operations
- ConsumptionsList accepted consumptions · Create accepted consumption2 operations
- Reading requestsList on-demand and scheduled remote reading requests · Create reading request2 operations
- Reading schedulesList remote meter acquisition schedules · Schedule recurring remote readings · Pause or resume a remote reading schedule · Turn due schedules into idempotent reading requests4 operations
- Reading disputesList consumer disputes in the utility tenant · Review, resolve, or reject a consumer reading dispute2 operations
- Meter inspection requestsList consumer and field-reader meter-inspection requests · Schedule, complete, or cancel an inspection request2 operations
- Water qualityList configured quality limits · Put quality standard · List water samples · Record a sample at a reservoir or distribution zone · Get a sample …7 operations
- SensorsList telemetry sensors · Register a telemetry sensor · Get a sensor3 operations
- Alarm rulesList alarm rules · Create a threshold rule with hysteresis · Get an alarm rule · Activate a rule · Deactivate a rule5 operations
- AlarmsList alarms · Get an alarm · Acknowledge an open alarm · Close an alarm with optional notes4 operations
- Water balanceIWA water balance for the whole system with per-DMA detail1 operation
- Reconciliation tariffsList unit-volume reconciliation pricing rules · Create a unit-volume reconciliation pricing rule2 operations
- Reconciliation contractsList operator and agent commission agreements · Create an operator or agent commission agreement on a meter · Get a commission agreement · Activate, suspend or terminate a commission agreement4 operations
- Metered reconciliationsList metered volume and remittance reconciliations · Create metered reconciliation · Get a metered reconciliation with variance flags · Confirm a metered reconciliation · Issue the reconciliation settlement statement5 operations
- Reconciliation settlementsList reconciliation settlement statements · Get a reconciliation settlement statement · Download the reconciliation settlement statement PDF3 operations
- Leak allowance policyGet the tenant leak allowance policy · Save the tenant leak allowance policy2 operations
- Leak allowancesAssess an invoice against the policy without saving · List leak allowance applications · Apply on behalf of a customer · Get a leak allowance application · Download proof of repair …9 operations
- CollectorsList the utility collectors · Get a utility collector · Operational health of a utility collector3 operations
Network and field work
- PropertiesList tenant-scoped properties · Register a property for an existing utility customer · Get the metadata of a property · Merge metadata · Get one property …7 operations
- Service areasList utility service areas · Create a utility service area2 operations
- ConnectionsCut a connection for non-payment · List water service connections · Create a new water service connection · Get water service connection details · Update water service connection details …13 operations
- Field visitsList field visit records and inspection outcomes · Record field visit evidence, outcome, or revisit requirement · Get details of a recorded field visit3 operations
- Evidence photosUpload an evidence photo · Read an evidence photo2 operations
- Service requestsList the utility's service request queue · Get a service request of the utility's queue · Accept a service request · Decline a service request with a reason from the list · List the tariff prices a request's quote can use …9 operations
- Service request decline reasonsGet service request decline reasons · Replace the tenant's decline reasons2 operations
- Site visitsRecord what a site visit found · Cancel a site visit still to happen2 operations
- AssetsList water network assets · Register a water network asset · Get network asset details · Update a water network asset4 operations
- DmasList District Metered Areas · Register a DMA · Get District Metered Area details · Update dma · IWA water balance of one DMA …6 operations
- TopologyList network graph nodes · Create topology node · Get a graph node · Update a graph node · Delete a node with no links and no ledger history …16 operations
- Work ordersList field operations work orders · Create a field work order · Get work order details · Assign work order to crew · Complete work order …20 operations
- IncidentsList water network incidents · Report a water leak or incident · Get incident details · Mark incident resolved · Get the metadata of a incident …6 operations
- InterruptionsList water supply interruptions · Schedule a supply interruption · Get supply interruption details · Mark supply restored4 operations
- CrewsList maintenance crews · Register a maintenance crew · Get maintenance crew details3 operations
- CalendarGet calendar · Update calendar · List holidays, closures and extra working days · Add a holiday, closure or extra working day · Remove a calendar day …19 operations
- Service indicatorsUtility service indicators for operational, commercial1 operation
- InventoryList catalogue items · Create a catalogue item · Get a catalogue item with its reorder levels · Change an item, its standard cost and reorder levels · List warehouses, shelf areas and vans …39 operations
Customer messages
- Notification preferencesList utility communication preferences and consent policies · Update business notification preference2 operations
- Notification intentsList durable business notification intents · Queue a recipient notification intent · Get a notification intent3 operations
- InboxList staff notification inbox · Mark a staff inbox message as read · Archive a staff inbox message3 operations
- CasesList collection cases · Open a collection case · Get collection case · Issue a disconnection notice for a collection case · List notices issued for a collection case …8 operations
- TicketsList support tickets and service requests · Open a support ticket, optionally on behalf of a customer · Get support ticket details · Assign support ticket to agent · Resolve support ticket …10 operations
- CampaignsList promotional credit campaigns · Create a promotional credit campaign · Get a promotional credit campaign · Activate a promotional credit campaign · Pause a promotional credit campaign5 operations
Integrate
- IntegrationsList utility integrations · Register utility integration · Get integration registration metadata · Activate, suspend, or disable a utility integration · Update utility integration configuration5 operations
- EventsList audit events · Verify audit log cryptographic hash-chain integrity2 operations
- DefinitionsList utility report definitions · Create utility report definition · Get a utility report definition3 operations
- ExecutionsList durable report execution runs · Trigger report execution · Get report execution details3 operations
- ExportQueue an asynchronous compliance export · Get an export status · Download a completed compliance package3 operations
- ExportsDownload a completed report execution as CSV · Download a completed report execution as PDF2 operations
- AutomationsList automation rules · Create an automation rule. Requires automations · Ready-made rules · Read a rule · Update automation …15 operations
- Automation triggersList automation triggers1 operation
- Decision policiesRead the decision policy of an approval type · Configure an approval type's mode, conditions and limits · Evaluate a policy against one case and record the decision3 operations
- DecisionsList automatic and human decisions1 operation
- DeveloperGet developer overview · Scopes the caller can put on an API key · Webhook event type catalog · List API keys by prefix and last four · Create a secret or restricted API key …29 operations
- OutboxList the tenant's outbox events and their delivery state · Audit log of status transitions for an aggregate2 operations
- TemporalThe meter bound to a connection at a valid and system time · Full binding history including superseded corrections · Correct meter binding · The tariff in force for a category at a point in time · The owner of a property at a point in time5 operations
- JobsList durable background jobs · Counts of jobs by status, including dead letters · List jobs that exhausted their attempts · Requeue a dead letter as a new job · Read one job5 operations
Platform and account
- OrganizationGet the authenticated utility profile1 operation
- OrganizationsList owned, linked · Request to add an account, pending its owner's consent · Request organization account removal · Get organization portfolio · List organization setting templates …20 operations
- TenantList available organization templates · List template adoptions requested for this account · Accept organization template adoption · Detach organization template adoption · Get pending organization link consents …6 operations
- Organization linksApprove organization account link · Reject organization account link2 operations
- SearchSearch the authenticated utility tenant1 operation
- CustomersDownload the customer import CSV template · Validate a customer CSV without writing anything · Confirm a customer import dry run · List customers · Register a utility customer …9 operations
- AccountsList service and billing accounts for the utility tenant · Open a billing/service account · Get an account in the authenticated utility tenant · List identities linked to an account · Grant a consumer explicit account permissions …12 operations
- Tariff templatesTariff templates for the utility's country · Create a tariff from a template2 operations
- SubscriptionGet utility subscription · Request cancellation of utility platform SaaS subscription · Get utility usage against the plan's limits · Get utility platform credit balance and grants · Redeem a platform promotional code …13 operations
- MetricsList utility governed metrics catalog1 operation
- AuditExport audit events · Verify audit export2 operations
- TeamList a team member sessions · End every session of a team member · List invitations for the active utility or organization team · Invite a member to the active utility or organization team · Revoke utility team invitation …9 operations
- Security policyGet the tenant security policy · Replace the tenant security policy2 operations
- ComplianceGet the retention schedule · Update retention days per class2 operations
- WorkspaceGet workspace verification requirements · Request workspace close · Reverse workspace close3 operations
- OnboardingGet business onboarding · Update business onboarding · Submit the application for review · Submit custom onboarding requirement · List uploaded onboarding documents …11 operations
- Account invitationsCreate invitations for many accounts and send them1 operation
- Account link requestsQueue of consumer link requests · Approve a link request, creating the membership · Reject a link request3 operations
- MetadataList resources by metadata1 operation
- OverviewGet business overview1 operation
- BrandingGet business branding · Change the utility's brand · Upload a utility brand file · Return a utility brand file to the next level down4 operations
- SandboxAdvance sandbox1 operation
- First runCheck the utility's payment connection · Read first-use progress for one journey · Skip or resume one first-use step · Record an explicit exit from a first-use journey4 operations
- Next stepsThe next one to three first-use steps1 operation
- LdapRead the tenant's directory connection · Create or replace the tenant's directory connection · Remove the tenant's directory connection · Synchronize members from the directory now · Test connectivity to the directory server5 operations
- SsoRead the tenant's single sign-on connection · Create or replace the tenant's single sign-on connection · Remove the tenant's single sign-on connection · Extract SAML settings from identity provider metadata · Probe the configured identity provider …6 operations
- ScimShow the tenant's SCIM directory tokens · Issue a SCIM directory token · Revoke a SCIM directory token3 operations
- SiemShow the tenant's audit event destinations · Add a destination for real-time audit events · Read one audit event destination · Remove an audit event destination · Send a test event to an audit event destination5 operations
- Portfolio overviewGet portfolio overview1 operation
- Utility relationshipsList people's relationships with the utility1 operation