Skip to main content

How do I set up a connection with my BI database?

With the BI database connection, Payt automatically synchronises your financial data to your own database, so you can use it in your BI tool for reports and analyses.

Requirements

You need the following to set up a BI database connection:

  • Administrator rights at organisation level in Payt

  • The API module activated for the relevant administration(s)

  • A PostgreSQL or SQL Server database (Azure)

  • A database user with read and write access to the target database

  • A database accessible via host address 54.228.211.212

Setting up the connection

You set up a connection in the organisation settings. Access these by clicking the Payt logo in the top left to go to the organisation dashboard, then clicking 'Organisation settings' in the top right.

  1. Open 'Connections'

    Go to the 'Connections' tab on the left and click 'Actions' > 'Connect BI database' in the top right.

  2. Enter the database details

    Fill in the following database details:

    1. Name - the name of the database

    2. Username and password - the login credentials of the database user

    3. Host - the host address of the database

    4. Type - choose Postgres or SQL server (Azure)

    5. Port - filled in automatically:

      1. PostgreSQL uses 5432

      2. SQL Server uses 1433

  3. Test the connection

    Click 'Test connection'.

    1. If the test succeeds, the 'Create connection' button at the bottom of the page will become available.

    2. If the test fails, check the details you entered and try again.

  4. Choose what to synchronise

    Under 'Access rights (scopes)', select which data Payt should send to your database. The scope determines which data you receive. Only select what you actually need for your reports. You must select at least one option. The following scopes are available:

    Administrations · Customers · Contacts · Invoices · Debt collection cases · Payments · Payment plans · PSP mandates · PSP transactions · Messages · Notes · Notifications · Tasks · Order lines · VAT rates

  5. Choose the administration(s)

    Under 'Administrations', select which administration(s) you want to receive data for. You can choose all current and future administrations, or select specific ones.

  6. Accept the terms and create the connection

    Check the agreement box and click 'Create connection'.

After setting up

Payt synchronises the selected data to your database daily. The first synchronisation takes place the day after setup; there is no immediate first synchronisation. Only changed data is transferred (incremental synchronisation).

In the overview of all connections, you can also start a synchronisation manually using the synchronisation icon 🔁.

Editing or deleting a connection

You can update database details, access rights (scopes), and administrations at any time via the 'Connections' page in your organisation settings. When changing database credentials, you must test the connection again before you can save the connection.

To delete a connection, open the overview of all connections and click the trash icon next to the connection.

Please note: the connection and all associated access rights will be immediately and permanently deleted upon removal.

Related Articles
How do I connect AFAS to Payt?
How do I connect Exact Online to Payt?
How do I connect Netsuite to Payt?
How do I add an iDEAL | Wero link for my customers?
How do I connect my own provider for sending SMS messages?
Did this answer your question?