We’ve migrated our documentation to a new site, which means some URLs have changed.
Audience

Data Extract Schedules

Overview

The Data Extract Schedule feature allows Data Extracts to be automatically generated on a recurring schedule. The created extract reflects the properties of the schedule such as currency, locale and time zone and the start and end dates reflect the period of the schedule.

Data Extract Schedules can also be managed via the Data Extract Schedule REST API.

Usage

The Data Extract Schedules feature is available from the Management tab under the Finance section.

Creating Extract Schedules

Extract Schedules are created by selecting the schedules parameters in the Create Schedule section and clicking Create. 

  • Extract Type - The type of extract to generate. This can be any combination Account Totals, Account Transactions, Inventory Distribution or Operational Finance. See Data Extracts for extract details.

  • Schedule Period - The period type for the schedule. This can be Daily, Weekly or Monthly.

Once the schedule is created, the system will generate the requested extract type for the previous period (yesterday, last week or last month) and will then wait until it is due to run again.

Extracts created via a schedule appear in the Data Extracts page.

Schedule Periods

The following schedule periods are currently supported:

  • Daily - The schedule will create extracts with a start date of midnight and end date of 11:59:59 PM yesterday.

  • Weekly - The schedule will create extracts with a start date of midnight Monday and end date of 11:59:59 PM Sunday for the previous week.

  • Monthly - The schedule will create extracts with a start date of midnight of the 1st and end date of 11:59:59 PM of the last day of the month for the previous month.

General Notes

Email Notification

The system will alert the user who created the schedule via email every time a scheduled extract is created.

Time Zones, Currency and Locale

Extracts generated from a schedule using the time zone, currency and locale of the user who created the schedule as defined in their User Preferences.

All date and time values as well as the start and end dates for the extract are converted into the users time zone.

All currency amounts are converted into the users currency using the exchange rates defined by the broker.

The user locale is used to determine the extracts output in regards to number formatting, translations etc.

Last updated: