Documentation Index

Fetch the complete documentation index at: https://docs.abakion.com/llms.txt

Use this file to discover all available pages before exploring further.

Sproom FTP Integration

Prev Next

The Sproom FTP Integration in Electronic Invoicing with Sproom transfers electronic invoices and credit memos to the Sproom e-invoicing service by uploading OIOUBL XML files to a designated FTP folder that Sproom monitors and processes automatically. The FTP method is the established integration path for companies that have existing FTP infrastructure in place, operate in network environments that restrict REST API access, or prefer SSH key-based server authentication.

Feature Overview

The Sproom FTP Integration handles the transmission portion of the electronic invoicing workflow through file transfer. When an electronic document is posted and sent, Business Central generates the OIOUBL XML file and deposits it in the configured FTP folder — named after the document number. Sproom picks up the file from the FTP server, validates it, and delivers it to the recipient. Unlike the REST API integration, delivery status is not tracked inside Business Central with the FTP method — users who need to confirm that a document reached its recipient must check the Sproom portal directly. All FTP connection details, including the folder path, credentials, and optional SSH private key, are managed in Sproom Service Settings.

Typical Use Cases / User Stories

  • A company that has been sending invoices via Sproom FTP for several years wants to continue with the same proven setup after upgrading Business Central, without migrating to the API integration.
  • As a network administrator, I need to configure electronic invoicing in an environment where outbound connections are restricted to FTP and SFTP only — the Sproom REST API is not reachable from this network.
  • A consultant setting up Sproom for a client whose Sproom service agreement specifies file-based FTP delivery as the transmission channel needs a reliable, configuration-driven integration with no API credential management.
  • An IT department that requires SSH key-based server authentication for security policy compliance wants to use a private key (.ppk file) to secure the FTP upload rather than a username and password.
  • A company migrating Business Central to a new environment needs to preserve the existing Sproom FTP configuration — including the stored private key — without disrupting the live invoicing process.

Key Concepts

  • FTP / SFTP: The file transfer protocol used to deposit OIOUBL XML files on the Sproom server. When a private key is configured, the connection uses SFTP (SSH File Transfer Protocol) for secure key-based authentication instead of a password.
  • Folder Path: The target directory on the FTP server where Business Central uploads the XML files for Sproom to collect. Each file is named after the Business Central document number.
  • Private Key: An SSH key file in .ppk format used to authenticate the FTP connection without a password. Using a private key is optional — password authentication is also supported.
  • OIOUBL XML: The structured electronic document format generated by Business Central and transferred to Sproom via the FTP folder.

Relations to Other Features or Apps

  • The FTP connection details — Folder Path, User Name, User Password, and SSH private key — are all configured in Sproom Service Settings.
  • Companies that need delivery status tracking inside Business Central should consider the Sproom API Integration instead. The REST API integration sends documents directly and monitors delivery outcomes automatically, without requiring access to an external portal.
  • The Sproom FTP Integration hooks into Business Central's standard OIOUBL document generation. The OIOUBL XML is produced by the Danish localization; the FTP integration handles transmission from that point onward.

Frequently Asked Questions

Can I track whether an invoice sent via the Sproom FTP integration was delivered to the recipient?
Delivery status for documents sent via the Sproom FTP integration is not tracked inside Business Central. The FTP method deposits XML files on a server for Sproom to collect and process; to verify that a document reached the recipient, you need to log into the Sproom portal directly. Companies that need delivery confirmation inside Business Central should use the REST API integration instead.

What is the difference between the Sproom FTP and REST API integration?
The Sproom FTP integration uploads OIOUBL XML files to an FTP server where Sproom picks them up — there is no delivery status tracking in Business Central. The REST API integration sends documents directly to Sproom and tracks delivery states automatically inside Business Central on the Sproom Document Activity Status page. The REST API integration is recommended for new setups; the FTP method remains available for environments that require it.

Do I need an SSH private key to use the Sproom FTP integration?
An SSH private key is not required. The Sproom FTP integration supports both username and password authentication and key-based SFTP authentication using a .ppk private key file. Use whichever method your Sproom FTP server is configured to accept — if Sproom has provided a .ppk file, upload it using the Import Private Key action on Sproom Service Settings.

When This Feature Adds Value

  • You are running an existing Sproom FTP integration and need to maintain, migrate, or document it without switching to the REST API.
  • Your network environment restricts outbound connections to FTP or SFTP only, making the REST API integration unavailable.
  • Your security policy requires SSH key-based authentication for server connections, and you use a .ppk private key to authenticate the FTP upload.
  • You need a straightforward, file-based delivery method with no ongoing API credential management or status polling infrastructure.