The Sproom REST API integration connects Electronic Invoicing with Sproom directly to the Sproom e-invoicing service over a secure HTTPS connection, enabling Business Central to transmit electronic invoices automatically and track their delivery in real time — without requiring an FTP server, a file export, or access to an external portal. This is the recommended connection method for companies that want delivery visibility inside Business Central with minimal operational overhead.
Feature Overview
The Sproom REST API integration handles the full electronic invoicing lifecycle from a single environment. When a document is sent, the integration transmits it to Sproom, records the delivery entry, and monitors the outcome automatically in the background. All delivery states — whether successful, in progress, or failed — are visible inside Business Central, along with built-in guidance when something goes wrong. The integration covers two distinct capabilities: the connection configuration managed in Sproom Service Settings, and the delivery monitoring interface on the Sproom Document Activity Status page — each described in the linked articles below.
Typical Use Cases / User Stories
- A Danish company invoicing public-sector customers wants a direct, fully automated connection to Sproom that tracks delivery outcomes inside Business Central, eliminating the need to check a separate portal.
- As a finance manager, I want to know the delivery state of every electronic invoice we send, so that I can plan follow-ups and escalations based on real delivery data rather than assumptions.
- An IT administrator setting up a new Business Central environment wants to configure the Sproom API connection once and have it operate reliably without manual maintenance or file servers.
- As an accounts receivable clerk, I want to understand why an invoice failed and receive actionable guidance on how to fix it, without having to contact Sproom support or leave Business Central.
- A growing company sending increasing volumes of invoices needs a scalable, low-maintenance e-invoicing solution with automated status tracking that does not require additional manual monitoring effort as volume grows.
Key Concepts
- Integration Type: The setting that determines how Business Central connects to Sproom. Export to API activates the REST API integration; Export to FTP uses the legacy file-transfer method; Disabled turns off document sending.
- Token Value: A secure credential issued by Sproom that authorizes Business Central to submit documents and query delivery status.
- Status Polling: An automated background process that refreshes delivery states for all pending documents at a configurable interval, with no manual action required.
Relations to Other Features or Apps
The Sproom API integration is made up of two capabilities, each covered in a dedicated article:
- Sproom Service Settings — where the API connection is configured, the polling interval is set, and the connection health can be verified at any time.
- Sproom Document Activity Status — where delivery states are monitored, error details are reviewed, and corrective actions such as Look Up Recipient are available.
The integration hooks into Business Central's standard OIOUBL document generation. The OIOUBL XML is produced by the Danish localization; the Sproom API integration handles everything from transmission onward.
Frequently Asked Questions
What is the difference between the Sproom API and FTP integration?
The REST API integration sends documents directly to Sproom over HTTPS and tracks delivery status automatically in the background — no file server, SSH key, or manual monitoring is required. The FTP integration transfers XML files to an FTP server where Sproom picks them up, and delivery status is not tracked inside Business Central when using this method.
Do I need to do anything after sending an invoice through the Sproom API integration?
No manual steps are required after sending. The Sproom API integration handles transmission and status monitoring automatically — delivery states update in the background, and any failures surface on the Sproom Document Activity Status page without intervention.
Which Integration Type should I choose when setting up Sproom?
Choose Export to API unless you have a specific operational requirement for the FTP method. The REST API integration is the recommended choice for all new setups — it is simpler to configure, requires no file server, and provides automated delivery tracking directly inside Business Central.
When This Feature Adds Value
- You invoice public-sector or private-sector customers who require electronic documents delivered via PEPPOL or OIOUBL, and you want automated delivery confirmation inside Business Central.
- You are moving away from the FTP-based integration to a modern setup with no server infrastructure and built-in status tracking.
- You need consistent, auditable delivery records for all electronic invoices without depending on an external portal or a manual checking process.