Synchronization Settings

The sync-settings allows you to automatically synchronize your DATATYPES.

For each dataType you must be able to configure:

• frequency: The frequency of synchronization (frequency supported by the datatype)
• schedule: The moment of synchronization
• initial_sync: If a synchronization is to be launched when the DataConnection switches to CONNECTED
• month_history: Number of months of history to be retrieved during the first synchronization. The month_history must be between 0 and 120.

note

The value NONE of frequency disables the scheduled automatic synchronization.

note

The schedule represents the date on which the synchronization will take place. Depending on the frequency of synchronization this date will be used differently:

• DAILY: we will use: Hour / Minute / Second.
• WEEKLY: we will use: DAY of the week /Hour / Minute / Second
• MONTHLY: we will use: DAY / Hour / Minute / Second

The REGISTRATION_PROOF dataType does not support any frequency.

note

Some Provider have some specific behaviour with this setting:

• Company legal FR does not take into account the month history setting
• Infogreffe will use the month history setting to enrich the synchronization.

Moreover, some Datatype have a default month history setting.

Datatype	Default Value
BANK_TRANSACTION	12
COMMERCE_BALANCE	12
COMMERCE_CUSTOMER	12
COMMERCE_DISPUTE	12
COMMERCE_LOCATION	12
COMMERCE_ORDER	12
COMMERCE_PRODUCT	12
COMMERCE_SUBSCRIPTION	12
COMMERCE_TRANSACTION	12

You can configure all your syncs with the endpoint:

PATCH /api/v6/sync-settings

    [
      {
        data_type_name: "COMPANY_PROFILE",
        frequency: "DAILY|WEEKLY|MONTHLY|NONE",
        schedule: "2020-01-01 15:00:00",
        initial_sync: true,
        month_history: 12
      },
      {
        data_type_name: "COMPANY_OFFICER",
        frequency: "DAILY|WEEKLY|MONTHLY|NONE",
        schedule: "2020-01-01 15:00:00",
        initial_sync: true,
        month_history: 12
      },
      ...
    ]