Install via Composer

Download Php-Console and its dependencies to the vendor directory. You can use Composer for the automated process:

$ php composer.phar require splash/sellsy

Composer will install the bundle to vendor/splash/sellsy directory.

The data it covers

Changes made in Sellsy reach Splash through webhooks, installed on your account by the connector itself: no polling, no delay.

What you need

• A Sellsy account with Api access, on a plan that exposes the Api V2 :key:
• A Sellsy Oauth2 application, created by you, from which the connector gets its credentials — see Connect your account
• A Splash account, with a server ready to host the connector

[!IMPORTANT] Sellsy requires PKCE on its authorization flow, and every scope the connector asks for has to be granted on your application. The configuration page tells you which ones are missing, if any.

The rules Sellsy enforces

Sellsy applies accounting rules that no connector can bypass. They shape what Splash is allowed to write, and knowing them now saves a support ticket later:

• a validated invoice can no longer be modified, only paid;
• an invoice laid out by hand in Sellsy, with title, sub-total or page break rows, belongs to its author: Splash reads it but never rewrites it;
• a document date cannot be set before the last validated document of the same series.

These are detailed in Invoices.

The connector signs in with Oauth2, using an application you create on your own Sellsy account. Splash never sees your Sellsy password, and you can revoke the access at any time from Sellsy.

1. Create the Oauth2 application in Sellsy

In Sellsy, open Settings > Api & Integrations > Oauth2 applications, then create an application:

• give it a name that will be recognizable later, Splash Sync for instance;
• set its redirect uri to the one shown on your Splash server configuration page;
• grant it every scope the connector needs, listed in Required scopes.

Sellsy then gives you a Client ID and a Client Secret.

[!IMPORTANT] Keep the Client Secret safe: Sellsy shows it once. If you lose it, generate a new one and update it in Splash.

2. Declare the application in Splash

On your Splash server, open the Sellsy connector configuration and fill in:

Save: the page now offers to connect.

3. Authorize the connection

Click Connect to the Api. Sellsy asks you to log in and to confirm the access you are granting, then sends you back to Splash with a token.

Once connected, the configuration page shows:

• the Api access scopes, with any scope still missing on your application;
• the Vat rates and payment methods read from your account;
• the webhooks the connector installed to receive your changes.

[!TIP] The access token expires after one hour and is renewed automatically, as long as the connection has not been revoked in Sellsy. The page tells you when it expires.

Troubleshooting

[!NOTE] A refused connection is always explained on screen, with the message Sellsy itself returned.

Some scopes missing

The connector works, but every object covered by a missing scope stays out of reach. Add the scope on your Sellsy application, then connect again.

The connection is refused

Check that the redirect uri declared in Sellsy is exactly the one shown by Splash, including the scheme and any trailing path.