Web API
Need Help?
Contact Us
Home
Getting Started
Access MicrOpay Web API Reference
Access MicrOpay Web API Explorer
AddDeds
GET api/AddDeds?page={page}&pageSize={pageSize}
AuditLogs
GET api/audit-logs/last-changes/{employeeId}
ChangeEmployee
POST api/ChangeEmployee
GET api/ChangeEmployee/{id}
ChangeEmployeeImmediate
POST api/ChangeEmployeeImmediate
CompanyDefaultSuper
GET api/CompanyDefaultSuper
DeletedEmployees
GET api/DeletedEmployees?deletedSince={deletedSince}
EmployeeBasic
GET api/EmployeeBasic?includeTerminated={includeTerminated}&terminatedSince={terminatedSince}&page={page}&pageSize={pageSize}&applyUserDefinedStructure={applyUserDefinedStructure}
GET api/EmployeeBasic/{id}?applyUserDefinedStructure={applyUserDefinedStructure}
GET api/EmployeeBasic?changedSince={changedSince}&includeTerminated={includeTerminated}&page={page}&pageSize={pageSize}&applyUserDefinedStructure={applyUserDefinedStructure}
EmployeeDetails
GET api/EmployeeDetails?includeTerminated={includeTerminated}&terminatedSince={terminatedSince}&page={page}&pageSize={pageSize}&onlyAnnualisedSalary={onlyAnnualisedSalary}&applyUserDefinedStructure={applyUserDefinedStructure}
GET api/EmployeeDetails/{id}?applyUserDefinedStructure={applyUserDefinedStructure}
GET api/EmployeeDetails?changedSince={changedSince}&includeTerminated={includeTerminated}&page={page}&pageSize={pageSize}&onlyAnnualisedSalary={onlyAnnualisedSalary}&applyUserDefinedStructure={applyUserDefinedStructure}
GET api/EmployeeDetails?changedSince={changedSince}&includeTerminated={includeTerminated}&terminatedSince={terminatedSince}&page={page}&pageSize={pageSize}&onlyAnnualisedSalary={onlyAnnualisedSalary}&isEss={isEss}&applyUserDefinedStructure={applyUserDefinedStructure}
EmployeeLeaveBalances
GET api/EmployeeLeaveBalances/{id}
EmployeeLeaveForecasts
GET api/EmployeeLeaveForecasts/{id}?byDate={byDate}
EmployeeRdo
GET api/RDO?page={page}&pageSize={pageSize}
GET api/EmployeeRDOBalance?page={page}&pageSize={pageSize}
GET api/EmployeeRDOBalance/{employeeCode}?page={page}&pageSize={pageSize}
EmployeeTransactionSummary
GET api/EmployeeTransactionSummary?periodEndFromDate={periodEndFromDate}&periodEndToDate={periodEndToDate}&includeTerminated={includeTerminated}&empCode={empCode}&page={page}&pageSize={pageSize}
EmployeeWorkDays
GET api/EmployeeWorkDays/{id}?startDate={startDate}&endDate={endDate}&leaveReasonCode={leaveReasonCode}
LeaveApplication
POST api/LeaveApplication
GET api/LeaveApplication/{id}
LeaveClass
GET api/LeaveClass?page={page}&pageSize={pageSize}&leaveType={leaveType}
LeavePlanning
POST api/LeavePlanning
GET api/LeavePlanning/{id}
LeaveReasons
GET api/LeaveReasons?page={page}&pageSize={pageSize}
LeaveReasonsLive
GET api/LeaveReasonsLive?page={page}&pageSize={pageSize}
GET api/LeaveReasonsLive/{leaveReasonCode}?page={page}&pageSize={pageSize}
Lookups
GET api/Lookups?type={type}&page={page}&pageSize={pageSize}
GET api/Lookups?type={type}&code={code}
MifData
GET api/MifData/{id}
POST api/MifData
PayAdvicePDF
GET api/PayAdvicePDF?empCode={empCode}&periodEndDate={periodEndDate}&payAdvicePDFId={payAdvicePDFId}
PayAdviceSummary
GET api/PayAdviceSummary?periodEndFromDate={periodEndFromDate}&periodEndToDate={periodEndToDate}&empCode={empCode}&page={page}&pageSize={pageSize}
PayClasses
GET api/PayClasses/{payClassCode}?page={page}&pageSize={pageSize}
GET api/PayClasses?page={page}&pageSize={pageSize}
PayFrequency
GET api/PayFrequency
PaymentSummaryData
GET api/PaymentSummaryData?financialYearFrom={financialYearFrom}&financialYearTo={financialYearTo}&empCode={empCode}&page={page}&pageSize={pageSize}
PaymentSummaryPDF
GET api/PaymentSummaryPDF?financialYear={financialYear}&page={page}&pageSize={pageSize}
PayRateHistory
GET api/PayRateHistory/{employeeCode}?page={page}&pageSize={pageSize}&effectiveFrom={effectiveFrom}&effectiveTo={effectiveTo}
GET api/PayRateHistory?page={page}&pageSize={pageSize}&effectiveFrom={effectiveFrom}&effectiveTo={effectiveTo}
SuperFund
GET api/SuperFund?page={page}&pageSize={pageSize}
GET api/SuperFund/{superFundCode}?page={page}&pageSize={pageSize}
TaxScales
GET api/TaxScales?financialYear={financialYear}&page={page}&pageSize={pageSize}
UserDefinedField
GET api/UserDefinedField
Webhooks
POST api/webhooks
GET api/webhooks
DELETE api/webhooks/{webhookId}
WeChangeEmployee
POST api/WeChangeEmployee
GET api/WeChangeEmployee/{id}
WeEmployeeBasic
GET api/WeEmployeeBasic/{id}
GET api/WeEmployeeBasic?includeTerminated={includeTerminated}&terminatedSince={terminatedSince}&page={page}&pageSize={pageSize}
GET api/WeEmployeeBasic?changedSince={changedSince}&includeTerminated={includeTerminated}&page={page}&pageSize={pageSize}
WeEmployeeDetails
GET api/WeEmployeeDetails/{id}
GET api/WeEmployeeDetails?includeTerminated={includeTerminated}&terminatedSince={terminatedSince}&page={page}&pageSize={pageSize}
GET api/WeEmployeeDetails?changedSince={changedSince}&includeTerminated={includeTerminated}&page={page}&pageSize={pageSize}
Access MicrOpay Web API Change Log
Authentication details
Username
Password
api Key
POST api/webhooks
API Reference page
POST data (JSON)
Input format
JSON
XML
Go
Request Info
Response Info
