Module storecove

ballerinax/storecove Ballerina library

2.0.0

Overview

Storecove is a document exchange platform that sends and receives electronic business documents, such as invoices and credit notes, over networks like Peppol on behalf of its customers. It handles legal entity registration, recipient discovery, document submission with delivery evidence, and the retrieval of documents received from trading partners.

The Storecove connector lets Ballerina applications call the Storecove API, version 2.0.1, to manage legal entities and their identifiers, discover trading partners on the network, submit documents and track their delivery, and fetch received documents and purchase invoices.

Key features

  • Register and manage legal entities, their Peppol identifiers and additional tax identifiers
  • Discover whether trading partners exist on the network and which documents they can receive
  • Submit invoices and other documents and retrieve their delivery evidence
  • Retrieve received documents and purchase invoices in JSON or the original format

Setup guide

To use the Storecove connector, you need a Storecove account and an API key.

  1. Sign in to your Storecove account or request access from Storecove if you do not have one.

  2. Open the API settings of your account and create an API key.

  3. Copy the key and keep it secure. The connector sends it as a bearer token in the Authorization header (Authorization: Bearer <API_KEY>) of every request.

Quickstart

To use the Storecove connector in your Ballerina application, update the .bal file as follows:

Step 1: Import the module

Copy
import ballerinax/storecove;

Step 2: Instantiate a new connector

Create a Config.toml file with your API key.

Copy
apiKey = "<API_KEY>"

Then create a storecove:Client using the configured key as a bearer token.

Copy
configurable string apiKey = ?;

final storecove:Client storecoveClient = check new ({auth: {token: apiKey}});

Step 3: Invoke the connector operation

Retrieve the identifier specifications that Storecove supports for each country.

Copy
public function main() returns error? {
    storecove:CountrySpecifications _ = check storecoveClient->discoverIdentifiers();
}

Step 4: Run the Ballerina application

Copy
bal run

Examples

The Storecove connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:

  1. Legal entity onboarding - Create a legal entity, register its Peppol and additional tax identifiers, and read it back.
  2. Peppol recipient discovery - Check whether a recipient exists on the Peppol network and which document types it can receive.

Import

import ballerinax/storecove;Copy

Other versions

See more...

Metadata

Released date: 1 day ago

Version: 2.0.0

License: Apache-2.0


Security

Direct vulnerabilities: No known direct vulnerabilities

Indirect vulnerabilities: 

Checked on 2026-11-21 via OSV.dev


Compatibility

Platform: any

Ballerina version: 2201.12.0

GraalVM compatible: Yes


Pull count

Total: 47

Current verison: 1


Weekly downloads


Source repository


Keywords

Vendor/Storecove

Area/Finance & Accounting

Type/Connector


Contributors