edoc invoice Administration Guide
edoc invoice Administration Guide
Breadcrumbs

Export transactional data to a destination system

You can export the transactional data in edoc invoice at any time and import it into a selected destination system. The export function for the transactional data is available for SQL databases and for REST API functions.

The export function for transactional data from edoc invoice is helpful, for example, if you want to save the changes to the transactional data per event (backup).

Here's how

  1. Click on edoc invoice in the sidebar to open the edoc invoice dashboard.

  2. Click on Settings and select the relevant company under Company settings.

  3. Click on Data > Export - Transactional data in the sidebar.

  4. Click on New export in the ribbon.

  5. Under Settings, specify the following:

    1. Name: Enter a name for the export.

    2. Connection type: Select the connection type that you have specified for the destination system under Connections > Connection details.

    3. Schema version: Select the version of the schema that you want to use for the export. Select the latest version if you do not have any applications that use an older version.

    4. Workflow restart: Select the In case of incorrect export checkbox to force a restart of the workflow for the Complete workflow event if the export of the transactional data fails. The workflow is then reset to the workflow step that lies in the workflow before the workflow step Complete workflow.

    5. Under Events, select the results that should trigger an export of the transactional data.

For more information on the schema versions, see: Which transactional data is exported with the schema?

SQL database as connection type

If you have selected an SQL database as the connection type, enter the following data in the Connection section:

  • Connection: Select the connection type that you have specified for the destination system under Connections > Connection details.

  • Table prefix: Optional, except when using a Microsoft SQL Server database. Enter a prefix for the table name for the selected SQL database in which the transactional data is to be saved in the destination system. If you are using a Microsoft SQL Server database, you must specify the database schema in the Table prefix field in certain cases. For more information, see: Important note on the table prefix for Microsoft SQL Server databases

  • Table suffix: Optional. Enter a suffix for the table name for the selected SQL database in which the transactional data is to be saved in the destination system.

If you are using an SQL database as the connection type, click Synchronize tables in the ribbon to create the SQL table. Save the export details.

If you want to use a prefix and/or a suffix for the table name, note the length restrictions for table names in your SQL database.

Important note on the table prefix for Microsoft SQL Server databases

If you use a Microsoft SQL Server database for the transactional data export, the target tables must be in the default schema of the SQL Server database of the specified database user. You enter the database user in the settings for a company under Connections > Connection details.

If the default schema of the SQL Server database of the database user differs from the schema of the transactional data tables, you must specify the database schema in the Table prefix field before the table prefix.

Assume that the database schema of the database user is edoc and the transactional data tables are in the database schema dbo. Then enter the following in the Table prefix field, depending on the scenario:

  • Only database schema required (name of the database schema followed by a dot): dbo.

  • Database schema and table prefix in combination (separated by a dot): dbo.<table prefix>

"REST Api" as connection type

If you have selected REST Api as the connection type, enter the following in the Connection section:

  • Connection: Select the connection type that you have specified for the destination system under Connections > Connection details.

  • Export format: Select the export format suitable for your purposes (JSON or XML).

  • Individual endpoints: Only activate this option if you want to send the exports per category (status, header data, transactional data) to separate endpoints:

    • Endpoint - status: Specify the endpoint that receives the statuses.

    • Endpoint - header data: Specify the endpoint that receives the header data.

    • Endpoint - line item data: Specify the endpoint that receives the line item data.

  • Collective endpoint: Enter the endpoint of your API function if you want to send all exports to a single endpoint.

See also