Skip to main content

Leave applications sent from third-party to MicrOpay via Web API

Required information for leave transactions sent to MicrOpay via WebAPI and steps to process the leave

Updated over 2 weeks ago

When sending leave applications from your Third-Party system e.g. Time & Attendance or HR system to MicrOpay via the Web API, there are specific data requirements that need to be included in the file. The specification for what needs to be included can be found on the Post Leave Application page of the Web API reference.
​
Each leave application will need to include (amongst other fields) the Leave Type and the Leave Reason. For User Defined Leave applications, you also need to include the User Defined Leave Code. See the table below for specifics.

Parameter

Description of the value to include in the file

LeaveType

Leave Type, must be either:

  • SickLeave

  • AnnualLeave

  • LongServiceLeave

  • UserDefinedLeave

LeaveReason

Code from Leave Reason in MicrOpay

LeaveCode

Code from the User Defined Leave class in MicrOpay

Note: The Leave Type should be inserted as it appears in the table above. The other fields are the code in MicrOpay.

Leave applications posted to the API will display in Payroll, Transactions, Import and Export, Leave Processing.

To process the Leave Applications:

  1. Go to Payroll, Transactions, Import and Export, Leave Processing.

  2. Enter a Description for the batch.

  3. Filter the leave for specific Payroll Companies or Locations or use the default value of All.

  4. Select Pay Frequency. You can only process one Pay Frequency at a time. The current Period End Date for the Frequency will display.

  5. Select the Existing Transactions option. The default is Append. This creates a separate transaction for the leave if one already exists. The other options are Overwrite (deletes and replaces the existing transaction) or Merge (adds leave to the existing transaction).

  6. Choose the processing options that you want to apply:

    • Bypass Standard Additions and Deductions

    • Bypass Bank Splits

    • Add Balance of Hours

  7. Click Preview to load leave into the grid.

  8. Review the leave and tick On Hold for any applications you don't want to process.

  9. Click Process.

Errors

If a User Defined Leave application doesn't include LeaveCode (e.g. TOIL for the Time in Lieu leave class), you may receive the following errors:

  • 'Class not defined for employee. Record Ignored' on the Import Audit Report for User Defined Leave

  • 'LeaveCode is required for User Defined Leave' received in Sage People log for leave in MicrOpay:

Did this answer your question?