Connections

Connections are business and persons in the private address book of a space and they represent the actors involved in document exchange, such as: customers, suppliers, accountants, partners, groups.

📄️ Create connection

Create connection on the given space

📄️ Create connection on the given space (v4)

Creates a connection on the given space with a generated local identifier. Addresses use ISO 20022 format (buildingNumber, postCode, townName, ISO country code). <br/> Scope: space_write

📄️ Create connection relation

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Create connection relation on the given space <br/> Scope: space_write

📄️ Create connection v2

Create connection v2 on the given space

📄️ Create connection v3

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Create connection v3 on the given space <br/> Scope: space_write

📄️ Create payment account for connection owned by space

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Create the payment account for connection owned by space <br/> Scope: space_write

📄️ Create tax information

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Store Valitax specific Connection information <br/> Scope: space_write

📄️ Create tax registration

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Create connection's VAT registration <br/> Scope: space_write

📄️ Create/update connectors in the connection v3.

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Create/update entire content inside the connectors of the given connectionId. <br/> Scope: space_write

📄️ Delete connection

Delete connection by its ID on the given space

📄️ Delete connection relation

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Delete connection relation by its ID on the given space <br/> Scope: space_write

📄️ Delete connection v2

Delete connection v2 by its ID on the given space

📄️ Delete tax information

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Delete tax information associated for the connection in the given space. Will cascade delete tax registrations.

📄️ Delete tax registration of a connection

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Delete tax registration by ID.

📄️ Disconnect a connection (v4)

Disconnects the source connection (sets status to DISCONNECTED, active to false, clears externalKey) and, when successorConnectionId is given, registers it as a predecessor on the successor connection. The request body is optional. <br/> Scope: space_write

📄️ Download import business partners template on the given space

Download import business partners template on the given space. Use the Accept header to request the desired format: 'text/csv' (default) or 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' for Excel. <br/> Scope: space_read

📄️ Get connection info v3

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get connection information v3 by its ID on the given space <br/> Scope: space_read

📄️ Get connection relation info

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get connection relation information by its ID on the given space <br/> Scope: space_read

📄️ Get connectors for a connection

Returns a list of connectors that can be used to interact with the connection. <br/> Scope: space_read

📄️ Get list of connection relations

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get list of connection relations on the given space. The API supports pagination.

📄️ Get list of connections v3

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get list of connections v3 on the given space with optional filtering by identifiers.

📄️ Get or create connection on the given space (v4)

Attempts to create the connection. If the DataStore rejects the create because a connection with the same global:participantId already exists, returns the existing connection with HTTP 200. Otherwise returns the newly created connection with HTTP 201. <br/> Scope: space_write

📄️ Get payment accounts for connection owned by space

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get list of payment accounts for connection owned by space <br/> Scope: space_read

📄️ Get tax information

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Retrieve the tax information associated with the given connection <br/> Scope: space_read

📄️ Import bulk connections on the given space

Created or updated connections on the given space <br/> Scope: space_write

📄️ Look up connections on the given space (v4)

Looks up existing connections using a strategy-based matching algorithm. When `global:participantId` is present it is used as the primary key, optionally combined with `legalName` to disambiguate connections that share the same participant ID. When not found and `strict=false`, the lookup falls through to other global identifiers, then to name-based matching (tradeName first, then legalName). Always returns 200; the list is empty when no match is found. DISCONNECTED connections are excluded from all steps. At most the first 10 matches are returned. <br/> Scope: space_read

📄️ Update connection

Update connection by its ID on the given space

📄️ Update connection relation

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Update connection relation by its ID on the given space <br/> Scope: space_write

📄️ Update connection v2

Update connection v2 by its ID on the given space

📄️ Update connection v2

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Update connection v2 by its ID on the given space by sending JSON patch <br/> Scope: space_write

📄️ Update connection v3

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Update connection v3 by its ID on the given space <br/> Scope: space_write

📄️ Update payment account in context of connection

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Allow to set the default flag and ownerName of connection payment account <br/> Scope: space_write

📄️ Update tax information

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Update tax information <br/> Scope: space_write

📄️ Update tax registration

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Update connection's VAT registration <br/> Scope: space_write

📄️ Update the connection (v4)

Update the connection by its ID on the given space <br/> Scope: space_write

📄️ ⚠️Add selected connector

Add the selected connector which user chooses on the connection (customer/supplier)

📄️ ⚠️Create connection on the given space

Created connection on the given space with generated local identifier

📄️ ⚠️Create/update connectors in the connection.

Create/update entire content inside the connectors of the given connectionId.

📄️ ⚠️Get connection info

Get connection information by its ID on the given space

📄️ ⚠️Get connection info v2

Get connection information v2 by its ID on the given space

📄️ ⚠️Get list of connections

Get list of connections on the given space with optional filtering by identifiers.

📄️ ⚠️Get list of connections v2

Get list of connections v2 on the given space with optional filtering by identifiers.

📄️ ⚠️Update the connection

Update the connection by its ID on the given space