Skip to main content

Optimum integration

API sync of working hours and absences to Optimum payroll (Lithuania).

Written by Gerda Lill

Use the Optimum integration to sync working hours, overtime, and absences from Begin directly to Optimum payroll software.

Note: Optimum integration must be enabled by the Begin team before it becomes available in your account.

Configure sync settings

Before setting up the integration:

  • Obtain an API key from your Optimum administrator.

  • Obtain the Optimum time-type codes required for your payroll setup.

  • Ensure each employee has an Export code configured in their employee profile. The code must match the employee identifier used in Optimum.

To configure the integration:

  1. Go to Integrations.

  2. Open Optimum.

  3. Enter the API key.

  4. Save your changes.

  5. Open the Setup tab.

  6. Enter the Optimum time-type code for each hour or absence type you want to sync.

  7. Save your changes.

You can configure the following time-type codes:

  • Working hours

  • Night hours

  • Weekend hours

  • Holiday hours

  • Overtime

  • Paid vacation

  • Unpaid vacation

  • Paid sick leave

  • Unpaid sick leave

Note: Leave a time-type code blank if you do not want that type of entry to be synced.

You can also configure a sync schedule to send data automatically.

Run sync

  1. Open the Sync tab.

  2. Select the period you want to sync.

  3. Choose a data source:

    • Real hours – uses worked hours based on attendance.

    • Hybrid – combines scheduled and real hours.

    • Scheduled hours – uses hours from the schedule.

  4. (Optional) Click Filter to sync data for specific employees, locations, departments, or objects.

  5. Click Run Sync.

  6. Wait for the sync to complete.

Sync history

Every sync is recorded in the sync history.

For each sync, you can view:

  • Sync status

  • Sync period

  • Number of records processed

  • User who started the sync

  • Any returned errors or warnings

You can also review any messages returned by Optimum.

Troubleshooting

Authentication failed

Verify that the API key is correct and belongs to the correct Optimum account.

Employee not synced

Make sure the employee has an Export code configured in their employee profile.

No entries were synced

Verify that the selected period contains exportable data and that the required time-type codes have been configured.

Entry rejected by Optimum

Verify that the configured time-type codes exist and are active in Optimum.

Need help?

If the sync fails or Optimum rejects the data, contact our support team through the in-app chat or email support@begin.ee.

Did this answer your question?