ChannelEngine: custom settlement reports [beta]

About this article

This article describes how to retrieve settlement reports via ChannelEngine's web interface and create custom settlement reports.

Table of contents

Introduction

Export settlements

Custom settlement report

• Setup

FAQs

Introduction

Each payment a marketplace performs toward a merchant is included in a settlement report. A settlement report contains the information on transactions and other financial activity. This information helps you reconcile the totals in the report with the amount received from the marketplace.

On ChannelEngine, you can access your marketplace settlement reports through either the web interface or the Merchant API. For more information, check out the article ChannelEngine: settlement reports.

In this article, you learn how to retrieve settlement reports using ChannelEngine's web interface and deliver them to your FTP(S) server or email. Additionally, you learn how to create a custom settlement report using JSON and specify the transactions to include.

Export settlements

To export settlement reports via the web interface, add a ChannelEngine settlement export plugin to your tenant.

1. From the left-hand side menu, go to Plugins, and select the plugin from the dashboard.
2. Go to the Setup page of the plugin. Configure the settings as follows:
   • Export settlements automatically - choose your preferred way of receiving settlement reports: via email or FTP(S) server. If email is selected, provide the email address for settlement export. If FTP(S) server is selected, make sure to enter the required credentials in the Connection settings. I.e.: hostname, username, password, root folder, port number. It is also possible to choose 'No' and retrieve your settlements via the Merchant API.
   • Settlement report type - select the type of the settlement report to be exported to your email or FTP(S) server. Options are:
     
     • Detailed - a detailed report containing all transactions. It includes the currency, transaction type, order date, VAT, and net/gross amount.
     • Custom JSON mapper - a custom settlement report. You can specify which data to include in the report. To configure the settings required for the custom JSON mapper, refer to the next section of the article.
3. Click Save.
4. To activate the plugin on ChannelEngine, go to the Activation tab and toggle the Activate synchronization for settlement export setting.

Once activated, ChannelEngine starts executing the Export settlements to merchant task and sending the settlement reports in CSV format to your email or FTP(S) server. The frequency of the task is set to once a day. To see the latest scheduled tasks, their status, and the next schedule, go to the Dashboard.

Custom settlement report

Use the custom JSON mapper to generate a custom settlement report in CSV format. This report unifies the format of settlements retrieved from various marketplaces, making it easier to settle orders in your systems (e.g.: ERP, financial system).

The report has three parts: order, product, and additional costs. These parts appear in the following order:

1. Order - includes order proceeds and various types of commissions.
2. Product - includes marketplace inventory fees.
3. Additional costs - includes other fees charged by the marketplace, such as marketplace fulfillment fees or subscription fees.

The table below lists all ChannelEngine fields available for mapping.

Setup

To generate a custom settlement report in CSV format:

1. In the Settlement report type dropdown, select Custom JSON mapper.
2. Proceed to the Plugin-specific settings.
3. In the Custom JSON mapper, map ChannelEngine fields to your preferred names. To do so:
   1. Choose the fields to add to the report from the table above.
   2. Input the data in JSON format as shown below. For each ChannelEngine field you add, set the active value to 1 if the field should be included in the report. To hide a certain field, set its value to 0.
   3. Provide the appropriate name for each ChannelEngine field in the name field. E.g.: the JSON configuration below renames the field orderProceeds to 'Order proceeds' in the report. Note that the revenue field is not included in the settlement report as its active value is set to 0.
   4. Lastly, specify the sortId of the property to determine its horizontal placement in the CSV file.
      

      {
       "mapping": {
        "orderProceeds": {
         "active": 1,
         "name": "Order proceeds",
         "sortId": 1
      },
       "fees": {
        "active": 1,
        "name": "fees",
        "sortId": 2
      },
       "revenue": {
        "active": 0,
        "name": "revenue",
        "sortId": 3
        }
       }
      }

4. To include the reference field in the report, enter the value in the corresponding Channel reference for [marketplace] setting on the Setup page. This will be your unique reference for the marketplace.
5. You can easily exclude specific parts from the report (i.e.: order, product, or additional costs) by disabling the corresponding settings at the bottom of the Setup page. To include a certain part in the report, add one or several fields related to that part to the JSON, and make sure the corresponding setting is enabled. E.g.: if you want to add the orderId , orderProceeds, and revenue to your settlement report, make sure the Include order part in export setting is enabled.

FAQs

How do I know if the export of a settlement report has succeeded?

ChannelEngne runs a scheduled task to export settlement reports to your email or FTP(S) server. To receive notifications if the export fails, set up the Settlement export failed notification. For more details, check out the article ChannelEngine: how to configure notifications.