Devices
Device register
Bill a service plan for a fleet with the device register: billing from activation, dealer prepaid terms, webhooks, swaps, returns, transfers and identifiers.
updated: applies-to: 1.3.5.0
When you sell hardware with serial numbers together with a service, for example connected devices, meters, sensors, payment terminals, routers or telematics units, Bitta Subscriptions keeps a device register: one row per serial number on the customer contract, beside one service line whose quantity is the number of devices. Swaps, returns, transfers and identifiers are tracked per device, and the customer gets a Device Schedule instead of an invoice with thousands of lines.
Use it for a large installed base. A customer with 5,000 devices stays one service line per plan on the contract and one invoice line per period, with the devices listed on the device schedule.
Turn on the device features
The device features are shown only in companies that sell hardware with serial numbers: Devices is a module of Subscription Features. In the assisted setup Set Up Bitta Subscriptions, the Features step asks Which features do you use? Choose Devices: Sell Hardware with Serial Numbers to turn them on; leave it off if you sell only services, software or items without serial numbers. You can change it later on the Subscription Features page, or with Sell Devices on the Bitta Subscriptions Setup page (group Devices), then reload the browser page.
With Sell Devices off:
- the Devices, Device Activation, Device Returns, Device History, Device Identifiers (IMEI, MAC), Load Device Identifiers, Device Identifier Types and Device Schedule pages, their role center links and cues, the device fields and actions on contracts, subscriptions, sales lines, return lines and posted invoices, the prepaid term fields and the device settings of the setup are hidden;
- shipments of serial-numbered items register no devices, the sales order does not warn about hardware that would skip the register, and the setup guide does not schedule the daily prepaid term task;
- Webhooks stay: they send the contract events, and only the device events are hidden.
The switch uses a Business Central application area, so the pages appear or disappear for every user of the company, in the menus and in search, after they reload the browser page. A company that upgraded from release 1.2 with devices, identifier types, device returns or webhooks has it on.
How the register works
| Part | What it is |
|---|---|
| Hardware | An inventory item with serial numbers whose Subscription Option is No Subscription, sold, shipped and invoiced on the sales order |
| Service plan | A Microsoft subscription item on the customer contract, quantity = number of devices |
| Device register | One row per serial number, linked to the customer, the contract and the service line, with status, dates and identifiers |
Sell the hardware and the plan on one sales order. When the order ships, every shipped serial number becomes an Active device on the contract of the plan's subscription (Register Devices on Shipment on the setup page, on by default). Choose Devices on the role center, the contract or the subscription to see them; devices already installed at customers can be added by hand or with Load Identifiers.
Set up the hardware item: Subscription Option = No Subscription
The register takes a shipped serial number only from hardware whose Subscription Option (on the item card) is No Subscription. Microsoft's demo hardware, and any item copied from it, has Sales with Subscription: Microsoft then creates one subscription per serial number when the order ships, and the register stays empty. So:
- Open the hardware item, and set Subscription Option to No Subscription. Give it an Item Tracking Code with serial numbers.
- Sell the service as a separate Subscription Item, one unit per device.
When the setup registers devices on shipment and a sales order or quote has a serial-tracked item with Sales with Subscription, a notification on the order says that its serial numbers will not be registered, with Open Item to change the option. It never blocks the order: Microsoft's model keeps working (see below).
When Sell Devices is on, the demo data has a ready pair: the hardware BAASUB-DEVICE (Connected device, serial numbers, No Subscription) and its service plan BAASUB-DEVSVC (Device service, plan family CONNECTED), and the identifier types ASSET-TAG, MAC and IMEI. Sell both items on one order, ship it with serial numbers, and the devices appear on the contract.
Start billing when a device is activated
Some devices ship weeks before they are installed. With billing on activation, a shipped device waits as Awaiting Activation and is not billed until the day it goes into service, for example the day it first reports.
- Choose when billing starts: Device Billing Start on the Bitta Subscriptions Setup page (group Devices), Shipment or Activation. A contract can override it with its own Device Billing Start (Default uses the setup). The setting applies to devices shipped after it changes.
- Sell and ship as usual. On a contract that bills from activation, every shipped serial number becomes Awaiting Activation, and the service waits at quantity 0. The contract shows how many devices are Awaiting Activation, and so does the role center cue.
- Activate the devices:
- On the Devices page, select them and choose Activate Devices. Device Activation opens with them.
- Or search for Device Activation. Paste rows copied from Excel or a provisioning report into Pasted Rows (the serial number, then the activation date, separated by a tab, a semicolon or a comma), or choose Import from Excel. Rows without a date take the Default Activation Date.
- Or let the provisioning platform call the
devices(...)/activateAPI action when the unit first reports.
- Choose Preview. Each row gets a Status: Ready, Not Found, Not Awaiting Activation, Ambiguous, Duplicate in File, Date Missing, Date in Future or Date Before Start, with a Message.
- Choose Activate. Each ready device becomes Active, and its service quantity goes up from its activation date with a prorated charge.
The activation date must be on or before the work date and not before the shipment. A group that fails keeps its error on its rows, and the others go on. A device that is returned while it waits changes nothing on billing. Activation never needs approval, but it does not run on a locked contract: the devices stay Awaiting Activation, and their Activation Error says why.
Dealer prepaid terms
A dealer or reseller sometimes pays the service of each device for a term, for example three or five years per device. During the term the device is not billed on the customer's contract; when it ends, the device is billed to the customer or waits for the dealer to renew.
When you sell the term on the order. On the sales order line of the serial-numbered device, enter the Prepaid Term, for example 3Y or 5Y, and choose After Prepaid Term: Bill Customer or Renew with Reseller. Sell the term itself on a separate line of the order, so the dealer is invoiced once. The term of each device starts when it ships.
For devices already in service. On the Devices page, select active devices and choose Set Prepaid Term. Enter the Reseller No., Prepaid From, the Term (it fills Prepaid Until), a Document No. for reference and After Prepaid Term. The service quantity goes down from Prepaid From, with a credit for days already billed.
The Devices page shows each device's Billing (Service Quantity, Prepaid or Prepaid Ended), Prepaid Until, Prepaid Reseller No. and After Prepaid Term. Extend Prepaid Term moves the end date when the dealer renews; a term that ended and waits for the dealer starts again.
A daily task ends the terms. The device then joins the customer's service quantity and is billed (Bill Customer), or waits for the dealer (Renew with Reseller). Schedule it with Schedule Daily Tasks in the assisted setup.
Tell other systems about devices
Provisioning platforms, carriers and device portals often need to know when a device ships, activates, is swapped, returned or transferred. Bitta Subscriptions tells them in two ways:
- Business events for Power Automate and other subscribers: Device shipped, Device activated, Subscription device swapped, Device returned and Device transferred, one per unit, with the serial number, contract, customer, subscription, date and identifiers. See APIs and events.
- Webhooks: signed messages to an HTTPS address. Search for Webhooks, and on the webhook card turn on the Device Events you need: Device Shipped, Device Activated, Device Swapped, Device Returned, Device Transferred. The same webhook can receive the contract events too. How to set up a webhook, its signature, retries and the message log: APIs and events.
Swap a device
On the Devices page, select an active device and choose Swap Device. Enter the New Serial No., the Swap Date, a Reason Code and a note. The old device becomes Swapped, the new one is Active with the same contract, service line and identifiers, and the history names both units. Billing does not change, because the number of devices does not change.
Return devices
On a sales return order or credit memo line, choose the Device Return Action: Reduce Quantity or Keep Quantity (the setup has the default). When the return posts, each returned serial number becomes Returned. With Reduce Quantity, the service quantity goes down by the returned devices from the posting date, with a credit for days already billed; at zero devices the service subscription is terminated. A return that cannot be processed stays open on the Device Returns page with its error, and nothing can make the posting fail.
Transfer devices to another customer
Select active devices of one contract, and choose Transfer Devices. Choose the New Customer No., the New Contract and the Transfer Date. The old contract's service quantity goes down from that date (with a credit for billed days), and the new contract's subscription of the same plan goes up (with a prorated charge). When the new contract has none, a new subscription of the plan is created. The devices keep their serial numbers and identifiers.
Identifiers and bulk load
Set up Identifier Types, for example asset tag, MAC address, IMEI or, for vehicles, the VIN, and choose the Main Identifier Type on the setup page. Load Identifiers takes pasted rows or an Excel file with Serial No. and one column per identifier type, and previews every value as OK, Unchanged, New Device, Not Found, Ambiguous, Duplicate in File, Value in Use, Unknown Type or Blank Value before anything is written. Add Unknown Serial Numbers adds devices that are not in the register yet.
The Device Identifiers (IMEI, MAC) page lists every identifier value with its device and serial number; search for IMEI, MAC address or asset tag to open it. The role center link is called Device Identifiers.
Device schedule and quantity check
The Device Schedule report lists, per contract, the devices with serial number, identifiers, dates and status, and the active devices against each service line's quantity. Print it from the contract, the Devices page or the posted sales invoice, to send with the invoice, or turn on Attach Device Schedule on the contract so that every invoice email carries it as a second PDF (Invoices and statements). Check Device Quantities on the contract shows the differences, and Sync Device Quantities proposes one amendment per subscription to the device count.
Serial numbers on Microsoft's own model
Microsoft's own model, a "Sales with Subscription" item that creates one subscription per serial number, keeps working: Bitta Subscriptions carries the serial number through amendments, holds, terminations, renewals, price increases and reseller attribution. For lots, one subscription per lot gets the lot's quantity. Promotions are not offered on these items. The register is recommended for a large installed base, because one subscription per device means one invoice line per device.
What happens in Microsoft Subscription Billing
- The service plan stays one Microsoft subscription line per contract; quantity changes go through the amendment engine with prorated charges and credits, and terminations through the termination engine.
- Co-term: with Co-term New Lines on the contract, a new order's lines take the term of the contract's existing lines, so every device renews on one date.
Limits
- The invoice keeps one line per plan. The device schedule is attached to the invoice email only on contracts with Attach Device Schedule, and only to emails of posted invoices.
- An order with several service plans links its devices to the first plan.
- A transfer with a date after today schedules the amendments, and the device rows change at once.
- A device's billing start is decided when it is registered. Changing Device Billing Start later does not move devices already shipped.
- A service that waited for activation is invoiced from its next billing date with a credit for the days before the activation, so the charge and the credit are on one invoice.
- A prepaid term starts at shipment, also on a contract that bills from activation.
- The webhook address check sees only the text of the URL. A public host name that points to a private address is refused by Business Central online when it sends. In a sandbox, turn on Allow HttpClient Requests for Bitta Subscriptions in Extension Management, or every message fails with that hint.
- Business events carry identifiers up to 250 characters. The webhook message and the devices API carry all of them.
See also
- Amend subscriptions
- Charges and batches: batch changes accept serial numbers.
- Background runs and large books: holds, terminations and batch changes for large contracts.
- Revenue recognition: recognize hardware revenue per serial number over the contract.
- Invoices and statements: attach the Device Schedule to the invoice email.
- Report: Device Schedule