Generate an account balance export file

Before you start

The account balance feature allows you to export an overview of key financial data of your advertisers or partners, including the account balance at the beginning and the end of the period you select. In other words, your will get an overview of the financial flow on your platform.

Please note the overview can only be created for advertisers with the following billing mode:

  • Postpayment direct

  • Postpayment standard

  • Prepayment

Generating the account balance export file

Getting started

Make sure you are logged in to your admin UI, click on ‘finance’ in the main navigation menu and proceed to click on ‘account balances’. If you do so, you will see a page looking more or less like this:

 As you can see, the page contains two elements: a panel in which you can define the settings of the export file and a table containing an overview of all the export files generated on the platform, along with their main settings. Please note the panel will change somewhat depending on whether you choose to create an overview for advertisers or for partners.

Defining the settings of your account balance file

To generate an export file, you need to define the following settings:

  • Under ‘type’, you need to define whether you want to create a file for advertisers or for partners. The next three settings allow you to narrow down what advertisers or partners the file should consider. By default, all of them are selected. You can exclude one or more entities, labels and individual advertisers or partners. Please note that you can always choose to select all again by using the corresponding button in the right top corner of the drop-down menu.

  • Subsequently, you need to select the period to which the data in your file will relate. You can choose to use a dynamic timeframe (last week, last month, etc.) or define a custom timeframe.

  • Under ‘granularity’ you define how the fluctuation of the account balances will be displayed:

    • If you select ‘month’, your file will contain the account balance on the first and last day of every full month in the selected period.

    • If you select ‘day’, your file will contain the account balance for every day during the selected period. If you select this option, your file can get very large. Therefore, it is recommended to narrow down the number of advertisers or partners in your file as much as possible in this case.

  • With the reference currency, you can convert the values of your export in another currency. The conversion rate, the converted values and the currency will be added to the export file separately.

  • Finally, you need to choose the format of your file.

When you are done defining your settings, make sure you hit the button ‘create export’ in the right lower corner of the panel.

Creating your export

Once you have hit the button ‘create report’, a new row will appear in the table at the bottom of the page. In the table, you will find all the settings you have selected, along with a file status. Please note the table has two tabs, one for advertiser and one for partner. The advertiser tab is selected by default.

After you’ve started to create your report, the status of your file will be blue, indicating your file is being generated. The status bar will also indicate in how many minutes your file will be available. As soon as your file is available, the bar will turn green and you can download your file by clicking on the icon in the column ‘files’. Once the export is available for download the status will be updated as shown below:

You don’t have to remain on the page while your file is being generated. If you move to a different page, you will see a notification popping up in the right top corner of the page

Account balance file output

The file you export will contain the data described in the table below. Please not some columns will only appear for the advertiser type, others only for the partner type.

Name

Explanation

Possible values

Name

Explanation

Possible values

period

The period to which the data in the file relates.

yyyy-mm-dd

advertiser_id

The ID of the advertiser (MID) used on the platform. The column only appears when you export the account balances of your advertisers.

Numeric

partner_id

The ID of the partner (UID) used on the platform. The column only appears when you export the account balances of your partners.

Numeric

external_reference

The external reference number of your advertiser or partner. For more information, please read this article.

Alphanumeric

advertiser_name

The name of the advertiser. The column only appears when you export the account balances of your advertisers.

Alphanumeric

name

The company name of the partner. The column only appears when you export the account balances of your partners.

Alphanumeric

vat_id

The VAT ID of the advertiser or the partner.

Alphanumeric

country_code

The ID of the country in which the advertiser is registered, according to the ISO 3166.

Alphabetic, three digits, for example FRA.

start_balance

The account balance on the first day of a month within the selected period (in case you chose a monthly granularity) or the account balance at the beginning of a day within the selected period (in case you chose a daily granularity).

Numeric, seperated by a dot: nn.nn

deposit_amount

The deposit amount of the advertiser. Please note this column only appears when you export the account balances of your advertisers and the advertiser uses prepayment as a billing method.

Numeric, seperated by a dot: nn.nn

delta

The difference between the start and the end balance in the corresponding row. Please note, the amount can be negative.

Numeric, seperated by a dot: nn.nn

end_balance

The account balance on the last day of a month within the selected period (in case you chose a monthly granularity) or the account balance at the end of a day within the selected period (in case you chose a daily granularity).

Numeric, seperated by a dot: nn.nn

billed_amount

The amount already covered in existing invoices.

Numeric, seperated by a dot: nn.nn

billed_amount

The amount already covered in existing payout entries.

Numeric, seperated by a dot: nn.nn

currency_code

The code of the currency applied to the mentioned amounts, according to ISO 4217.

Alphabetic, for example EUR.

labels

Labels applied to the advertiser or the partner.

Alphanumeric

entity_name

The name of the entity to which the advertiser or partner has been allocated.

Alphanumeric

currency_rate

The rate of the currency in which the values are converted.

Numeric, seperated by a dot: nn.nn

end_balance_conv

The converted account balance.

Numeric, seperated by a dot: nn.nn

reference_currency_code

The ISO 4217 code of the currency to which the values were converted.