SOAP overview | eConnect

This API is deprecated. eConnect no longer accepts new SOAP connections. Software vendors still using the SOAP API are advised to migrate to the REST API (PSB). Existing SOAP connections will continue to function but are no longer being developed.

The SOAP API v3.1 is the original API of the eConnect platform. This API is still supported for existing integrations, but eConnect no longer accepts new SOAP connections. All new integrations go through the REST API (PSB).

Who is this documentation for?

This documentation is intended exclusively for software vendors and organizations that already have a working SOAP connection with the eConnect platform, such as existing integrations from parties like ECI, Inventive or Bloxs. Building a new integration? Choose the PSB REST API. It offers OAuth 2.0 security, webhooks, SDKs and extensive documentation via Swagger UI.

Technical requirements

The SOAP API runs on SOAP 1.1 over HTTPS/SSL and is WSDL-compliant with Basic Profile v1.1. An important note: Transfer-Encoding=chunked is not supported. This is a common implementation mistake.

Property

Value

Protocol

SOAP 1.1 over HTTPS/SSL

Endpoint

https://api.everbinding.nl/soap/v3.1?subscriptionKey={subscriptionKey}

WSDL

Available via [email protected] (subscriptionKey required)

Authentication

Token validity

4 hours (or request a new token per session)

Available endpoints

The SOAP API v3.1 offers the following endpoints:

Authentication and account management

Endpoint

Function

Login

Retrieve SecurityToken with Consumer Key + Consumer Secret

GetAccountDetails

Request account information

GetAccountParties

Retrieve own parties (with EConnectPartyId and Peppol status)

GetParties

Retrieve all known parties

GetParty

Retrieve party details by ReferenceId

Sending documents

Endpoint

Function

SendDocument

Send document (Inbox + Outbox)

GetOutboxDocuments

List of sent documents (metadata)

GetOutboxDocument

Retrieve full outbox document by ExternalId

GetOutboxDocumentStatus

Request status of a sent document

Receiving documents

Endpoint

Function

GetInboxDocuments

List of received documents (metadata)

GetInboxDocument

Retrieve full inbox document by ExternalId

GetInboxDocumentStatus

Request current status of a received document

SetInboxDocumentStatus

Change status of a received document

Drafts and PDFs

Endpoint

Function

GetDocuments

Retrieve draft documents

GetDocument

Retrieve full draft document by DocumentId

GetDocumentPdf

Download PDF of a document as base64

Other

Endpoint

Function

GetAdvisedInvoiceRecipientId

Recommend best Peppol recipient ID

RequestAppIntegration

Start app integration request (accountant flow)

SOAP vs. REST: the key differences

SOAP API v3.1

PSB REST API

Protocol

SOAP 1.1

REST (JSON)

Authentication

Consumer Key/Secret + SecurityToken

OAuth 2.0

Documentation

WSDL (on request)

Swagger UI / OpenAPI

SDKs

None

PHP and .NET (open source)

Webhooks

Not available

Fully supported

Status

Deprecated (no new connections)

Actively developed

Requesting the WSDL

The WSDL is not publicly available. Do you have an existing SOAP connection and need the WSDL? Contact [email protected]. For new integrations the WSDL is not available; use the REST API instead.

Want to switch to the modern REST API? Check the PSB documentation at psb.econnect.eu for the full Swagger UI and getting started guide.

Migrate to the REST API