API package
CRM
Accounts, sales automation, service cases, and field service — closed-won deals bill through Accounting.
160 APIs1210 operationsBase path
/api/crmAccounts & Contacts
Accounts
Open a customer for its sites, selling context, financial terms, credit profile and account relationships — ship-to, bill-to and payer are frequently three different places.
GET6 POST5 PUT2 PATCH1 DELETE2
Contacts
Read and maintain contacts records (crm.contacts).
GET2 POST2 PUT1 DELETE1
Automation
Follow-up Enrolments
Who is going through which sequence, and when the next step is due.
GET2 POST1 PUT1 DELETE1
Follow-up Sequences
Timed follow-ups: each step is a task for the owner or an email to the person, so many days after the start. A sequence may take every lead routing hands out.
GET2 POST2 PUT1 DELETE1
Sales Automation Rules
Renewals, stale pipeline, churn, lead routing, follow-ups, case assignment and field dispatch: each switched on here, with its limits and strategy. What a rule may change is the company's autonomy level for its key.
GET2 POST3 PUT1 DELETE1
Technician Skills
Who can be dispatched to what, where, and how many visits a day. Field dispatch picks the least busy available technician with the skill in the customer's country.
GET2 POST2 PUT1 DELETE1
Broadcast
Broadcast Channels
One row per channel a broadcast goes out on. This is where the simultaneous part lives: an email row, an X row, a LinkedIn row, all pointing at one message and all sent together.
GET3 POST3 PUT1 DELETE1
Broadcasts
Every send, with what became of it. The rates are over what was DELIVERED rather than what was sent: an open rate over sends counts the bounces as people who did not open, which flatters a bad list and punishes a clean one.
GET4 POST9 PUT1 DELETE1
Never Write To These
Addresses that must never be written to again, whatever a list says. Separate from consent because they are different facts: consent is what somebody chose, and a suppression is what happened.
GET2 POST2 PUT1 DELETE1
Credit Control
Credit Blocks
What credit stopped or warned about, on an order, a delivery or an invoice. A credit controller releases a block with a note, which lets that document through, or rejects it.
GET2 POST4 PUT1 DELETE1
Credit Control Areas
A selling unit’s credit policy: a default limit and, for orders, deliveries and invoices, whether credit is checked and whether a breach blocks or only warns. With no area and no risk rule, credit works exactly as before.
GET2 POST2 PUT1 DELETE1
Credit Limits by Area
A customer’s own limit in a credit control area, in the company’s currency.
GET2 POST2 PUT1 DELETE1
Credit Risk Rules
By the customer’s risk category: how much of the limit may be used, a cap, what a breach does, and how overdue an invoice may be before new business stops.
GET2 POST2 PUT1 DELETE1
Customer Portal
Customer Portal Settings
What the customer portal offers -- paying online, accepting quotations, raising cases, asking for returns -- and how its sign-in is kept: two-step, session length, lockout.
GET2 POST3 PUT1 DELETE1
Customer Portal Users
People at your customers who sign in to the customer portal to see their invoices, orders, quotations, cases and returns: invited by email, held to their own account, with a second step where you require one. The supplier portal's people are in Supply Chain.
GET3 POST6
Engagement & Retention
Forecasting & Quotas
Forecast Board
Quota, closed, commit, best case and pipeline for you and the people who report to you: attainment, weighted pipeline and coverage, your call for the period, and how past calls compared with what closed.
GET3 POST4
Forecast Calls
Every call made for a period: what the system saw, what the rep committed, and what their manager changed it to and why.
GET2 POST2 PUT1 DELETE1
Forecast Categories
Pipeline, best case, commit, closed and omitted, and which opportunity stages fall in each. A deal can be moved out of its stage's category with a reason.
GET2 POST2 PUT1 DELETE1
Forecast Snapshots
A photograph of every salesperson's numbers each week, so forecast against actual can be read back afterwards.
GET2 POST2 PUT1 DELETE1
Quota Periods
The months or quarters of each plan, as the fiscal calendar gives them.
GET2 POST2 PUT1 DELETE1
Quota Plans
A plan per fiscal year, cut into months, quarters or the year from the company's fiscal calendar. Activate one and the forecast board and the weekly snapshot read it.
GET2 POST5 PUT1 DELETE1
Quotas
What each salesperson, team or territory is expected to close in a period, in money and units, optionally per product line.
GET2 POST2 PUT1 DELETE1
Sales Team Members
The people in each team.
GET2 POST2 PUT1 DELETE1
Sales Teams
Who sells together and who manages them. A manager sees and rolls up their team's forecasts; a team may sit under another.
GET2 POST2 PUT1 DELETE1
Sales Territories
Where each team sells: countries and regions. A territory can carry a quota of its own.
GET2 POST2 PUT1 DELETE1
Inbox & Calendar
Mailbox Apps
The company's app registrations at Microsoft (Entra ID) and Google, through which each person connects their own mailbox. The client secret is sealed and never shown.
GET2 POST2 PUT2 DELETE1
Mailbox Connections
Your Microsoft 365 or Google mailbox and calendar, logged into CRM as emails and meetings against the people and companies they involve. Nothing is read until you opt in; you choose what is kept.
GET2 POST7 PUT1
Mailbox Sync Log
Every message and meeting your mailbox sync looked at, and what became of it. Yours only.
GET1
Mailbox Sync Runs
Each time your mailbox was read: how much, what was logged, and what was left out.
GET1
Interaction Centre
Call Scripts
What a call in a salesperson’s AI voice says. Only an approved script can be used, approved by somebody other than its author; changing an approved script makes a new version, and every call records the version it used. The AI-voice disclosure is always spoken before the script.
GET2 POST5 PUT1 DELETE1
Connected Channels
Teams, Zoom, Twilio, a contact centre, an email provider — what this company can actually reach a customer through, and what each one is capable of. Microsoft Teams calls, meetings and presence are set up here: register an app in Microsoft Entra, grant it the Graph application permissions Calls.Initiate.All, OnlineMeetings.ReadWrite.All, Presence.Read.All and CallRecords.Read.All with admin consent, enter its tenant id and client id below, save its client secret with "Set the credential", then press "Test it" — the test names anything still missing. TRANXACT starts the call or meeting and logs it; the conversation itself happens in Teams.
GET2 POST2 PUT1 DELETE1
Dispositions
The reasons a call can be closed with. Configuration rather than free text, because a disposition somebody types is a disposition nobody can count.
GET2 POST2 PUT1 DELETE1
Interactions
Every call, chat, meeting and message with a customer. The disposition is the field that makes a desk countable and the one most often left empty.
GET2 POST2 PUT1 DELETE1
My Voice
Record your consent and a sample of your own voice, so calls can be placed in it on your behalf. Every such call opens by saying it is an AI-generated voice. Only you can use your voice.
GET4 POST8 PUT1
Queue Staffing
Who staffs each queue and how good they are at it. The proficiency is what makes skill-based routing worth having: everybody can take a billing call, and three people should.
GET2 POST2 PUT1 DELETE1
Queues
What customers wait in. The columns are the promises a desk makes: answer within this many seconds, offer a callback rather than hold past this.
GET2 POST2 PUT1 DELETE1
Recordings
What was recorded, whether the caller was told, and when it must be destroyed. Most regimes cap how long a recording may be kept, and nobody deletes what has no date on it.
GET2 POST2 PUT1 DELETE1
Who Is Available
Where each person is right now, and whether the platform agrees. They disagree constantly — somebody on a Teams call is on a call whether or not the desk knows — and the disagreement is shown rather than reconciled away.
GET2 POST2 PUT1 DELETE1
Lead Scoring
Lead Score History
Every score a lead has been given, by which model, and what it set off.
GET2 POST2 PUT1 DELETE1
Lead Scoring Models
How leads are scored: weighted rules on what a lead is and what it has done, or a model trained from the leads you converted and lost. One is active; grades A-D, and what happens at each threshold.
GET2 POST7 PUT1 DELETE1
Lead Scoring Rules
A rules model's lines: what is tested, and the points it adds.
GET2 POST2 PUT1 DELETE1
Marketing
Campaigns
What is being run, to whom, at what cost and to what effect.
GET3 POST5 PUT2 DELETE2
Events
Open days, webinars and fairs. A full event waitlists; attending counts for far more than registering.
GET3 POST5 PUT2 DELETE2
Segmentation
Saved audiences. A dynamic segment is rebuilt from its criteria, so it cannot quietly go stale.
GET4 POST4 PUT1 DELETE1
Point of Sale
POS Registers
The tills in each store.
GET2 POST2 PUT1 DELETE1
POS Sessions
Each cashier's shift on each till: float, takings, the count and the over or short.
GET2 POST2 PUT1 DELETE1
POS Stores
A shop: where its stock comes from, what it charges, its tax, its card provider, and the ledger accounts its takings post to.
GET2 POST2 PUT1 DELETE1
POS Terminal
The till: open a session with its float, scan and sell, take cash, card or both, take returns, and close with a cash count. Works through a short outage and catches up.
GET3 POST5
POS Tickets
Every sale and return rung up, with its tax and how it was paid.
GET2 POST2 PUT1 DELETE1
POS Z Reports
The end of a closed session: takings summed and posted as one journal, and the stock issued.
GET2 POST1
Pricing
Price List Entries
Priced by item or by whole category, with quantity breaks. A category line is what makes "10% off all fasteners" one row rather than four hundred.
GET2 POST2 PUT1 DELETE1
Price Lists
A set of prices valid over a period, for a currency. A list may be derived from another by a percentage, which is how most regional lists exist.
GET2 POST2 PUT1 DELETE1
Pricing Procedures
Access Sequence Steps
One attempt of a sequence: the keys a condition record must carry to be found. The first step that finds a record wins.
GET2 POST2 PUT1 DELETE1
Customer Pricing Group Assignments
Which pricing group each customer is in.
GET2 POST2 PUT1 DELETE1
Customer Pricing Groups
Groups of customers that share pricing conditions (distributors, retail, key accounts).
GET2 POST2 PUT1 DELETE1
Price List Discount Steps
Discounts taken off a list’s price one after another, in step order, each with its own quantity threshold. A step with no entry applies to the whole list.
GET2 POST2 PUT1 DELETE1
Pricing Access Sequences
The order in which a condition looks for its value: the most specific key first (customer and item), then wider ones (item alone). Add the steps on Access Sequence Steps.
GET2 POST2 PUT1 DELETE1
Pricing Condition Records
The values: 5% off for this customer on this item, 8% off for the distributor group on a category, a freight surcharge for any item. The access sequence decides which one applies.
GET2 POST2 PUT1 DELETE1
Pricing Condition Types
The kinds of element a procedure stacks: a price, discounts, surcharges -- and charges on the document (freight, insurance, packing, inspection, duty) for quotations, sales orders and purchase orders. PR00 is the list price. Liquidated damages (LD): 0.5% of the late goods’ net value for every week late, at most 5% of the order’s net value, no VAT/GST, found for an order by its own condition records.
GET2 POST2 PUT1 DELETE1
Pricing Procedure by Document
Which procedure prices each kind of document. A document type with no row uses the default procedure. "Apply on save" lets a new line left at its untouched default price take the procedure’s price; otherwise the procedure’s price is only recorded beside the line.
GET2 POST2 PUT1 DELETE1
Pricing Procedure Steps
One step of a procedure: which condition, whether a percentage is taken of the running price or of the price after an earlier step, whether it is mandatory, whether it is only shown.
GET2 POST2 PUT1 DELETE1
Pricing Procedures
The ordered steps that arrive at a unit price. The standard procedure is the list-price lookup, exactly as before; add steps for discounts and surcharges and assign the procedure to a document type.
GET2 POST2 PUT1 DELETE1
Sales Document Charges
Every charge a quotation or sales order carries: those worked out from the charge records and those added by hand. Billed charges are in the document’s total and are invoiced with the goods.
GET2 POST2 PUT1 DELETE1
Prospecting
Prospects
Students and businesses being recruited. Scoring explains itself; converting hands over to SLCM or opens an account.
GET3 POST6 PUT2 DELETE2
Referrals
Who was referred, by whom, what became of it and what the referrer is owed.
GET2 POST3 PUT1 DELETE1
Reachable by link
Arrangement Installments
Each installment of each arrangement: due, paid, missed.
GET2 POST2 PUT1 DELETE1
Bill Lines
The charges on each bill, block by block.
GET2 POST2 PUT1 DELETE1
Customer · Credit Profile
The limit, what it is made of, what happens when it is reached, and what security is held against it. Reviewed on its own cycle by different people.
GET2 POST2 PUT1 DELETE1
Customer · Financial
Terms, payment method, how invoices are grouped and what happens when they do not pay — at account level, or overridden per site.
GET2 POST2 PUT1 DELETE1
Customer · Relationships
Who acts for whom. A parent that pays a subsidiary, a buying group, a guarantor — and whether the exposure rolls up.
GET2 POST2 PUT1 DELETE1
Customer · Selling Context
The same account seen from one of your own business units — different terms, different price list, different salesperson, and all of them right.
GET2 POST2 PUT1 DELETE1
Customer Addresses
One customer, several places: where it orders from, where the invoice goes, where the goods go and which warehouse takes them in. Purposes are independent ticks because one address is very often both ship-to and bill-to.
GET2 POST2 PUT1 DELETE1
Interaction Events
The transfers, the holds and the conference joins — what a supervisor reads when a customer says they were passed around four times.
GET2 POST2 PUT1 DELETE1
Recipients
One row per person per broadcast, with what became of it — and why it was not sent where it was not. "No consent", "hard bounced before", "duplicate address" and "on the suppression list" are four different problems and three of them are fixable.
GET2 POST2 PUT1 DELETE1
Records
Filing obligation
Read and maintain filing obligation records (acct.tax_filing_calendar).
GET2 POST2 PUT1 DELETE1
Finding
Read and maintain finding records (acct.tax_wizard_findings).
GET2 POST2 PUT1 DELETE1
Jurisdiction total
Read and maintain jurisdiction total records (acct.tax_wizard_jurisdictions).
GET2 POST2 PUT1 DELETE1
Jurisdiction zone
Read and maintain jurisdiction zone records (acct.tax_jurisdiction_zones).
GET2 POST2 PUT1 DELETE1
Sales tax period
Read and maintain sales tax period records (acct.tax_wizard_runs).
GET2 POST2 PUT1 DELETE1
Step
Read and maintain step records (acct.tax_wizard_steps).
GET2 POST2 PUT1 DELETE1
Tax registration
Read and maintain tax registration records (acct.tax_registrations).
GET2 POST2 PUT1 DELETE1
Relationships
Activities
Calls, e-mails, meetings and notes logged against a customer, a contact or an opportunity, and what is still to do.
GET2 POST5 PUT1 DELETE1
Calendar Invitations
Invitations sent from CRM meetings and activities: who was invited to what, when, and how often it was sent. Sending again after a change updates the same calendar entry; cancelling removes it from every calendar.
GET1 POST2
Interaction History
One timeline whatever the channel — calls, emails, meetings, events, payments and portal sign-ins.
GET2 POST3 PUT1 DELETE1
Relationship Management
Who is connected to whom — parents, employers, referrers, decision makers — and how strongly.
GET2 POST2 PUT1 DELETE1
Tasks & Follow-ups
What is owed to whom and by when. A task past its due date says so rather than waiting to be noticed.
GET2 POST3 PUT1 DELETE1
Reporting
Sales
Lead Contacts
The people at each lead: names, email, mobile and office numbers, titles and addresses. Import a contacts sheet after its leads sheet; each row is attached to its lead by the Lead Name it carries.
GET2 POST2 PUT1 DELETE1
Leads
Read and maintain leads records (crm.leads).
GET5 POST6 PUT3 DELETE3
Opportunities
Read and maintain opportunities records (crm.opportunities).
GET4 POST5 PUT3 DELETE2
Sales Channels
Channel Connectors
Shopify, Magento / Adobe Commerce and Amazon: orders come in as sales orders once, stock and tracking go back out. Webhooks are checked against the connector's own secret. A sandbox connector runs sample payloads through the same import.
GET3 POST10 PUT2 DELETE1
Channel Orders
Every order a channel sent, once each however often it arrived, and the sales order it became.
GET2 POST2 PUT1 DELETE1
Channel Payouts
What each marketplace paid out, after its fees and refunds, for reconciling to the bank.
GET2 POST2 PUT1 DELETE1
Channel SKUs
Which item each channel SKU is. An order with an unmapped SKU is held, naming it, until it is mapped here.
GET2 POST2 PUT1 DELETE1
Channel Sync Runs
Each order pull, stock push, fulfilment and payout import, with what it did.
GET2 POST2 PUT1 DELETE1
Channel Webhooks
Every webhook received: whether its signature checked out, and what was done with it.
GET2 POST2 PUT1 DELETE1
Sales Order Types
Sales Order Settings
What confirming a sales order with a zero total does: nothing (off), a warning with the confirmation, or a refusal until its lines are priced. Orders of a free-of-charge order type are never stopped.
GET2 POST2 PUT1 DELETE1
Sales Order Types
What each kind of sales order does: its own numbers, the warehouse it ships from, whether credit is checked and whether a delivery may ship part of it. A customer’s "Order type default" names the type their orders take.
GET2 POST2 PUT1 DELETE1
Selling
Deliveries
Read and maintain deliveries records (crm.deliveries).
GET3 POST6 PUT2 DELETE2
Quotation Approval Rules
Which quotations an approver has to check before they go to the customer, and who. A quotation a rule covers cannot be sent, or turned into an order, until every approver has signed; one no rule covers is sent as it always was.
GET2 POST2 PUT1 DELETE1
Quotation Approvals
Every signature a quotation is waiting for, in the order they are collected. A quotation is sent to the customer only once every level has approved.
GET2 POST3 PUT1 DELETE1
Quotations
Read and maintain quotations records (crm.quotations).
GET5 POST9 PUT2 DELETE2
Sales Orders
Read and maintain sales orders records (crm.sales_orders).
GET8 POST13 PUT2 DELETE2
Shipments
Read and maintain shipments records (crm.shipments).
GET3 POST4 PUT2 DELETE2
Service
Field Work Orders
Read and maintain work orders records (crm.work_orders).
GET5 POST6 PUT3 DELETE3
Service Cases
Read and maintain cases records (crm.cases).
GET3 POST4 PUT2 DELETE2
Service & Feedback
Communication Consent
Who may be contacted, on which channel, for what, and on what lawful basis. Campaign builds exclude anyone who has opted out.
GET2 POST2 PUT1 DELETE1
Communication Templates
Reusable messages with merge fields, so what is sent is consistent and reviewable.
GET2 POST2 PUT1 DELETE1
Concierge
Questions and needs from people who are not yet, or no longer, customers — with an SLA on the reply.
GET2 POST3 PUT1 DELETE1
Survey Responses
Every answer, classified. Promoter, passive or detractor is computed, not typed.
GET3 POST3 PUT2 DELETE2
Surveys & Feedback
NPS and satisfaction. A detractor raises an intervention rather than sitting in a report.
GET3 POST4 PUT2 DELETE2
Services and actions
Ai visibility
The ai visibility service of CRM: 13 operation(s).
GET5 POST4 PUT3 DELETE1
Contact finder
The contact finder service of CRM: 3 operation(s).
GET1 POST2
Interaction
The interaction service of CRM: 10 operation(s).
GET2 POST8
Interaction history
The interaction history service of CRM: 1 operation(s).
GET1
Linkedin invitations
The linkedin invitations service of CRM: 9 operation(s).
GET1 POST7 PUT1
My tasks
The my tasks service of CRM: 1 operation(s).
GET1
Price for
The price for service of CRM: 1 operation(s).
GET1
Pricing simulate
The pricing simulate service of CRM: 1 operation(s).
GET1
Profile
The profile service of CRM: 1 operation(s).
GET1
Social
The social service of CRM: 45 operation(s).
GET13 POST30 PUT1 DELETE1
Tax wizard
The tax wizard service of CRM: 15 operation(s).
GET5 POST10
Utilities
Customer Requests
What the public and portal customers asked for — start, stop or move service, a leak or an outage, an arrangement — waiting for somebody to review it.
GET3 POST8 PUT1 DELETE1
Portal Account Links
Which customer portal sign-in sees which utility account, and how it was linked.
GET2 POST3 PUT1 DELETE1
Premises
Every place that takes service: address, parcel (APN), district, read route and walk order, map point, and the services it can take.
GET2 POST2 PUT1 DELETE1
Service Accounts
A customer's utility account: class, cycle, contact, paperless and autopay, the life-support flag, and the deposit and credit the utility holds. Open one for its 360 view.
GET3 POST7 PUT1 DELETE1
Service Agreements
Account × premise × service × rate plan, from its start to its stop. Made by Start service, ended by Stop or Transfer; the rate plan can be changed here.
GET2 POST2 PUT1 DELETE1
Utilities Dashboard
The key figures of the utility first: accounts, meters reporting, read exceptions, the bill run, billed and collected, what is owed over 60 and 90 days, arrangements, disconnects and open work — each a link to its list.
GET1
Utility Billing
Bill Runs
A cycle billed in four steps: preview, review the exceptions, approve (somebody other than who previewed it), post to the receivable.
GET2 POST6 PUT1 DELETE1
Billing Cycles
Groups of accounts read, billed and due together.
GET2 POST2 PUT1 DELETE1
Leak Adjustments
Credits for water lost to a repaired customer-side leak, by the company's policy: how much was billed, the account's normal use, the excess and the credit, who asked, who approved, and the bill that shows it. Asked for from a posted bill (Utility Bills › Leak adjustment).
GET2 POST5 PUT1 DELETE1
Rate Blocks
The usage blocks of each plan: from and to (blank: no ceiling), the rate per unit, and the season.
GET2 POST2 PUT1 DELETE1
Rate Fees
Fees on a plan's bills: a fixed amount, an amount per unit, or a percentage of the service's charges, taxable or not.
GET2 POST2 PUT1 DELETE1
Rate Plans
What each service costs: the customer charge, block rates (with summer and winter blocks), fees, a minimum bill, the tax code the company's tax engine rates, and the dates it applies.
GET3 POST2 PUT1 DELETE1
Utility Bills
Every bill: the run it came from, the account, the charges, what was owed before, what is due, and the AR invoice it became.
GET4 POST8 PUT1 DELETE1
Utility Cashiering & Payments
Autopay
Accounts paid automatically by a card kept in the card vault: the mask, the consent and when it was given. Each posted bill becomes a one-off charge on its due date.
GET2 POST5 PUT1 DELETE1
Cash Approvals
For a supervisor: voids the cashiers asked for and drawer closes waiting to be approved — never their own.
GET1 POST3
Cash Drawers
The drawers at the counter.
GET2 POST2 PUT1 DELETE1
Cash Sessions
Each cashier's session on a drawer: the float, the takings, the count, the over or short, and who approved the close.
GET2 POST2 PUT1 DELETE1
Cashiering
The counter: open a drawer session with its float, find the account, take cash, check, card or money order, take a deposit, ask for a void, close with the count.
GET2 POST4
Lockbox & Bank Files
A lockbox or bank file of payments: each line posted once by its reference, duplicates and bad lines named.
GET2 POST3 PUT1 DELETE1
Online Payments
Pay-now from the customer portal, handed to the payment provider and posted when the provider confirms it.
GET2 POST4 PUT1 DELETE1
Refunds
Credit balances and deposits paid back to customers.
GET2 POST3 PUT1 DELETE1
Utility Payments
Every payment on a utility account — counter, mail, lockbox, bank, portal, autopay — what it paid, what became a credit, and any void.
GET2 POST4 PUT1 DELETE1
Utility Collections
Collection Actions
The collections trail: every notice (and whether it was emailed or printed), late fee, arrangement, disconnect, block and write-off.
GET2 POST2 PUT1 DELETE1
Collections Worklist
Every account with money past due, worst first, with the next step: a notice, a final notice, a disconnect order — or, for life support, a call. Run collections to send the notices and charge the late fees.
GET1 POST4
Payment Arrangements
Past-due balances split into installments: requested from the portal or set up by staff, paid down by payments, broken when one is missed.
GET2 POST6 PUT1 DELETE1
Utility Field Service
My Service Orders
The field technician's own orders for today and after, most urgent first: start each, then complete it with the read or the new meter.
GET1 POST2
Utility Service Orders
Field work at a premise — start, stop, transfer, meter install or exchange, re-read, disconnect, reconnect, leak, high bill — assigned to a crew member and completed with the read or the new meter.
GET2 POST6 PUT1 DELETE1
Utility Settings
The company's own numbers: grace and notice days, the late fee, the reconnect fee, deposits, read checks, the ledger accounts, and whether the public forms are open. One row; the shipped defaults apply until it is saved.
GET3 POST3 PUT1 DELETE1
Utility Meters & Reads
Device Alarms
Battery, tamper, leak and reverse-flow alarms the devices raised. A leak or tamper raises a service order by itself.
GET2 POST4 PUT1 DELETE1
IoT Devices
AMI and IoT endpoints that post their own reads: each with a key the server makes and a secret shown once, its health (last seen, battery, signal) and its alarms.
GET2 POST3 PUT1 DELETE1
Meter History
Every install, exchange and removal: which meter, where, the start and end reads, and the order that did it.
GET2 POST2 PUT1 DELETE1
Meter Reads
Every read from every source — the reader, an AMR file, an IoT device, the field, the portal, an estimate — with its consumption and what billed it.
GET2 POST3 PUT1 DELETE1
Meter Tests
Bench and field accuracy tests of meters, pass or fail.
GET2 POST2 PUT1 DELETE1
Meters
Every meter: serial, service, make and model, size, unit, multiplier and dials, how it is read, where it is installed and its last read.
GET2 POST2 PUT1 DELETE1
Read Exceptions
Reads that did not look right — high or low against the meter's history, no use at a live service, gone backwards — held from billing until somebody accepts, rejects or re-reads them.
GET2 POST3 PUT1 DELETE1
Read Files (AMR)
A handheld or AMR drive-by file of reads: each line checked on its own, duplicates counted, bad lines named.
GET2 POST3 PUT1 DELETE1
Read Routes
The reading books: which premises, in what walk order, read how and by whom.
GET2 POST2 PUT1 DELETE1