Skip to navigation

Send a UBL document over the Peppol network

Dispatches a base64-encoded UBL (Peppol BIS Billing 3.0) document to the receiver via the organization’s configured Access Point provider (Storecove, ecosio, or mock for testing). Every attempt — success or failure — is persisted to the transmissions log. Configure the provider first in the console under Settings → Peppol.

Authentication

AuthorizationBearer

API Key authentication. Use sk_live_* for production or sk_test_* for testing.

Request

This endpoint expects an object.
receiverPeppolIdstringRequiredformat: "^\d{4}:.+$"
Receiver participant address
documentstringRequired>=1 character

Base64-encoded UBL XML (Peppol BIS Billing 3.0) — e.g. from a /generate endpoint

environmentenumOptionalDefaults to production

Peppol settings scope to use (which provider config + API key)

Allowed values:
documentTypeenumOptionalDefaults to invoice
Document type of the UBL payload
Allowed values:
invoiceNumberstringOptional<=255 characters

Invoice number for the transmissions log (UI only, not sent over the network)

issueDatestringOptional<=64 characters

ISO 8601 issue date (log/UI only)

verifyReceiverbooleanOptional

Run an SMP discovery check first and refuse with RECEIVER_NOT_REACHABLE when the receiver cannot accept the document type

Response

Document accepted by the Access Point
successboolean
transmissionobject or null

Persisted log row — present for every attempt that reached the provider

errorCodestringOptional
errorMessagestringOptional

Errors

400
Bad Request Error
409
Conflict Error
422
Unprocessable Entity Error
501
Not Implemented Error
502
Bad Gateway Error