Peppol

PEPPOL Business Functions (Client API)

This document describes the three core PEPPOL use cases for client-side integrations:

1. Send

2. Receive (implemented as ReceivePull)

3. GetStatus

All examples are based on app.businessFunction(...) usage conventions from the Business Function client docs.

Prerequisites

Workspace settings (SettingsEditor -> Communication -> PEPPOL):

• PEPPOL API Key

• PEPPOL Inbox IDs

• PEPPOL Default Sender Id

• PEPPOL Receive Document Type Id (optional)

Operation Matrix

Use case	Client call	Backend endpoint
Send document from attachment	app.businessFunction({ functionName: "Peppol", methodName: "Send", ... })	POST /Peppol/Send
Pull received documents	app.businessFunction({ functionName: "Peppol", methodName: "ReceivePull", ... })	POST /Peppol/ReceivePull
Get transfer status	app.businessFunction({ functionName: "Peppol", methodName: "GetStatus", ... })	POST /Peppol/GetStatus

Quick Examples

Send

const sendResult = app.businessFunction({
  functionName: "Peppol",
  methodName: "Send",
  attachmentId: 197,
  senderId: "89c5026c-23ce-4542-b0b1-4b750c5737f2" // InboxId optional
});

Receive

const receiveResult = await app.businessFunction({
  functionName: "Peppol",
  methodName: "ReceivePull"
});

GetStatus

const statusResult = await app.businessFunction({
  functionName: "Peppol",
  methodName: "GetStatus",
  transferId: "75909014-117c-41a3-b57e-ea3029d563cf"
});

Detailed Docs

• Send

• Receive

• Get Status